mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-24 04:04:06 -08:00
✨ Add Stop and Error node (#2232)
* Throw Error Node * 🔨 Refactor Throw Error node * 🚚 Rename node * ⚡ Allow multiple nodes in the workflow * 🚚 Rename node * ⚡ Fix codex file name Co-authored-by: Günther Erb <Guenther.Erb@gruber-logistics.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
parent
1341958aae
commit
d3a312cc6b
25
packages/nodes-base/nodes/StopAndError.node.json
Normal file
25
packages/nodes-base/nodes/StopAndError.node.json
Normal file
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"node": "n8n-nodes-base.stopAndError",
|
||||
"nodeVersion": "1.0",
|
||||
"codexVersion": "1.0",
|
||||
"categories": [
|
||||
"Core Nodes"
|
||||
],
|
||||
"resources": {
|
||||
"primaryDocumentation": [
|
||||
{
|
||||
"url": "https://docs.n8n.io/nodes/n8n-nodes-base.stopAndError/"
|
||||
}
|
||||
]
|
||||
},
|
||||
"alias": [
|
||||
"error",
|
||||
"throw",
|
||||
"exception"
|
||||
],
|
||||
"subcategories": {
|
||||
"Core Nodes": [
|
||||
"Flow"
|
||||
]
|
||||
}
|
||||
}
|
110
packages/nodes-base/nodes/StopAndError.node.ts
Normal file
110
packages/nodes-base/nodes/StopAndError.node.ts
Normal file
|
@ -0,0 +1,110 @@
|
|||
import {
|
||||
IExecuteFunctions,
|
||||
} from 'n8n-core';
|
||||
|
||||
import {
|
||||
INodeExecutionData,
|
||||
INodeType,
|
||||
INodeTypeDescription,
|
||||
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'],
|
||||
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;
|
||||
const errorObject = JSON.parse(json);
|
||||
|
||||
toThrow = {
|
||||
name: 'User-thrown error',
|
||||
message: `Workflow ID ${workflowId} "${workflowName}" has failed`,
|
||||
...errorObject,
|
||||
};
|
||||
}
|
||||
|
||||
throw new NodeOperationError(this.getNode(), toThrow);
|
||||
}
|
||||
}
|
|
@ -584,6 +584,7 @@
|
|||
"dist/nodes/Salesmate/Salesmate.node.js",
|
||||
"dist/nodes/Segment/Segment.node.js",
|
||||
"dist/nodes/Sendy/Sendy.node.js",
|
||||
"dist/nodes/StopAndError.node.js",
|
||||
"dist/nodes/SurveyMonkey/SurveyMonkeyTrigger.node.js",
|
||||
"dist/nodes/Taiga/Taiga.node.js",
|
||||
"dist/nodes/Taiga/TaigaTrigger.node.js",
|
||||
|
|
Loading…
Reference in a new issue