feat: Add appendN8nAttribution option to sendAndWait operation (#13697)

Co-authored-by: Michael Kret <michael.k@radency.com>
This commit is contained in:
Ria Scholz
2025-03-18 10:43:21 +01:00
committed by GitHub
parent 7e1036187f
commit d6d5a66f5d
16 changed files with 173 additions and 40 deletions

View File

@@ -392,11 +392,13 @@ export async function sendDiscordMessage(
export function createSendAndWaitMessageBody(context: IExecuteFunctions) {
const config = getSendAndWaitConfig(context);
const instanceId = context.getInstanceId();
const attributionText = 'This message was sent automatically with ';
const link = createUtmCampaignLink('n8n-nodes-base.discord', instanceId);
const description = `${config.message}\n\n_${attributionText}_[n8n](${link})`;
let description = config.message;
if (config.appendAttribution !== false) {
const instanceId = context.getInstanceId();
const attributionText = 'This message was sent automatically with ';
const link = createUtmCampaignLink('n8n-nodes-base.discord', instanceId);
description = `${config.message}\n\n_${attributionText}_[n8n](${link})`;
}
const body = {
embeds: [

View File

@@ -46,7 +46,8 @@ describe('Test EmailSendV2, email => sendAndWait', () => {
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my subject');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('http://localhost/waiting-webhook');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('nodeID');
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({});
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // approvalOptions
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // options
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('approval');
// configureWaitTillDate

View File

@@ -8,7 +8,10 @@ import type {
import { fromEmailProperty, toEmailProperty } from './descriptions';
import { configureTransport } from './utils';
import { configureWaitTillDate } from '../../../utils/sendAndWait/configureWaitTillDate.util';
import { createEmailBody } from '../../../utils/sendAndWait/email-templates';
import {
createEmailBodyWithN8nAttribution,
createEmailBodyWithoutN8nAttribution,
} from '../../../utils/sendAndWait/email-templates';
import {
createButton,
getSendAndWaitConfig,
@@ -30,9 +33,14 @@ export async function execute(this: IExecuteFunctions): Promise<INodeExecutionDa
buttons.push(createButton(config.url, option.label, option.value, option.style));
}
const instanceId = this.getInstanceId();
let htmlBody: string;
const htmlBody = createEmailBody(config.message, buttons.join('\n'), instanceId);
if (config.appendAttribution !== false) {
const instanceId = this.getInstanceId();
htmlBody = createEmailBodyWithN8nAttribution(config.message, buttons.join('\n'), instanceId);
} else {
htmlBody = createEmailBodyWithoutN8nAttribution(config.message, buttons.join('\n'));
}
const mailOptions: IDataObject = {
from: fromEmail,

View File

@@ -162,16 +162,19 @@ export function getPagingParameters(resource: string, operation = 'getAll') {
export function createSendAndWaitMessageBody(context: IExecuteFunctions) {
const config = getSendAndWaitConfig(context);
const instanceId = context.getInstanceId();
const attributionText = '_This_ _message_ _was_ _sent_ _automatically_ _with_';
const link = createUtmCampaignLink('n8n-nodes-base.googleChat', instanceId);
const attribution = `${attributionText} _<${link}|n8n>_`;
const buttons: string[] = config.options.map(
(option) => `*<${`${config.url}?approved=${option.value}`}|${option.label}>*`,
);
const text = `${config.message}\n\n\n${buttons.join(' ')}\n\n${attribution}`;
let text = `${config.message}\n\n\n${buttons.join(' ')}`;
if (config.appendAttribution !== false) {
const instanceId = context.getInstanceId();
const attributionText = '_This_ _message_ _was_ _sent_ _automatically_ _with_';
const link = createUtmCampaignLink('n8n-nodes-base.googleChat', instanceId);
const attribution = `${attributionText} _<${link}|n8n>_`;
text += `\n\n${attribution}`;
}
const body = {
text,

View File

@@ -41,7 +41,8 @@ describe('Test GoogleChat, message => sendAndWait', () => {
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my subject');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('http://localhost/waiting-webhook');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('nodeID');
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({});
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // approvalOptions
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // options
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('approval');
// configureWaitTillDate

View File

@@ -48,7 +48,8 @@ describe('Test MicrosoftOutlookV2, message => sendAndWait', () => {
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my subject');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('http://localhost/waiting-webhook');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('nodeID');
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({});
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // approvalOptions
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // options
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('approval');
// configureWaitTillDate

View File

@@ -5,7 +5,10 @@ import type {
INodeProperties,
} from 'n8n-workflow';
import { createEmailBody } from '../../../../../../utils/sendAndWait/email-templates';
import {
createEmailBodyWithN8nAttribution,
createEmailBodyWithoutN8nAttribution,
} from '../../../../../../utils/sendAndWait/email-templates';
import {
getSendAndWaitConfig,
getSendAndWaitProperties,
@@ -34,9 +37,13 @@ export async function execute(this: IExecuteFunctions, index: number, items: INo
buttons.push(createButton(config.url, option.label, option.value, option.style));
}
const instanceId = this.getInstanceId();
const bodyContent = createEmailBody(config.message, buttons.join('\n'), instanceId);
let bodyContent: string;
if (config.appendAttribution !== false) {
const instanceId = this.getInstanceId();
bodyContent = createEmailBodyWithN8nAttribution(config.message, buttons.join('\n'), instanceId);
} else {
bodyContent = createEmailBodyWithoutN8nAttribution(config.message, buttons.join('\n'));
}
const fields: IDataObject = {
subject: config.title,

View File

@@ -23,15 +23,18 @@ export async function execute(this: IExecuteFunctions, i: number, instanceId: st
const chatId = this.getNodeParameter('chatId', i, '', { extractValue: true }) as string;
const config = getSendAndWaitConfig(this);
const attributionText = 'This message was sent automatically with';
const link = createUtmCampaignLink('n8n-nodes-base.microsoftTeams', instanceId);
const attribution = `<em>${attributionText} <a href="${link}">n8n</a></em>`;
const buttons = config.options.map(
(option) => `<a href="${config.url}?approved=${option.value}">${option.label}</a>`,
);
const content = `${config.message}<br><br>${buttons.join(' ')}<br><br>${attribution}`;
let content = `${config.message}<br><br>${buttons.join(' ')}`;
if (config.appendAttribution !== false) {
const attributionText = 'This message was sent automatically with';
const link = createUtmCampaignLink('n8n-nodes-base.microsoftTeams', instanceId);
const attribution = `<em>${attributionText} <a href="${link}">n8n</a></em>`;
content += `<br><br>${attribution}`;
}
const body = {
body: {

View File

@@ -12,6 +12,7 @@ import { NodeOperationError } from 'n8n-workflow';
import type { SendAndWaitMessageBody } from './MessageInterface';
import { getSendAndWaitConfig } from '../../../utils/sendAndWait/utils';
import { createUtmCampaignLink } from '../../../utils/utilities';
export async function slackApiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions | IWebhookFunctions,
@@ -307,6 +308,19 @@ export function createSendAndWaitMessageBody(context: IExecuteFunctions) {
],
};
if (config.appendAttribution) {
const instanceId = context.getInstanceId();
const attributionText = 'This message was sent automatically with ';
const link = createUtmCampaignLink('n8n-nodes-base.slack', instanceId);
body.blocks.push({
type: 'section',
text: {
type: 'mrkdwn',
text: `${attributionText} _<${link}|n8n>_`,
},
});
}
if (context.getNode().typeVersion > 2.2 && body.blocks?.[1]?.type === 'section') {
delete body.blocks[1].text.emoji;
}

View File

@@ -260,14 +260,17 @@ export function createSendAndWaitMessageBody(context: IExecuteFunctions) {
const config = getSendAndWaitConfig(context);
let text = config.message;
const instanceId = context.getInstanceId();
const attributionText = 'This message was sent automatically with ';
const link = createUtmCampaignLink('n8n-nodes-base.telegram', instanceId);
text = `${text}\n\n_${attributionText}_[n8n](${link})`;
if (config.appendAttribution !== false) {
const instanceId = context.getInstanceId();
const attributionText = 'This message was sent automatically with ';
const link = createUtmCampaignLink('n8n-nodes-base.telegram', instanceId);
text = `${text}\n\n_${attributionText}_[n8n](${link})`;
}
const body = {
chat_id,
text,
disable_web_page_preview: true,
parse_mode: 'Markdown',
reply_markup: {

View File

@@ -44,7 +44,8 @@ describe('Test Telegram, message => sendAndWait', () => {
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my subject');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('http://localhost/waiting-webhook');
mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('nodeID');
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({});
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // approvalOptions
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); // options
mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('approval');
// configureWaitTillDate

View File

@@ -15,6 +15,7 @@ import type {
WhatsAppAppWebhookSubscription,
} from './types';
import type { SendAndWaitConfig } from '../../utils/sendAndWait/utils';
import { createUtmCampaignLink } from '../../utils/utilities';
export const WHATSAPP_BASE_URL = 'https://graph.facebook.com/v13.0/';
async function appAccessTokenRead(
@@ -109,11 +110,19 @@ export const createMessage = (
sendAndWaitConfig: SendAndWaitConfig,
phoneNumberId: string,
recipientPhoneNumber: string,
instanceId: string,
): IHttpRequestOptions => {
const buttons = sendAndWaitConfig.options.map((option) => {
return `*${option.label}:*\n_${sendAndWaitConfig.url}?approved=${option.value}_\n\n`;
});
let n8nAttribution: string = '';
if (sendAndWaitConfig.appendAttribution) {
const attributionText = 'This message was sent automatically with ';
const link = createUtmCampaignLink('n8n-nodes-base.whatsapp', instanceId);
n8nAttribution = `\n\n${attributionText}${link}`;
}
return {
baseURL: WHATSAPP_BASE_URL,
method: 'POST',
@@ -121,7 +130,7 @@ export const createMessage = (
body: {
messaging_product: 'whatsapp',
text: {
body: `${sendAndWaitConfig.message}\n\n${buttons.join('')}`,
body: `${sendAndWaitConfig.message}\n\n${buttons.join('')}${n8nAttribution}`,
},
type: 'text',
to: recipientPhoneNumber,

View File

@@ -83,11 +83,12 @@ export class WhatsApp implements INodeType {
);
const config = getSendAndWaitConfig(this);
const instanceId = this.getInstanceId();
await this.helpers.httpRequestWithAuthentication.call(
this,
WHATSAPP_CREDENTIALS_TYPE,
createMessage(config, phoneNumberId, recipientPhoneNumber),
createMessage(config, phoneNumberId, recipientPhoneNumber, instanceId),
);
const waitTill = configureWaitTillDate(this);

View File

@@ -43,6 +43,7 @@ describe('createMessage', () => {
mockSendAndWaitConfig,
phoneID,
recipientPhone,
'',
);
expect(request).toEqual({
@@ -77,7 +78,12 @@ describe('createMessage', () => {
],
};
const request: IHttpRequestOptions = createMessage(singleOptionConfig, phoneID, recipientPhone);
const request: IHttpRequestOptions = createMessage(
singleOptionConfig,
phoneID,
recipientPhone,
'',
);
expect(request).toEqual({
baseURL: WHATSAPP_BASE_URL,