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

243 lines
4.8 KiB
TypeScript

import { IExecuteFunctions } from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
NodeOperationError,
} from 'n8n-workflow';
import {moceanApiRequest} from './GenericFunctions';
export class Mocean implements INodeType {
description: INodeTypeDescription = {
displayName: 'Mocean',
name: 'mocean',
icon: 'file:mocean.png',
group: ['transform'],
version: 1,
description: 'Send SMS & voice messages via Mocean (https://moceanapi.com)',
defaults: {
name: 'Mocean',
color: '#772244',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'moceanApi',
required: true,
},
],
properties: [
// Node properties which the user gets displayed and
// can change on the node.
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options:[
{
name: 'SMS',
value: 'sms',
},
{
name: 'Voice',
value: 'voice',
},
],
default: 'sms',
},
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'sms',
'voice',
],
},
},
options: [
{
name: 'Send',
value: 'send',
description: 'Send SMS/Voice message',
},
],
default: 'send',
description: 'The operation to perform.',
},
{
displayName: 'From',
name: 'from',
type: 'string',
default: '',
placeholder: 'Sender Number',
required: true,
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
'voice',
],
},
},
description: 'The number to which to send the message',
},
{
displayName: 'To',
name: 'to',
type: 'string',
default: '',
placeholder: 'Receipient number',
required: true,
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
'voice',
],
},
},
description: 'The number from which to send the message',
},
{
displayName: 'Language',
name: 'language',
type: 'options',
options:[
{
name: 'Chinese Mandarin (China)',
value: 'cmn-CN',
},
{
name: 'English (United Kingdom)',
value: 'en-GB',
},
{
name: 'English (United States)',
value: 'en-US',
},
{
name: 'Japanese (Japan)',
value: 'ja-JP',
},
{
name: 'Korean (Korea)',
value: 'ko-KR',
},
],
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'voice',
],
},
},
default: 'en-US',
},
{
displayName: 'Message',
name: 'message',
type: 'string',
default: '',
placeholder: '',
required: true,
displayOptions: {
show: {
operation: [
'send',
],
resource: [
'sms',
'voice',
],
},
},
description: 'The message to send',
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
let endpoint: string;
let operation: string;
let requesetMethod: string;
let resource: string;
let text: string;
let dataKey: string;
// For Post
let body: IDataObject;
// For Query string
let qs: IDataObject;
for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
body = {};
qs = {};
resource = this.getNodeParameter('resource', itemIndex, '') as string;
operation = this.getNodeParameter('operation',itemIndex,'') as string;
text = this.getNodeParameter('message', itemIndex, '') as string;
requesetMethod = 'POST';
body['mocean-from'] = this.getNodeParameter('from', itemIndex, '') as string;
body['mocean-to'] = this.getNodeParameter('to', itemIndex, '') as string;
if (resource === 'voice') {
const language: string = this.getNodeParameter('language', itemIndex) as string;
const command = [
{
action: 'say',
language,
text,
},
];
dataKey = 'voice';
body['mocean-command'] = JSON.stringify(command);
endpoint = '/rest/2/voice/dial';
} else if(resource === 'sms') {
dataKey = 'messages';
body['mocean-text'] = text;
endpoint = '/rest/2/sms';
} else {
throw new NodeOperationError(this.getNode(), `Unknown resource ${resource}`);
}
if (operation === 'send') {
const responseData = await moceanApiRequest.call(this,requesetMethod,endpoint,body,qs);
for (const item of responseData[dataKey] as IDataObject[]) {
item.type = resource;
returnData.push(item);
}
} else {
throw new NodeOperationError(this.getNode(), `Unknown operation ${operation}`);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}