✨ Improve node error handling (#1309)

* Add path mapping and response error interfaces

* Add error handling and throwing functionality

* Refactor error handling into a single function

* Re-implement error handling in Hacker News node

* Fix linting details

* Re-implement error handling in Spotify node

* Re-implement error handling in G Suite Admin node

* 🚧 create basic setup NodeError

* 🚧 add httpCodes

* 🚧 add path priolist

* 🚧 handle statusCode in error, adjust interfaces

* 🚧 fixing type issues w/Ivan

* 🚧 add error exploration

* 👔 fix linter issues

* 🔧 improve object check

* 🚧 remove path passing from NodeApiError

* 🚧 add multi error + refactor findProperty method

* 👔 allow any

* 🔧 handle multi error message callback

* ⚡ change return type of callback

* ⚡ add customCallback to MultiError

* 🚧 refactor to use INode

* 🔨 handle arrays, continue search after first null property found

* 🚫 refactor method access

* 🚧 setup NodeErrorView

* ⚡ change timestamp to Date.now

* 📚 Add documentation for methods and constants

* 🚧 change message setting

* 🚚 move NodeErrors to workflow

* ✨ add new ErrorView for Nodes

* 🎨 improve error notification

* 🎨 refactor interfaces

* ⚡ add WorkflowOperationError, refactor error throwing

* 👕 fix linter issues

* 🎨 rename param

* 🐛 fix handling normal errors

* ⚡ add usage of NodeApiError

* 🎨 fix throw new error instead of constructor

* 🎨 remove unnecessary code/comments

* 🎨 adjusted spacing + updated status messages

* 🎨 fix tab indentation

* ✨ Replace current errors with custom errors (#1576)

* ⚡ Introduce NodeApiError in catch blocks

* ⚡ Introduce NodeOperationError in nodes

* ⚡ Add missing errors and remove incompatible

* ⚡ Fix NodeOperationError in incompatible nodes

* 🔧 Adjust error handling in missed nodes

PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes

* 🔨 Adjust Strava Trigger node error handling

* 🔨 Adjust AWS nodes error handling

* 🔨 Remove duplicate instantiation of NodeApiError

* 🐛 fix strava trigger node error handling

* Add XML parsing to NodeApiError constructor (#1633)

* 🐛 Remove type annotation from catch variable

* ✨ Add XML parsing to NodeApiError

* ⚡ Simplify error handling in Rekognition node

* ⚡ Pass in XML flag in generic functions

* 🔥 Remove try/catch wrappers at call sites

* 🔨 Refactor setting description from XML

* 🔨 Refactor let to const in resource loaders

* ⚡ Find property in parsed XML

* ⚡ Change let to const

* 🔥 Remove unneeded try/catch block

* 👕 Fix linting issues

* 🐛 Fix errors from merge conflict resolution

* ⚡ Add custom errors to latest contributions

* 👕 Fix linting issues

* ⚡ Refactor MongoDB helpers for custom errors

* 🐛 Correct custom error type

* ⚡ Apply feedback to A nodes

* ⚡ Apply feedback to missed A node

* ⚡ Apply feedback to B-D nodes

* ⚡ Apply feedback to E-F nodes

* ⚡ Apply feedback to G nodes

* ⚡ Apply feedback to H-L nodes

* ⚡ Apply feedback to M nodes

* ⚡ Apply feedback to P nodes

* ⚡ Apply feedback to R nodes

* ⚡ Apply feedback to S nodes

* ⚡ Apply feedback to T nodes

* ⚡ Apply feedback to V-Z nodes

* ⚡ Add HTTP code to iterable node error

* 🔨 Standardize e as error

* 🔨 Standardize err as error

* ⚡ Fix error handling for non-standard nodes

Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com>

Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com>
Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>

packages/cli/src/WorkflowRunner.ts

@@ -27,12 +27,12 @@ import {
 } from 'n8n-core';
 
 import {
-	IDataObject,
-	IExecutionError,
+	ExecutionError,
 	IRun,
 	Workflow,
 	WorkflowExecuteMode,
 	WorkflowHooks,
+	WorkflowOperationError,
 } from 'n8n-workflow';
 
 import * as config from '../config';
@@ -78,13 +78,13 @@ export class WorkflowRunner {
 	/**
 	 * The process did error
 	 *
-	 * @param {IExecutionError} error
+	 * @param {ExecutionError} error
 	 * @param {Date} startedAt
 	 * @param {WorkflowExecuteMode} executionMode
 	 * @param {string} executionId
 	 * @memberof WorkflowRunner
 	 */
-	processError(error: IExecutionError, startedAt: Date, executionMode: WorkflowExecuteMode, executionId: string) {
+	processError(error: ExecutionError, startedAt: Date, executionMode: WorkflowExecuteMode, executionId: string) {
 		const fullRunData: IRun = {
 			data: {
 				resultData: {
@@ -250,9 +250,7 @@ export class WorkflowRunner {
 				const fullRunData :IRun = {
 					data: {
 						resultData: {
-							error: {
-								message: 'Workflow has been canceled!',
-							} as IExecutionError,
+							error: new WorkflowOperationError('Workflow has been canceled!'),
 							runData: {},
 						},
 					},
@@ -464,14 +462,14 @@ export class WorkflowRunner {
 
 			} else if (message.type === 'processError') {
 				clearTimeout(executionTimeout);
-				const executionError = message.data.executionError as IExecutionError;
+				const executionError = message.data.executionError as ExecutionError;
 				this.processError(executionError, startedAt, data.executionMode, executionId);
 
 			} else if (message.type === 'processHook') {
 				this.processHookMessage(workflowHooks, message.data as IProcessMessageDataHook);
 			} else if (message.type === 'timeout') {
 				// Execution timed out and its process has been terminated
-				const timeoutError = { message: 'Workflow execution timed out!' } as IExecutionError;
+				const timeoutError = new WorkflowOperationError('Workflow execution timed out!');
 
 				this.processError(timeoutError, startedAt, data.executionMode, executionId);
 			} else if (message.type === 'startExecution') {
@@ -486,16 +484,12 @@ export class WorkflowRunner {
 		subprocess.on('exit', (code, signal) => {
 			if (signal === 'SIGTERM'){
 				// Execution timed out and its process has been terminated
-				const timeoutError = {
-					message: 'Workflow execution timed out!',
-				} as IExecutionError;
+				const timeoutError = new WorkflowOperationError('Workflow execution timed out!');
 
 				this.processError(timeoutError, startedAt, data.executionMode, executionId);
 			} else if (code !== 0) {
 				// Process did exit with error code, so something went wrong.
-				const executionError = {
-					message: 'Workflow execution process did crash for an unknown reason!',
-				} as IExecutionError;
+				const executionError = new WorkflowOperationError('Workflow execution process did crash for an unknown reason!');
 
 				this.processError(executionError, startedAt, data.executionMode, executionId);
 			}