✨ 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/nodes-base/nodes/Facebook/FacebookGraphApi.node.ts

@@ -8,6 +8,8 @@ import {
 	INodeExecutionData,
 	INodeType,
 	INodeTypeDescription,
+	NodeApiError,
+	NodeOperationError,
 } from 'n8n-workflow';
 
 import {
@@ -365,7 +367,7 @@ export class FacebookGraphApi implements INodeType {
 			if (sendBinaryData) {
 				const item = items[itemIndex];
 				if (item.binary === undefined) {
-					throw new Error('No binary data exists on item!');
+					throw new NodeOperationError(this.getNode(), 'No binary data exists on item!');
 				}
 
 				const binaryPropertyNameFull = this.getNodeParameter('binaryPropertyName', itemIndex) as string;
@@ -379,7 +381,7 @@ export class FacebookGraphApi implements INodeType {
 				}
 
 				if (item.binary[binaryPropertyName] === undefined) {
-					throw new Error(`No binary data property "${binaryPropertyName}" does not exists on item!`);
+					throw new NodeOperationError(this.getNode(), `No binary data property "${binaryPropertyName}" does not exists on item!`);
 				}
 
 				const binaryProperty = item.binary[binaryPropertyName] as IBinaryData;
@@ -400,7 +402,7 @@ export class FacebookGraphApi implements INodeType {
 				response = await this.helpers.request(requestOptions);
 			} catch (error) {
 				if (this.continueOnFail() === false) {
-					throw error;
+					throw new NodeApiError(this.getNode(), error);
 				}
 
 				let errorItem;
@@ -425,7 +427,7 @@ export class FacebookGraphApi implements INodeType {
 
 			if (typeof response === 'string') {
 				if (this.continueOnFail() === false) {
-					throw new Error('Response body is not valid JSON.');
+					throw new NodeOperationError(this.getNode(), 'Response body is not valid JSON.');
 				}
 
 				returnItems.push({ json: { message: response } });

packages/nodes-base/nodes/Facebook/FacebookTrigger.node.ts

@@ -8,6 +8,7 @@ import {
 	INodeType,
 	INodeTypeDescription,
 	IWebhookResponseData,
+	NodeApiError,
 } from 'n8n-workflow';
 
 import * as uuid from 'uuid/v4';
@@ -192,7 +193,7 @@ export class FacebookTrigger implements INodeType {
 
 				if (responseData.success !== true) {
 					// Facebook did not return success, so something went wrong
-					throw new Error('Facebook webhook creation response did not contain the expected data.');
+					throw new NodeApiError(this.getNode(), responseData, { message: 'Facebook webhook creation response did not contain the expected data.' });
 				}
 				return true;
 			},
@@ -202,7 +203,7 @@ export class FacebookTrigger implements INodeType {
 
 				try {
 					await facebookApiRequest.call(this, 'DELETE', `/${appId}/subscriptions`, { object: snakeCase(object) });
-				} catch (e) {
+				} catch (error) {
 					return false;
 				}
 				return true;

packages/nodes-base/nodes/Facebook/GenericFunctions.ts

@@ -11,7 +11,7 @@ import {
 } from 'n8n-core';
 
 import {
-	IDataObject,
+	IDataObject, NodeApiError,
 } from 'n8n-workflow';
 
 export async function facebookApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IWebhookFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
@@ -41,13 +41,6 @@ export async function facebookApiRequest(this: IHookFunctions | IExecuteFunction
 	try {
 		return await this.helpers.request!(options);
 	} catch (error) {
-
-		if (error.response.body && error.response.body.error) {
-			const message = error.response.body.error.message;
-			throw new Error(
-				`Facebook Trigger error response [${error.statusCode}]: ${message}`,
-			);
-		}
-		throw new Error(error);
+		throw new NodeApiError(this.getNode(), error);
 	}
 }