n8n/packages/nodes-base/nodes/Aws/AwsSnsTrigger.node.ts

204 lines
5.1 KiB
TypeScript
Raw Normal View History

2020-02-08 14:19:00 -08:00
import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
ILoadOptionsFunctions,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
2020-02-08 14:19:00 -08:00
} from 'n8n-workflow';
import {
awsApiRequestSOAP,
} from './GenericFunctions';
import {
get,
} from 'lodash';
2020-02-08 14:19:00 -08:00
export class AwsSnsTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'AWS SNS Trigger',
subtitle: `={{$parameter["topic"].split(':')[5]}}`,
2020-02-09 18:27:06 -08:00
name: 'awsSnsTrigger',
2020-02-08 14:19:00 -08:00
icon: 'file:sns.png',
group: ['trigger'],
version: 1,
description: 'Handle AWS SNS events via webhooks',
defaults: {
2020-02-09 18:27:06 -08:00
name: 'AWS-SNS-Trigger',
2020-02-08 14:19:00 -08:00
color: '#FF9900',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'aws',
required: true,
},
2020-02-08 14:19:00 -08:00
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Topic',
name: 'topic',
type: 'options',
required: true,
typeOptions: {
loadOptionsMethod: 'getTopics',
},
default: '',
},
],
};
methods = {
loadOptions: {
// Get all the available topics to display them to user so that he can
// select them easily
async getTopics(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
let data;
try {
data = await awsApiRequestSOAP.call(this, 'sns', 'GET', '/?Action=ListTopics');
} catch (err) {
throw new Error(`AWS Error: ${err}`);
}
let topics = data.ListTopicsResponse.ListTopicsResult.Topics.member;
if (!Array.isArray(topics)) {
// If user has only a single topic no array get returned so we make
// one manually to be able to process everything identically
topics = [topics];
}
for (const topic of topics) {
const topicArn = topic.TopicArn as string;
const topicName = topicArn.split(':')[5];
returnData.push({
name: topicName,
value: topicArn,
});
}
return returnData;
2020-10-22 06:46:03 -07:00
},
2020-02-08 14:19:00 -08:00
},
};
// @ts-ignore
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const topic = this.getNodeParameter('topic') as string;
if (webhookData.webhookId === undefined) {
return false;
}
const params = [
`TopicArn=${topic}`,
'Version=2010-03-31',
];
const data = await awsApiRequestSOAP.call(this, 'sns', 'GET', '/?Action=ListSubscriptionsByTopic&' + params.join('&'));
const subscriptions = get(data, 'ListSubscriptionsByTopicResponse.ListSubscriptionsByTopicResult.Subscriptions');
if (!subscriptions || !subscriptions.member) {
return false;
}
let subscriptionMembers = subscriptions.member;
if (!Array.isArray(subscriptionMembers)) {
subscriptionMembers = [subscriptionMembers];
}
for (const subscription of subscriptionMembers) {
2020-02-08 14:19:00 -08:00
if (webhookData.webhookId === subscription.SubscriptionArn) {
return true;
}
}
return false;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
2020-02-09 18:27:06 -08:00
const webhookUrl = this.getNodeWebhookUrl('default') as string;
2020-02-08 14:19:00 -08:00
const topic = this.getNodeParameter('topic') as string;
2020-02-09 18:27:06 -08:00
if (webhookUrl.includes('%20')) {
throw new Error('The name of the SNS Trigger Node is not allowed to contain any spaces!');
}
2020-02-08 14:19:00 -08:00
const params = [
`TopicArn=${topic}`,
`Endpoint=${webhookUrl}`,
`Protocol=${webhookUrl?.split(':')[0]}`,
'ReturnSubscriptionArn=true',
'Version=2010-03-31',
];
2020-02-09 18:27:06 -08:00
const { SubscribeResponse } = await awsApiRequestSOAP.call(this, 'sns', 'GET', '/?Action=Subscribe&' + params.join('&'));
webhookData.webhookId = SubscribeResponse.SubscribeResult.SubscriptionArn;
2020-02-08 14:19:00 -08:00
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
const params = [
`SubscriptionArn=${webhookData.webhookId}`,
'Version=2010-03-31',
];
try {
await awsApiRequestSOAP.call(this, 'sns', 'GET', '/?Action=Unsubscribe&' + params.join('&'));
} catch(error) {
return false;
}
delete webhookData.webhookId;
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const req = this.getRequestObject();
const topic = this.getNodeParameter('topic') as string;
2020-02-09 18:27:06 -08:00
// @ts-ignore
const body = JSON.parse((req.rawBody).toString());
if (body.Type === 'SubscriptionConfirmation' &&
body.TopicArn === topic) {
const { Token } = body;
2020-02-08 14:19:00 -08:00
const params = [
`TopicArn=${topic}`,
`Token=${Token}`,
'Version=2010-03-31',
];
await awsApiRequestSOAP.call(this, 'sns', 'GET', '/?Action=ConfirmSubscription&' + params.join('&'));
2020-02-09 18:27:06 -08:00
return {
noWebhookResponse: true,
};
2020-02-08 14:19:00 -08:00
}
2020-02-09 18:27:06 -08:00
if (body.Type === 'UnsubscribeConfirmation') {
2020-02-08 14:19:00 -08:00
return {};
}
2020-02-09 18:27:06 -08:00
2020-02-08 14:19:00 -08:00
//TODO verify message signature
return {
workflowData: [
2020-02-09 18:27:06 -08:00
this.helpers.returnJsonArray(body),
2020-02-08 14:19:00 -08:00
],
};
}
}