n8n/packages/nodes-base/nodes/Bubble/Bubble.node.ts

186 lines
5.9 KiB
TypeScript
Raw Normal View History

import { IExecuteFunctions } from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
:sparkles: 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 * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: 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 09:33:36 -07:00
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',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'bubbleApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
options: [
{
name: 'Object',
value: 'object',
},
],
default: 'object',
},
...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: INodeExecutionData[] = [];
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', {
itemIndex: i,
});
}
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 = { success: true };
}
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
return this.prepareOutputData(returnData);
}
}