Merge branch 'next' into nv-4931-in-app-preview-improvements

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}}!',
+            body: 'Hello {{subscriber.firstName}} {{subscriber.lastName}}, Welcome to {{PAYLOAD.ORGANIZATIONNAME | UPCASE}}!',
           },
           type: 'in_app',
         },
@@ -69,7 +69,7 @@ describe('Workflow Step Preview - POST /:workflowId/step/:stepId/preview', () =>
             lastName: '{{subscriber.lastName}}',
           },
           payload: {
-            organizationName: '{{payload.organizationName}}',
+            organizationName: '{{payload.organizationName | upcase}}',
           },
         },
       },
@@ -409,14 +409,15 @@ describe('Workflow Step Preview - POST /:workflowId/step/:stepId/preview', () =>
       result: {
         preview: {
           subject: 'Welcome John',
-          body: 'Hello John, your order #undefined is ready!', // orderId is not defined in the payload schema
+          body: 'Hello John, your order #{{payload.orderId}} is ready!', // orderId is not defined in the payload schema
         },
         type: 'in_app',
       },
       previewPayloadExample: {
         payload: {
           lastName: '{{payload.lastName}}',
           organizationName: '{{payload.organizationName}}',
+          orderId: '{{payload.orderId}}',
           firstName: 'John',
         },
       },

apps/api/src/app/workflows-v2/usecases/generate-preview/generate-preview.usecase.ts

@@ -1,4 +1,4 @@
-import { BadRequestException, Injectable, InternalServerErrorException } from '@nestjs/common';
+import { Injectable, InternalServerErrorException } from '@nestjs/common';
 import _ from 'lodash';
 import {
   ChannelTypeEnum,
@@ -22,13 +22,15 @@ import { GeneratePreviewCommand } from './generate-preview.command';
 import { extractTemplateVars } from '../../util/template-variables/extract-template-variables';
 import { pathsToObject } from '../../util/path-to-object';
 import { createMockPayloadFromSchema, flattenObjectValues } from '../../util/utils';
+import { PrepareAndValidateContentUsecase } from '../validate-content/prepare-and-validate-content/prepare-and-validate-content.usecase';
 
 @Injectable()
 export class GeneratePreviewUsecase {
   constructor(
     private legacyPreviewStepUseCase: PreviewStep,
     private buildStepDataUsecase: BuildStepDataUsecase,
-    private getWorkflowByIdsUseCase: GetWorkflowByIdsUseCase
+    private getWorkflowByIdsUseCase: GetWorkflowByIdsUseCase,
+    private prepareAndValidateContentUsecase: PrepareAndValidateContentUsecase
   ) {}
 
   @InstrumentUsecase()
@@ -37,18 +39,24 @@ export class GeneratePreviewUsecase {
       command.generatePreviewRequestDto;
     const stepData = await this.getStepData(command);
     const workflow = await this.findWorkflow(command);
-
+    const preparedAndValidatedContent = await this.prepareAndValidateContentUsecase.execute({
+      user: command.user,
+      previewPayloadFromDto: commandVariablesExample,
+      controlValues: commandControlValues || stepData.controls.values || {},
+      controlDataSchema: stepData.controls.dataSchema || {},
+      variableSchema: stepData.variables,
+    });
     const variablesExample = this.buildVariablesExample(
       workflow,
-      stepData,
-      commandVariablesExample,
-      commandControlValues
+      preparedAndValidatedContent.finalPayload,
+      commandVariablesExample
     );
+
     const executeOutput = await this.executePreviewUsecase(
       command,
       stepData,
       variablesExample,
-      commandControlValues || {}
+      preparedAndValidatedContent.finalControlValues
     );
 
     return {
@@ -63,17 +71,24 @@ export class GeneratePreviewUsecase {
   @Instrument()
   private buildVariablesExample(
     workflow: WorkflowInternalResponseDto,
-    stepData: StepDataDto,
-    commandVariablesExample?: PreviewPayload,
-    commandControlValues?: Record<string, unknown>
+    finalPayload?: PreviewPayload,
+    commandVariablesExample?: PreviewPayload | undefined
   ) {
-    const variablesExample = this.generateVariablesExample(stepData, commandControlValues);
+    if (workflow.origin !== WorkflowOriginEnum.EXTERNAL) {
+      return finalPayload;
+    }
 
-    if (workflow.origin === WorkflowOriginEnum.EXTERNAL) {
-      variablesExample.payload = createMockPayloadFromSchema(workflow.payloadSchema);
+    const examplePayloadSchema = createMockPayloadFromSchema(workflow.payloadSchema);
+
+    if (!examplePayloadSchema || Object.keys(examplePayloadSchema).length === 0) {
+      return finalPayload;
     }
 
-    return _.merge(variablesExample, commandVariablesExample as Record<string, unknown>);
+    return _.merge(
+      finalPayload as Record<string, unknown>,
+      { payload: examplePayloadSchema },
+      commandVariablesExample || {}
+    );
   }
 
   @Instrument()

apps/api/src/app/workflows-v2/util/utils.ts

@@ -86,17 +86,24 @@ export function flattenObjectValues(obj: Record<string, unknown>): string[] {
 export function createMockPayloadFromSchema(
   schema: JSONSchemaDto,
   path = 'payload',
-  depth = 0
+  depth = 0,
+  safe = true
 ): Record<string, unknown> {
   const MAX_DEPTH = 10;
   if (depth >= MAX_DEPTH) {
+    if (safe) {
+      return {};
+    }
     throw new BadRequestException({
       message: 'Schema has surpassed the maximum allowed depth. Please specify a more shallow payload schema.',
       maxDepth: MAX_DEPTH,
     });
   }
 
-  if (schema.type !== 'object' || !schema.properties) {
+  if (schema?.type !== 'object' || !schema?.properties) {
+    if (safe) {
+      return {};
+    }
     throw new BadRequestException({
       message: 'Schema must define an object with properties.',
     });