✨ 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/Google/Sheet/GoogleSheet.ts

@@ -1,5 +1,5 @@
 import {
-	IDataObject,
+	IDataObject, NodeOperationError,
 } from 'n8n-workflow';
 
 import {
@@ -283,7 +283,7 @@ export class GoogleSheet {
 		const rangeEndSplit = rangeEnd.match(/([a-zA-Z]{1,10})([0-9]{0,10})/);
 
 		if (rangeStartSplit === null || rangeStartSplit.length !== 3 || rangeEndSplit === null || rangeEndSplit.length !== 3) {
-			throw new Error(`The range "${range}" is not valid.`);
+			throw new NodeOperationError(this.executeFunctions.getNode(), `The range "${range}" is not valid.`);
 		}
 
 		const keyRowRange = `${sheet ? sheet + '!' : ''}${rangeStartSplit[1]}${dataStartRowIndex}:${rangeEndSplit[1]}${dataStartRowIndex}`;
@@ -291,7 +291,7 @@ export class GoogleSheet {
 		const sheetDatakeyRow = await this.getData(this.encodeRange(keyRowRange), valueRenderMode);
 
 		if (sheetDatakeyRow === undefined) {
-			throw new Error('Could not retrieve the key row!');
+			throw new NodeOperationError(this.executeFunctions.getNode(), 'Could not retrieve the key row!');
 		}
 
 		const keyColumnOrder = sheetDatakeyRow[0];
@@ -299,7 +299,7 @@ export class GoogleSheet {
 		const keyIndex = keyColumnOrder.indexOf(indexKey);
 
 		if (keyIndex === -1) {
-			throw new Error(`Could not find column for key "${indexKey}"!`);
+			throw new NodeOperationError(this.executeFunctions.getNode(), `Could not find column for key "${indexKey}"!`);
 		}
 
 		const startRowIndex = rangeStartSplit[2] || '';
@@ -311,7 +311,7 @@ export class GoogleSheet {
 		const sheetDataKeyColumn = await this.getData(this.encodeRange(keyColumnRange), valueRenderMode);
 
 		if (sheetDataKeyColumn === undefined) {
-			throw new Error('Could not retrieve the key column!');
+			throw new NodeOperationError(this.executeFunctions.getNode(), 'Could not retrieve the key column!');
 		}
 
 		// TODO: The data till here can be cached optionally. Maybe add an option which can
@@ -397,7 +397,7 @@ export class GoogleSheet {
 
 		if (keyRowIndex < 0 || dataStartRowIndex < keyRowIndex || keyRowIndex >= inputData.length) {
 			// The key row does not exist so it is not possible to look up the data
-			throw new Error(`The key row does not exist!`);
+			throw new NodeOperationError(this.executeFunctions.getNode(), `The key row does not exist!`);
 		}
 
 		// Create the keys array
@@ -417,7 +417,7 @@ export class GoogleSheet {
 			returnColumnIndex = keys.indexOf(lookupValue.lookupColumn);
 
 			if (returnColumnIndex === -1) {
-				throw new Error(`The column "${lookupValue.lookupColumn}" could not be found!`);
+				throw new NodeOperationError(this.executeFunctions.getNode(), `The column "${lookupValue.lookupColumn}" could not be found!`);
 			}
 
 			// Loop over all the items and find the one with the matching value
@@ -460,7 +460,7 @@ export class GoogleSheet {
 		const keyColumnData = await this.getData(getRange, 'UNFORMATTED_VALUE');
 
 		if (keyColumnData === undefined) {
-			throw new Error('Could not retrieve the column data!');
+			throw new NodeOperationError(this.executeFunctions.getNode(), 'Could not retrieve the column data!');
 		}
 
 		const keyColumnOrder = keyColumnData[0];