mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 05:04:05 -08:00
1d27a9e87e
* 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>
344 lines
9.1 KiB
TypeScript
344 lines
9.1 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
import {
|
|
IDataObject,
|
|
INodeExecutionData,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
import {
|
|
customerIoApiRequest,
|
|
validateJSON,
|
|
} from './GenericFunctions';
|
|
import {
|
|
campaignFields,
|
|
campaignOperations,
|
|
} from './CampaignDescription';
|
|
import {
|
|
customerFields,
|
|
customerOperations,
|
|
} from './CustomerDescription';
|
|
import {
|
|
eventFields,
|
|
eventOperations,
|
|
} from './EventDescription';
|
|
import {
|
|
segmentFields,
|
|
segmentOperations,
|
|
} from './SegmentDescription';
|
|
|
|
|
|
export class CustomerIo implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Customer.io',
|
|
name: 'customerIo',
|
|
icon: 'file:customerio.png',
|
|
group: ['output'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume Customer.io API',
|
|
defaults: {
|
|
name: 'CustomerIo',
|
|
color: '#ffcd00',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'customerIoApi',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Customer',
|
|
value: 'customer',
|
|
},
|
|
{
|
|
name: 'Event',
|
|
value: 'event',
|
|
},
|
|
{
|
|
name: 'Campaign',
|
|
value: 'campaign',
|
|
},
|
|
{
|
|
name: 'Segment',
|
|
value: 'segment',
|
|
},
|
|
],
|
|
default: 'customer',
|
|
description: 'Resource to consume.',
|
|
},
|
|
// CAMPAIGN
|
|
...campaignOperations,
|
|
...campaignFields,
|
|
// CUSTOMER
|
|
...customerOperations,
|
|
...customerFields,
|
|
// EVENT
|
|
...eventOperations,
|
|
...eventFields,
|
|
// SEGMENT
|
|
...segmentOperations,
|
|
...segmentFields,
|
|
],
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const returnData: IDataObject[] = [];
|
|
const items = this.getInputData();
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
const body: IDataObject = {};
|
|
|
|
let responseData;
|
|
for (let i = 0; i < items.length; i++) {
|
|
|
|
if (resource === 'campaign') {
|
|
if (operation === 'get') {
|
|
const campaignId = this.getNodeParameter('campaignId', i) as number;
|
|
const endpoint = `/campaigns/${campaignId}`;
|
|
|
|
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
|
|
responseData = responseData.campaign;
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const endpoint = `/campaigns`;
|
|
|
|
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
|
|
responseData = responseData.campaigns;
|
|
}
|
|
|
|
if (operation === 'getMetrics') {
|
|
const campaignId = this.getNodeParameter('campaignId', i) as number;
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
|
|
} else {
|
|
throw new NodeOperationError(this.getNode(), 'Additional fields must be a valid JSON');
|
|
}
|
|
}
|
|
} else {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
const period = this.getNodeParameter('period', i) as string;
|
|
let endpoint = `/campaigns/${campaignId}/metrics`;
|
|
|
|
if (period !== 'days') {
|
|
endpoint = `${endpoint}?period=${period}`;
|
|
}
|
|
if (additionalFields.steps) {
|
|
body.steps = additionalFields.steps as number;
|
|
}
|
|
if (additionalFields.type) {
|
|
if (additionalFields.type === 'urbanAirship') {
|
|
additionalFields.type = 'urban_airship';
|
|
} else {
|
|
body.type = additionalFields.type as string;
|
|
}
|
|
}
|
|
|
|
responseData = await customerIoApiRequest.call(this, 'GET', endpoint, body, 'beta');
|
|
responseData = responseData.metric;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (resource === 'customer') {
|
|
|
|
if (operation === 'upsert') {
|
|
const id = this.getNodeParameter('id', i) as number;
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
|
|
} else {
|
|
throw new NodeOperationError(this.getNode(), 'Additional fields must be a valid JSON');
|
|
}
|
|
}
|
|
} else {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
if (additionalFields.customProperties) {
|
|
const data: any = {}; // tslint:disable-line:no-any
|
|
//@ts-ignore
|
|
additionalFields.customProperties.customProperty.map(property => {
|
|
data[property.key] = property.value;
|
|
});
|
|
|
|
body.data = data;
|
|
}
|
|
|
|
if (additionalFields.email) {
|
|
body.email = additionalFields.email as string;
|
|
}
|
|
|
|
if (additionalFields.createdAt) {
|
|
body.created_at = new Date(additionalFields.createdAt as string).getTime() / 1000;
|
|
}
|
|
}
|
|
|
|
const endpoint = `/customers/${id}`;
|
|
|
|
responseData = await customerIoApiRequest.call(this, 'PUT', endpoint, body, 'tracking');
|
|
|
|
responseData = Object.assign({ id }, body);
|
|
}
|
|
|
|
if (operation === 'delete') {
|
|
const id = this.getNodeParameter('id', i) as number;
|
|
|
|
body.id = id;
|
|
|
|
const endpoint = `/customers/${id}`;
|
|
|
|
await customerIoApiRequest.call(this, 'DELETE', endpoint, body, 'tracking');
|
|
|
|
responseData = {
|
|
success: true,
|
|
};
|
|
}
|
|
}
|
|
|
|
if (resource === 'event') {
|
|
if (operation === 'track') {
|
|
const customerId = this.getNodeParameter('customerId', i) as number;
|
|
const eventName = this.getNodeParameter('eventName', i) as string;
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
body.name = eventName;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
} else {
|
|
throw new NodeOperationError(this.getNode(), 'Additional fields must be a valid JSON');
|
|
}
|
|
}
|
|
} else {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
const data: any = {}; // tslint:disable-line:no-any
|
|
|
|
if (additionalFields.customAttributes) {
|
|
//@ts-ignore
|
|
additionalFields.customAttributes.customAttribute.map(property => {
|
|
data[property.key] = property.value;
|
|
});
|
|
}
|
|
|
|
if (additionalFields.type) {
|
|
data.type = additionalFields.type as string;
|
|
}
|
|
|
|
body.data = data;
|
|
}
|
|
|
|
const endpoint = `/customers/${customerId}/events`;
|
|
|
|
await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
|
|
responseData = {
|
|
success: true,
|
|
};
|
|
}
|
|
|
|
if (operation === 'trackAnonymous') {
|
|
const eventName = this.getNodeParameter('eventName', i) as string;
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
body.name = eventName;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter('additionalFieldsJson', i) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
|
|
} else {
|
|
throw new NodeOperationError(this.getNode(), 'Additional fields must be a valid JSON');
|
|
}
|
|
}
|
|
} else {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
const data: any = {}; // tslint:disable-line:no-any
|
|
|
|
if (additionalFields.customAttributes) {
|
|
//@ts-ignore
|
|
additionalFields.customAttributes.customAttribute.map(property => {
|
|
data[property.key] = property.value;
|
|
});
|
|
}
|
|
body.data = data;
|
|
}
|
|
|
|
const endpoint = `/events`;
|
|
await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
|
|
|
|
responseData = {
|
|
success: true,
|
|
};
|
|
}
|
|
}
|
|
|
|
if (resource === 'segment') {
|
|
const segmentId = this.getNodeParameter('segmentId', i) as number;
|
|
const customerIds = this.getNodeParameter('customerIds', i) as string;
|
|
|
|
body.id = segmentId;
|
|
body.ids = customerIds.split(',');
|
|
|
|
let endpoint = '';
|
|
|
|
if (operation === 'add') {
|
|
endpoint = `/segments/${segmentId}/add_customers`;
|
|
} else {
|
|
endpoint = `/segments/${segmentId}/remove_customers`;
|
|
}
|
|
|
|
responseData = await customerIoApiRequest.call(this, 'POST', endpoint, body, 'tracking');
|
|
|
|
responseData = {
|
|
success: true,
|
|
};
|
|
}
|
|
|
|
if (Array.isArray(responseData)) {
|
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
|
} else {
|
|
returnData.push(responseData as unknown as IDataObject);
|
|
}
|
|
}
|
|
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|