mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-10 22:54:05 -08:00
6f95121fac
* 👕 Add `action` to `INodePropertyOptions` * 👕 Apply `node-param-operation-option-without-action` * ✏️ Fix add/remove phrasing * ✏️ Fix email template phrasing * ✏️ Fix add/remove phrasing * ✏️ Fix custom fields phrasing * ✏️ Fix job report phrasing * ✏️ Fix query phrasing * ✏️ Various phrasing fixes * ✏️ Fix final phrasings * ✏️ Remove `conversation` * ✏️ Fix plural
409 lines
10 KiB
TypeScript
409 lines
10 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodeParameters,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
NodeApiError,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
URL,
|
|
} from 'url';
|
|
|
|
import {
|
|
awsApiRequestSOAP,
|
|
} from '../GenericFunctions';
|
|
|
|
import {
|
|
pascalCase,
|
|
} from 'change-case';
|
|
|
|
export class AwsSqs implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'AWS SQS',
|
|
name: 'awsSqs',
|
|
icon: 'file:sqs.svg',
|
|
group: ['output'],
|
|
version: 1,
|
|
subtitle: `={{$parameter["operation"]}}`,
|
|
description: 'Sends messages to AWS SQS',
|
|
defaults: {
|
|
name: 'AWS SQS',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'aws',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
options: [
|
|
{
|
|
name: 'Send Message',
|
|
value: 'sendMessage',
|
|
description: 'Send a message to a queue',
|
|
action: 'Send a message to a queue',
|
|
},
|
|
],
|
|
default: 'sendMessage',
|
|
},
|
|
{
|
|
displayName: 'Queue Name or ID',
|
|
name: 'queue',
|
|
type: 'options',
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getQueues',
|
|
},
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'sendMessage',
|
|
],
|
|
},
|
|
},
|
|
options: [],
|
|
default: '',
|
|
required: true,
|
|
description: 'Queue to send a message to. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
|
|
},
|
|
{
|
|
displayName: 'Queue Type',
|
|
name: 'queueType',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'FIFO',
|
|
value: 'fifo',
|
|
description: 'FIFO SQS queue',
|
|
},
|
|
{
|
|
name: 'Standard',
|
|
value: 'standard',
|
|
description: 'Standard SQS queue',
|
|
},
|
|
],
|
|
default: 'standard',
|
|
},
|
|
{
|
|
displayName: 'Send Input Data',
|
|
name: 'sendInputData',
|
|
type: 'boolean',
|
|
default: true,
|
|
description: 'Whether to send the data the node receives as JSON to SQS',
|
|
},
|
|
{
|
|
displayName: 'Message',
|
|
name: 'message',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'sendMessage',
|
|
],
|
|
sendInputData: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
required: true,
|
|
typeOptions: {
|
|
alwaysOpenEditWindow: true,
|
|
},
|
|
default: '',
|
|
description: 'Message to send to the queue',
|
|
},
|
|
{
|
|
displayName: 'Message Group ID',
|
|
name: 'messageGroupId',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Tag that specifies that a message belongs to a specific message group. Applies only to FIFO (first-in-first-out) queues.',
|
|
displayOptions: {
|
|
show: {
|
|
queueType: [
|
|
'fifo',
|
|
],
|
|
},
|
|
},
|
|
required: true,
|
|
},
|
|
{
|
|
displayName: 'Options',
|
|
name: 'options',
|
|
type: 'collection',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'sendMessage',
|
|
],
|
|
},
|
|
},
|
|
default: {},
|
|
placeholder: 'Add Option',
|
|
options: [
|
|
{
|
|
displayName: 'Delay Seconds',
|
|
name: 'delaySeconds',
|
|
type: 'number',
|
|
displayOptions: {
|
|
show: {
|
|
'/queueType': [
|
|
'standard',
|
|
],
|
|
},
|
|
},
|
|
description: 'How long, in seconds, to delay a message for',
|
|
default: 0,
|
|
typeOptions: {
|
|
minValue: 0,
|
|
maxValue: 900,
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Message Attributes',
|
|
name: 'messageAttributes',
|
|
placeholder: 'Add Attribute',
|
|
type: 'fixedCollection',
|
|
typeOptions: {
|
|
multipleValues: true,
|
|
},
|
|
description: 'Attributes to set',
|
|
default: {},
|
|
options: [
|
|
{
|
|
name: 'binary',
|
|
displayName: 'Binary',
|
|
values: [
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Name of the attribute',
|
|
},
|
|
{
|
|
displayName: 'Property Name',
|
|
name: 'dataPropertyName',
|
|
type: 'string',
|
|
default: 'data',
|
|
description: 'Name of the binary property which contains the data for the message attribute',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
name: 'number',
|
|
displayName: 'Number',
|
|
values: [
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Name of the attribute',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'number',
|
|
default: 0,
|
|
description: 'Number value of the attribute',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
name: 'string',
|
|
displayName: 'String',
|
|
values: [
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Name of the attribute',
|
|
},
|
|
{
|
|
displayName: 'Value',
|
|
name: 'value',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'String value of attribute',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
{
|
|
displayName: 'Message Deduplication ID',
|
|
name: 'messageDeduplicationId',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Token used for deduplication of sent messages. Applies only to FIFO (first-in-first-out) queues.',
|
|
displayOptions: {
|
|
show: {
|
|
'/queueType': [
|
|
'fifo',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
],
|
|
},
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
// Get all the available queues to display them to user so that it can be selected easily
|
|
async getQueues(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const params = [
|
|
'Version=2012-11-05',
|
|
`Action=ListQueues`,
|
|
];
|
|
|
|
let data;
|
|
try {
|
|
// loads first 1000 queues from SQS
|
|
data = await awsApiRequestSOAP.call(this, 'sqs', 'GET', `?${params.join('&')}`);
|
|
} catch (error) {
|
|
throw new NodeApiError(this.getNode(), error);
|
|
}
|
|
|
|
let queues = data.ListQueuesResponse.ListQueuesResult.QueueUrl;
|
|
if (!queues) {
|
|
return [];
|
|
}
|
|
|
|
if (!Array.isArray(queues)) {
|
|
// If user has only a single queue no array get returned so we make
|
|
// one manually to be able to process everything identically
|
|
queues = [queues];
|
|
}
|
|
|
|
return queues.map((queueUrl: string) => {
|
|
const urlParts = queueUrl.split('/');
|
|
const name = urlParts[urlParts.length - 1];
|
|
|
|
return {
|
|
name,
|
|
value: queueUrl,
|
|
};
|
|
});
|
|
},
|
|
},
|
|
};
|
|
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: IDataObject[] = [];
|
|
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
|
|
for (let i = 0; i < items.length; i++) {
|
|
try {
|
|
const queueUrl = this.getNodeParameter('queue', i) as string;
|
|
const queuePath = new URL(queueUrl).pathname;
|
|
|
|
const params = [
|
|
'Version=2012-11-05',
|
|
`Action=${pascalCase(operation)}`,
|
|
];
|
|
|
|
const options = this.getNodeParameter('options', i, {}) as IDataObject;
|
|
const sendInputData = this.getNodeParameter('sendInputData', i) as boolean;
|
|
|
|
const message = sendInputData ? JSON.stringify(items[i].json) : this.getNodeParameter('message', i) as string;
|
|
params.push(`MessageBody=${message}`);
|
|
|
|
if (options.delaySeconds) {
|
|
params.push(`DelaySeconds=${options.delaySeconds}`);
|
|
}
|
|
|
|
const queueType = this.getNodeParameter('queueType', i, {}) as string;
|
|
if (queueType === 'fifo') {
|
|
const messageDeduplicationId = this.getNodeParameter('options.messageDeduplicationId', i, '') as string;
|
|
if (messageDeduplicationId) {
|
|
params.push(`MessageDeduplicationId=${messageDeduplicationId}`);
|
|
}
|
|
|
|
const messageGroupId = this.getNodeParameter('messageGroupId', i) as string;
|
|
if (messageGroupId) {
|
|
params.push(`MessageGroupId=${messageGroupId}`);
|
|
}
|
|
}
|
|
|
|
let attributeCount = 0;
|
|
// Add string values
|
|
(this.getNodeParameter('options.messageAttributes.string', i, []) as INodeParameters[]).forEach((attribute) => {
|
|
attributeCount++;
|
|
params.push(`MessageAttribute.${attributeCount}.Name=${attribute.name}`);
|
|
params.push(`MessageAttribute.${attributeCount}.Value.StringValue=${attribute.value}`);
|
|
params.push(`MessageAttribute.${attributeCount}.Value.DataType=String`);
|
|
});
|
|
|
|
// Add binary values
|
|
(this.getNodeParameter('options.messageAttributes.binary', i, []) as INodeParameters[]).forEach((attribute) => {
|
|
attributeCount++;
|
|
const dataPropertyName = attribute.dataPropertyName as string;
|
|
const item = items[i];
|
|
|
|
if (item.binary === undefined) {
|
|
throw new NodeOperationError(this.getNode(), 'No binary data set. So message attribute cannot be added!');
|
|
}
|
|
|
|
if (item.binary[dataPropertyName] === undefined) {
|
|
throw new NodeOperationError(this.getNode(), `The binary property "${dataPropertyName}" does not exist. So message attribute cannot be added!`);
|
|
}
|
|
|
|
const binaryData = item.binary[dataPropertyName].data;
|
|
|
|
params.push(`MessageAttribute.${attributeCount}.Name=${attribute.name}`);
|
|
params.push(`MessageAttribute.${attributeCount}.Value.BinaryValue=${binaryData}`);
|
|
params.push(`MessageAttribute.${attributeCount}.Value.DataType=Binary`);
|
|
});
|
|
|
|
// Add number values
|
|
(this.getNodeParameter('options.messageAttributes.number', i, []) as INodeParameters[]).forEach((attribute) => {
|
|
attributeCount++;
|
|
params.push(`MessageAttribute.${attributeCount}.Name=${attribute.name}`);
|
|
params.push(`MessageAttribute.${attributeCount}.Value.StringValue=${attribute.value}`);
|
|
params.push(`MessageAttribute.${attributeCount}.Value.DataType=Number`);
|
|
});
|
|
|
|
let responseData;
|
|
try {
|
|
responseData = await awsApiRequestSOAP.call(this, 'sqs', 'GET', `${queuePath}?${params.join('&')}`);
|
|
} catch (error) {
|
|
throw new NodeApiError(this.getNode(), error);
|
|
}
|
|
|
|
const result = responseData.SendMessageResponse.SendMessageResult;
|
|
returnData.push(result as IDataObject);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
returnData.push({ error: error.description });
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|