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>
This commit is contained in:
Iván Ovejero
2021-04-16 18:33:36 +02:00
committed by GitHub
parent 1a0e129921
commit 1d27a9e87e
374 changed files with 2041 additions and 2826 deletions

View File

@@ -8,13 +8,13 @@ import {
} from 'n8n-core';
import {
IDataObject,
IDataObject, NodeApiError, NodeOperationError,
} from 'n8n-workflow';
export async function intercomApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, endpoint: string, method: string, body: any = {}, query?: IDataObject, uri?: string): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('intercomApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}
const headerWithAuthentication = Object.assign({},
@@ -32,12 +32,7 @@ export async function intercomApiRequest(this: IHookFunctions | IExecuteFunction
try {
return await this.helpers.request!(options);
} catch (error) {
const errorMessage = error.response.body.message || error.response.body.Message;
if (errorMessage !== undefined) {
throw errorMessage;
}
throw error.response.body;
throw new NodeApiError(this.getNode(), error);
}
}

View File

@@ -8,6 +8,8 @@ import {
INodePropertyOptions,
INodeType,
INodeTypeDescription,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';
import {
leadFields,
@@ -101,8 +103,8 @@ export class Intercom implements INodeType {
let companies, response;
try {
response = await intercomApiRequest.call(this, '/companies', 'GET');
} catch (err) {
throw new Error(`Intercom Error: ${err}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
companies = response.companies;
for (const company of companies) {
@@ -214,8 +216,8 @@ export class Intercom implements INodeType {
try {
responseData = await intercomApiRequest.call(this, '/contacts', 'POST', body);
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
if (operation === 'get') {
@@ -237,8 +239,8 @@ export class Intercom implements INodeType {
responseData = await intercomApiRequest.call(this, '/contacts', 'GET', {}, qs);
responseData = responseData.contacts;
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
if (operation === 'getAll') {
@@ -254,8 +256,8 @@ export class Intercom implements INodeType {
responseData = await intercomApiRequest.call(this, '/contacts', 'GET', {}, qs);
responseData = responseData.contacts;
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
if (operation === 'delete') {
@@ -268,8 +270,8 @@ export class Intercom implements INodeType {
qs.user_id = value;
responseData = await intercomApiRequest.call(this, '/contacts', 'DELETE', {}, qs);
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
}
@@ -378,8 +380,8 @@ export class Intercom implements INodeType {
try {
responseData = await intercomApiRequest.call(this, '/users', 'POST', body, qs);
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
if (operation === 'get') {
@@ -394,8 +396,8 @@ export class Intercom implements INodeType {
} else {
responseData = await intercomApiRequest.call(this, '/users', 'GET', {}, qs);
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
if (operation === 'getAll') {
@@ -411,16 +413,16 @@ export class Intercom implements INodeType {
responseData = await intercomApiRequest.call(this, '/users', 'GET', {}, qs);
responseData = responseData.users;
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
if (operation === 'delete') {
const id = this.getNodeParameter('id', i) as string;
try {
responseData = await intercomApiRequest.call(this, `/users/${id}`, 'DELETE');
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeOperationError(this.getNode(), `Intercom Error: ${JSON.stringify(error)}`);
}
}
}
@@ -469,8 +471,8 @@ export class Intercom implements INodeType {
}
try {
responseData = await intercomApiRequest.call(this, '/companies', 'POST', body, qs);
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeOperationError(this.getNode(), `Intercom Error: ${JSON.stringify(error)}`);
}
}
if (operation === 'get') {
@@ -488,8 +490,8 @@ export class Intercom implements INodeType {
} else {
responseData = await intercomApiRequest.call(this, '/companies', 'GET', {}, qs);
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeOperationError(this.getNode(), `Intercom Error: ${JSON.stringify(error)}`);
}
}
if (operation === 'getAll') {
@@ -505,8 +507,8 @@ export class Intercom implements INodeType {
responseData = await intercomApiRequest.call(this, '/companies', 'GET', {}, qs);
responseData = responseData.companies;
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeOperationError(this.getNode(), `Intercom Error: ${JSON.stringify(error)}`);
}
}
if (operation === 'users') {
@@ -522,8 +524,8 @@ export class Intercom implements INodeType {
qs.type = 'users';
responseData = await intercomApiRequest.call(this, '/companies', 'GET', {}, qs);
}
} catch (err) {
throw new Error(`Intercom Error: ${JSON.stringify(err)}`);
} catch (error) {
throw new NodeOperationError(this.getNode(), `Intercom Error: ${JSON.stringify(error)}`);
}
}
}