n8n/packages/nodes-base/nodes/Bubble/Bubble.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

208 lines
5.9 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import {
bubbleApiRequest,
bubbleApiRequestAllItems,
validateJSON,
} from './GenericFunctions';
import {
objectFields,
objectOperations,
} from './ObjectDescription';
export class Bubble implements INodeType {
description: INodeTypeDescription = {
displayName: 'Bubble',
name: 'bubble',
icon: 'file:bubble.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume the Bubble Data API',
defaults: {
name: 'Bubble',
color: '#0205d3',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'bubbleApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Object',
value: 'object',
},
],
default: 'object',
description: 'Resource to consume',
},
...objectOperations,
...objectFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
let responseData;
const qs: IDataObject = {};
const returnData: IDataObject[] = [];
for (let i = 0; i < items.length; i++) {
if (resource === 'object') {
// *********************************************************************
// object
// *********************************************************************
// https://bubble.io/reference#API
if (operation === 'create') {
// ----------------------------------
// object: create
// ----------------------------------
const typeNameInput = this.getNodeParameter('typeName', i) as string;
const typeName = typeNameInput.replace(/\s/g, '').toLowerCase();
const { property } = this.getNodeParameter('properties', i) as {
property: [
{ key: string; value: string; },
],
};
const body = {} as IDataObject;
property.forEach(data => body[data.key] = data.value);
responseData = await bubbleApiRequest.call(this, 'POST', `/obj/${typeName}`, body, {});
} else if (operation === 'delete') {
// ----------------------------------
// object: delete
// ----------------------------------
const typeNameInput = this.getNodeParameter('typeName', i) as string;
const typeName = typeNameInput.replace(/\s/g, '').toLowerCase();
const objectId = this.getNodeParameter('objectId', i) as string;
const endpoint = `/obj/${typeName}/${objectId}`;
responseData = await bubbleApiRequest.call(this, 'DELETE', endpoint, {}, {});
responseData = { success: true };
} else if (operation === 'get') {
// ----------------------------------
// object: get
// ----------------------------------
const typeNameInput = this.getNodeParameter('typeName', i) as string;
const typeName = typeNameInput.replace(/\s/g, '').toLowerCase();
const objectId = this.getNodeParameter('objectId', i) as string;
const endpoint = `/obj/${typeName}/${objectId}`;
responseData = await bubbleApiRequest.call(this, 'GET', endpoint, {}, {});
responseData = responseData.response;
} else if (operation === 'getAll') {
// ----------------------------------
// object: getAll
// ----------------------------------
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
const typeNameInput = this.getNodeParameter('typeName', i) as string;
const typeName = typeNameInput.replace(/\s/g, '').toLowerCase();
const endpoint = `/obj/${typeName}`;
const jsonParameters = this.getNodeParameter('jsonParameters', 0) as boolean;
const options = this.getNodeParameter('options', i) as IDataObject;
if (jsonParameters === false) {
if (options.filters) {
const { filter } = options.filters as IDataObject;
qs.constraints = JSON.stringify(filter);
}
} else {
const filter = options.filtersJson as string;
const data = validateJSON(filter);
if (data === undefined) {
throw new NodeOperationError(this.getNode(), 'Filters must be a valid JSON');
}
qs.constraints = JSON.stringify(data);
}
if (options.sort) {
const { sortValue } = options.sort as IDataObject;
Object.assign(qs, sortValue);
}
if (returnAll === true) {
responseData = await bubbleApiRequestAllItems.call(this, 'GET', endpoint, {}, qs);
} else {
qs.limit = this.getNodeParameter('limit', 0) as number;
responseData = await bubbleApiRequest.call(this, 'GET', endpoint, {}, qs);
responseData = responseData.response.results;
}
} else if (operation === 'update') {
// ----------------------------------
// object: update
// ----------------------------------
const typeNameInput = this.getNodeParameter('typeName', i) as string;
const typeName = typeNameInput.replace(/\s/g, '').toLowerCase();
const objectId = this.getNodeParameter('objectId', i) as string;
const endpoint = `/obj/${typeName}/${objectId}`;
const { property } = this.getNodeParameter('properties', i) as {
property: [
{ key: string; value: string; },
],
};
const body = {} as IDataObject;
property.forEach(data => body[data.key] = data.value);
responseData = await bubbleApiRequest.call(this, 'PATCH', endpoint, body, {});
responseData = { sucess: true };
}
}
Array.isArray(responseData)
? returnData.push(...responseData)
: returnData.push(responseData);
}
return [this.helpers.returnJsonArray(returnData)];
}
}