Skip to content

The open alternative to Salesforce, designed for AI.

Show recipients a plain page when a tracking or unsubscribe link fails (#28110)

neo773989e4989cb76
diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/build-recipient-error-page.util.spec.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/build-recipient-error-page.util.spec.ts
new file mode 100644
index 00000000000..3b825b157e1
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/build-recipient-error-page.util.spec.ts
@@ -0,0 +1,41 @@
+import { buildRecipientErrorPage } from 'src/engine/core-modules/emailing-domain/utils/build-recipient-error-page.util';
+
+const extractVisibleText = (page: string) => ({
+ title: page.match(/<title>(.*?)<\/title>/)?.[1],
+ heading: page.match(/<h1>(.*?)<\/h1>/)?.[1],
+ body: page.match(/<p>(.*?)<\/p>/)?.[1],
+});
+
+describe('buildRecipientErrorPage', () => {
+ it('tells the recipient a malformed link is not valid', () => {
+ expect(extractVisibleText(buildRecipientErrorPage(400))).toEqual({
+ title: 'This link is not valid',
+ heading: 'This link is not valid',
+ body: 'The link may be incomplete or expired. Open it again from the latest email you received.',
+ });
+ });
+
+ it('tells the recipient an unknown link does not exist', () => {
+ expect(extractVisibleText(buildRecipientErrorPage(404))).toEqual({
+ title: 'Link not found',
+ heading: 'Link not found',
+ body: 'This link does not exist or is no longer available.',
+ });
+ });
+
+ it('asks a throttled recipient to retry later', () => {
+ expect(extractVisibleText(buildRecipientErrorPage(429))).toEqual({
+ title: 'Too many requests',
+ heading: 'Too many requests',
+ body: 'Please wait a minute and try again.',
+ });
+ });
+
+ it('shows a generic page when the server fails', () => {
+ expect(extractVisibleText(buildRecipientErrorPage(500))).toEqual({
+ title: 'Something went wrong',
+ heading: 'Something went wrong',
+ body: 'Please try again later.',
+ });
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/build-recipient-error-page.util.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/build-recipient-error-page.util.ts
new file mode 100644
index 00000000000..edd4bbe5870
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/build-recipient-error-page.util.ts
@@ -0,0 +1,28 @@
+import { HttpStatus } from '@nestjs/common';
+
+import { buildUnsubscribeResultPage } from 'src/engine/core-modules/emailing-domain/utils/build-unsubscribe-result-page.util';
+
+export const buildRecipientErrorPage = (statusCode: number): string => {
+ switch (statusCode) {
+ case HttpStatus.BAD_REQUEST:
+ return buildUnsubscribeResultPage(
+ 'This link is not valid',
+ 'The link may be incomplete or expired. Open it again from the latest email you received.',
+ );
+ case HttpStatus.NOT_FOUND:
+ return buildUnsubscribeResultPage(
+ 'Link not found',
+ 'This link does not exist or is no longer available.',
+ );
+ case HttpStatus.TOO_MANY_REQUESTS:
+ return buildUnsubscribeResultPage(
+ 'Too many requests',
+ 'Please wait a minute and try again.',
+ );
+ default:
+ return buildUnsubscribeResultPage(
+ 'Something went wrong',
+ 'Please try again later.',
+ );
+ }
+};
diff --git a/packages/twenty-server/src/modules/emailing/controllers/campaign-tracking.controller.ts b/packages/twenty-server/src/modules/emailing/controllers/campaign-tracking.controller.ts
index 5ac4eb0b880..a5e26715033 100644
--- a/packages/twenty-server/src/modules/emailing/controllers/campaign-tracking.controller.ts
+++ b/packages/twenty-server/src/modules/emailing/controllers/campaign-tracking.controller.ts
@@ -9,6 +9,7 @@ import {
Redirect,
Req,
Res,
+ UseFilters,
UseGuards,
} from '@nestjs/common';
import { isNonEmptyString } from '@sniptt/guards';
@@ -23,6 +24,7 @@ import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { PublicEndpointGuard } from 'src/engine/guards/public-endpoint.guard';
import { ShortLinkService } from 'src/engine/core-modules/short-link/services/short-link.service';
import { TRACKABLE_URL_PATTERN } from 'src/modules/emailing/constants/trackable-url-pattern.constant';
+import { RecipientPageExceptionFilter } from 'src/modules/emailing/filters/recipient-page-exception.filter';
import { CampaignEngagementCaptureService } from 'src/modules/emailing/services/campaign-engagement-capture.service';
const FOUND_STATUS_CODE = 302;
@@ -44,6 +46,7 @@ export class CampaignTrackingController {
@Get('c/:token')
@Redirect()
+ @UseFilters(RecipientPageExceptionFilter)
@Header('Cache-Control', 'no-store')
@Header('Referrer-Policy', 'no-referrer')
async handleTrackedLinkClick(
diff --git a/packages/twenty-server/src/modules/emailing/controllers/unsubscribe.controller.ts b/packages/twenty-server/src/modules/emailing/controllers/unsubscribe.controller.ts
index 60fb3520fdf..bd051d761a0 100644
--- a/packages/twenty-server/src/modules/emailing/controllers/unsubscribe.controller.ts
+++ b/packages/twenty-server/src/modules/emailing/controllers/unsubscribe.controller.ts
@@ -9,6 +9,7 @@ import {
Post,
Query,
Req,
+ UseFilters,
UseGuards,
} from '@nestjs/common';
@@ -26,6 +27,7 @@ import { PublicEndpointGuard } from 'src/engine/guards/public-endpoint.guard';
import { ThrottlerException } from 'src/engine/core-modules/throttler/throttler.exception';
import { ThrottlerService } from 'src/engine/core-modules/throttler/throttler.service';
import { throttlerToRestApiExceptionHandler } from 'src/engine/core-modules/throttler/utils/throttler-to-rest-api-exception-handler.util';
+import { RecipientPageExceptionFilter } from 'src/modules/emailing/filters/recipient-page-exception.filter';
import { MessageSuppressionService } from 'src/modules/emailing/services/message-suppression.service';
const UNSUBSCRIBE_TOKEN_FORMAT = /^[A-Za-z0-9_-]{1,1024}$/;
@@ -51,6 +53,7 @@ const RESUBSCRIBE_MAX_AGE_MS = 30 * 24 * 60 * 60 * 1000;
@Controller(`${ApiPath.Emailing}/unsubscribe`)
@UseGuards(PublicEndpointGuard, NoPermissionGuard)
+@UseFilters(RecipientPageExceptionFilter)
export class UnsubscribeController {
constructor(
private readonly unsubscribeTokenService: UnsubscribeTokenService,
diff --git a/packages/twenty-server/src/modules/emailing/filters/recipient-page-exception.filter.ts b/packages/twenty-server/src/modules/emailing/filters/recipient-page-exception.filter.ts
new file mode 100644
index 00000000000..9297e81e699
--- /dev/null
+++ b/packages/twenty-server/src/modules/emailing/filters/recipient-page-exception.filter.ts
@@ -0,0 +1,40 @@
+import {
+ type ArgumentsHost,
+ Catch,
+ type ExceptionFilter,
+ HttpException,
+} from '@nestjs/common';
+
+import { type Response } from 'express';
+
+import { buildRecipientErrorPage } from 'src/engine/core-modules/emailing-domain/utils/build-recipient-error-page.util';
+import { ExceptionHandlerService } from 'src/engine/core-modules/exception-handler/exception-handler.service';
+import { handleException } from 'src/engine/utils/global-exception-handler.util';
+
+@Catch()
+export class RecipientPageExceptionFilter implements ExceptionFilter {
+ constructor(
+ private readonly exceptionHandlerService: ExceptionHandlerService,
+ ) {}
+
+ catch(exception: Error, host: ArgumentsHost) {
+ const statusCode =
+ exception instanceof HttpException ? exception.getStatus() : 500;
+
+ handleException({
+ exception,
+ exceptionHandlerService: this.exceptionHandlerService,
+ statusCode,
+ });
+
+ host
+ .switchToHttp()
+ .getResponse<Response>()
+ .status(statusCode)
+ .set({
+ 'Content-Type': 'text/html; charset=utf-8',
+ 'Cache-Control': 'no-store',
+ })
+ .send(buildRecipientErrorPage(statusCode));
+ }
+}