mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-27 13:39:44 -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>
237 lines
8.2 KiB
TypeScript
237 lines
8.2 KiB
TypeScript
import {
|
|
OptionsWithUri,
|
|
} from 'request';
|
|
|
|
import { IDataObject, NodeApiError, NodeOperationError, } from 'n8n-workflow';
|
|
|
|
import {
|
|
BINARY_ENCODING,
|
|
IExecuteFunctions,
|
|
IExecuteSingleFunctions,
|
|
ILoadOptionsFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import * as _ from 'lodash';
|
|
import * as uuid from 'uuid/v4';
|
|
|
|
|
|
interface MessageResponse {
|
|
chunk: Message[];
|
|
}
|
|
|
|
interface Message {
|
|
content: object;
|
|
room_id: string;
|
|
sender: string;
|
|
type: string;
|
|
user_id: string;
|
|
|
|
}
|
|
|
|
export async function matrixApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: string | object = {}, query: object = {}, headers: {} | undefined = undefined, option: {} = {}): Promise<any> { // tslint:disable-line:no-any
|
|
let options: OptionsWithUri = {
|
|
method,
|
|
headers: headers || {
|
|
'Content-Type': 'application/json; charset=utf-8',
|
|
},
|
|
body,
|
|
qs: query,
|
|
uri: '',
|
|
json: true,
|
|
};
|
|
options = Object.assign({}, options, option);
|
|
if (Object.keys(body).length === 0) {
|
|
delete options.body;
|
|
}
|
|
if (Object.keys(query).length === 0) {
|
|
delete options.qs;
|
|
}
|
|
try {
|
|
|
|
let response: any; // tslint:disable-line:no-any
|
|
|
|
const credentials = this.getCredentials('matrixApi');
|
|
if (credentials === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
|
|
}
|
|
//@ts-ignore
|
|
options.uri = `${credentials.homeserverUrl}/_matrix/${option.overridePrefix || 'client'}/r0${resource}`;
|
|
options.headers!.Authorization = `Bearer ${credentials.accessToken}`;
|
|
//@ts-ignore
|
|
response = await this.helpers.request(options);
|
|
|
|
// When working with images, the request cannot be JSON (it's raw binary data)
|
|
// But the output is JSON so we have to parse it manually.
|
|
//@ts-ignore
|
|
return options.overridePrefix === 'media' ? JSON.parse(response) : response;
|
|
} catch (error) {
|
|
throw new NodeApiError(this.getNode(), error);
|
|
}
|
|
}
|
|
|
|
export async function handleMatrixCall(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, item: IDataObject, index: number, resource: string, operation: string): Promise<any> { // tslint:disable-line:no-any
|
|
|
|
if (resource === 'account') {
|
|
if (operation === 'me') {
|
|
return await matrixApiRequest.call(this, 'GET', '/account/whoami');
|
|
}
|
|
}
|
|
else if (resource === 'room') {
|
|
if (operation === 'create') {
|
|
const name = this.getNodeParameter('roomName', index) as string;
|
|
const preset = this.getNodeParameter('preset', index) as string;
|
|
const roomAlias = this.getNodeParameter('roomAlias', index) as string;
|
|
const body: IDataObject = {
|
|
name,
|
|
preset,
|
|
};
|
|
if (roomAlias) {
|
|
body.room_alias_name = roomAlias;
|
|
}
|
|
return await matrixApiRequest.call(this, 'POST', `/createRoom`, body);
|
|
} else if (operation === 'join') {
|
|
const roomIdOrAlias = this.getNodeParameter('roomIdOrAlias', index) as string;
|
|
return await matrixApiRequest.call(this, 'POST', `/rooms/${roomIdOrAlias}/join`);
|
|
} else if (operation === 'leave') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
return await matrixApiRequest.call(this, 'POST', `/rooms/${roomId}/leave`);
|
|
} else if (operation === 'invite') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const userId = this.getNodeParameter('userId', index) as string;
|
|
const body: IDataObject = {
|
|
user_id: userId,
|
|
};
|
|
return await matrixApiRequest.call(this, 'POST', `/rooms/${roomId}/invite`, body);
|
|
} else if (operation === 'kick') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const userId = this.getNodeParameter('userId', index) as string;
|
|
const reason = this.getNodeParameter('reason', index) as string;
|
|
const body: IDataObject = {
|
|
user_id: userId,
|
|
reason,
|
|
};
|
|
return await matrixApiRequest.call(this, 'POST', `/rooms/${roomId}/kick`, body);
|
|
}
|
|
} else if (resource === 'message') {
|
|
if (operation === 'create') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const text = this.getNodeParameter('text', index, '') as string;
|
|
const messageType = this.getNodeParameter('messageType', index) as string;
|
|
const messageFormat = this.getNodeParameter('messageFormat', index) as string;
|
|
const body: IDataObject = {
|
|
msgtype: messageType,
|
|
body: text,
|
|
};
|
|
if (messageFormat === 'org.matrix.custom.html') {
|
|
const fallbackText = this.getNodeParameter('fallbackText', index, '') as string;
|
|
body.format = messageFormat;
|
|
body.formatted_body = text;
|
|
body.body = fallbackText;
|
|
}
|
|
const messageId = uuid();
|
|
return await matrixApiRequest.call(this, 'PUT', `/rooms/${roomId}/send/m.room.message/${messageId}`, body);
|
|
} else if (operation === 'getAll') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const returnAll = this.getNodeParameter('returnAll', index) as boolean;
|
|
const otherOptions = this.getNodeParameter('otherOptions', index) as IDataObject;
|
|
const returnData: IDataObject[] = [];
|
|
|
|
if (returnAll) {
|
|
let responseData;
|
|
let from;
|
|
do {
|
|
const qs: IDataObject = {
|
|
dir: 'b', // Get latest messages first - doesn't return anything if we use f without a previous token.
|
|
from,
|
|
};
|
|
|
|
if (otherOptions.filter) {
|
|
qs.filter = otherOptions.filter;
|
|
}
|
|
|
|
responseData = await matrixApiRequest.call(this, 'GET', `/rooms/${roomId}/messages`, {}, qs);
|
|
returnData.push.apply(returnData, responseData.chunk);
|
|
from = responseData.end;
|
|
} while (responseData.chunk.length > 0);
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', index) as number;
|
|
const qs: IDataObject = {
|
|
dir: 'b', // GetfallbackText latest messages first - doesn't return anything if we use f without a previous token.
|
|
limit,
|
|
};
|
|
|
|
if (otherOptions.filter) {
|
|
qs.filter = otherOptions.filter;
|
|
}
|
|
|
|
const responseData = await matrixApiRequest.call(this, 'GET', `/rooms/${roomId}/messages`, {}, qs);
|
|
returnData.push.apply(returnData, responseData.chunk);
|
|
}
|
|
|
|
return returnData;
|
|
}
|
|
} else if (resource === 'event') {
|
|
if (operation === 'get') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const eventId = this.getNodeParameter('eventId', index) as string;
|
|
return await matrixApiRequest.call(this, 'GET', `/rooms/${roomId}/event/${eventId}`);
|
|
}
|
|
} else if (resource === 'media') {
|
|
if (operation === 'upload') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const mediaType = this.getNodeParameter('mediaType', index) as string;
|
|
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', index) as string;
|
|
|
|
let body;
|
|
const qs: IDataObject = {};
|
|
const headers: IDataObject = {};
|
|
let filename;
|
|
|
|
if (item.binary === undefined
|
|
//@ts-ignore
|
|
|| item.binary[binaryPropertyName] === undefined) {
|
|
throw new NodeOperationError(this.getNode(), `No binary data property "${binaryPropertyName}" does not exists on item!`);
|
|
}
|
|
|
|
//@ts-ignore
|
|
qs.filename = item.binary[binaryPropertyName].fileName;
|
|
//@ts-ignore
|
|
filename = item.binary[binaryPropertyName].fileName;
|
|
|
|
//@ts-ignore
|
|
body = Buffer.from(item.binary[binaryPropertyName].data, BINARY_ENCODING);
|
|
//@ts-ignore
|
|
headers['Content-Type'] = item.binary[binaryPropertyName].mimeType;
|
|
headers['accept'] = 'application/json,text/*;q=0.99';
|
|
|
|
const uploadRequestResult = await matrixApiRequest.call(this, 'POST', `/upload`, body, qs, headers, {
|
|
overridePrefix: 'media',
|
|
json: false,
|
|
});
|
|
|
|
body = {
|
|
msgtype: `m.${mediaType}`,
|
|
body: filename,
|
|
url: uploadRequestResult.content_uri,
|
|
};
|
|
const messageId = uuid();
|
|
return await matrixApiRequest.call(this, 'PUT', `/rooms/${roomId}/send/m.room.message/${messageId}`, body);
|
|
|
|
}
|
|
} else if (resource === 'roomMember') {
|
|
if (operation === 'getAll') {
|
|
const roomId = this.getNodeParameter('roomId', index) as string;
|
|
const filters = this.getNodeParameter('filters', index) as IDataObject;
|
|
const qs: IDataObject = {
|
|
membership: filters.membership ? filters.membership : '',
|
|
not_membership: filters.notMembership ? filters.notMembership : '',
|
|
};
|
|
const roomMembersResponse = await matrixApiRequest.call(this, 'GET', `/rooms/${roomId}/members`, {}, qs);
|
|
return roomMembersResponse.chunk;
|
|
}
|
|
}
|
|
|
|
|
|
throw new NodeOperationError(this.getNode(), 'Not implemented yet');
|
|
}
|