mirror of
https://github.com/n8n-io/n8n.git
synced 2025-02-21 02:56:40 -08:00
added amqp sender
This commit is contained in:
parent
230dc33752
commit
c31dc77b06
|
@ -11,6 +11,18 @@ export class Amqp implements ICredentialType {
|
||||||
// The credentials to get from user and save encrypted.
|
// The credentials to get from user and save encrypted.
|
||||||
// Properties can be defined exactly in the same way
|
// Properties can be defined exactly in the same way
|
||||||
// as node properties.
|
// as node properties.
|
||||||
|
{
|
||||||
|
displayName: 'Hostname',
|
||||||
|
name: 'hostname',
|
||||||
|
type: 'string' as NodePropertyTypes,
|
||||||
|
default: '',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Port',
|
||||||
|
name: 'port',
|
||||||
|
type: 'number' as NodePropertyTypes,
|
||||||
|
default: 5672,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
displayName: 'User',
|
displayName: 'User',
|
||||||
name: 'username',
|
name: 'username',
|
||||||
|
|
117
packages/nodes-base/nodes/Amqp/Amqp.node.ts
Normal file
117
packages/nodes-base/nodes/Amqp/Amqp.node.ts
Normal file
|
@ -0,0 +1,117 @@
|
||||||
|
import { IExecuteSingleFunctions } from 'n8n-core';
|
||||||
|
import {
|
||||||
|
IDataObject,
|
||||||
|
INodeExecutionData,
|
||||||
|
INodeType,
|
||||||
|
INodeTypeDescription,
|
||||||
|
} from 'n8n-workflow';
|
||||||
|
import { Delivery } from 'rhea';
|
||||||
|
|
||||||
|
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: 'Host',
|
||||||
|
name: 'hostname',
|
||||||
|
type: 'string',
|
||||||
|
default: 'localhost',
|
||||||
|
description: 'hostname of the amqp server',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
displayName: 'Port',
|
||||||
|
name: 'port',
|
||||||
|
type: 'number',
|
||||||
|
typeOptions: {
|
||||||
|
minValue: 1,
|
||||||
|
},
|
||||||
|
default: 5672,
|
||||||
|
description: 'TCP Port to connect to',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
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<INodeExecutionData> {
|
||||||
|
const item = this.getInputData();
|
||||||
|
|
||||||
|
const credentials = this.getCredentials('amqp');
|
||||||
|
if (!credentials) {
|
||||||
|
throw new Error('Credentials are mandatory!');
|
||||||
|
}
|
||||||
|
|
||||||
|
const sink = this.getNodeParameter('sink', '') as string;
|
||||||
|
let 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!');
|
||||||
|
}
|
||||||
|
|
||||||
|
let container = require('rhea');
|
||||||
|
|
||||||
|
let connectOptions = {
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
let allSent = new Promise( function( resolve ) {
|
||||||
|
container.on('sendable', function (context: any) {
|
||||||
|
|
||||||
|
let message = {
|
||||||
|
application_properties: headerProperties,
|
||||||
|
body: JSON.stringify(item)
|
||||||
|
}
|
||||||
|
let sendResult = context.sender.send(message);
|
||||||
|
|
||||||
|
resolve(sendResult);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
container.connect(connectOptions).open_sender(sink);
|
||||||
|
|
||||||
|
let sendResult: Delivery = await allSent as Delivery; // sendResult has a a property that causes circular reference if returned
|
||||||
|
|
||||||
|
return { json: { id: sendResult.id } } as INodeExecutionData;
|
||||||
|
}
|
||||||
|
}
|
|
@ -7,44 +7,27 @@ import {
|
||||||
} from 'n8n-workflow';
|
} from 'n8n-workflow';
|
||||||
|
|
||||||
|
|
||||||
export class AmqpListener implements INodeType {
|
export class AmqpTrigger implements INodeType {
|
||||||
description: INodeTypeDescription = {
|
description: INodeTypeDescription = {
|
||||||
displayName: 'AMQP Listener',
|
displayName: 'AMQP Trigger',
|
||||||
name: 'amqpListener',
|
name: 'amqpTrigger',
|
||||||
icon: 'file:amqp.png',
|
icon: 'file:amqp.png',
|
||||||
group: ['trigger'],
|
group: ['trigger'],
|
||||||
version: 1,
|
version: 1,
|
||||||
description: 'Listens to AMQP 1.0 Messages',
|
description: 'Listens to AMQP 1.0 Messages',
|
||||||
defaults: {
|
defaults: {
|
||||||
name: 'AMQP Listener',
|
name: 'AMQP Trigger',
|
||||||
color: '#00FF00',
|
color: '#00FF00',
|
||||||
},
|
},
|
||||||
inputs: [],
|
inputs: [],
|
||||||
outputs: ['main'],
|
outputs: ['main'],
|
||||||
credentials: [{
|
credentials: [{
|
||||||
name: 'amqp',
|
name: 'amqp',
|
||||||
required: false,
|
required: true,
|
||||||
}],
|
}],
|
||||||
properties: [
|
properties: [
|
||||||
// Node properties which the user gets displayed and
|
// Node properties which the user gets displayed and
|
||||||
// can change on the node.
|
// can change on the node.
|
||||||
{
|
|
||||||
displayName: 'Host',
|
|
||||||
name: 'hostname',
|
|
||||||
type: 'string',
|
|
||||||
default: 'localhost',
|
|
||||||
description: 'hostname of the amqp server',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
displayName: 'Port',
|
|
||||||
name: 'port',
|
|
||||||
type: 'number',
|
|
||||||
typeOptions: {
|
|
||||||
minValue: 1,
|
|
||||||
},
|
|
||||||
default: 5672,
|
|
||||||
description: 'TCP Port to connect to',
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
displayName: 'Queue / Topic',
|
displayName: 'Queue / Topic',
|
||||||
name: 'sink',
|
name: 'sink',
|
||||||
|
@ -76,9 +59,10 @@ export class AmqpListener implements INodeType {
|
||||||
async trigger(this: ITriggerFunctions): Promise<ITriggerResponse> {
|
async trigger(this: ITriggerFunctions): Promise<ITriggerResponse> {
|
||||||
|
|
||||||
const credentials = this.getCredentials('amqp');
|
const credentials = this.getCredentials('amqp');
|
||||||
|
if (!credentials) {
|
||||||
|
throw new Error('Credentials are mandatory!');
|
||||||
|
}
|
||||||
|
|
||||||
const hostname = this.getNodeParameter('hostname', 'localhost') as string;
|
|
||||||
const port = this.getNodeParameter('port', 5672) as number;
|
|
||||||
const sink = this.getNodeParameter('sink', '') as string;
|
const sink = this.getNodeParameter('sink', '') as string;
|
||||||
const clientname = this.getNodeParameter('clientname', '') as string;
|
const clientname = this.getNodeParameter('clientname', '') as string;
|
||||||
const subscription = this.getNodeParameter('subscription', '') as string;
|
const subscription = this.getNodeParameter('subscription', '') as string;
|
||||||
|
@ -88,19 +72,18 @@ export class AmqpListener implements INodeType {
|
||||||
}
|
}
|
||||||
let durable: boolean = false;
|
let durable: boolean = false;
|
||||||
if(subscription && clientname) {
|
if(subscription && clientname) {
|
||||||
console.log('durable subscription')
|
|
||||||
durable = true;
|
durable = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
let container = require('rhea');
|
let container = require('rhea');
|
||||||
let connectOptions = {
|
let connectOptions = {
|
||||||
host: hostname,
|
host: credentials.hostname,
|
||||||
port: port,
|
port: credentials.port,
|
||||||
reconnect: true, // this id the default anyway
|
reconnect: true, // this id the default anyway
|
||||||
reconnect_limit: 50, // try for max 50 times, based on a back-off algorithm
|
reconnect_limit: 50, // try for max 50 times, based on a back-off algorithm
|
||||||
container_id: (durable ? clientname : null)
|
container_id: (durable ? clientname : null)
|
||||||
}
|
}
|
||||||
if (credentials) {
|
if (credentials.username || credentials.password) {
|
||||||
container.options.username = credentials.username;
|
container.options.username = credentials.username;
|
||||||
container.options.password = credentials.password;
|
container.options.password = credentials.password;
|
||||||
}
|
}
|
||||||
|
@ -109,11 +92,8 @@ export class AmqpListener implements INodeType {
|
||||||
let self = this;
|
let self = this;
|
||||||
|
|
||||||
container.on('message', function (context: any) {
|
container.on('message', function (context: any) {
|
||||||
console.log('AMQP: received message id: ' + (context.message.message_id ? context.message.message_id : ''));
|
|
||||||
console.log(context.message.body);
|
|
||||||
if (context.message.message_id && context.message.message_id == lastMsgId) {
|
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
|
// ignore duplicate message check, don't think it's necessary, but it was in the rhea-lib example code
|
||||||
console.log('duplicate received: ' + context.message.message_id);
|
|
||||||
lastMsgId = context.message.message_id;
|
lastMsgId = context.message.message_id;
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
@ -141,25 +121,33 @@ export class AmqpListener implements INodeType {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
connection.open_receiver(clientOptions);
|
connection.open_receiver(clientOptions);
|
||||||
console.log('AMQP: listener attached');
|
|
||||||
|
|
||||||
|
|
||||||
// The "closeFunction" function gets called by n8n whenever
|
// The "closeFunction" function gets called by n8n whenever
|
||||||
// the workflow gets deactivated and can so clean up.
|
// the workflow gets deactivated and can so clean up.
|
||||||
async function closeFunction() {
|
async function closeFunction() {
|
||||||
connection.close();
|
connection.close();
|
||||||
console.log('AMQP: listener closed');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// The "manualTriggerFunction" function gets called by n8n
|
// The "manualTriggerFunction" function gets called by n8n
|
||||||
// when a user is in the workflow editor and starts the
|
// when a user is in the workflow editor and starts the
|
||||||
// workflow manually.
|
// workflow manually.
|
||||||
// does not make really sense for AMQP
|
// 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() {
|
async function manualTriggerFunction() {
|
||||||
console.log('AMQP: manual trigger clicked, this will make the node spinn, until a message is received on: ' + sink);
|
|
||||||
/* self.emit([self.helpers.returnJsonArray([{
|
await new Promise( function( resolve ) {
|
||||||
error: '"manually triggered execution" stops the node right afterwards which unsubscribes the listener from the service bus. You need to activate the workflow to test.'
|
let timeoutHandler = setTimeout(function() {
|
||||||
}])]); */
|
self.emit([self.helpers.returnJsonArray([{
|
||||||
|
error: 'Aborted, no message received within 30secs. This 30sec timeout is only set for "manually triggered execution". Active Workflows will listen indefinitely.'
|
||||||
|
}])]);
|
||||||
|
resolve(true);
|
||||||
|
}, 30000);
|
||||||
|
container.on('message', function (context: any) {
|
||||||
|
clearTimeout(timeoutHandler);
|
||||||
|
resolve(true);
|
||||||
|
});
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
|
@ -60,7 +60,8 @@
|
||||||
"nodes": [
|
"nodes": [
|
||||||
"dist/nodes/ActiveCampaign/ActiveCampaign.node.js",
|
"dist/nodes/ActiveCampaign/ActiveCampaign.node.js",
|
||||||
"dist/nodes/Airtable/Airtable.node.js",
|
"dist/nodes/Airtable/Airtable.node.js",
|
||||||
"dist/nodes/Amqp/AmqpListener.node.js",
|
"dist/nodes/Amqp/Amqp.node.js",
|
||||||
|
"dist/nodes/Amqp/AmqpTrigger.node.js",
|
||||||
"dist/nodes/Asana/Asana.node.js",
|
"dist/nodes/Asana/Asana.node.js",
|
||||||
"dist/nodes/Asana/AsanaTrigger.node.js",
|
"dist/nodes/Asana/AsanaTrigger.node.js",
|
||||||
"dist/nodes/Aws/AwsLambda.node.js",
|
"dist/nodes/Aws/AwsLambda.node.js",
|
||||||
|
|
Loading…
Reference in a new issue