Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): Run Error Workflow also on activation error #3470

Merged
merged 2 commits into from
Jun 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions packages/cli/src/ActiveWorkflowRunner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import { ActiveWorkflows, NodeExecuteFunctions } from 'n8n-core';

import {
ExecutionError,
IDeferredPromise,
IExecuteData,
IExecuteResponsePromiseData,
Expand All @@ -22,11 +23,13 @@ import {
INodeExecutionData,
IRun,
IRunExecutionData,
IWorkflowBase,
IWorkflowExecuteAdditionalData as IWorkflowExecuteAdditionalDataWorkflow,
NodeHelpers,
WebhookHttpMethod,
Workflow,
WorkflowActivateMode,
WorkflowActivationError,
WorkflowExecuteMode,
LoggerProxy as Logger,
} from 'n8n-workflow';
Expand Down Expand Up @@ -118,6 +121,7 @@ export class ActiveWorkflowRunner {
workflowName: workflowData.name,
workflowId: workflowData.id,
});
this.executeErrorWorkflow(error, workflowData, 'internal');
}
}
Logger.verbose('Finished initializing active workflows (startup)');
Expand Down Expand Up @@ -715,11 +719,39 @@ export class ActiveWorkflowRunner {
message: error.message,
},
};
const activationError = new WorkflowActivationError(
'There was a problem with the trigger, for that reason did the workflow had to be deactivated',
error,
node,
);

this.executeErrorWorkflow(activationError, workflowData, mode);
};
return returnFunctions;
};
}

executeErrorWorkflow(
error: ExecutionError,
workflowData: IWorkflowBase,
mode: WorkflowExecuteMode,
): void {
const fullRunData: IRun = {
data: {
resultData: {
error,
runData: {},
},
},
finished: false,
mode,
startedAt: new Date(),
stoppedAt: new Date(),
};

WorkflowExecuteAdditionalData.executeErrorWorkflow(workflowData, fullRunData, mode);
}

/**
* Makes a workflow active
*
Expand Down
7 changes: 2 additions & 5 deletions packages/cli/src/WorkflowExecuteAdditionalData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import {
IRun,
IRunExecutionData,
ITaskData,
IWorkflowCredentials,
IWorkflowExecuteAdditionalData,
IWorkflowExecuteHooks,
IWorkflowHooksOptionalParameters,
Expand Down Expand Up @@ -57,7 +56,6 @@ import {
Push,
ResponseHelper,
WebhookHelpers,
WorkflowCredentials,
WorkflowHelpers,
} from '.';
import {
Expand All @@ -66,7 +64,6 @@ import {
getWorkflowOwner,
} from './UserManagement/UserManagementHelper';
import { whereClause } from './WorkflowHelpers';
import { RESPONSE_ERROR_MESSAGES } from './constants';

const ERROR_TRIGGER_TYPE = config.getEnv('nodes.errorTriggerType');

Expand All @@ -79,7 +76,7 @@ const ERROR_TRIGGER_TYPE = config.getEnv('nodes.errorTriggerType');
* @param {WorkflowExecuteMode} mode The mode in which the workflow got started in
* @param {string} [executionId] The id the execution got saved as
*/
function executeErrorWorkflow(
export function executeErrorWorkflow(
workflowData: IWorkflowBase,
fullRunData: IRun,
mode: WorkflowExecuteMode,
Expand Down Expand Up @@ -1028,7 +1025,7 @@ export function sendMessageToUI(source: string, messages: any[]) {
* Returns the base additional data without webhooks
*
* @export
* @param {IWorkflowCredentials} credentials
* @param {userId} string
* @param {INodeParameters} currentNodeParameters
* @returns {Promise<IWorkflowExecuteAdditionalData>}
*/
Expand Down
61 changes: 40 additions & 21 deletions packages/core/src/ActiveWorkflows.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
LoggerProxy as Logger,
Workflow,
WorkflowActivateMode,
WorkflowActivationError,
WorkflowExecuteMode,
} from 'n8n-workflow';

Expand Down Expand Up @@ -82,35 +83,53 @@ export class ActiveWorkflows {
let triggerResponse: ITriggerResponse | undefined;
this.workflowData[id].triggerResponses = [];
for (const triggerNode of triggerNodes) {
triggerResponse = await workflow.runTrigger(
triggerNode,
getTriggerFunctions,
additionalData,
mode,
activation,
);
if (triggerResponse !== undefined) {
// If a response was given save it
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.workflowData[id].triggerResponses!.push(triggerResponse);
try {
triggerResponse = await workflow.runTrigger(
triggerNode,
getTriggerFunctions,
additionalData,
mode,
activation,
);
if (triggerResponse !== undefined) {
// If a response was given save it
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.workflowData[id].triggerResponses!.push(triggerResponse);
}
} catch (error) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
throw new WorkflowActivationError(
'There was a problem activating the workflow',
error,
triggerNode,
);
}
}

const pollNodes = workflow.getPollNodes();
if (pollNodes.length) {
this.workflowData[id].pollResponses = [];
for (const pollNode of pollNodes) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.workflowData[id].pollResponses!.push(
await this.activatePolling(
try {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.workflowData[id].pollResponses!.push(
await this.activatePolling(
pollNode,
workflow,
additionalData,
getPollFunctions,
mode,
activation,
),
);
} catch (error) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
throw new WorkflowActivationError(
'There was a problem activating the workflow',
error,
pollNode,
workflow,
additionalData,
getPollFunctions,
mode,
activation,
),
);
);
}
}
}
}
Expand Down
7 changes: 6 additions & 1 deletion packages/workflow/src/Interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { URLSearchParams } from 'url';
import { IDeferredPromise } from './DeferredPromise';
import { Workflow } from './Workflow';
import { WorkflowHooks } from './WorkflowHooks';
import { WorkflowActivationError } from './WorkflowActivationError';
import { WorkflowOperationError } from './WorkflowErrors';
import { NodeApiError, NodeOperationError } from './NodeErrors';

Expand Down Expand Up @@ -56,7 +57,11 @@ export interface IConnection {
index: number;
}

export type ExecutionError = WorkflowOperationError | NodeOperationError | NodeApiError;
export type ExecutionError =
| WorkflowActivationError
| WorkflowOperationError
| NodeOperationError
| NodeApiError;

// Get used to gives nodes access to credentials
export interface IGetCredentials {
Expand Down
16 changes: 16 additions & 0 deletions packages/workflow/src/WorkflowActivationError.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// eslint-disable-next-line import/no-cycle
import { ExecutionBaseError, INode } from '.';

/**
* Class for instantiating an workflow activation error
*/
export class WorkflowActivationError extends ExecutionBaseError {
node: INode | undefined;

constructor(message: string, error: Error, node?: INode) {
super(error);
this.node = node;
this.cause = error;
this.message = message;
}
}
1 change: 1 addition & 0 deletions packages/workflow/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export * from './NodeErrors';
export * as TelemetryHelpers from './TelemetryHelpers';
export * from './RoutingNode';
export * from './Workflow';
export * from './WorkflowActivationError';
export * from './WorkflowDataProxy';
export * from './WorkflowErrors';
export * from './WorkflowHooks';
Expand Down