feat: add separateResponse param to incoming webhooks for optional per-channel responses markdown

.changeset/nice-mice-pump.md

@@ -0,0 +1,5 @@
+---
+'@rocket.chat/meteor': minor
+---
+
+Adds `separateResponse` param to incoming webhooks to return per-channel statuses; when false or omitted, validates all targets and aborts sending to any channel if one fails.

apps/meteor/app/api/server/v1/chat.ts

@@ -216,7 +216,7 @@ API.v1.addRoute(
 
 			const messageReturn = (await applyAirGappedRestrictionsValidation(() => processWebhookMessage(this.bodyParams, this.user)))[0];
 
-			if (!messageReturn) {
+			if (!messageReturn?.message) {
 				return API.v1.failure('unknown-error');
 			}
 

apps/meteor/app/integrations/server/api/api.ts

@@ -13,6 +13,7 @@ import { APIClass } from '../../../api/server/ApiClass';
 import type { RateLimiterOptions } from '../../../api/server/api';
 import { API, defaultRateLimiterOptions } from '../../../api/server/api';
 import type { FailureResult, PartialThis, SuccessResult, UnavailableResult } from '../../../api/server/definition';
+import type { WebhookResponseItem } from '../../../lib/server/functions/processWebhookMessage';
 import { processWebhookMessage } from '../../../lib/server/functions/processWebhookMessage';
 import { settings } from '../../../settings/server';
 import { IsolatedVMScriptEngine } from '../lib/isolated-vm/isolated-vm';
@@ -115,7 +116,12 @@ async function removeIntegration(options: { target_url: string }, user: IUser):
 
 async function executeIntegrationRest(
 	this: IntegrationThis,
-): Promise<SuccessResult<Record<string, string> | undefined | void> | FailureResult<string> | UnavailableResult<string>> {
+): Promise<
+	| SuccessResult<Record<string, string> | { responses: WebhookResponseItem[] } | undefined | void>
+	| FailureResult<string>
+	| FailureResult<{ responses: WebhookResponseItem[] }>
+	| UnavailableResult<string>
+> {
 	incomingLogger.info({ msg: 'Post integration:', integration: this.request.integration.name });
 	incomingLogger.debug({ urlParams: this.urlParams, bodyParams: this.bodyParams });
 
@@ -133,6 +139,7 @@ async function executeIntegrationRest(
 	const scriptEngine = getEngine(this.request.integration);
 
 	let { bodyParams } = this;
+	const separateResponse = this.bodyParams?.separateResponse === true;
 	let scriptResponse: Record<string, any> | undefined;
 
 	if (scriptEngine.integrationHasValidScript(this.request.integration) && this.request.body) {
@@ -185,6 +192,11 @@ async function executeIntegrationRest(
 			}
 
 			bodyParams = result && result.content;
+
+			if (!('separateResponse' in bodyParams)) {
+				bodyParams.separateResponse = separateResponse;
+			}
+
 			scriptResponse = result.response;
 			if (result.user) {
 				this.user = result.user;
@@ -217,16 +229,23 @@ async function executeIntegrationRest(
 	bodyParams.bot = { i: this.request.integration._id };
 
 	try {
-		const message = await processWebhookMessage(bodyParams, this.user, defaultValues);
-		if (_.isEmpty(message)) {
+		const messageResponse = await processWebhookMessage(bodyParams, this.user, defaultValues);
+		if (_.isEmpty(messageResponse)) {
 			return API.v1.failure('unknown-error');
 		}
 
 		if (scriptResponse) {
 			incomingLogger.debug({ msg: 'response', response: scriptResponse });
+			return API.v1.success(scriptResponse);
 		}
-
-		return API.v1.success(scriptResponse);
+		if (bodyParams.separateResponse) {
+			const allFailed = messageResponse.every((response) => 'error' in response && response.error);
+			if (allFailed) {
+				return API.v1.failure({ responses: messageResponse });
+			}
+			return API.v1.success({ responses: messageResponse });
+		}
+		return API.v1.success();
 	} catch ({ error, message }: any) {
 		return API.v1.failure(error || message);
 	}

apps/meteor/app/integrations/server/lib/triggerHandler.ts

@@ -126,7 +126,7 @@ class RocketChatIntegrationHandler {
 		room?: IRoom;
 		message: { channel: string; bot?: Record<string, any>; message: Partial<IMessage> };
 		data: IntegrationData;
-	}): Promise<{ channel: string; message: Partial<IMessage> } | undefined> {
+	}): Promise<{ channel: string; message: Partial<IMessage> }[] | undefined> {
 		let user: IUser | null = null;
 		// Try to find the user who we are impersonating
 		if (trigger.impersonateUser) {
@@ -180,12 +180,7 @@ class RocketChatIntegrationHandler {
 			channel: tmpRoom.t === 'd' ? `@${tmpRoom._id}` : `#${tmpRoom._id}`,
 		};
 
-		message = (await processWebhookMessage(
-			message as any,
-			user as IUser & { username: RequiredField<IUser, 'username'> },
-			defaultValues,
-		)) as unknown as { channel: string; message: Partial<IMessage> };
-		return message;
+		return processWebhookMessage(message, user as IUser & { username: RequiredField<IUser, 'username'> }, defaultValues);
 	}
 
 	eventNameArgumentsToObject(...args: unknown[]) {
@@ -575,7 +570,7 @@ class RocketChatIntegrationHandler {
 			await updateHistory({
 				historyId,
 				step: 'after-prepare-send-message',
-				prepareSentMessage: [prepareMessage],
+				prepareSentMessage: prepareMessage,
 			});
 		}
 
@@ -669,7 +664,7 @@ class RocketChatIntegrationHandler {
 					await updateHistory({
 						historyId,
 						step: 'after-process-send-message',
-						processSentMessage: [resultMessage],
+						processSentMessage: resultMessage,
 						finished: true,
 					});
 					return;
@@ -765,7 +760,7 @@ class RocketChatIntegrationHandler {
 						await updateHistory({
 							historyId,
 							step: 'url-response-sent-message',
-							resultMessage: [resultMsg],
+							resultMessage: resultMsg,
 							finished: true,
 						});
 					}