n8n/packages/nodes-base/nodes/Vero/Vero.node.ts
Iván Ovejero 1d27a9e87e
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>
2021-04-16 18:33:36 +02:00

235 lines
7.3 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';
import {
validateJSON,
veroApiRequest,
} from './GenericFunctions';
import {
userFields,
userOperations,
} from './UserDescription';
import {
eventFields,
eventOperations,
} from './EventDescripion';
export class Vero implements INodeType {
description: INodeTypeDescription = {
displayName: 'Vero',
name: 'vero',
icon: 'file:vero.png',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Vero API',
defaults: {
name: 'Vero',
color: '#c02428',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'veroApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'User',
value: 'user',
description: `Create, update and manage the subscription status of your users.`,
},
{
name: 'Event',
value: 'event',
description: `Track events based on actions your customers take in real time.`,
},
],
default: 'user',
description: 'Resource to consume.',
},
...userOperations,
...eventOperations,
...userFields,
...eventFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length as unknown as number;
let responseData;
for (let i = 0; i < length; i++) {
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
//https://developers.getvero.com/?bash#users
if (resource === 'user') {
//https://developers.getvero.com/?bash#users-identify
if (operation === 'create') {
const id = this.getNodeParameter('id', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const jsonActive = this.getNodeParameter('jsonParameters', i) as boolean;
const body = {
id,
};
if (additionalFields.email) {
// @ts-ignore
body.email = additionalFields.email as string;
}
if (!jsonActive) {
const dataAttributesValues = (this.getNodeParameter('dataAttributesUi', i) as IDataObject).dataAttributesValues as IDataObject[];
if (dataAttributesValues) {
const dataAttributes = {};
for (let i = 0; i < dataAttributesValues.length; i++) {
// @ts-ignore
dataAttributes[dataAttributesValues[i].key] = dataAttributesValues[i].value;
// @ts-ignore
body.data = dataAttributes;
}
}
} else {
const dataAttributesJson = validateJSON(this.getNodeParameter('dataAttributesJson', i) as string);
if (dataAttributesJson) {
// @ts-ignore
body.data = dataAttributesJson;
}
}
try {
responseData = await veroApiRequest.call(this, 'POST', '/users/track', body);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
//https://developers.getvero.com/?bash#users-alias
if (operation === 'alias') {
const id = this.getNodeParameter('id', i) as string;
const newId = this.getNodeParameter('newId', i) as string;
const body = {
id,
new_id: newId,
};
try {
responseData = await veroApiRequest.call(this, 'PUT', '/users/reidentify', body);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
//https://developers.getvero.com/?bash#users-unsubscribe
//https://developers.getvero.com/?bash#users-resubscribe
//https://developers.getvero.com/?bash#users-delete
if (operation === 'unsubscribe' ||
operation === 'resubscribe' ||
operation === 'delete') {
const id = this.getNodeParameter('id', i) as string;
const body = {
id,
};
try {
responseData = await veroApiRequest.call(this, 'POST', `/users/${operation}`, body);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
//https://developers.getvero.com/?bash#tags-add
//https://developers.getvero.com/?bash#tags-remove
if (operation === 'addTags' ||
operation === 'removeTags') {
const id = this.getNodeParameter('id', i) as string;
const tags = (this.getNodeParameter('tags', i) as string).split(',') as string[];
const body = {
id,
};
if (operation === 'addTags') {
// @ts-ignore
body.add = JSON.stringify(tags);
}
if (operation === 'removeTags') {
// @ts-ignore
body.remove = JSON.stringify(tags);
}
try {
responseData = await veroApiRequest.call(this, 'PUT', '/users/tags/edit', body);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
}
//https://developers.getvero.com/?bash#events
if (resource === 'event') {
//https://developers.getvero.com/?bash#events-track
if (operation === 'track') {
const id = this.getNodeParameter('id', i) as string;
const email = this.getNodeParameter('email', i) as string;
const eventName = this.getNodeParameter('eventName', i) as string;
const jsonActive = this.getNodeParameter('jsonParameters', i) as boolean;
const body = {
identity: { id, email },
event_name: eventName,
email,
};
if (!jsonActive) {
const dataAttributesValues = (this.getNodeParameter('dataAttributesUi', i) as IDataObject).dataAttributesValues as IDataObject[];
if (dataAttributesValues) {
const dataAttributes = {};
for (let i = 0; i < dataAttributesValues.length; i++) {
// @ts-ignore
dataAttributes[dataAttributesValues[i].key] = dataAttributesValues[i].value;
// @ts-ignore
body.data = JSON.stringify(dataAttributes);
}
}
const extraAttributesValues = (this.getNodeParameter('extraAttributesUi', i) as IDataObject).extraAttributesValues as IDataObject[];
if (extraAttributesValues) {
const extraAttributes = {};
for (let i = 0; i < extraAttributesValues.length; i++) {
// @ts-ignore
extraAttributes[extraAttributesValues[i].key] = extraAttributesValues[i].value;
// @ts-ignore
body.extras = JSON.stringify(extraAttributes);
}
}
} else {
const dataAttributesJson = validateJSON(this.getNodeParameter('dataAttributesJson', i) as string);
if (dataAttributesJson) {
// @ts-ignore
body.data = JSON.stringify(dataAttributesJson);
}
const extraAttributesJson = validateJSON(this.getNodeParameter('extraAttributesJson', i) as string);
if (extraAttributesJson) {
// @ts-ignore
body.extras = JSON.stringify(extraAttributesJson);
}
}
try {
responseData = await veroApiRequest.call(this, 'POST', '/events/track', body);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}