bug(api): generate-preview/index.ts

bug(api): spelling bug(api): more tests passing bug(api): tests are starting to pass bug(api): workflow tests pass bug(api): compiling again bug(api): renamed bug(api): augmant test bug(api): augmant test bug(api): clean placeholder bug(api): tests failing lets fix bug(api): fix merge on upsert bug(api): added new test cases bug(api): fix variable validation
novuhq · Nov 14, 2024 · 72c5d45 · 72c5d45
1 parent 01858f5
commit 72c5d45
Show file tree

Hide file tree

Showing 69 changed files with 1,486 additions and 976 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -789,6 +789,7 @@
     "packages/shared/src/types/timezones/timezones.types.ts",
     "*.riv",
     "websockets",
+    "apps/api/src/app/workflows-v2/usecases/validate-content/validate-placeholders/validate-placeholder.usecase.ts",
     ".env",
     ".env.development",
     ".env.local",

diff --git a/.source b/.source
diff --git a/...i/src/app/environments-v1/usecases/output-renderers/expand-email-editor-schema-command.ts b/...i/src/app/environments-v1/usecases/output-renderers/expand-email-editor-schema-command.ts
@@ -4,6 +4,6 @@ import { BaseCommand } from '@novu/application-generic';
 import { FullPayloadForRender } from './render-command';
 
 export class ExpandEmailEditorSchemaCommand extends BaseCommand {
-  body: string;
+  emailEditorJson: string;
   fullPayloadForRender: FullPayloadForRender;
 }
diff --git a/...i/src/app/environments-v1/usecases/output-renderers/expand-email-editor-schema.usecase.ts b/...i/src/app/environments-v1/usecases/output-renderers/expand-email-editor-schema.usecase.ts
@@ -16,7 +16,7 @@ export class ExpandEmailEditorSchemaUsecase {
   }
   private hydrate(command: ExpandEmailEditorSchemaCommand) {
     const { hydratedEmailSchema } = this.hydrateEmailSchemaUseCase.execute({
-      emailEditor: command.body,
+      emailEditor: command.emailEditorJson,
       fullPayloadForRender: command.fullPayloadForRender,
     });
 

diff --git a/apps/api/src/app/environments-v1/usecases/output-renderers/hydrate-email-schema.usecase.ts b/apps/api/src/app/environments-v1/usecases/output-renderers/hydrate-email-schema.usecase.ts
@@ -3,51 +3,65 @@ import { Injectable } from '@nestjs/common';
 import { PreviewPayload, TipTapNode } from '@novu/shared';
 import { z } from 'zod';
 import { HydrateEmailSchemaCommand } from './hydrate-email-schema.command';
+import { PlaceholderAggregation } from '../../../workflows-v2/usecases';
 
 @Injectable()
 export class HydrateEmailSchemaUseCase {
   execute(command: HydrateEmailSchemaCommand): {
     hydratedEmailSchema: TipTapNode;
-    nestedPayload: Record<string, unknown>;
+    placeholderAggregation: PlaceholderAggregation;
   } {
-    const defaultPayload: Record<string, unknown> = {};
+    const placeholderAggregation: PlaceholderAggregation = {
+      nestedForPlaceholders: {},
+      regularPlaceholdersToDefaultValue: {},
+    };
     const emailEditorSchema: TipTapNode = TipTapSchema.parse(JSON.parse(command.emailEditor));
     if (emailEditorSchema.content) {
-      this.transformContentInPlace(emailEditorSchema.content, defaultPayload, command.fullPayloadForRender);
+      this.transformContentInPlace(emailEditorSchema.content, command.fullPayloadForRender, placeholderAggregation);
     }
 
-    return { hydratedEmailSchema: emailEditorSchema, nestedPayload: this.flattenToNested(defaultPayload) };
+    return {
+      hydratedEmailSchema: emailEditorSchema,
+      placeholderAggregation,
+    };
   }
 
   private variableLogic(
     masterPayload: PreviewPayload,
-    node: TipTapNode & { attrs: { id: string } },
-    defaultPayload: Record<string, unknown>,
+    node: TipTapNode & {
+      attrs: { id: string };
+    },
     content: TipTapNode[],
-    index: number
+    index: number,
+    placeholderAggregation: PlaceholderAggregation
   ) {
-    const resolvedValueRegularPlaceholder = this.getResolvedValueRegularPlaceholder(masterPayload, node);
-    defaultPayload[node.attrs.id] = resolvedValueRegularPlaceholder;
+    const resolvedValueRegularPlaceholder = this.getResolvedValueRegularPlaceholder(
+      masterPayload,
+      node,
+      placeholderAggregation
+    );
     content[index] = {
       type: 'text',
       text: resolvedValueRegularPlaceholder,
     };
   }
 
   private forNodeLogic(
-    node: TipTapNode & { attrs: { each: string } },
+    node: TipTapNode & {
+      attrs: { each: string };
+    },
     masterPayload: PreviewPayload,
-    defaultPayload: Record<string, unknown>,
     content: TipTapNode[],
-    index: number
+    index: number,
+    placeholderAggregation: PlaceholderAggregation
   ) {
     const itemPointerToDefaultRecord = this.collectAllItemPlaceholders(node);
     const resolvedValueForPlaceholder = this.getResolvedValueForPlaceholder(
       masterPayload,
       node,
-      itemPointerToDefaultRecord
+      itemPointerToDefaultRecord,
+      placeholderAggregation
     );
-    defaultPayload[node.attrs.each] = resolvedValueForPlaceholder;
     content[index] = {
       type: 'for',
       attrs: { each: resolvedValueForPlaceholder },
@@ -57,31 +71,31 @@ export class HydrateEmailSchemaUseCase {
 
   private showLogic(
     masterPayload: PreviewPayload,
-    node: TipTapNode & { attrs: { show: string } },
-    defaultPayload: Record<string, unknown>
+    node: TipTapNode & {
+      attrs: { show: string };
+    },
+    placeholderAggregation: PlaceholderAggregation
   ) {
-    const resolvedValueShowPlaceholder = this.getResolvedValueShowPlaceholder(masterPayload, node);
-    defaultPayload[node.attrs.show] = resolvedValueShowPlaceholder;
-    node.attrs.show = resolvedValueShowPlaceholder;
+    node.attrs.show = this.getResolvedValueShowPlaceholder(masterPayload, node, placeholderAggregation);
   }
 
   private transformContentInPlace(
     content: TipTapNode[],
-    defaultPayload: Record<string, unknown>,
-    masterPayload: PreviewPayload
+    masterPayload: PreviewPayload,
+    placeholderAggregation: PlaceholderAggregation
   ) {
     content.forEach((node, index) => {
       if (this.isVariableNode(node)) {
-        this.variableLogic(masterPayload, node, defaultPayload, content, index);
+        this.variableLogic(masterPayload, node, content, index, placeholderAggregation);
       }
       if (this.isForNode(node)) {
-        this.forNodeLogic(node, masterPayload, defaultPayload, content, index);
+        this.forNodeLogic(node, masterPayload, content, index, placeholderAggregation);
       }
       if (this.isShowNode(node)) {
-        this.showLogic(masterPayload, node, defaultPayload);
+        this.showLogic(masterPayload, node, placeholderAggregation);
       }
       if (node.content) {
-        this.transformContentInPlace(node.content, defaultPayload, masterPayload);
+        this.transformContentInPlace(node.content, masterPayload, placeholderAggregation);
       }
     });
   }
@@ -98,53 +112,65 @@ export class HydrateEmailSchemaUseCase {
     return !!(node.type === 'variable' && node.attrs && 'id' in node.attrs && typeof node.attrs.id === 'string');
   }
 
-  private getResolvedValueRegularPlaceholder(masterPayload: PreviewPayload, node) {
+  private getResolvedValueRegularPlaceholder(
+    masterPayload: PreviewPayload,
+    node,
+    placeholderAggregation: PlaceholderAggregation
+  ) {
     const resolvedValue = this.getValueByPath(masterPayload, node.attrs.id);
     const { fallback } = node.attrs;
 
-    return resolvedValue || fallback || `{{${node.attrs.id}}}`;
+    const finalValue = resolvedValue || fallback || `{{${node.attrs.id}}}`;
+    placeholderAggregation.regularPlaceholdersToDefaultValue[`{{${node.attrs.id}}}`] = finalValue;
+
+    return finalValue;
   }
 
-  private getResolvedValueShowPlaceholder(masterPayload: PreviewPayload, node) {
+  private getResolvedValueShowPlaceholder(
+    masterPayload: PreviewPayload,
+    node,
+    placeholderAggregation: PlaceholderAggregation
+  ) {
     const resolvedValue = this.getValueByPath(masterPayload, node.attrs.show);
     const { fallback } = node.attrs;
 
-    return resolvedValue || fallback || `true`;
-  }
+    const finalValue = resolvedValue || fallback || `true`;
+    placeholderAggregation.regularPlaceholdersToDefaultValue[`{{${node.attrs.show}}}`] = finalValue;
 
-  private flattenToNested(flatJson: Record<string, any>): Record<string, any> {
-    const nestedJson: Record<string, any> = {};
-    // eslint-disable-next-line guard-for-in
-    for (const key in flatJson) {
-      const keys = key.split('.');
-      keys.reduce((acc, part, index) => {
-        if (index === keys.length - 1) {
-          acc[part] = flatJson[key];
-        } else if (!acc[part]) {
-          acc[part] = {};
-        }
-
-        return acc[part];
-      }, nestedJson);
-    }
-
-    return nestedJson;
+    return finalValue;
   }
 
   private getResolvedValueForPlaceholder(
     masterPayload: PreviewPayload,
-    node: TipTapNode & { attrs: { each: string } },
-    itemPointerToDefaultRecord: Record<string, string>
+    node: TipTapNode & {
+      attrs: { each: string };
+    },
+    itemPointerToDefaultRecord: Record<string, string>,
+    placeholderAggregation: PlaceholderAggregation
   ) {
-    const resolvedValue = this.getValueByPath(masterPayload, node.attrs.each);
+    let resolvedValueIfFound = this.getValueByPath(masterPayload, node.attrs.each);
 
-    if (!resolvedValue) {
-      return [this.buildElement(itemPointerToDefaultRecord, '1'), this.buildElement(itemPointerToDefaultRecord, '2')];
+    if (!resolvedValueIfFound) {
+      resolvedValueIfFound = [
+        this.buildElement(itemPointerToDefaultRecord, '1'),
+        this.buildElement(itemPointerToDefaultRecord, '2'),
+      ];
     }
+    placeholderAggregation.nestedForPlaceholders[`{{${node.attrs.each}}}`] =
+      this.buildNestedVariableRecord(itemPointerToDefaultRecord);
 
-    return resolvedValue;
+    return resolvedValueIfFound;
   }
 
+  private buildNestedVariableRecord(itemPointerToDefaultRecord: Record<string, string>) {
+    const transformedObj: Record<string, string> = {};
+
+    Object.entries(itemPointerToDefaultRecord).forEach(([key, value]) => {
+      transformedObj[value] = value;
+    });
+
+    return transformedObj;
+  }
   private collectAllItemPlaceholders(nodeExt: TipTapNode) {
     const payloadValues = {};
     const traverse = (node: TipTapNode) => {
@@ -153,7 +179,7 @@ export class HydrateEmailSchemaUseCase {
       }
       if (this.isPayloadValue(node)) {
         const { id } = node.attrs;
-        payloadValues[node.attrs.id] = node.attrs.fallback || `{{item.${id}}}`;
+        payloadValues[`${node.attrs.id}`] = node.attrs.fallback || `{{item.${id}}}`;
       }
       if (node.content && Array.isArray(node.content)) {
         node.content.forEach(traverse);
@@ -164,18 +190,16 @@ export class HydrateEmailSchemaUseCase {
     return payloadValues;
   }
 
-  private getValueByPath(obj: Record<string, any>, path: string): any {
-    const keys = path.split('.');
+  private getValueByPath(masterPayload: Record<string, any>, placeholderRef: string): any {
+    const keys = placeholderRef.split('.');
 
     return keys.reduce((currentObj, key) => {
       if (currentObj && typeof currentObj === 'object' && key in currentObj) {
-        const nextObj = currentObj[key];
-
-        return nextObj;
+        return currentObj[key];
       }
 
       return undefined;
-    }, obj);
+    }, masterPayload);
   }
 
   private buildElement(itemPointerToDefaultRecord: Record<string, string>, suffix: string) {

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
@@ -13,15 +13,14 @@ export class RenderEmailOutputUsecase {
 
   async execute(renderCommand: RenderEmailOutputCommand): Promise<EmailRenderOutput> {
     const { emailEditor, subject } = EmailStepControlSchema.parse(renderCommand.controlValues);
-    console.log('payload', JSON.stringify(renderCommand.fullPayloadForRender));
     const expandedSchema = this.transformForAndShowLogic(emailEditor, renderCommand.fullPayloadForRender);
     const htmlRendered = await render(expandedSchema);
 
     return { subject, body: htmlRendered };
   }
 
   private transformForAndShowLogic(body: string, fullPayloadForRender: FullPayloadForRender) {
-    return this.expendEmailEditorSchemaUseCase.execute({ body, fullPayloadForRender });
+    return this.expendEmailEditorSchemaUseCase.execute({ emailEditorJson: body, fullPayloadForRender });
   }
 }
 

diff --git a/...rate-preview/step-id-missing.exception.ts → ...2/exceptions/step-id-missing.exception.ts b/...rate-preview/step-id-missing.exception.ts → ...2/exceptions/step-id-missing.exception.ts
diff --git a/apps/api/src/app/workflows-v2/generate-preview.e2e.ts b/apps/api/src/app/workflows-v2/generate-preview.e2e.ts
@@ -192,7 +192,60 @@ describe('Generate Preview', () => {
         });
       });
     });
+    describe('payload sanitation', () => {
+      it('Should produce a correct payload when pipe is used etc {{payload.variable | upper}}', async () => {
+        const { stepDatabaseId, workflowId } = await createWorkflowAndReturnId(StepTypeEnum.SMS);
+        const requestDto = {
+          controlValues: {
+            body: 'This is a legal placeholder with a pipe [{{payload.variableName | upper}}the pipe should show in the preview]',
+          },
+        };
+        const previewResponseDto = await generatePreview(workflowId, stepDatabaseId, requestDto, 'email');
+        console.log('previewResponseDto\n', JSON.stringify(previewResponseDto, null, 2));
+        expect(previewResponseDto.result!.preview).to.exist;
+        if (previewResponseDto.result!.type !== 'sms') {
+          throw new Error('Expected sms');
+        }
+        expect(previewResponseDto.result!.preview.body).to.contain('{{payload.variableName | upper}}');
+        expect(previewResponseDto.previewPayloadExample).to.exist;
+        expect(previewResponseDto?.previewPayloadExample?.payload?.variableName).to.equal(
+          '{{payload.variableName | upper}}'
+        );
+      });
+    });
 
+    describe('Error Handling', () => {
+      it('Should not fail on illegal placeholder {{}} ', async () => {
+        const { stepDatabaseId, workflowId } = await createWorkflowAndReturnId(StepTypeEnum.SMS);
+        const requestDto = {
+          controlValues: { body: 'some text that illegal placeholder[{{}}this text should be alone in brackets]' },
+        };
+        const previewResponseDto = await generatePreview(workflowId, stepDatabaseId, requestDto, 'sms');
+        expect(previewResponseDto.result!.preview).to.exist;
+        if (previewResponseDto.result!.type === 'sms') {
+          expect(previewResponseDto.result!.preview.body).to.contain('[this text should be alone in brackets]');
+        }
+        const issue = previewResponseDto.issues.body;
+        expect(issue).to.exist;
+        expect(issue[0].variableName).to.equal('{{}}');
+        expect(issue[0].issueType).to.equal('ILLEGAL_VARIABLE_IN_CONTROL_VALUE');
+      });
+      it('Should return a clear error on illegal placeholder {{name}} ', async () => {
+        const { stepDatabaseId, workflowId } = await createWorkflowAndReturnId(StepTypeEnum.SMS);
+        const requestDto = {
+          controlValues: { body: 'some text that illegal placeholder[{{name}}this text should be alone in brackets]' },
+        };
+        const previewResponseDto = await generatePreview(workflowId, stepDatabaseId, requestDto, 'sms');
+        expect(previewResponseDto.result!.preview).to.exist;
+        if (previewResponseDto.result!.type === 'sms') {
+          expect(previewResponseDto.result!.preview.body).to.contain('[this text should be alone in brackets]');
+        }
+        const issue = previewResponseDto.issues.body;
+        expect(issue).to.exist;
+        expect(issue[0].variableName).to.equal('{{name}}');
+        expect(issue[0].issueType).to.equal('ILLEGAL_VARIABLE_IN_CONTROL_VALUE');
+      });
+    });
     describe('Missing Required ControlValues', () => {
       const channelTypes = [{ type: StepTypeEnum.IN_APP, description: 'InApp' }];
 
@@ -427,14 +480,14 @@ function assertEmail(dto: GeneratePreviewResponseDto) {
   if (dto.result!.type === ChannelTypeEnum.EMAIL) {
     const preview = dto.result!.preview.body;
     expect(preview).to.exist;
-    expect(preview).to.contain('{{item.header}}1');
-    expect(preview).to.contain('{{item.header}}2');
-    expect(preview).to.contain('{{item.name}}1');
-    expect(preview).to.contain('{{item.name}}2');
-    expect(preview).to.contain('{{item.id}}1');
-    expect(preview).to.contain('{{item.id}}2');
-    expect(preview).to.contain('{{item.origin.country}}1');
-    expect(preview).to.contain('{{item.origin.country}}2');
+    expect(preview).to.contain('{{item.header}}-1');
+    expect(preview).to.contain('{{item.header}}-2');
+    expect(preview).to.contain('{{item.name}}-1');
+    expect(preview).to.contain('{{item.name}}-2');
+    expect(preview).to.contain('{{item.id}}-1');
+    expect(preview).to.contain('{{item.id}}-2');
+    expect(preview).to.contain('{{item.origin.country}}-1');
+    expect(preview).to.contain('{{item.origin.country}}-2');
     expect(preview).to.contain('{{payload.body}}');
     expect(preview).to.contain('should be the fallback value');
   }

diff --git a/apps/api/src/app/workflows-v2/shared/build-string-schema.ts b/apps/api/src/app/workflows-v2/shared/build-string-schema.ts