n8n/packages/nodes-base/nodes/StopAndError/StopAndError.node.ts

108 lines
2.5 KiB
TypeScript
Raw Normal View History

import { IExecuteFunctions } from 'n8n-core';
import {
INodeExecutionData,
INodeType,
INodeTypeDescription,
jsonParse,
NodeOperationError,
} from 'n8n-workflow';
const errorObjectPlaceholder = `{
"code": "404",
"description": "The resource could not be fetched"
}`;
export class StopAndError implements INodeType {
description: INodeTypeDescription = {
displayName: 'Stop and Error',
name: 'stopAndError',
icon: 'fa:exclamation-triangle',
group: ['input'],
version: 1,
description: 'Throw an error in the workflow',
defaults: {
name: 'Stop And Error',
color: '#ff0000',
},
inputs: ['main'],
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
// eslint-disable-next-line n8n-nodes-base/node-class-description-outputs-wrong
outputs: [],
properties: [
{
displayName: 'Error Type',
name: 'errorType',
type: 'options',
options: [
{
name: 'Error Message',
value: 'errorMessage',
},
{
name: 'Error Object',
value: 'errorObject',
},
],
default: 'errorMessage',
description: 'Type of error to throw',
},
{
displayName: 'Error Message',
name: 'errorMessage',
type: 'string',
placeholder: 'An error occurred!',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
required: true,
displayOptions: {
show: {
errorType: ['errorMessage'],
},
},
},
{
displayName: 'Error Object',
name: 'errorObject',
type: 'json',
description: 'Object containing error properties',
default: '',
typeOptions: {
alwaysOpenEditWindow: true,
},
placeholder: errorObjectPlaceholder,
required: true,
displayOptions: {
show: {
errorType: ['errorObject'],
},
},
},
],
};
execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const errorType = this.getNodeParameter('errorType', 0) as 'errorMessage' | 'errorObject';
const { id: workflowId, name: workflowName } = this.getWorkflow();
let toThrow: string | { name: string; message: string; [otherKey: string]: unknown };
if (errorType === 'errorMessage') {
toThrow = this.getNodeParameter('errorMessage', 0) as string;
} else {
const json = this.getNodeParameter('errorObject', 0) as string;
// tslint:disable-next-line:no-any
const errorObject = jsonParse<any>(json);
toThrow = {
name: 'User-thrown error',
message: `Workflow ID ${workflowId} "${workflowName}" has failed`,
...errorObject,
};
}
throw new NodeOperationError(this.getNode(), toThrow);
}
}