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

282 lines
9.8 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import {
affiliateFields,
affiliateOperations
} from './AffiliateDescription';
import {
affiliateMetadataFields,
affiliateMetadataOperations,
} from './AffiliateMetadataDescription';
import {
programAffiliateFields,
programAffiliateOperations,
} from './ProgramAffiliateDescription';
import {
tapfiliateApiRequest,
tapfiliateApiRequestAllItems,
} from './GenericFunctions';
export class Tapfiliate implements INodeType {
description: INodeTypeDescription = {
displayName: 'Tapfiliate',
name: 'tapfiliate',
icon: 'file:tapfiliate.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ":" + $parameter["resource"]}}',
description: 'Consume Tapfiliate API',
defaults: {
name: 'Tapfiliate',
color: '#4a8de8',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'tapfiliateApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Affiliate',
value: 'affiliate',
},
{
name: 'Affiliate Metadata',
value: 'affiliateMetadata',
},
{
name: 'Program Affiliate',
value: 'programAffiliate',
},
],
default: 'affiliate',
required: true,
description: 'Resource to consume',
},
...affiliateOperations,
...affiliateFields,
...affiliateMetadataOperations,
...affiliateMetadataFields,
...programAffiliateOperations,
...programAffiliateFields,
],
};
methods = {
loadOptions: {
// Get custom fields to display to user so that they can select them easily
async getPrograms(this: ILoadOptionsFunctions,): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const programs = await tapfiliateApiRequestAllItems.call(this, 'GET', '/programs/');
for (const program of programs) {
returnData.push({
name: program.title,
value: program.id,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const length = (items.length as unknown) as number;
const qs: IDataObject = {};
let responseData;
const returnData: IDataObject[] = [];
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
if (resource === 'affiliate') {
if (operation === 'create') {
//https://tapfiliate.com/docs/rest/#affiliates-affiliates-collection-post
for (let i = 0; i < length; i++) {
const firstname = this.getNodeParameter('firstname', i) as string;
const lastname = this.getNodeParameter('lastname', i) as string;
const email = this.getNodeParameter('email', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
firstname,
lastname,
email,
};
Object.assign(body, additionalFields);
if (body.addressUi) {
body.address = (body.addressUi as IDataObject).addressValues as IDataObject;
delete body.addressUi;
if ((body.address as IDataObject).country) {
(body.address as IDataObject).country = {
code: (body.address as IDataObject).country,
};
}
}
if (body.companyName) {
body.company = {
name: body.companyName,
};
delete body.companyName;
}
responseData = await tapfiliateApiRequest.call(this, 'POST', '/affiliates/', body);
returnData.push(responseData);
}
}
if (operation === 'delete') {
//https://tapfiliate.com/docs/rest/#affiliates-affiliate-delete
for (let i = 0; i < length; i++) {
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'DELETE', `/affiliates/${affiliateId}/`);
returnData.push({ success: true });
}
}
if (operation === 'get') {
//https://tapfiliate.com/docs/rest/#affiliates-affiliate-get
for (let i = 0; i < length; i++) {
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'GET', `/affiliates/${affiliateId}/`);
returnData.push(responseData);
}
}
if (operation === 'getAll') {
//https://tapfiliate.com/docs/rest/#affiliates-affiliates-collection-get
for (let i = 0; i < length; i++) {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const filters = this.getNodeParameter('filters', i) as IDataObject;
Object.assign(qs, filters);
if (returnAll) {
responseData = await tapfiliateApiRequestAllItems.call(this, 'GET', `/affiliates/`, {}, qs);
} else {
const limit = this.getNodeParameter('limit', i) as number;
responseData = await tapfiliateApiRequest.call(this, 'GET', `/affiliates/`, {}, qs);
responseData = responseData.splice(0, limit);
}
returnData.push.apply(returnData, responseData);
}
}
}
if (resource === 'affiliateMetadata') {
if (operation === 'add') {
//https://tapfiliate.com/docs/rest/#affiliates-meta-data-key-put
for (let i = 0; i < length; i++) {
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
const metadata = (this.getNodeParameter('metadataUi', i) as IDataObject || {}).metadataValues as IDataObject[] || [];
if (metadata.length === 0) {
throw new NodeOperationError(this.getNode(), 'Metadata cannot be empty.');
}
for (const { key, value } of metadata) {
await tapfiliateApiRequest.call(this, 'PUT', `/affiliates/${affiliateId}/meta-data/${key}/`, { value });
}
returnData.push({ success: true });
}
}
if (operation === 'remove') {
//https://tapfiliate.com/docs/rest/#affiliates-meta-data-key-delete
for (let i = 0; i < length; i++) {
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
const key = this.getNodeParameter('key', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'DELETE', `/affiliates/${affiliateId}/meta-data/${key}/`);
returnData.push({ success: true });
}
}
if (operation === 'update') {
//https://tapfiliate.com/docs/rest/#affiliates-notes-collection-get
for (let i = 0; i < length; i++) {
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
const key = this.getNodeParameter('key', i) as string;
const value = this.getNodeParameter('value', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'PUT', `/affiliates/${affiliateId}/meta-data/`, { [key]: value });
returnData.push(responseData);
}
}
}
if (resource === 'programAffiliate') {
if (operation === 'add') {
//https://tapfiliate.com/docs/rest/#programs-program-affiliates-collection-post
for (let i = 0; i < length; i++) {
const programId = this.getNodeParameter('programId', i) as string;
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
affiliate: {
id: affiliateId,
},
};
Object.assign(body, additionalFields);
responseData = await tapfiliateApiRequest.call(this, 'POST', `/programs/${programId}/affiliates/`, body);
returnData.push(responseData);
}
}
if (operation === 'approve') {
//https://tapfiliate.com/docs/rest/#programs-approve-an-affiliate-for-a-program-put
for (let i = 0; i < length; i++) {
const programId = this.getNodeParameter('programId', i) as string;
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'PUT', `/programs/${programId}/affiliates/${affiliateId}/approved/`);
returnData.push(responseData);
}
}
if (operation === 'disapprove') {
//https://tapfiliate.com/docs/rest/#programs-approve-an-affiliate-for-a-program-delete
for (let i = 0; i < length; i++) {
const programId = this.getNodeParameter('programId', i) as string;
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'DELETE', `/programs/${programId}/affiliates/${affiliateId}/approved/`);
returnData.push(responseData);
}
}
if (operation === 'get') {
//https://tapfiliate.com/docs/rest/#programs-affiliate-in-program-get
for (let i = 0; i < length; i++) {
const programId = this.getNodeParameter('programId', i) as string;
const affiliateId = this.getNodeParameter('affiliateId', i) as string;
responseData = await tapfiliateApiRequest.call(this, 'GET', `/programs/${programId}/affiliates/${affiliateId}/`);
returnData.push(responseData);
}
}
if (operation === 'getAll') {
//https://tapfiliate.com/docs/rest/#programs-program-affiliates-collection-get
for (let i = 0; i < length; i++) {
const programId = this.getNodeParameter('programId', i) as string;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const filters = this.getNodeParameter('filters', i) as IDataObject;
Object.assign(qs, filters);
if (returnAll) {
responseData = await tapfiliateApiRequestAllItems.call(this, 'GET', `/programs/${programId}/affiliates/`, {}, qs);
} else {
const limit = this.getNodeParameter('limit', i) as number;
responseData = await tapfiliateApiRequest.call(this, 'GET', `/programs/${programId}/affiliates/`, {}, qs);
responseData = responseData.splice(0, limit);
}
returnData.push.apply(returnData, responseData);
}
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}