🐛 Fixes error responses & replaced executeSingle in Rocketchat node (#1367) (#1369)

* 🐛 Fixes issue handling error responses in Rocketchat node (#1367)

*  Minor improvements on Rocketchat Node

Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Jan 2021-02-19 13:34:46 +01:00 committed by GitHub
commit 7df9694b3c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 116 additions and 98 deletions

View file

@ -1,12 +1,14 @@
import { OptionsWithUri } from 'request'; import {
OptionsWithUri,
} from 'request';
import { import {
IExecuteFunctions, IExecuteFunctions,
IExecuteSingleFunctions,
IHookFunctions, IHookFunctions,
ILoadOptionsFunctions, ILoadOptionsFunctions,
} from 'n8n-core'; } from 'n8n-core';
export async function rocketchatApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, resource: string, method: string, operation: string, body: any = {}, headers?: object): Promise<any> { // tslint:disable-line:no-any export async function rocketchatApiRequest(this: IExecuteFunctions | ILoadOptionsFunctions, resource: string, method: string, operation: string, body: any = {}, headers?: object): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('rocketchatApi'); const credentials = this.getCredentials('rocketchatApi');
if (credentials === undefined) { if (credentials === undefined) {
@ -14,7 +16,11 @@ export async function rocketchatApiRequest(this: IHookFunctions | IExecuteFuncti
} }
const headerWithAuthentication = Object.assign({}, headers, const headerWithAuthentication = Object.assign({}, headers,
{ 'X-Auth-Token': credentials.authKey, 'X-User-Id': credentials.userId }); {
'X-Auth-Token': credentials.authKey,
'X-User-Id': credentials.userId,
},
);
const options: OptionsWithUri = { const options: OptionsWithUri = {
headers: headerWithAuthentication, headers: headerWithAuthentication,
@ -29,13 +35,15 @@ export async function rocketchatApiRequest(this: IHookFunctions | IExecuteFuncti
try { try {
return await this.helpers.request!(options); return await this.helpers.request!(options);
} catch (error) { } catch (error) {
let errorMessage = error.message; if (error.response && error.response.body && error.response.body.error) {
if (error.response.body.error) { const errorMessage = error.response.body.error;
errorMessage = error.response.body.error; // Try to return the error prettier
throw new Error(
`Rocketchat error response [${error.statusCode}]: ${errorMessage}`,
);
} }
throw error;
throw new Error(`Rocket.chat error response [${error.statusCode}]: ${errorMessage}`);
} }
} }

View file

@ -1,13 +1,15 @@
import { import {
IExecuteSingleFunctions, IExecuteFunctions,
} from 'n8n-core'; } from 'n8n-core';
import { import {
IDataObject, IDataObject,
INodeExecutionData, INodeExecutionData,
INodeType, INodeType,
INodeTypeDescription, INodeTypeDescription,
} from 'n8n-workflow'; } from 'n8n-workflow';
import {
import {
rocketchatApiRequest, rocketchatApiRequest,
validateJSON validateJSON
} from './GenericFunctions'; } from './GenericFunctions';
@ -50,7 +52,7 @@ export class Rocketchat implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'RocketChat', displayName: 'RocketChat',
name: 'rocketchat', name: 'rocketchat',
icon: 'file:rocketchat.png', icon: 'file:rocketchat.svg',
group: ['output'], group: ['output'],
version: 1, version: 1,
subtitle: '={{$parameter["resource"] + ": " + $parameter["operation"]}}', subtitle: '={{$parameter["resource"] + ": " + $parameter["operation"]}}',
@ -395,106 +397,113 @@ export class Rocketchat implements INodeType {
], ],
}; };
async executeSingle(this: IExecuteSingleFunctions): Promise<INodeExecutionData> { async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const resource = this.getNodeParameter('resource') as string; const items = this.getInputData();
const operation = this.getNodeParameter('operation') as string; const length = (items.length as unknown) as number;
let response; let responseData;
const returnData: IDataObject[] = [];
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 === 'chat') {
//https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage
if (operation === 'postMessage') {
const channel = this.getNodeParameter('channel', i) as string;
const text = this.getNodeParameter('text', i) as string;
const options = this.getNodeParameter('options', i) as IDataObject;
const jsonActive = this.getNodeParameter('jsonParameters', i) as boolean;
if (resource === 'chat') { const body: IPostMessageBody = {
//https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage channel,
if (operation === 'postMessage') { text,
const channel = this.getNodeParameter('channel') as string; };
const text = this.getNodeParameter('text') as string;
const options = this.getNodeParameter('options') as IDataObject;
const jsonActive = this.getNodeParameter('jsonParameters') as boolean;
const body: IPostMessageBody = { if (options.alias) {
channel, body.alias = options.alias as string;
text, }
}; if (options.avatar) {
body.avatar = options.avatar as string;
}
if (options.emoji) {
body.emoji = options.emoji as string;
}
if (options.alias) { if (!jsonActive) {
body.alias = options.alias as string; const optionsAttachments = this.getNodeParameter('attachments', i) as IDataObject[];
} if (optionsAttachments.length > 0) {
if (options.avatar) { const attachments: IAttachment[] = [];
body.avatar = options.avatar as string; for (let i = 0; i < optionsAttachments.length; i++) {
} const attachment: IAttachment = {};
if (options.emoji) { for (const option of Object.keys(optionsAttachments[i])) {
body.emoji = options.emoji as string; if (option === 'color') {
} attachment.color = optionsAttachments[i][option] as string;
} else if (option === 'text') {
if (!jsonActive) { attachment.text = optionsAttachments[i][option] as string;
const optionsAttachments = this.getNodeParameter('attachments') as IDataObject[]; } else if (option === 'ts') {
if (optionsAttachments.length > 0) { attachment.ts = optionsAttachments[i][option] as string;
const attachments: IAttachment[] = []; } else if (option === 'messageLinks') {
for (let i = 0; i < optionsAttachments.length; i++) { attachment.message_link = optionsAttachments[i][option] as string;
const attachment: IAttachment = {}; } else if (option === 'thumbUrl') {
for (const option of Object.keys(optionsAttachments[i])) { attachment.thumb_url = optionsAttachments[i][option] as string;
if (option === 'color') { } else if (option === 'collapsed') {
attachment.color = optionsAttachments[i][option] as string; attachment.collapsed = optionsAttachments[i][option] as boolean;
} else if (option === 'text') { } else if (option === 'authorName') {
attachment.text = optionsAttachments[i][option] as string; attachment.author_name = optionsAttachments[i][option] as string;
} else if (option === 'ts') { } else if (option === 'authorLink') {
attachment.ts = optionsAttachments[i][option] as string; attachment.author_link = optionsAttachments[i][option] as string;
} else if (option === 'messageLinks') { } else if (option === 'authorIcon') {
attachment.message_link = optionsAttachments[i][option] as string; attachment.author_icon = optionsAttachments[i][option] as string;
} else if (option === 'thumbUrl') { } else if (option === 'title') {
attachment.thumb_url = optionsAttachments[i][option] as string; attachment.title = optionsAttachments[i][option] as string;
} else if (option === 'collapsed') { } else if (option === 'titleLink') {
attachment.collapsed = optionsAttachments[i][option] as boolean; attachment.title_link = optionsAttachments[i][option] as string;
} else if (option === 'authorName') { } else if (option === 'titleLinkDownload') {
attachment.author_name = optionsAttachments[i][option] as string; attachment.title_link_download = optionsAttachments[i][option] as boolean;
} else if (option === 'authorLink') { } else if (option === 'imageUrl') {
attachment.author_link = optionsAttachments[i][option] as string; attachment.image_url = optionsAttachments[i][option] as string;
} else if (option === 'authorIcon') { } else if (option === 'audioUrl') {
attachment.author_icon = optionsAttachments[i][option] as string; attachment.audio_url = optionsAttachments[i][option] as string;
} else if (option === 'title') { } else if (option === 'videoUrl') {
attachment.title = optionsAttachments[i][option] as string; attachment.video_url = optionsAttachments[i][option] as string;
} else if (option === 'titleLink') { } else if (option === 'fields') {
attachment.title_link = optionsAttachments[i][option] as string; const fieldsValues = (optionsAttachments[i][option] as IDataObject).fieldsValues as IDataObject[];
} else if (option === 'titleLinkDownload') { if (fieldsValues.length > 0) {
attachment.title_link_download = optionsAttachments[i][option] as boolean; const fields: IField[] = [];
} else if (option === 'imageUrl') { for (let i = 0; i < fieldsValues.length; i++) {
attachment.image_url = optionsAttachments[i][option] as string; const field: IField = {};
} else if (option === 'audioUrl') { for (const key of Object.keys(fieldsValues[i])) {
attachment.audio_url = optionsAttachments[i][option] as string; if (key === 'short') {
} else if (option === 'videoUrl') { field.short = fieldsValues[i][key] as boolean;
attachment.video_url = optionsAttachments[i][option] as string; } else if (key === 'title') {
} else if (option === 'fields') { field.title = fieldsValues[i][key] as string;
const fieldsValues = (optionsAttachments[i][option] as IDataObject).fieldsValues as IDataObject[]; } else if (key === 'value') {
if (fieldsValues.length > 0) { field.value = fieldsValues[i][key] as string;
const fields: IField[] = []; }
for (let i = 0; i < fieldsValues.length; i++) {
const field: IField = {};
for (const key of Object.keys(fieldsValues[i])) {
if (key === 'short') {
field.short = fieldsValues[i][key] as boolean;
} else if (key === 'title') {
field.title = fieldsValues[i][key] as string;
} else if (key === 'value') {
field.value = fieldsValues[i][key] as string;
} }
fields.push(field);
attachment.fields = fields;
} }
fields.push(field);
attachment.fields = fields;
} }
} }
} }
attachments.push(attachment);
} }
attachments.push(attachment); body.attachments = attachments;
} }
body.attachments = attachments; } else {
body.attachments = validateJSON(this.getNodeParameter('attachmentsJson', i) as string);
} }
} else {
body.attachments = validateJSON(this.getNodeParameter('attachmentsJson') as string);
}
response = await rocketchatApiRequest.call(this, '/chat', 'POST', 'postMessage', body); responseData = await rocketchatApiRequest.call(this, '/chat', 'POST', 'postMessage', body);
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else if (responseData !== undefined) {
returnData.push(responseData as IDataObject);
} }
} }
return { return [this.helpers.returnJsonArray(returnData)];
json: response,
};
} }
} }

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

View file

@ -0,0 +1 @@
<svg width="2500" height="2139" viewBox="0 0 256 219" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMidYMid"><path d="M255.95 109.307c0-12.853-3.844-25.173-11.43-36.63-6.81-10.283-16.351-19.385-28.355-27.057-23.18-14.806-53.647-22.963-85.782-22.963-10.734 0-21.315.907-31.577 2.705-6.366-5.96-13.82-11.322-21.707-15.56C34.964-10.62.022 9.322.022 9.322s32.487 26.688 27.204 50.08C12.693 73.821 4.814 91.207 4.814 109.307c0 .056.003.115.003.173 0 .057-.003.113-.003.174 0 18.1 7.876 35.486 22.412 49.902C32.509 182.95.022 209.639.022 209.639s34.942 19.939 77.077-.48c7.886-4.238 15.338-9.603 21.707-15.56 10.264 1.796 20.843 2.702 31.577 2.702 32.137 0 62.601-8.151 85.782-22.958 12.004-7.671 21.545-16.77 28.356-27.058 7.585-11.455 11.43-23.781 11.43-36.628 0-.06-.003-.115-.003-.174l.002-.176z" fill="#C1272D"/><path d="M130.383 40.828c59.505 0 107.746 30.814 107.746 68.824 0 38.007-48.241 68.823-107.746 68.823-13.25 0-25.94-1.532-37.662-4.325-11.915 14.332-38.125 34.26-63.587 27.82 8.282-8.895 20.552-23.926 17.926-48.686-15.262-11.873-24.422-27.07-24.422-43.632-.003-38.013 48.238-68.824 107.745-68.824" fill="#FFF"/><path d="M130.383 126.18c7.906 0 14.314-6.408 14.314-14.314 0-7.905-6.408-14.313-14.314-14.313-7.905 0-14.313 6.408-14.313 14.313 0 7.906 6.408 14.314 14.313 14.314zm49.764 0c7.905 0 14.314-6.408 14.314-14.314 0-7.905-6.409-14.313-14.314-14.313s-14.313 6.408-14.313 14.313c0 7.906 6.408 14.314 14.313 14.314zm-99.53-.003c7.904 0 14.311-6.407 14.311-14.31 0-7.904-6.407-14.312-14.31-14.312-7.905 0-14.312 6.408-14.312 14.311 0 7.904 6.407 14.311 14.311 14.311z" fill="#C1272D"/><path d="M130.383 169.42c-13.25 0-25.94-1.33-37.662-3.75-10.52 10.969-32.188 25.714-54.643 25.172-2.959 4.484-6.175 8.15-8.944 11.126 25.462 6.44 51.672-13.486 63.587-27.82 11.723 2.795 24.414 4.325 37.662 4.325 59.027 0 106.962-30.326 107.726-67.915-.764 32.582-48.699 58.861-107.726 58.861z" fill="#CCC"/></svg>

After

Width:  |  Height:  |  Size: 1.9 KiB