import type { Connection, ContainerOptions, Dictionary, EventContext, Sender } from 'rhea'; import { create_container } from 'rhea'; import type { IExecuteFunctions, IDataObject, INodeExecutionData, INodeType, INodeTypeDescription, ICredentialTestFunctions, INodeCredentialTestResult, ICredentialsDecrypted, ICredentialDataDecryptedObject, } from 'n8n-workflow'; import { NodeConnectionType, NodeOperationError } from 'n8n-workflow'; async function checkIfCredentialsValid( credentials: IDataObject, ): Promise { const connectOptions: ContainerOptions = { reconnect: false, host: credentials.hostname as string, hostname: credentials.hostname as string, port: credentials.port as number, username: credentials.username ? (credentials.username as string) : undefined, password: credentials.password ? (credentials.password as string) : undefined, transport: credentials.transportType ? (credentials.transportType as string) : undefined, }; let conn: Connection | undefined = undefined; try { const container = create_container(); await new Promise((resolve, reject) => { container.on('connection_open', function (_context: EventContext) { resolve(); }); container.on('disconnected', function (context: EventContext) { reject(context.error ?? new Error('unknown error')); }); conn = container.connect(connectOptions); }); } catch (error) { return { status: 'Error', message: (error as Error).message, }; } finally { if (conn) (conn as Connection).close(); } return { status: 'OK', message: 'Connection successful!', }; } export class Amqp implements INodeType { description: INodeTypeDescription = { displayName: 'AMQP Sender', name: 'amqp', icon: 'file:amqp.svg', group: ['transform'], version: 1, description: 'Sends a raw-message via AMQP 1.0, executed once per item', defaults: { name: 'AMQP Sender', }, inputs: [NodeConnectionType.Main], outputs: [NodeConnectionType.Main], credentials: [ { name: 'amqp', required: true, testedBy: 'amqpConnectionTest', }, ], properties: [ { displayName: 'Queue / Topic', name: 'sink', type: 'string', default: '', placeholder: 'e.g. 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.', }, { displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add option', default: {}, options: [ { displayName: 'Container ID', name: 'containerId', type: 'string', default: '', description: 'Will be used to pass to the RHEA Backend as container_id', }, { displayName: 'Data as Object', name: 'dataAsObject', type: 'boolean', default: false, description: 'Whether to send the data as an object', }, { displayName: 'Reconnect', name: 'reconnect', type: 'boolean', default: true, description: 'Whether to automatically reconnect if disconnected', }, { displayName: 'Reconnect Limit', name: 'reconnectLimit', type: 'number', default: 50, description: 'Maximum number of reconnect attempts', }, { displayName: 'Send Property', name: 'sendOnlyProperty', type: 'string', default: '', description: 'The only property to send. If empty the whole item will be sent.', }, ], }, ], }; methods = { credentialTest: { async amqpConnectionTest( this: ICredentialTestFunctions, credential: ICredentialsDecrypted, ): Promise { const credentials = credential.data as ICredentialDataDecryptedObject; return await checkIfCredentialsValid(credentials); }, }, }; async execute(this: IExecuteFunctions): Promise { const container = create_container(); let connection: Connection | undefined = undefined; let sender: Sender | undefined = undefined; try { const credentials = await this.getCredentials('amqp'); // check if credentials are valid to avoid unnecessary reconnects const credentialsTestResult = await checkIfCredentialsValid(credentials); if (credentialsTestResult.status === 'Error') { throw new NodeOperationError(this.getNode(), credentialsTestResult.message, { description: 'Check your credentials and try again', }); } const sink = this.getNodeParameter('sink', 0, '') as string; const applicationProperties = this.getNodeParameter('headerParametersJson', 0, {}) as | string | object; const options = this.getNodeParameter('options', 0, {}); const containerId = options.containerId as string; const containerReconnect = (options.reconnect as boolean) || true; const containerReconnectLimit = (options.reconnectLimit as number) || 50; let headerProperties: Dictionary; if (typeof applicationProperties === 'string' && applicationProperties !== '') { headerProperties = JSON.parse(applicationProperties); } else { headerProperties = applicationProperties as object; } if (sink === '') { throw new NodeOperationError(this.getNode(), 'Queue or Topic required!'); } /* Values are documented here: https://github.com/amqp/rhea#container */ const connectOptions: ContainerOptions = { host: credentials.hostname, hostname: credentials.hostname, port: credentials.port, username: credentials.username ? credentials.username : undefined, password: credentials.password ? credentials.password : undefined, transport: credentials.transportType ? credentials.transportType : undefined, container_id: containerId ? containerId : undefined, id: containerId ? containerId : undefined, reconnect: containerReconnect, reconnect_limit: containerReconnectLimit, }; const node = this.getNode(); const responseData: INodeExecutionData[] = await new Promise((resolve, reject) => { connection = container.connect(connectOptions); sender = connection.open_sender(sink); let limit = containerReconnectLimit; container.on('disconnected', function (context: EventContext) { //handling this manually as container, despite reconnect_limit, does reconnect on disconnect if (limit <= 0) { connection!.options.reconnect = false; const error = new NodeOperationError( node, ((context.error as Error) ?? {}).message ?? 'Disconnected', { description: `Check your credentials${options.reconnect ? '' : ', and consider enabling reconnect in the options'}`, itemIndex: 0, }, ); reject(error); } limit--; }); container.once('sendable', (context: EventContext) => { const returnData: INodeExecutionData[] = []; const items = this.getInputData(); for (let i = 0; i < items.length; i++) { const item = items[i]; let body: IDataObject | string = item.json; const sendOnlyProperty = options.sendOnlyProperty as string; if (sendOnlyProperty) { body = body[sendOnlyProperty] as string; } if (options.dataAsObject !== true) { body = JSON.stringify(body); } const result = context.sender?.send({ application_properties: headerProperties, body, }); returnData.push({ json: { id: result?.id }, pairedItems: { item: i } }); } resolve(returnData); }); }); return [responseData]; } catch (error) { if (this.continueOnFail()) { return [[{ json: { error: error.message }, pairedItems: { item: 0 } }]]; } else { throw error; } } finally { if (sender) (sender as Sender).close(); if (connection) (connection as Connection).close(); } } }