mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 01:56:46 +00:00
✨ Add Splunk node (#2180)
* ✨ Create Splunk node * 🔨 Move rejectUnauthorized to credentials * 🔨 Remove trailing slash * 🔨 Clarify 401 error * 🔥 Remove unused params * 🔥 Remove unused logic * ⚡ Guard against code missing * 🔨 Refactor filter * 🔥 Remove params with no effect * 🔥 Remove superfluous description * 🔥 Remove params for unimplemented resource * 🔥 Remove param with no effect * 🐛 Fix multiple roles in user create and upate * 🔥 Remove logging * ⚡ Simplify ID handling * 👕 Fix lint * ⚡ Add cred test * 🎨 Format import * ✏️ Apply Product feedback * 🐛 Make axiox errors compatible Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Iván Ovejero
268
packages/nodes-base/nodes/Splunk/GenericFunctions.ts
Normal file
268
packages/nodes-base/nodes/Splunk/GenericFunctions.ts
Normal file
@@ -0,0 +1,268 @@
|
||||
import {
|
||||
IExecuteFunctions,
|
||||
} from 'n8n-core';
|
||||
|
||||
import {
|
||||
IDataObject,
|
||||
ILoadOptionsFunctions,
|
||||
NodeApiError,
|
||||
} from 'n8n-workflow';
|
||||
|
||||
import {
|
||||
OptionsWithUri,
|
||||
} from 'request';
|
||||
|
||||
import {
|
||||
parseString,
|
||||
} from 'xml2js';
|
||||
|
||||
import {
|
||||
SplunkCredentials,
|
||||
SplunkError,
|
||||
SplunkFeedResponse,
|
||||
SplunkResultResponse,
|
||||
SplunkSearchResponse,
|
||||
} from './types';
|
||||
|
||||
export async function splunkApiRequest(
|
||||
this: IExecuteFunctions | ILoadOptionsFunctions,
|
||||
method: string,
|
||||
endpoint: string,
|
||||
body: IDataObject = {},
|
||||
qs: IDataObject = {},
|
||||
) {
|
||||
const {
|
||||
authToken,
|
||||
baseUrl,
|
||||
allowUnauthorizedCerts,
|
||||
} = await this.getCredentials('splunkApi') as SplunkCredentials;
|
||||
|
||||
const options: OptionsWithUri = {
|
||||
headers: {
|
||||
'Authorization': `Bearer ${authToken}`,
|
||||
'Content-Type': 'application/x-www-form-urlencoded',
|
||||
},
|
||||
method,
|
||||
form: body,
|
||||
qs,
|
||||
uri: `${baseUrl}${endpoint}`,
|
||||
json: true,
|
||||
rejectUnauthorized: !allowUnauthorizedCerts,
|
||||
useQuerystring: true, // serialize roles array as `roles=A&roles=B`
|
||||
};
|
||||
|
||||
if (!Object.keys(body).length) {
|
||||
delete options.body;
|
||||
}
|
||||
|
||||
if (!Object.keys(qs).length) {
|
||||
delete options.qs;
|
||||
}
|
||||
|
||||
try {
|
||||
return await this.helpers.request!(options).then(parseXml);
|
||||
} catch (error) {
|
||||
if (error?.cause?.code === 'ECONNREFUSED') {
|
||||
throw new NodeApiError(this.getNode(), { ...error, code: 401 });
|
||||
}
|
||||
|
||||
const rawError = await parseXml(error.error) as SplunkError;
|
||||
error = extractErrorDescription(rawError);
|
||||
|
||||
if ('fatal' in error) {
|
||||
error = { error: error.fatal };
|
||||
}
|
||||
|
||||
throw new NodeApiError(this.getNode(), error);
|
||||
}
|
||||
}
|
||||
|
||||
// ----------------------------------------
|
||||
// utils
|
||||
// ----------------------------------------
|
||||
|
||||
export function parseXml(xml: string) {
|
||||
return new Promise((resolve, reject) => {
|
||||
parseString(xml, { explicitArray: false }, (error, result) => {
|
||||
error ? reject(error) : resolve(result);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
export function extractErrorDescription(rawError: SplunkError) {
|
||||
const messages = rawError.response?.messages;
|
||||
return messages
|
||||
? { [messages.msg.$.type.toLowerCase()]: messages.msg._ }
|
||||
: rawError;
|
||||
}
|
||||
|
||||
export function toUnixEpoch(timestamp: string) {
|
||||
return Date.parse(timestamp) /1000;
|
||||
}
|
||||
|
||||
// ----------------------------------------
|
||||
// search formatting
|
||||
// ----------------------------------------
|
||||
|
||||
export function formatSearch(responseData: SplunkSearchResponse) {
|
||||
const { entry: entries } = responseData;
|
||||
|
||||
if (!entries) return [];
|
||||
|
||||
return Array.isArray(entries)
|
||||
? entries.map(formatEntry)
|
||||
: [formatEntry(entries)];
|
||||
}
|
||||
|
||||
// ----------------------------------------
|
||||
// feed formatting
|
||||
// ----------------------------------------
|
||||
|
||||
export function formatFeed(responseData: SplunkFeedResponse) {
|
||||
const { entry: entries } = responseData.feed;
|
||||
|
||||
if (!entries) return [];
|
||||
|
||||
return Array.isArray(entries)
|
||||
? entries.map(formatEntry)
|
||||
: [formatEntry(entries)];
|
||||
}
|
||||
|
||||
// ----------------------------------------
|
||||
// result formatting
|
||||
// ----------------------------------------
|
||||
|
||||
export function formatResults(responseData: SplunkResultResponse) {
|
||||
const results = responseData.results.result;
|
||||
if (!results) return [];
|
||||
|
||||
return Array.isArray(results)
|
||||
? results.map(r => formatResult(r.field))
|
||||
: [formatResult(results.field)];
|
||||
}
|
||||
|
||||
/* tslint:disable: no-any */
|
||||
|
||||
function formatResult(field: any): any {
|
||||
return field.reduce((acc: any, cur: any) => {
|
||||
acc = { ...acc, ...compactResult(cur) };
|
||||
return acc;
|
||||
}, {});
|
||||
}
|
||||
|
||||
function compactResult(splunkObject: any): any {
|
||||
if (typeof splunkObject !== 'object') {
|
||||
return {};
|
||||
}
|
||||
|
||||
if (
|
||||
Array.isArray(splunkObject?.value) &&
|
||||
splunkObject?.value[0]?.text
|
||||
) {
|
||||
return {
|
||||
[splunkObject.$.k]: splunkObject.value
|
||||
.map((v: { text: string }) => v.text)
|
||||
.join(','),
|
||||
};
|
||||
}
|
||||
|
||||
if (!splunkObject?.$?.k || !splunkObject?.value?.text) {
|
||||
return {};
|
||||
}
|
||||
|
||||
return {
|
||||
[splunkObject.$.k]: splunkObject.value.text,
|
||||
};
|
||||
}
|
||||
|
||||
// ----------------------------------------
|
||||
// entry formatting
|
||||
// ----------------------------------------
|
||||
|
||||
function formatEntry(entry: any): any {
|
||||
const { content, link, ...rest } = entry;
|
||||
const formattedEntry = { ...rest, ...formatEntryContent(content) };
|
||||
|
||||
if (formattedEntry.id) {
|
||||
formattedEntry.entryUrl = formattedEntry.id;
|
||||
formattedEntry.id = formattedEntry.id.split('/').pop();
|
||||
}
|
||||
|
||||
return formattedEntry;
|
||||
}
|
||||
|
||||
function formatEntryContent(content: any): any {
|
||||
return content['s:dict']['s:key'].reduce((acc: any, cur: any) => {
|
||||
acc = { ...acc, ...compactEntryContent(cur) };
|
||||
return acc;
|
||||
}, {});
|
||||
}
|
||||
|
||||
function compactEntryContent(splunkObject: any): any {
|
||||
if (typeof splunkObject !== 'object') {
|
||||
return {};
|
||||
}
|
||||
|
||||
if (Array.isArray(splunkObject)) {
|
||||
return splunkObject.reduce((acc, cur) => {
|
||||
acc = { ...acc, ...compactEntryContent(cur) };
|
||||
return acc;
|
||||
}, {});
|
||||
}
|
||||
|
||||
if (splunkObject['s:dict']) {
|
||||
const obj = splunkObject['s:dict']['s:key'];
|
||||
return { [splunkObject.$.name]: compactEntryContent(obj) };
|
||||
}
|
||||
|
||||
if (splunkObject['s:list']) {
|
||||
const items = splunkObject['s:list']['s:item'];
|
||||
return { [splunkObject.$.name]: items };
|
||||
}
|
||||
|
||||
if (splunkObject._) {
|
||||
return {
|
||||
[splunkObject.$.name]: splunkObject._,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
[splunkObject.$.name]: '',
|
||||
};
|
||||
}
|
||||
|
||||
// ----------------------------------------
|
||||
// param loaders
|
||||
// ----------------------------------------
|
||||
|
||||
/**
|
||||
* Set count of entries to retrieve.
|
||||
*/
|
||||
export function setCount(this: IExecuteFunctions, qs: IDataObject) {
|
||||
qs.count = this.getNodeParameter('returnAll', 0)
|
||||
? 0
|
||||
: this.getNodeParameter('limit', 0) as number;
|
||||
}
|
||||
|
||||
export function populate(source: IDataObject, destination: IDataObject) {
|
||||
if (Object.keys(source).length) {
|
||||
Object.assign(destination, source);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an ID, with tolerance when contained in an endpoint.
|
||||
* The field `id` in Splunk API responses is a full link.
|
||||
*/
|
||||
export function getId(
|
||||
this: IExecuteFunctions,
|
||||
i: number,
|
||||
idType: 'userId' | 'searchJobId' | 'searchConfigurationId',
|
||||
endpoint: string,
|
||||
) {
|
||||
const id = this.getNodeParameter(idType, i) as string;
|
||||
|
||||
return id.includes(endpoint)
|
||||
? id.split(endpoint).pop()!
|
||||
: id;
|
||||
}
|
||||
Reference in New Issue
Block a user