mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-17 01:54:06 -08:00
640 lines
21 KiB
TypeScript
640 lines
21 KiB
TypeScript
|
import {
|
||
|
|
Credentials,
|
||
|
|
IHookFunctions,
|
||
|
|
ILoadOptionsFunctions,
|
||
|
|
IWorkflowSettings,
|
||
|
|
WorkflowExecute,
|
||
|
|
BINARY_ENCODING,
|
||
|
|
} from './';
|
||
|
|
|
||
|
|
import {
|
||
|
|
IBinaryData,
|
||
|
|
IContextObject,
|
||
|
|
ICredentialDataDecryptedObject,
|
||
|
|
IDataObject,
|
||
|
|
IExecuteData,
|
||
|
|
IExecuteFunctions,
|
||
|
|
IExecuteSingleFunctions,
|
||
|
|
INode,
|
||
|
|
INodeExecutionData,
|
||
|
|
INodeParameters,
|
||
|
|
INodeType,
|
||
|
|
IRunExecutionData,
|
||
|
|
ITaskDataConnections,
|
||
|
|
ITriggerFunctions,
|
||
|
|
IWebhookDescription,
|
||
|
|
IWebhookFunctions,
|
||
|
|
IWorkflowExecuteAdditionalData,
|
||
|
|
NodeHelpers,
|
||
|
|
NodeParameterValue,
|
||
|
|
Workflow,
|
||
|
|
WorkflowExecuteMode,
|
||
|
|
} from 'n8n-workflow';
|
||
|
|
|
||
|
|
import { get } from 'lodash';
|
||
|
|
import * as express from "express";
|
||
|
|
import * as path from 'path';
|
||
|
|
import * as requestPromise from 'request-promise-native';
|
||
|
|
|
||
|
|
import { Magic, MAGIC_MIME_TYPE } from 'mmmagic';
|
||
|
|
|
||
|
|
const magic = new Magic(MAGIC_MIME_TYPE);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Takes a buffer and converts it into the format n8n uses. It encodes the binary data as
|
||
|
|
* base64 and adds metadata.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Buffer} binaryData
|
||
|
|
* @param {string} [filePath]
|
||
|
|
* @param {string} [mimeType]
|
||
|
|
* @returns {Promise<IBinaryData>}
|
||
|
|
*/
|
||
|
|
export async function prepareBinaryData(binaryData: Buffer, filePath?: string, mimeType?: string): Promise<IBinaryData> {
|
||
|
|
if (!mimeType) {
|
||
|
|
// If not mime type is given figure it out
|
||
|
|
mimeType = await new Promise<string>(
|
||
|
|
(resolve, reject) => {
|
||
|
|
magic.detect(binaryData, (err: Error, mimeType: string) => {
|
||
|
|
if (err) {
|
||
|
|
return reject(err);
|
||
|
|
}
|
||
|
|
|
||
|
|
return resolve(mimeType);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
const returnData: IBinaryData = {
|
||
|
|
mimeType,
|
||
|
|
// TODO: Should program it in a way that it does not have to converted to base64
|
||
|
|
// It should only convert to and from base64 when saved in database because
|
||
|
|
// of for example an error or when there is a wait node.
|
||
|
|
data: binaryData.toString(BINARY_ENCODING)
|
||
|
|
};
|
||
|
|
|
||
|
|
if (filePath) {
|
||
|
|
if (filePath.includes('?')) {
|
||
|
|
// Remove maybe present query parameters
|
||
|
|
filePath = filePath.split('?').shift();
|
||
|
|
}
|
||
|
|
|
||
|
|
const filePathParts = path.parse(filePath as string);
|
||
|
|
|
||
|
|
returnData.fileName = filePathParts.base;
|
||
|
|
|
||
|
|
// Remove the dot
|
||
|
|
const fileExtension = filePathParts.ext.slice(1);
|
||
|
|
if (fileExtension) {
|
||
|
|
returnData.fileExtension = fileExtension;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return returnData;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Takes generic input data and brings it into the json format n8n uses.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {(IDataObject | IDataObject[])} jsonData
|
||
|
|
* @returns {INodeExecutionData[]}
|
||
|
|
*/
|
||
|
|
export function returnJsonArray(jsonData: IDataObject | IDataObject[]): INodeExecutionData[] {
|
||
|
|
const returnData: INodeExecutionData[] = [];
|
||
|
|
|
||
|
|
if (!Array.isArray(jsonData)) {
|
||
|
|
jsonData = [jsonData];
|
||
|
|
}
|
||
|
|
|
||
|
|
jsonData.forEach((data) => {
|
||
|
|
returnData.push({ json: data });
|
||
|
|
});
|
||
|
|
|
||
|
|
return returnData;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the requested decrypted credentials if the node has access to them.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow Workflow which requests the data
|
||
|
|
* @param {INode} node Node which request the data
|
||
|
|
* @param {string} type The credential type to return
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @returns {(ICredentialDataDecryptedObject | undefined)}
|
||
|
|
*/
|
||
|
|
export function getCredentials(workflow: Workflow, node: INode, type: string, additionalData: IWorkflowExecuteAdditionalData): ICredentialDataDecryptedObject | undefined {
|
||
|
|
|
||
|
|
// Get the NodeType as it has the information if the credentials are required
|
||
|
|
const nodeType = workflow.nodeTypes.getByName(node.type);
|
||
|
|
if (nodeType === undefined) {
|
||
|
|
throw new Error(`Node type "${node.type}" is not known so can not get credentials!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (nodeType.description.credentials === undefined) {
|
||
|
|
throw new Error(`Node type "${node.type}" does not have any credentials defined!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
const nodeCredentialDescription = nodeType.description.credentials.find((credentialTypeDescription) => credentialTypeDescription.name === type);
|
||
|
|
if (nodeCredentialDescription === undefined) {
|
||
|
|
throw new Error(`Node type "${node.type}" does not have any credentials of type "${type}" defined!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (NodeHelpers.displayParameter(node.parameters, nodeCredentialDescription, node.parameters) === false) {
|
||
|
|
// Credentials should not be displayed so return undefined even if they would be defined
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Check if node has any credentials defined
|
||
|
|
if (!node.credentials || !node.credentials[type]) {
|
||
|
|
// If none are defined check if the credentials are required or not
|
||
|
|
|
||
|
|
if (nodeCredentialDescription.required === true) {
|
||
|
|
// Credentials are required so error
|
||
|
|
if (!node.credentials) {
|
||
|
|
throw new Error('Node does not have any credentials set!');
|
||
|
|
}
|
||
|
|
if (!node.credentials[type]) {
|
||
|
|
throw new Error(`Node does not have any credentials set for "${type}"!`);
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
// Credentials are not required so resolve with undefined
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
const name = node.credentials[type];
|
||
|
|
|
||
|
|
if (!additionalData.credentials[type]) {
|
||
|
|
throw new Error(`No credentials of type "${type}" exist.`);
|
||
|
|
}
|
||
|
|
if (!additionalData.credentials[type][name]) {
|
||
|
|
throw new Error(`No credentials with name "${name}" exist for type "${type}".`);
|
||
|
|
}
|
||
|
|
const credentialData = additionalData.credentials[type][name];
|
||
|
|
|
||
|
|
const credentials = new Credentials(name, type, credentialData.nodesAccess, credentialData.data);
|
||
|
|
const decryptedDataObject = credentials.getData(additionalData.encryptionKey, node.type);
|
||
|
|
|
||
|
|
if (decryptedDataObject === null) {
|
||
|
|
throw new Error('Could not get the credentials');
|
||
|
|
}
|
||
|
|
|
||
|
|
return decryptedDataObject;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the requested resolved (all expressions replaced) node parameters.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {(IRunExecutionData | null)} runExecutionData
|
||
|
|
* @param {number} runIndex
|
||
|
|
* @param {INodeExecutionData[]} connectionInputData
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {string} parameterName
|
||
|
|
* @param {number} itemIndex
|
||
|
|
* @param {*} [fallbackValue]
|
||
|
|
* @returns {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object)}
|
||
|
|
*/
|
||
|
|
export function getNodeParameter(workflow: Workflow, runExecutionData: IRunExecutionData | null, runIndex: number, connectionInputData: INodeExecutionData[], node: INode, parameterName: string, itemIndex: number, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object { //tslint:disable-line:no-any
|
||
|
|
const nodeType = workflow.nodeTypes.getByName(node.type);
|
||
|
|
if (nodeType === undefined) {
|
||
|
|
throw new Error(`Node type "${node.type}" is not known so can not return paramter value!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
const value = get(node.parameters, parameterName, fallbackValue);
|
||
|
|
|
||
|
|
if (value === undefined) {
|
||
|
|
throw new Error(`Could not get parameter "${parameterName}"!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
const returnData = workflow.getParameterValue(value, runExecutionData, runIndex, itemIndex, node.name, connectionInputData);
|
||
|
|
|
||
|
|
return returnData;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the timezone for the workflow
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @returns {string}
|
||
|
|
*/
|
||
|
|
export function getTimezone(workflow: Workflow, additionalData: IWorkflowExecuteAdditionalData):string {
|
||
|
|
if (workflow.settings !== undefined && workflow.settings.timezone !== undefined) {
|
||
|
|
return (workflow.settings as IWorkflowSettings).timezone as string;
|
||
|
|
}
|
||
|
|
return additionalData.timezone;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the execute functions the trigger nodes have access to.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @param {WorkflowExecuteMode} mode
|
||
|
|
* @returns {ITriggerFunctions}
|
||
|
|
*/
|
||
|
|
export function getExecuteTriggerFunctions(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): ITriggerFunctions {
|
||
|
|
return ((workflow: Workflow, node: INode) => {
|
||
|
|
return {
|
||
|
|
emit: (data: INodeExecutionData[][]): void => {
|
||
|
|
const workflowExecute = new WorkflowExecute(additionalData, mode);
|
||
|
|
const nodeExecutionStack: IExecuteData[] = [
|
||
|
|
{
|
||
|
|
node,
|
||
|
|
data: {
|
||
|
|
main: data,
|
||
|
|
}
|
||
|
|
}
|
||
|
|
];
|
||
|
|
|
||
|
|
const runExecutionData: IRunExecutionData = {
|
||
|
|
startData: {},
|
||
|
|
resultData: {
|
||
|
|
runData: {},
|
||
|
|
},
|
||
|
|
executionData: {
|
||
|
|
contextData: {},
|
||
|
|
nodeExecutionStack,
|
||
|
|
waitingExecution: {},
|
||
|
|
},
|
||
|
|
};
|
||
|
|
|
||
|
|
workflowExecute.runExecutionData(workflow, runExecutionData);
|
||
|
|
},
|
||
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined {
|
||
|
|
return getCredentials(workflow, node, type, additionalData);
|
||
|
|
},
|
||
|
|
getMode: (): WorkflowExecuteMode => {
|
||
|
|
return mode;
|
||
|
|
},
|
||
|
|
getNodeParameter: (parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object => { //tslint:disable-line:no-any
|
||
|
|
const runExecutionData: IRunExecutionData | null = null;
|
||
|
|
const itemIndex = 0;
|
||
|
|
const runIndex = 0;
|
||
|
|
const connectionInputData: INodeExecutionData[] = [];
|
||
|
|
|
||
|
|
return getNodeParameter(workflow, runExecutionData, runIndex, connectionInputData, node, parameterName, itemIndex, fallbackValue);
|
||
|
|
},
|
||
|
|
getTimezone: (): string => {
|
||
|
|
return getTimezone(workflow, additionalData);
|
||
|
|
},
|
||
|
|
getWorkflowStaticData(type: string): IDataObject {
|
||
|
|
return workflow.getStaticData(type, node);
|
||
|
|
},
|
||
|
|
helpers: {
|
||
|
|
prepareBinaryData,
|
||
|
|
request: requestPromise,
|
||
|
|
returnJsonArray,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
}) (workflow, node);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the execute functions regular nodes have access to.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {IRunExecutionData} runExecutionData
|
||
|
|
* @param {number} runIndex
|
||
|
|
* @param {INodeExecutionData[]} connectionInputData
|
||
|
|
* @param {ITaskDataConnections} inputData
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @param {WorkflowExecuteMode} mode
|
||
|
|
* @returns {IExecuteFunctions}
|
||
|
|
*/
|
||
|
|
export function getExecuteFunctions(workflow: Workflow, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], inputData: ITaskDataConnections, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): IExecuteFunctions {
|
||
|
|
return ((workflow, runExecutionData, connectionInputData, inputData, node) => {
|
||
|
|
return {
|
||
|
|
getContext(type: string): IContextObject {
|
||
|
|
return NodeHelpers.getContext(runExecutionData, type, node);
|
||
|
|
},
|
||
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined {
|
||
|
|
return getCredentials(workflow, node, type, additionalData);
|
||
|
|
},
|
||
|
|
getInputData: (inputIndex = 0, inputName = 'main') => {
|
||
|
|
|
||
|
|
if (!inputData.hasOwnProperty(inputName)) {
|
||
|
|
// Return empty array because else it would throw error when nothing is connected to input
|
||
|
|
return [];
|
||
|
|
}
|
||
|
|
|
||
|
|
// TODO: Check if nodeType has input with that index defined
|
||
|
|
if (inputData[inputName].length < inputIndex) {
|
||
|
|
throw new Error(`Could not get input index "${inputIndex}" of input "${inputName}"!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
if (inputData[inputName][inputIndex] === null) {
|
||
|
|
// return [];
|
||
|
|
throw new Error(`Value "${inputIndex}" of input "${inputName}" did not get set!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
// TODO: Maybe do clone of data only here so it only clones the data that is really needed
|
||
|
|
return inputData[inputName][inputIndex] as INodeExecutionData[];
|
||
|
|
},
|
||
|
|
getNodeParameter: (parameterName: string, itemIndex: number, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object => { //tslint:disable-line:no-any
|
||
|
|
return getNodeParameter(workflow, runExecutionData, runIndex, connectionInputData, node, parameterName, itemIndex, fallbackValue);
|
||
|
|
},
|
||
|
|
getMode: (): WorkflowExecuteMode => {
|
||
|
|
return mode;
|
||
|
|
},
|
||
|
|
getTimezone: (): string => {
|
||
|
|
return getTimezone(workflow, additionalData);
|
||
|
|
},
|
||
|
|
getWorkflowStaticData(type: string): IDataObject {
|
||
|
|
return workflow.getStaticData(type, node);
|
||
|
|
},
|
||
|
|
prepareOutputData: NodeHelpers.prepareOutputData,
|
||
|
|
helpers: {
|
||
|
|
prepareBinaryData,
|
||
|
|
request: requestPromise,
|
||
|
|
returnJsonArray,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
})(workflow, runExecutionData, connectionInputData, inputData, node);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the execute functions regular nodes have access to when single-function is defined.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {IRunExecutionData} runExecutionData
|
||
|
|
* @param {number} runIndex
|
||
|
|
* @param {INodeExecutionData[]} connectionInputData
|
||
|
|
* @param {ITaskDataConnections} inputData
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {number} itemIndex
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @param {WorkflowExecuteMode} mode
|
||
|
|
* @returns {IExecuteSingleFunctions}
|
||
|
|
*/
|
||
|
|
export function getExecuteSingleFunctions(workflow: Workflow, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], inputData: ITaskDataConnections, node: INode, itemIndex: number, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): IExecuteSingleFunctions {
|
||
|
|
return ((workflow, runExecutionData, connectionInputData, inputData, node, itemIndex) => {
|
||
|
|
return {
|
||
|
|
getContext(type: string): IContextObject {
|
||
|
|
return NodeHelpers.getContext(runExecutionData, type, node);
|
||
|
|
},
|
||
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined {
|
||
|
|
return getCredentials(workflow, node, type, additionalData);
|
||
|
|
},
|
||
|
|
getInputData: (inputIndex = 0, inputName = 'main') => {
|
||
|
|
if (!inputData.hasOwnProperty(inputName)) {
|
||
|
|
// Return empty array because else it would throw error when nothing is connected to input
|
||
|
|
return {json: {}};
|
||
|
|
}
|
||
|
|
|
||
|
|
// TODO: Check if nodeType has input with that index defined
|
||
|
|
if (inputData[inputName].length < inputIndex) {
|
||
|
|
throw new Error(`Could not get input index "${inputIndex}" of input "${inputName}"!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
const allItems = inputData[inputName][inputIndex];
|
||
|
|
|
||
|
|
if (allItems === null) {
|
||
|
|
// return [];
|
||
|
|
throw new Error(`Value "${inputIndex}" of input "${inputName}" did not get set!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (allItems[itemIndex] === null) {
|
||
|
|
// return [];
|
||
|
|
throw new Error(`Value "${inputIndex}" of input "${inputName}" with itemIndex "${itemIndex}" did not get set!`);
|
||
|
|
}
|
||
|
|
|
||
|
|
return allItems[itemIndex] as INodeExecutionData;
|
||
|
|
},
|
||
|
|
getMode: (): WorkflowExecuteMode => {
|
||
|
|
return mode;
|
||
|
|
},
|
||
|
|
getTimezone: (): string => {
|
||
|
|
return getTimezone(workflow, additionalData);
|
||
|
|
},
|
||
|
|
getNodeParameter: (parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object => { //tslint:disable-line:no-any
|
||
|
|
return getNodeParameter(workflow, runExecutionData, runIndex, connectionInputData, node, parameterName, itemIndex, fallbackValue);
|
||
|
|
},
|
||
|
|
getWorkflowStaticData(type: string): IDataObject {
|
||
|
|
return workflow.getStaticData(type, node);
|
||
|
|
},
|
||
|
|
helpers: {
|
||
|
|
prepareBinaryData,
|
||
|
|
request: requestPromise,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
})(workflow, runExecutionData, connectionInputData, inputData, node, itemIndex);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the execute functions regular nodes have access to in load-options-function.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @returns {ILoadOptionsFunctions}
|
||
|
|
*/
|
||
|
|
export function getLoadOptionsFunctions(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData): ILoadOptionsFunctions {
|
||
|
|
return ((workflow: Workflow, node: INode) => {
|
||
|
|
const that = {
|
||
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined {
|
||
|
|
return getCredentials(workflow, node, type, additionalData);
|
||
|
|
},
|
||
|
|
getNodeParameter: (parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object => { //tslint:disable-line:no-any
|
||
|
|
const runExecutionData: IRunExecutionData | null = null;
|
||
|
|
const itemIndex = 0;
|
||
|
|
const runIndex = 0;
|
||
|
|
const connectionInputData: INodeExecutionData[] = [];
|
||
|
|
|
||
|
|
return getNodeParameter(workflow, runExecutionData, runIndex, connectionInputData, node, parameterName, itemIndex, fallbackValue);
|
||
|
|
},
|
||
|
|
getTimezone: (): string => {
|
||
|
|
return getTimezone(workflow, additionalData);
|
||
|
|
},
|
||
|
|
helpers: {
|
||
|
|
request: requestPromise,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
return that;
|
||
|
|
})(workflow, node);
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the execute functions regular nodes have access to in hook-function.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @param {WorkflowExecuteMode} mode
|
||
|
|
* @returns {IHookFunctions}
|
||
|
|
*/
|
||
|
|
export function getExecuteHookFunctions(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, isTest?: boolean): IHookFunctions {
|
||
|
|
return ((workflow: Workflow, node: INode) => {
|
||
|
|
const that = {
|
||
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined {
|
||
|
|
return getCredentials(workflow, node, type, additionalData);
|
||
|
|
},
|
||
|
|
getMode: (): WorkflowExecuteMode => {
|
||
|
|
return mode;
|
||
|
|
},
|
||
|
|
getNodeParameter: (parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object => { //tslint:disable-line:no-any
|
||
|
|
const runExecutionData: IRunExecutionData | null = null;
|
||
|
|
const itemIndex = 0;
|
||
|
|
const runIndex = 0;
|
||
|
|
const connectionInputData: INodeExecutionData[] = [];
|
||
|
|
|
||
|
|
return getNodeParameter(workflow, runExecutionData, runIndex, connectionInputData, node, parameterName, itemIndex, fallbackValue);
|
||
|
|
},
|
||
|
|
getNodeWebhookUrl: (name: string): string | undefined => {
|
||
|
|
let baseUrl = additionalData.webhookBaseUrl;
|
||
|
|
if (isTest === true) {
|
||
|
|
baseUrl = additionalData.webhookTestBaseUrl;
|
||
|
|
}
|
||
|
|
|
||
|
|
const webhookDescription = that.getWebhookDescription(name);
|
||
|
|
if (webhookDescription === undefined) {
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
const path = workflow.getWebhookParameterValue(node, webhookDescription, 'path');
|
||
|
|
if (path === undefined) {
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
return NodeHelpers.getNodeWebhookUrl(baseUrl, workflow.id!, node, path);
|
||
|
|
},
|
||
|
|
getTimezone: (): string => {
|
||
|
|
return getTimezone(workflow, additionalData);
|
||
|
|
},
|
||
|
|
getWebhookDescription(name: string): IWebhookDescription | undefined {
|
||
|
|
const nodeType = workflow.nodeTypes.getByName(node.type) as INodeType;
|
||
|
|
|
||
|
|
if (nodeType.description.webhooks === undefined) {
|
||
|
|
// Node does not have any webhooks so return
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
for (const webhookDescription of nodeType.description.webhooks) {
|
||
|
|
if (webhookDescription.name === name) {
|
||
|
|
return webhookDescription;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return undefined;
|
||
|
|
},
|
||
|
|
getWorkflowStaticData(type: string): IDataObject {
|
||
|
|
return workflow.getStaticData(type, node);
|
||
|
|
},
|
||
|
|
helpers: {
|
||
|
|
request: requestPromise,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
return that;
|
||
|
|
})(workflow, node);
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the execute functions regular nodes have access to when webhook-function is defined.
|
||
|
|
*
|
||
|
|
* @export
|
||
|
|
* @param {Workflow} workflow
|
||
|
|
* @param {IRunExecutionData} runExecutionData
|
||
|
|
* @param {INode} node
|
||
|
|
* @param {IWorkflowExecuteAdditionalData} additionalData
|
||
|
|
* @param {WorkflowExecuteMode} mode
|
||
|
|
* @returns {IWebhookFunctions}
|
||
|
|
*/
|
||
|
|
export function getExecuteWebhookFunctions(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): IWebhookFunctions {
|
||
|
|
return ((workflow: Workflow, node: INode) => {
|
||
|
|
return {
|
||
|
|
getBodyData(): IDataObject {
|
||
|
|
if (additionalData.httpRequest === undefined) {
|
||
|
|
throw new Error('Request is missing!');
|
||
|
|
}
|
||
|
|
return additionalData.httpRequest.body;
|
||
|
|
},
|
||
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined {
|
||
|
|
return getCredentials(workflow, node, type, additionalData);
|
||
|
|
},
|
||
|
|
getHeaderData(): object {
|
||
|
|
if (additionalData.httpRequest === undefined) {
|
||
|
|
throw new Error('Request is missing!');
|
||
|
|
}
|
||
|
|
return additionalData.httpRequest.headers;
|
||
|
|
},
|
||
|
|
getMode: (): WorkflowExecuteMode => {
|
||
|
|
return mode;
|
||
|
|
},
|
||
|
|
getNodeParameter: (parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object => { //tslint:disable-line:no-any
|
||
|
|
const runExecutionData: IRunExecutionData | null = null;
|
||
|
|
const itemIndex = 0;
|
||
|
|
const runIndex = 0;
|
||
|
|
const connectionInputData: INodeExecutionData[] = [];
|
||
|
|
|
||
|
|
return getNodeParameter(workflow, runExecutionData, runIndex, connectionInputData, node, parameterName, itemIndex, fallbackValue);
|
||
|
|
},
|
||
|
|
getQueryData(): object {
|
||
|
|
if (additionalData.httpRequest === undefined) {
|
||
|
|
throw new Error('Request is missing!');
|
||
|
|
}
|
||
|
|
return additionalData.httpRequest.query;
|
||
|
|
},
|
||
|
|
getRequestObject(): express.Request {
|
||
|
|
if (additionalData.httpRequest === undefined) {
|
||
|
|
throw new Error('Request is missing!');
|
||
|
|
}
|
||
|
|
return additionalData.httpRequest;
|
||
|
|
},
|
||
|
|
getResponseObject(): express.Response {
|
||
|
|
if (additionalData.httpResponse === undefined) {
|
||
|
|
throw new Error('Response is missing!');
|
||
|
|
}
|
||
|
|
return additionalData.httpResponse;
|
||
|
|
},
|
||
|
|
getTimezone: (): string => {
|
||
|
|
return getTimezone(workflow, additionalData);
|
||
|
|
},
|
||
|
|
getWorkflowStaticData(type: string): IDataObject {
|
||
|
|
return workflow.getStaticData(type, node);
|
||
|
|
},
|
||
|
|
prepareOutputData: NodeHelpers.prepareOutputData,
|
||
|
|
helpers: {
|
||
|
|
prepareBinaryData,
|
||
|
|
request: requestPromise,
|
||
|
|
returnJsonArray,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
})(workflow, node);
|
||
|
|
|
||
|
|
}
|