Config for unsubscribe page (Depends on: https://github.com/vivid-planet/comet-brevo-module/pull/114)

.changeset/twelve-games-run.md

@@ -0,0 +1,17 @@
+---
+"@comet/brevo-api": major
+"@comet/brevo-admin": minor
+---
+
+Add a brevo configuration field for `allowedRedirectionUrl`
+Env vars containing this information can be removed and must be removed from the brevo module configuration.
+
+```diff
+BrevoModule.register({
+    brevo: {
+-       allowedRedirectionUrl: config.brevo.allowedRedirectionUrl,
+        //...
+    },
+    //..
+})
+```

demo/api/schema.gql

@@ -421,6 +421,7 @@ type EmailCampaign implements DocumentInterface {
   subject: String!
   brevoId: Int
   scheduledAt: DateTime
+  unsubscriptionPageId: String
   targetGroups: [TargetGroup!]!
   content: EmailCampaignContentBlockData!
   scope: EmailCampaignContentScope!
@@ -507,6 +508,8 @@ type BrevoConfig implements DocumentInterface {
   senderName: String!
   doubleOptInTemplateId: Int!
   folderId: Int!
+  allowedRedirectionUrl: String!
+  unsubscriptionPageId: String!
   createdAt: DateTime!
   scope: EmailCampaignContentScope!
 }
@@ -1034,11 +1037,15 @@ input BrevoConfigInput {
   senderName: String!
   doubleOptInTemplateId: Int!
   folderId: Int!
+  allowedRedirectionUrl: String!
+  unsubscriptionPageId: String!
 }
 
 input BrevoConfigUpdateInput {
   senderMail: String
   senderName: String
   doubleOptInTemplateId: Int
   folderId: Int
+  allowedRedirectionUrl: String
+  unsubscriptionPageId: String
 }

demo/api/src/app.module.ts

@@ -148,13 +148,11 @@ export class AppModule {
                             if (scope.domain === "main") {
                                 return {
                                     apiKey: config.brevo.apiKey,
-                                    allowedRedirectUrl: config.brevo.allowedRedirectUrl,
                                     redirectUrlForImport: config.brevo.redirectUrlForImport,
                                 };
                             } else {
                                 return {
                                     apiKey: config.brevo.apiKey,
-                                    allowedRedirectUrl: config.brevo.allowedRedirectUrl,
                                     redirectUrlForImport: config.brevo.redirectUrlForImport,
                                 };
                             }

demo/api/src/config/config.ts

@@ -57,7 +57,6 @@ export function createConfig(processEnv: NodeJS.ProcessEnv) {
         },
         brevo: {
             apiKey: envVars.BREVO_API_KEY,
-            allowedRedirectUrl: envVars.BREVO_ALLOWED_REDIRECT_URL,
             redirectUrlForImport: envVars.REDIRECT_URL_FOR_IMPORT,
         },
         campaign: {

demo/api/src/config/environment-variables.ts

@@ -115,9 +115,6 @@ export class EnvironmentVariables {
     @IsString()
     BREVO_API_KEY: string;
 
-    @IsString()
-    BREVO_ALLOWED_REDIRECT_URL: string;
-
     @IsString()
     REDIRECT_URL_FOR_IMPORT: string;
 

packages/admin/src/brevoConfiguration/BrevoConfigForm.gql.ts

@@ -6,6 +6,8 @@ export const brevoConfigFormFragment = gql`
         senderName
         doubleOptInTemplateId
         folderId
+        allowedRedirectionUrl
+        unsubscriptionPageId
     }
 `;
 

packages/admin/src/brevoConfiguration/BrevoConfigForm.tsx

@@ -8,6 +8,7 @@ import {
     Loading,
     MainContent,
     NumberField,
+    TextField,
     Toolbar,
     ToolbarActions,
     ToolbarFillSpace,
@@ -50,12 +51,24 @@ type FormValues = {
     sender: Option;
     doubleOptInTemplate: Option;
     folderId: number;
+    allowedRedirectionUrl: string;
+    unsubscriptionPageId: string;
 };
 
 interface FormProps {
     scope: ContentScopeInterface;
 }
 
+function validateUrl(value: string): React.ReactNode | undefined {
+    const urlPattern = /^(https?:\/\/)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d{1,5})?(\/[^\s]*)?$/;
+    if (!urlPattern.test(value)) {
+        return (
+            <FormattedMessage id="cometBrevoModule.brevoConfig.allowedRedirectionUrl.validationError" defaultMessage="Please enter a valid URL." />
+        );
+    }
+    return undefined;
+}
+
 export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
     const client = useApolloClient();
     const formApiRef = useFormApiRef<FormValues>();
@@ -114,14 +127,19 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
                       label: `${doubleOptInTemplate?.id}: ${doubleOptInTemplate?.name}`,
                   }
                 : undefined,
+            allowedRedirectionUrl: data?.brevoConfig?.allowedRedirectionUrl ?? "",
             folderId: data?.brevoConfig?.folderId ?? 1,
+            unsubscriptionPageId: data?.brevoConfig?.unsubscriptionPageId ?? "",
         };
     }, [
         data?.brevoConfig?.folderId,
+        data?.brevoConfig?.allowedRedirectionUrl,
+
         data?.brevoConfig?.doubleOptInTemplateId,
         data?.brevoConfig?.senderMail,
         data?.brevoConfig?.senderName,
         doubleOptInTemplatesData?.doubleOptInTemplates,
+        data?.brevoConfig?.unsubscriptionPageId,
         sendersData?.senders,
     ]);
 
@@ -155,7 +173,7 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
 
         const sender = sendersData?.senders?.find((s) => s.email === state.sender.value);
 
-        if (!sender || !state.doubleOptInTemplate) {
+        if (!sender || !state.doubleOptInTemplate || !state.allowedRedirectionUrl || !state.unsubscriptionPageId) {
             throw new Error("Not all required fields are set");
         }
 
@@ -164,6 +182,8 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
             senderMail: sender?.email,
             doubleOptInTemplateId: Number(state.doubleOptInTemplate.value),
             folderId: state.folderId ?? 1,
+            allowedRedirectionUrl: state?.allowedRedirectionUrl ?? "",
+            unsubscriptionPageId: state.unsubscriptionPageId,
         };
 
         if (mode === "edit") {
@@ -177,7 +197,10 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
         } else {
             const { data: mutationResponse } = await client.mutate<GQLCreateBrevoConfigMutation, GQLCreateBrevoConfigMutationVariables>({
                 mutation: createBrevoConfigMutation,
-                variables: { scope, input: output },
+                variables: {
+                    scope,
+                    input: output,
+                },
             });
             if (!event.navigatingBack) {
                 const id = mutationResponse?.createBrevoConfig.id;
@@ -196,6 +219,19 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
         return <Loading behavior="fillPageHeight" />;
     }
 
+    const validateUnsubscriptionPageId = (value: string) => {
+        const validUnsubscriptionPageId = /^[a-zA-Z0-9]{24}$/;
+        if (!validUnsubscriptionPageId.test(value)) {
+            return (
+                <FormattedMessage
+                    id="cometBrevoModule.brevoConfig.unsubscriptionPageId.validation"
+                    defaultMessage="Must be a 24-digit alphanumeric ID"
+                />
+            );
+        }
+        return undefined;
+    };
+
     return (
         <FinalForm<FormValues> apiRef={formApiRef} onSubmit={handleSubmit} mode={mode} initialValues={initialValues}>
             {({ values }) => {
@@ -222,7 +258,6 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
                                 fullWidth
                                 required
                             />
-
                             <Field
                                 component={FinalFormAutocomplete}
                                 getOptionLabel={(option: Option) => option.label}
@@ -260,6 +295,43 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
                                 fullWidth
                                 required
                             />
+                            <TextField
+                                required
+                                fullWidth
+                                name="allowedRedirectionUrl"
+                                label={
+                                    <>
+                                        <FormattedMessage
+                                            id="cometBrevoModule.brevoConfig.allowedRedirectionUrl"
+                                            defaultMessage="Allowed redirection URL"
+                                        />
+                                        <Tooltip
+                                            title={
+                                                <FormattedMessage
+                                                    id="cometBrevoModule.brevoConfig.allowedRedirectionUrl.info"
+                                                    defaultMessage="Defines the schema of a valid redirection URL that is set when creating or importing contacts."
+                                                />
+                                            }
+                                            sx={{ marginLeft: "5px" }}
+                                        >
+                                            <Info />
+                                        </Tooltip>
+                                    </>
+                                }
+                                validate={validateUrl}
+                            />
+                            <TextField
+                                fullWidth
+                                name="unsubscriptionPageId"
+                                required
+                                label={
+                                    <FormattedMessage
+                                        id="cometBrevoModule.brevoConfig.unsubscriptionPageId"
+                                        defaultMessage="Unsubscription Page ID"
+                                    />
+                                }
+                                validate={validateUnsubscriptionPageId}
+                            />
                         </MainContent>
                     </>
                 );

packages/api/schema.gql

@@ -174,7 +174,7 @@ type TargetGroup implements DocumentInterface {
     createdAt: DateTime!
     title: String!
     isMainList: Boolean!
-    isTestList: Boolean
+    isTestList: Boolean!
     brevoId: Int!
     totalSubscribers: Int!
     scope: EmailCampaignContentScope!
@@ -202,6 +202,7 @@ type EmailCampaign implements DocumentInterface {
     createdAt: DateTime!
     title: String!
     subject: String!
+    unsubscriptionPageId: String
     brevoId: Int
     scheduledAt: DateTime
     targetGroups: [TargetGroup!]!
@@ -233,6 +234,8 @@ type BrevoConfig implements DocumentInterface {
     senderName: String!
     doubleOptInTemplateId: Int!
     folderId: Int!
+    allowedRedirectionUrl: String!
+    unsubscriptionPageId: String
     createdAt: DateTime!
     scope: EmailCampaignContentScope!
 }
@@ -451,11 +454,15 @@ input BrevoConfigInput {
     senderName: String!
     doubleOptInTemplateId: Int!
     folderId: Int!
+    allowedRedirectionUrl: String!
+    unsubscriptionPageId: String!
 }
 
 input BrevoConfigUpdateInput {
     senderMail: String
     senderName: String
     doubleOptInTemplateId: Int
     folderId: Int
+    allowedRedirectionUrl: String
+    unsubscriptionPageId: String
 }

packages/api/src/brevo-api/brevo-api-campaigns.service.ts

@@ -59,11 +59,13 @@ export class BrevoApiCampaignsService {
         htmlContent,
         sender,
         scheduledAt,
+        unsubscriptionPageId,
     }: {
         campaign: EmailCampaignInterface;
         htmlContent: string;
         sender: { name: string; mail: string };
         scheduledAt?: Date;
+        unsubscriptionPageId?: string;
     }): Promise<number> {
         try {
             const targetGroups = await campaign.targetGroups.loadItems();
@@ -75,6 +77,7 @@ export class BrevoApiCampaignsService {
                 recipients: { listIds: targetGroups.map((targetGroup) => targetGroup.brevoId) },
                 htmlContent,
                 scheduledAt: scheduledAt?.toISOString(),
+                unsubscriptionPageId,
             };
 
             const data = await this.getCampaignsApi(campaign.scope).createEmailCampaign(emailCampaign);

packages/api/src/brevo-config/dto/brevo-config.input.ts

@@ -1,6 +1,6 @@
 import { PartialType } from "@comet/cms-api";
 import { Field, InputType, Int } from "@nestjs/graphql";
-import { IsEmail, IsInt, IsNotEmpty, IsString } from "class-validator";
+import { IsEmail, IsInt, IsNotEmpty, IsString, IsUrl } from "class-validator";
 
 @InputType()
 export class BrevoConfigInput {
@@ -22,6 +22,15 @@ export class BrevoConfigInput {
     @Field(() => Int)
     @IsInt()
     folderId: number;
+
+    @IsNotEmpty()
+    @Field()
+    @IsUrl({ require_tld: process.env.NODE_ENV === "production" })
+    allowedRedirectionUrl: string;
+
+    @IsString()
+    @Field()
+    unsubscriptionPageId: string;
 }
 
 @InputType()

packages/api/src/brevo-config/entities/brevo-config-entity.factory.ts

@@ -13,6 +13,8 @@ export interface BrevoConfigInterface {
     senderMail: string;
     doubleOptInTemplateId: number;
     folderId: number;
+    allowedRedirectionUrl: string;
+    unsubscriptionPageId: string;
     createdAt: Date;
     updatedAt: Date;
     scope: EmailCampaignScopeInterface;
@@ -47,6 +49,14 @@ export class BrevoConfigEntityFactory {
             @Field(() => Int)
             folderId: number;
 
+            @Property({ columnType: "text" })
+            @Field()
+            allowedRedirectionUrl: string;
+
+            @Property({ columnType: "text" })
+            @Field(() => String)
+            unsubscriptionPageId: string;
+
             @Property({
                 columnType: "timestamp with time zone",
             })

packages/api/src/brevo-contact/brevo-contact-import.console.ts

@@ -5,6 +5,7 @@ import { isUUID, validateSync } from "class-validator";
 import { InvalidOptionArgumentError } from "commander";
 import * as fs from "fs";
 import { Command, Console } from "nestjs-console";
+import { BrevoConfigInterface } from "src/brevo-config/entities/brevo-config-entity.factory";
 
 import { BrevoContactImportService } from "../brevo-contact/brevo-contact-import.service";
 import { BrevoModuleConfig } from "../config/brevo-module.config";
@@ -29,6 +30,7 @@ export function createBrevoContactImportConsole({ Scope }: { Scope: Type<EmailCa
             @Inject(BREVO_MODULE_CONFIG) private readonly config: BrevoModuleConfig,
             private readonly brevoContactImportService: BrevoContactImportService,
             @InjectRepository("TargetGroup") private readonly targetGroupRepository: EntityRepository<TargetGroupInterface>,
+            @InjectRepository("BrevoConfig") private readonly brevoConfigRepository: EntityRepository<BrevoConfigInterface>,
         ) {}
 
         @Command({
@@ -99,13 +101,13 @@ export function createBrevoContactImportConsole({ Scope }: { Scope: Type<EmailCa
         }
 
         async validateRedirectUrl(urlToValidate: string, scope: Type<EmailCampaignScopeInterface>): Promise<boolean> {
-            const configForScope = this.config.brevo.resolveConfig(scope);
+            const configForScope = await this.brevoConfigRepository.findOneOrFail({ scope });
 
             if (!configForScope) {
                 throw Error("Scope does not exist");
             }
 
-            if (urlToValidate?.startsWith(configForScope.allowedRedirectUrl)) {
+            if (urlToValidate?.startsWith(configForScope.allowedRedirectionUrl)) {
                 return true;
             }