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

322 lines
7.5 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';
import {
sendyApiRequest,
} from './GenericFunctions';
import {
campaignFields,
campaignOperations,
} from './CampaignDescription';
import {
subscriberFields,
subscriberOperations,
} from './SubscriberDescription';
export class Sendy implements INodeType {
description: INodeTypeDescription = {
displayName: 'Sendy',
name: 'sendy',
icon: 'file:sendy.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Sendy API.',
defaults: {
name: 'Sendy',
color: '#000000',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'sendyApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Campaign',
value: 'campaign',
},
{
name: 'Subscriber',
value: 'subscriber',
},
],
default: 'subscriber',
description: 'The resource to operate on.',
},
...campaignOperations,
...campaignFields,
...subscriberOperations,
...subscriberFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = (items.length as unknown) as number;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
if (resource === 'campaign') {
if (operation === 'create') {
const fromName = this.getNodeParameter('fromName', i) as string;
const fromEmail = this.getNodeParameter('fromEmail', i) as string;
const replyTo = this.getNodeParameter('replyTo', i) as string;
const title = this.getNodeParameter('title', i) as string;
const subject = this.getNodeParameter('subject', i) as string;
const htmlText = this.getNodeParameter('htmlText', i) as boolean;
const sendCampaign = this.getNodeParameter('sendCampaign', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
from_name: fromName,
from_email: fromEmail,
reply_to: replyTo,
title,
subject,
send_campaign: sendCampaign ? 1 : 0,
html_text: htmlText,
};
if (additionalFields.plainText) {
body.plain_text = additionalFields.plainText;
}
if (additionalFields.listIds) {
body.list_ids = additionalFields.listIds as string;
}
if (additionalFields.segmentIds) {
body.segment_ids = additionalFields.segmentIds as string;
}
if (additionalFields.excludeListIds) {
body.exclude_list_ids = additionalFields.excludeListIds as string;
}
if (additionalFields.excludeSegmentIds) {
body.exclude_segments_ids = additionalFields.excludeSegmentIds as string;
}
if (additionalFields.brandId) {
body.brand_id = additionalFields.brandId as string;
}
if (additionalFields.queryString) {
body.query_string = additionalFields.queryString as string;
}
if (additionalFields.trackOpens) {
body.track_opens = additionalFields.trackOpens as boolean ? 1 : 0;
}
if (additionalFields.trackClicks) {
body.track_clicks = additionalFields.trackClicks as boolean ? 1 : 0;
}
responseData = await sendyApiRequest.call(
this,
'POST',
'/api/campaigns/create.php',
body,
);
const success = [
'Campaign created',
'Campaign created and now sending',
];
if (success.includes(responseData)) {
responseData = { message: responseData };
} else {
throw new NodeApiError(this.getNode(), responseData, { httpCode: '400' });
}
}
}
if (resource === 'subscriber') {
if (operation === 'add') {
const email = this.getNodeParameter('email', i) as string;
const listId = this.getNodeParameter('listId', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
email,
list: listId,
};
Object.assign(body, additionalFields);
responseData = await sendyApiRequest.call(
this,
'POST',
'/subscribe',
body,
);
if (responseData === '1') {
responseData = { success: true };
} else {
throw new NodeOperationError(this.getNode(), `Sendy error response [${400}]: ${responseData}`);
}
}
if (operation === 'count') {
const listId = this.getNodeParameter('listId', i) as string;
const body: IDataObject = {
list_id: listId,
};
responseData = await sendyApiRequest.call(
this,
'POST',
'/api/subscribers/active-subscriber-count.php',
body,
);
const errors = [
'No data passed',
'API key not passed',
'Invalid API key',
'List ID not passed',
'List does not exist',
];
if (!errors.includes(responseData)) {
responseData = { count: responseData };
} else {
throw new NodeOperationError(this.getNode(), `Sendy error response [${400}]: ${responseData}`);
}
}
if (operation === 'delete') {
const email = this.getNodeParameter('email', i) as string;
const listId = this.getNodeParameter('listId', i) as string;
const body: IDataObject = {
email,
list_id: listId,
};
responseData = await sendyApiRequest.call(
this,
'POST',
'/api/subscribers/delete.php',
body,
);
if (responseData === '1') {
responseData = { success: true };
} else {
throw new NodeOperationError(this.getNode(), `Sendy error response [${400}]: ${responseData}`);
}
}
if (operation === 'remove') {
const email = this.getNodeParameter('email', i) as string;
const listId = this.getNodeParameter('listId', i) as string;
const body: IDataObject = {
email,
list: listId,
};
responseData = await sendyApiRequest.call(
this,
'POST',
'/unsubscribe',
body,
);
if (responseData === '1') {
responseData = { success: true };
} else {
throw new NodeOperationError(this.getNode(), `Sendy error response [${400}]: ${responseData}`);
}
}
if (operation === 'status') {
const email = this.getNodeParameter('email', i) as string;
const listId = this.getNodeParameter('listId', i) as string;
const body: IDataObject = {
email,
list_id: listId,
};
responseData = await sendyApiRequest.call(
this,
'POST',
'/api/subscribers/subscription-status.php',
body,
);
const status = [
'Subscribed',
'Unsubscribed',
'Unconfirmed',
'Bounced',
'Soft bounced',
'Complained',
];
if (status.includes(responseData)) {
responseData = { status: responseData };
} else {
throw new NodeOperationError(this.getNode(), `Sendy error response [${400}]: ${responseData}`);
}
}
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else if (responseData !== undefined) {
returnData.push(responseData as IDataObject);
}
return [this.helpers.returnJsonArray(returnData)];
}
}