/* eslint-disable n8n-nodes-base/node-filename-against-convention */ import * as amqplib from 'amqplib'; import type { Options } from 'amqplib'; import type { IExecuteFunctions, ICredentialsDecrypted, ICredentialTestFunctions, IDataObject, INodeCredentialTestResult, INodeExecutionData, INodeType, INodeTypeDescription, JsonObject, } from 'n8n-workflow'; import { NodeApiError, NodeOperationError } from 'n8n-workflow'; import { rabbitmqConnectExchange, rabbitmqConnectQueue } from './GenericFunctions'; import { formatPrivateKey } from '@utils/utilities'; export class RabbitMQ implements INodeType { description: INodeTypeDescription = { displayName: 'RabbitMQ', name: 'rabbitmq', icon: 'file:rabbitmq.svg', group: ['transform'], version: [1, 1.1], description: 'Sends messages to a RabbitMQ topic', defaults: { name: 'RabbitMQ', }, inputs: ['main'], outputs: ['main'], credentials: [ { name: 'rabbitmq', required: true, testedBy: 'rabbitmqConnectionTest', }, ], properties: [ { displayName: 'Operation', name: 'operation', type: 'hidden', noDataExpression: true, default: 'sendMessage', displayOptions: { show: { '@version': [1], }, }, // To remove when action view is fixed options: [ { name: 'Send a Message to RabbitMQ', value: 'sendMessage', action: 'Send a Message to RabbitMQ', }, { name: 'Delete From Queue', value: 'deleteMessage', action: 'Delete From Queue', }, ], }, { displayName: 'Operation', name: 'operation', type: 'options', noDataExpression: true, default: 'sendMessage', displayOptions: { show: { '@version': [1.1], }, }, options: [ { name: 'Send a Message to RabbitMQ', value: 'sendMessage', action: 'Send a Message to RabbitMQ', }, { name: 'Delete From Queue', value: 'deleteMessage', action: 'Delete From Queue', }, ], }, { displayName: 'Will delete an item from the queue triggered earlier in the workflow by a RabbitMQ Trigger node', name: 'deleteMessage', type: 'notice', default: '', displayOptions: { show: { operation: ['deleteMessage'], }, }, }, { displayName: 'Mode', name: 'mode', type: 'options', displayOptions: { hide: { operation: ['deleteMessage'], }, }, options: [ { name: 'Queue', value: 'queue', description: 'Publish data to queue', }, { name: 'Exchange', value: 'exchange', description: 'Publish data to exchange', }, ], default: 'queue', description: 'To where data should be moved', }, // ---------------------------------- // Queue // ---------------------------------- { displayName: 'Queue / Topic', name: 'queue', type: 'string', displayOptions: { show: { mode: ['queue'], }, hide: { operation: ['deleteMessage'], }, }, default: '', placeholder: 'queue-name', description: 'Name of the queue to publish to', }, // ---------------------------------- // Exchange // ---------------------------------- { displayName: 'Exchange', name: 'exchange', type: 'string', displayOptions: { show: { mode: ['exchange'], }, }, default: '', placeholder: 'exchange-name', description: 'Name of the exchange to publish to', }, { displayName: 'Type', name: 'exchangeType', type: 'options', displayOptions: { show: { mode: ['exchange'], }, }, options: [ { name: 'Direct', value: 'direct', description: 'Direct exchange type', }, { name: 'Topic', value: 'topic', description: 'Topic exchange type', }, { name: 'Headers', value: 'headers', description: 'Headers exchange type', }, { name: 'Fanout', value: 'fanout', description: 'Fanout exchange type', }, ], default: 'fanout', description: 'Type of exchange', }, { displayName: 'Routing Key', name: 'routingKey', type: 'string', displayOptions: { show: { mode: ['exchange'], }, }, default: '', placeholder: 'routing-key', description: 'The routing key for the message', }, // ---------------------------------- // Default // ---------------------------------- { displayName: 'Send Input Data', name: 'sendInputData', type: 'boolean', displayOptions: { show: { operation: ['sendMessage'], }, }, default: true, description: 'Whether to send the data the node receives as JSON', }, { displayName: 'Message', name: 'message', type: 'string', displayOptions: { show: { sendInputData: [false], }, }, default: '', description: 'The message to be sent', }, { displayName: 'Options', name: 'options', type: 'collection', default: {}, displayOptions: { show: { operation: ['sendMessage'], }, }, placeholder: 'Add option', options: [ { displayName: 'Alternate Exchange', name: 'alternateExchange', type: 'string', displayOptions: { show: { '/mode': ['exchange'], }, }, default: '', description: 'An exchange to send messages to if this exchange can’t route them to any queues', }, { displayName: 'Arguments', name: 'arguments', placeholder: 'Add Argument', description: 'Arguments to add, See here for valid options', type: 'fixedCollection', typeOptions: { multipleValues: true, }, default: {}, options: [ { name: 'argument', displayName: 'Argument', values: [ { displayName: 'Key', name: 'key', type: 'string', default: '', }, { displayName: 'Value', name: 'value', type: 'string', default: '', }, ], }, ], }, { displayName: 'Auto Delete Queue', name: 'autoDelete', type: 'boolean', default: false, description: 'Whether the queue will be deleted when the number of consumers drops to zero', }, { displayName: 'Durable', name: 'durable', type: 'boolean', default: true, description: 'Whether the queue will survive broker restarts', }, { displayName: 'Exclusive', name: 'exclusive', type: 'boolean', displayOptions: { show: { '/mode': ['queue'], }, }, default: false, description: 'Whether to scope the queue to the connection', }, { displayName: 'Headers', name: 'headers', placeholder: 'Add Header', description: 'Headers to add', type: 'fixedCollection', typeOptions: { multipleValues: true, }, default: {}, options: [ { name: 'header', displayName: 'Header', values: [ { displayName: 'Key', name: 'key', type: 'string', default: '', }, { displayName: 'Value', name: 'value', type: 'string', default: '', }, ], }, ], }, ], }, ], }; methods = { credentialTest: { async rabbitmqConnectionTest( this: ICredentialTestFunctions, credential: ICredentialsDecrypted, ): Promise { const credentials = credential.data as IDataObject; try { const credentialKeys = ['hostname', 'port', 'username', 'password', 'vhost']; const credentialData: IDataObject = {}; credentialKeys.forEach((key) => { credentialData[key] = credentials[key] === '' ? undefined : credentials[key]; }); const optsData: IDataObject = {}; if (credentials.ssl === true) { credentialData.protocol = 'amqps'; optsData.ca = credentials.ca === '' ? undefined : [Buffer.from(formatPrivateKey(credentials.ca as string))]; if (credentials.passwordless === true) { optsData.cert = credentials.cert === '' ? undefined : Buffer.from(formatPrivateKey(credentials.cert as string)); optsData.key = credentials.key === '' ? undefined : Buffer.from(formatPrivateKey(credentials.key as string)); optsData.passphrase = credentials.passphrase === '' ? undefined : credentials.passphrase; optsData.credentials = amqplib.credentials.external(); } } const connection = await amqplib.connect(credentialData, optsData); await connection.close(); } catch (error) { return { status: 'Error', message: error.message, }; } return { status: 'OK', message: 'Connection successful!', }; }, }, }; async execute(this: IExecuteFunctions): Promise { let channel, options: IDataObject; try { const items = this.getInputData(); const operation = this.getNodeParameter('operation', 0); if (operation === 'deleteMessage') { this.sendResponse(items[0].json); return [items]; } const mode = (this.getNodeParameter('mode', 0) as string) || 'queue'; const returnItems: INodeExecutionData[] = []; if (mode === 'queue') { const queue = this.getNodeParameter('queue', 0) as string; options = this.getNodeParameter('options', 0, {}); channel = await rabbitmqConnectQueue.call(this, queue, options); const sendInputData = this.getNodeParameter('sendInputData', 0) as boolean; let message: string; const queuePromises = []; for (let i = 0; i < items.length; i++) { if (sendInputData) { message = JSON.stringify(items[i].json); } else { message = this.getNodeParameter('message', i) as string; } let headers: IDataObject = {}; if ( options.headers && ((options.headers as IDataObject).header! as IDataObject[]).length ) { const itemOptions = this.getNodeParameter('options', i, {}); const additionalHeaders: IDataObject = {}; ((itemOptions.headers as IDataObject).header as IDataObject[]).forEach( (header: IDataObject) => { additionalHeaders[header.key as string] = header.value; }, ); headers = additionalHeaders; } queuePromises.push( channel.sendToQueue(queue, Buffer.from(message), { headers, ...(options.arguments ? (options.arguments as Options.Publish) : {}), }), ); } // @ts-ignore const promisesResponses = await Promise.allSettled(queuePromises); // @ts-ignore promisesResponses.forEach((response: JsonObject) => { if (response.status !== 'fulfilled') { if (!this.continueOnFail()) { throw new NodeApiError(this.getNode(), response); } else { // Return the actual reason as error returnItems.push({ json: { error: response.reason, }, }); return; } } returnItems.push({ json: { success: response.value, }, }); }); await channel.close(); await channel.connection.close(); } else if (mode === 'exchange') { const exchange = this.getNodeParameter('exchange', 0) as string; const type = this.getNodeParameter('exchangeType', 0) as string; const routingKey = this.getNodeParameter('routingKey', 0) as string; options = this.getNodeParameter('options', 0, {}); channel = await rabbitmqConnectExchange.call(this, exchange, type, options); const sendInputData = this.getNodeParameter('sendInputData', 0) as boolean; let message: string; const exchangePromises = []; for (let i = 0; i < items.length; i++) { if (sendInputData) { message = JSON.stringify(items[i].json); } else { message = this.getNodeParameter('message', i) as string; } let headers: IDataObject = {}; if ( options.headers && ((options.headers as IDataObject).header! as IDataObject[]).length ) { const itemOptions = this.getNodeParameter('options', i, {}); const additionalHeaders: IDataObject = {}; ((itemOptions.headers as IDataObject).header as IDataObject[]).forEach( (header: IDataObject) => { additionalHeaders[header.key as string] = header.value; }, ); headers = additionalHeaders; } exchangePromises.push( channel.publish(exchange, routingKey, Buffer.from(message), { headers, ...(options.arguments ? (options.arguments as Options.Publish) : {}), }), ); } // @ts-ignore const promisesResponses = await Promise.allSettled(exchangePromises); // @ts-ignore promisesResponses.forEach((response: JsonObject) => { if (response.status !== 'fulfilled') { if (!this.continueOnFail()) { throw new NodeApiError(this.getNode(), response); } else { // Return the actual reason as error returnItems.push({ json: { error: response.reason, }, }); return; } } returnItems.push({ json: { success: response.value, }, }); }); await channel.close(); await channel.connection.close(); } else { throw new NodeOperationError(this.getNode(), `The operation "${mode}" is not known!`); } return [returnItems]; } catch (error) { if (channel) { await channel.close(); await channel.connection.close(); } throw error; } } }