diff --git a/packages/nodes-base/credentials/Amqp.credentials.ts b/packages/nodes-base/credentials/Amqp.credentials.ts new file mode 100644 index 0000000000..ff6b23ed1f --- /dev/null +++ b/packages/nodes-base/credentials/Amqp.credentials.ts @@ -0,0 +1,39 @@ +import { + ICredentialType, + NodePropertyTypes, +} from 'n8n-workflow'; + + +export class Amqp implements ICredentialType { + name = 'amqp'; + displayName = 'AMQP'; + properties = [ + { + displayName: 'Hostname', + name: 'hostname', + type: 'string' as NodePropertyTypes, + default: '', + }, + { + displayName: 'Port', + name: 'port', + type: 'number' as NodePropertyTypes, + default: 5672, + }, + { + displayName: 'User', + name: 'username', + type: 'string' as NodePropertyTypes, + default: '', + }, + { + displayName: 'Password', + name: 'password', + type: 'string' as NodePropertyTypes, + typeOptions: { + password: true, + }, + default: '', + }, + ]; +} diff --git a/packages/nodes-base/nodes/Amqp/Amqp.node.ts b/packages/nodes-base/nodes/Amqp/Amqp.node.ts new file mode 100644 index 0000000000..66ed1aa25d --- /dev/null +++ b/packages/nodes-base/nodes/Amqp/Amqp.node.ts @@ -0,0 +1,101 @@ +import { ContainerOptions, Delivery } from 'rhea'; + +import { IExecuteSingleFunctions } from 'n8n-core'; +import { + INodeExecutionData, + INodeType, + INodeTypeDescription, +} from 'n8n-workflow'; + +export class Amqp implements INodeType { + description: INodeTypeDescription = { + displayName: 'AMQP Sender', + name: 'amqpSender', + icon: 'file:amqp.png', + group: ['transform'], + version: 1, + description: 'Sends a raw-message via AMQP 1.0, executed once per item', + defaults: { + name: 'AMQP Sender', + color: '#00FF00', + }, + inputs: ['main'], + outputs: ['main'], + credentials: [{ + name: 'amqp', + required: true, + }], + properties: [ + { + displayName: 'Queue / Topic', + name: 'sink', + type: 'string', + default: '', + placeholder: 'topic://sourcename.something', + description: 'name of the queue of topic to publish to', + }, + // Header Parameters + { + displayName: 'Headers', + name: 'headerParametersJson', + type: 'json', + default: '', + description: 'Header parameters as JSON (flat object). Sent as application_properties in amqp-message meta info.', + } + ] + }; + + async executeSingle(this: IExecuteSingleFunctions): Promise { + const item = this.getInputData(); + + const credentials = this.getCredentials('amqp'); + if (!credentials) { + throw new Error('Credentials are mandatory!'); + } + + const sink = this.getNodeParameter('sink', '') as string; + const applicationProperties = this.getNodeParameter('headerParametersJson', {}) as string | object; + + let headerProperties = applicationProperties; + if(typeof applicationProperties === 'string' && applicationProperties !== '') { + headerProperties = JSON.parse(applicationProperties); + } + + if (sink === '') { + throw new Error('Queue or Topic required!'); + } + + const container = require('rhea'); + + const connectOptions: ContainerOptions = { + host: credentials.hostname, + port: credentials.port, + reconnect: true, // this id the default anyway + reconnect_limit: 50, // try for max 50 times, based on a back-off algorithm + }; + if (credentials.username || credentials.password) { + container.options.username = credentials.username; + container.options.password = credentials.password; + } + + const allSent = new Promise(( resolve ) => { + container.on('sendable', (context: any) => { // tslint:disable-line:no-any + + const message = { + application_properties: headerProperties, + body: JSON.stringify(item) + }; + + const sendResult = context.sender.send(message); + + resolve(sendResult); + }); + }); + + container.connect(connectOptions).open_sender(sink); + + const sendResult: Delivery = await allSent as Delivery; // sendResult has a a property that causes circular reference if returned + + return { json: { id: sendResult.id } } as INodeExecutionData; + } +} diff --git a/packages/nodes-base/nodes/Amqp/AmqpTrigger.node.ts b/packages/nodes-base/nodes/Amqp/AmqpTrigger.node.ts new file mode 100644 index 0000000000..91a4eff552 --- /dev/null +++ b/packages/nodes-base/nodes/Amqp/AmqpTrigger.node.ts @@ -0,0 +1,156 @@ +import { ContainerOptions } from 'rhea'; + +import { ITriggerFunctions } from 'n8n-core'; +import { + INodeType, + INodeTypeDescription, + ITriggerResponse, +} from 'n8n-workflow'; + + +export class AmqpTrigger implements INodeType { + description: INodeTypeDescription = { + displayName: 'AMQP Trigger', + name: 'amqpTrigger', + icon: 'file:amqp.png', + group: ['trigger'], + version: 1, + description: 'Listens to AMQP 1.0 Messages', + defaults: { + name: 'AMQP Trigger', + color: '#00FF00', + }, + inputs: [], + outputs: ['main'], + credentials: [{ + name: 'amqp', + required: true, + }], + properties: [ + // Node properties which the user gets displayed and + // can change on the node. + { + displayName: 'Queue / Topic', + name: 'sink', + type: 'string', + default: '', + placeholder: 'topic://sourcename.something', + description: 'name of the queue of topic to listen to', + }, + { + displayName: 'Clientname', + name: 'clientname', + type: 'string', + default: '', + placeholder: 'for durable/persistent topic subscriptions, example: "n8n"', + description: 'Leave empty for non-durable topic subscriptions or queues. ', + }, + { + displayName: 'Subscription', + name: 'subscription', + type: 'string', + default: '', + placeholder: 'for durable/persistent topic subscriptions, example: "order-worker"', + description: 'Leave empty for non-durable topic subscriptions or queues', + }, + ] + }; + + + async trigger(this: ITriggerFunctions): Promise { + + const credentials = this.getCredentials('amqp'); + if (!credentials) { + throw new Error('Credentials are mandatory!'); + } + + const sink = this.getNodeParameter('sink', '') as string; + const clientname = this.getNodeParameter('clientname', '') as string; + const subscription = this.getNodeParameter('subscription', '') as string; + + if (sink === '') { + throw new Error('Queue or Topic required!'); + } + let durable = false; + if(subscription && clientname) { + durable = true; + } + + const container = require('rhea'); + const connectOptions: ContainerOptions = { + host: credentials.hostname, + port: credentials.port, + reconnect: true, // this id the default anyway + reconnect_limit: 50, // try for max 50 times, based on a back-off algorithm + container_id: (durable ? clientname : null) + }; + if (credentials.username || credentials.password) { + container.options.username = credentials.username; + container.options.password = credentials.password; + } + + let lastMsgId: number | undefined = undefined; + const self = this; + + container.on('message', (context: any) => { // tslint:disable-line:no-any + if (context.message.message_id && context.message.message_id === lastMsgId) { + // ignore duplicate message check, don't think it's necessary, but it was in the rhea-lib example code + lastMsgId = context.message.message_id; + return; + } + self.emit([self.helpers.returnJsonArray([context.message])]); + }); + + const connection = container.connect(connectOptions); + let clientOptions = undefined; + if (durable) { + clientOptions = { + name: subscription, + source: { + address: sink, + durable: 2, + expiry_policy: 'never' + }, + credit_window: 1 // prefetch 1 + }; + } else { + clientOptions = { + source: { + address: sink, + }, + credit_window: 1 // prefetch 1 + }; + } + connection.open_receiver(clientOptions); + + + // The "closeFunction" function gets called by n8n whenever + // the workflow gets deactivated and can so clean up. + async function closeFunction() { + connection.close(); + } + + // The "manualTriggerFunction" function gets called by n8n + // when a user is in the workflow editor and starts the + // workflow manually. + // for AMQP it doesn't make much sense to wait here but + // for a new user who doesn't know how this works, it's better to wait and show a respective info message + async function manualTriggerFunction() { + await new Promise(( resolve, reject ) => { + const timeoutHandler = setTimeout(() => { + reject(new Error('Aborted, no message received within 30secs. This 30sec timeout is only set for "manually triggered execution". Active Workflows will listen indefinitely.')); + }, 30000); + container.on('message', (context: any) => { // tslint:disable-line:no-any + clearTimeout(timeoutHandler); + resolve(true); + }); + }); + } + + return { + closeFunction, + manualTriggerFunction, + }; + + } +} diff --git a/packages/nodes-base/nodes/Amqp/amqp.png b/packages/nodes-base/nodes/Amqp/amqp.png new file mode 100644 index 0000000000..0f0345078c Binary files /dev/null and b/packages/nodes-base/nodes/Amqp/amqp.png differ diff --git a/packages/nodes-base/package.json b/packages/nodes-base/package.json index aa2af1805f..2e36690692 100644 --- a/packages/nodes-base/package.json +++ b/packages/nodes-base/package.json @@ -28,6 +28,7 @@ "credentials": [ "dist/credentials/ActiveCampaignApi.credentials.js", "dist/credentials/AirtableApi.credentials.js", + "dist/credentials/Amqp.credentials.js", "dist/credentials/AsanaApi.credentials.js", "dist/credentials/Aws.credentials.js", "dist/credentials/ChargebeeApi.credentials.js", @@ -59,6 +60,8 @@ "nodes": [ "dist/nodes/ActiveCampaign/ActiveCampaign.node.js", "dist/nodes/Airtable/Airtable.node.js", + "dist/nodes/Amqp/Amqp.node.js", + "dist/nodes/Amqp/AmqpTrigger.node.js", "dist/nodes/Asana/Asana.node.js", "dist/nodes/Asana/AsanaTrigger.node.js", "dist/nodes/Aws/AwsLambda.node.js", @@ -159,6 +162,7 @@ "pdf-parse": "^1.1.1", "pg-promise": "^9.0.3", "redis": "^2.8.0", + "rhea": "^1.0.11", "rss-parser": "^3.7.0", "vm2": "^3.6.10", "xlsx": "^0.14.3",