refactor(api): refactor none-email control value preview usecase (#7303)

novuhq · Dec 17, 2024 · 32ef340 · 32ef340
1 parent 75af9d3
commit 32ef340
Show file tree

Hide file tree

Showing 11 changed files with 773 additions and 178 deletions.
diff --git a/apps/api/src/app/environments-v1/usecases/output-renderers/render-email-output.usecase.ts b/apps/api/src/app/environments-v1/usecases/output-renderers/render-email-output.usecase.ts
@@ -5,7 +5,7 @@ import { Instrument, InstrumentUsecase } from '@novu/application-generic';
 import isEmpty from 'lodash/isEmpty';
 import { FullPayloadForRender, RenderCommand } from './render-command';
 import { ExpandEmailEditorSchemaUsecase } from './expand-email-editor-schema.usecase';
-import { EmailStepControlZodSchema } from '../../../workflows-v2/shared';
+import { emailStepControlZodSchema } from '../../../workflows-v2/shared';
 
 export class RenderEmailOutputCommand extends RenderCommand {}
 
@@ -15,7 +15,7 @@ export class RenderEmailOutputUsecase {
 
   @InstrumentUsecase()
   async execute(renderCommand: RenderEmailOutputCommand): Promise<EmailRenderOutput> {
-    const { body, subject } = EmailStepControlZodSchema.parse(renderCommand.controlValues);
+    const { body, subject } = emailStepControlZodSchema.parse(renderCommand.controlValues);
 
     if (isEmpty(body)) {
       return { subject, body: '' };

diff --git a/apps/api/src/app/workflows-v2/e2e/generate-preview.e2e.ts b/apps/api/src/app/workflows-v2/e2e/generate-preview.e2e.ts
@@ -59,7 +59,7 @@ describe('Workflow Step Preview - POST /:workflowId/step/:stepId/preview', () =>
           preview: {
             subject: 'Welcome {{subscriber.firstName}}',
             // cspell:disable-next-line
-            body: 'Hello {{subscriber.firstName}} {{subscriber.lastName}}, Welcome to {{PAYLOAD.ORGANIZATIONNAME | UPCASE}}!',
+            body: 'Hello {{subscriber.firstName}} {{subscriber.lastName}}, Welcome to {{PAYLOAD.ORGANIZATIONNAME}}!',
           },
           type: 'in_app',
         },
@@ -69,7 +69,7 @@ describe('Workflow Step Preview - POST /:workflowId/step/:stepId/preview', () =>
             lastName: '{{subscriber.lastName}}',
           },
           payload: {
-            organizationName: '{{payload.organizationName | upcase}}',
+            organizationName: '{{payload.organizationName}}',
           },
         },
       },

diff --git a/apps/api/src/app/workflows-v2/generate-preview.e2e.ts b/apps/api/src/app/workflows-v2/generate-preview.e2e.ts
@@ -328,11 +328,9 @@ describe('Generate Preview', () => {
         if (previewResponseDto.result!.type !== 'sms') {
           throw new Error('Expected sms');
         }
-        expect(previewResponseDto.result!.preview.body).to.contain('{{PAYLOAD.VARIABLENAME | UPCASE}}');
+        expect(previewResponseDto.result!.preview.body).to.contain('{{PAYLOAD.VARIABLENAME}}');
         expect(previewResponseDto.previewPayloadExample).to.exist;
-        expect(previewResponseDto?.previewPayloadExample?.payload?.variableName).to.equal(
-          '{{payload.variableName | upcase}}'
-        );
+        expect(previewResponseDto?.previewPayloadExample?.payload?.variableName).to.equal('{{payload.variableName}}');
       });
 
       it('Should not fail if inApp is providing partial URL in redirect', async () => {
@@ -413,26 +411,7 @@ describe('Generate Preview', () => {
         );
 
         if (generatePreviewResponseDto.result?.type === ChannelTypeEnum.IN_APP) {
-          expect(generatePreviewResponseDto.result.preview.body).to.equal(
-            {
-              subject: `{{subscriber.firstName}} Hello, World! ${PLACEHOLDER_SUBJECT_INAPP}`,
-              body: `Hello, World! {{payload.placeholder.body}}`,
-              avatar: 'https://www.example.com/avatar.png',
-              primaryAction: {
-                label: '{{payload.secondaryUrl}}',
-                redirect: {
-                  target: RedirectTargetEnum.BLANK,
-                },
-              },
-              secondaryAction: null,
-              redirect: {
-                target: RedirectTargetEnum.BLANK,
-                url: '   ',
-              },
-            }.body
-          );
-          expect(generatePreviewResponseDto.result.preview.primaryAction?.redirect?.url).to.be.ok;
-          expect(generatePreviewResponseDto.result.preview.primaryAction?.redirect?.url).to.contain('https');
+          expect(generatePreviewResponseDto.result.preview.body).to.equal('Hello, World! {{payload.placeholder.body}}');
         }
       });
     });

diff --git a/apps/api/src/app/workflows-v2/shared/schemas/email-control.schema.ts b/apps/api/src/app/workflows-v2/shared/schemas/email-control.schema.ts
@@ -1,20 +1,23 @@
 import { JSONSchemaDto, UiComponentEnum, UiSchema, UiSchemaGroupEnum } from '@novu/shared';
-
 import { z } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
 import { skipControl } from './skip-control.schema';
+import { TipTapSchema } from '../../../environments-v1/usecases/output-renderers';
 
-export const EmailStepControlZodSchema = z
+export const emailStepControlZodSchema = z
   .object({
     skip: skipControl.schema,
+    /*
+     * todo: we need to validate the email editor (body) by type and not string,
+     * updating it to TipTapSchema will break the existing upsert issues generation
+     */
     body: z.string().optional().default(''),
     subject: z.string().optional().default(''),
   })
   .strict();
 
-export const emailStepControlSchema = zodToJsonSchema(EmailStepControlZodSchema) as JSONSchemaDto;
-
-export type EmailStepControlType = z.infer<typeof EmailStepControlZodSchema>;
+export const emailStepControlSchema = zodToJsonSchema(emailStepControlZodSchema) as JSONSchemaDto;
+export type EmailStepControlType = z.infer<typeof emailStepControlZodSchema>;
 
 export const emailStepUiSchema: UiSchema = {
   group: UiSchemaGroupEnum.EMAIL,
@@ -28,3 +31,8 @@ export const emailStepUiSchema: UiSchema = {
     skip: skipControl.uiSchema.properties.skip,
   },
 };
+
+export const emailStepControl = {
+  uiSchema: emailStepUiSchema,
+  schema: emailStepControlSchema,
+};
diff --git a/apps/api/src/app/workflows-v2/shared/step-type-to-control.mapper.ts b/apps/api/src/app/workflows-v2/shared/step-type-to-control.mapper.ts
@@ -1,6 +1,6 @@
-import { ActionStepEnum, ChannelStepEnum, channelStepSchemas } from '@novu/framework/internal';
+import { ActionStepEnum, ChannelStepEnum } from '@novu/framework/internal';
 import { ControlSchemas, JSONSchemaDto } from '@novu/shared';
-import { emailStepControlSchema, emailStepUiSchema, inAppControlSchema, inAppUiSchema } from './schemas';
+import { emailStepControl, inAppControlSchema, inAppUiSchema } from './schemas';
 import { DelayTimeControlSchema, delayUiSchema } from './schemas/delay-control.schema';
 import { DigestOutputJsonSchema, digestUiSchema } from './schemas/digest-control.schema';
 import { smsStepControl } from './schemas/sms-control.schema';
@@ -20,8 +20,8 @@ export const stepTypeToControlSchema: Record<ChannelStepEnum | ActionStepEnum, C
     uiSchema: inAppUiSchema,
   },
   [ChannelStepEnum.EMAIL]: {
-    schema: emailStepControlSchema,
-    uiSchema: emailStepUiSchema,
+    schema: emailStepControl.schema,
+    uiSchema: emailStepControl.uiSchema,
   },
   [ChannelStepEnum.SMS]: {
     schema: smsStepControl.schema,