fix(api-service): workflow creation api flow didn't generate payload …

…schema (#7366)
novuhq · Dec 24, 2024 · 55f7de6 · 55f7de6
1 parent e8e8fab
commit 55f7de6
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 8 deletions.
diff --git a/apps/api/src/app/workflows-v2/usecases/build-payload-schema/build-payload-schema.command.ts b/apps/api/src/app/workflows-v2/usecases/build-payload-schema/build-payload-schema.command.ts
@@ -1,10 +1,10 @@
 import { EnvironmentWithUserCommand } from '@novu/application-generic';
-import { IsString, IsObject, IsNotEmpty, IsOptional } from 'class-validator';
+import { IsString, IsObject, IsOptional } from 'class-validator';
 
 export class BuildPayloadSchemaCommand extends EnvironmentWithUserCommand {
   @IsString()
-  @IsNotEmpty()
-  workflowId: string;
+  @IsOptional()
+  workflowId?: string;
 
   /**
    * Control values used for preview purposes

diff --git a/apps/api/src/app/workflows-v2/usecases/build-payload-schema/build-payload-schema.usecase.ts b/apps/api/src/app/workflows-v2/usecases/build-payload-schema/build-payload-schema.usecase.ts
@@ -23,7 +23,7 @@ export class BuildPayloadSchema {
   private async getControlValues(command: BuildPayloadSchemaCommand) {
     let controlValues = command.controlValues ? [command.controlValues] : [];
 
-    if (!controlValues.length) {
+    if (!controlValues.length && command.workflowId) {
       controlValues = (
         await this.controlValuesRepository.find(
           {

diff --git a/...pp/workflows-v2/usecases/build-variable-schema/build-available-variable-schema.usecase.ts b/...pp/workflows-v2/usecases/build-variable-schema/build-available-variable-schema.usecase.ts
@@ -62,15 +62,15 @@ export class BuildAvailableVariableSchemaUsecase {
     workflow: NotificationTemplateEntity | undefined,
     command: BuildAvailableVariableSchemaCommand
   ): Promise<JSONSchemaDto> {
-    if (!workflow) {
+    if (workflow && workflow.steps.length === 0) {
       return {
         type: 'object',
         properties: {},
         additionalProperties: true,
       };
     }
 
-    if (workflow.payloadSchema) {
+    if (workflow?.payloadSchema) {
       return parsePayloadSchema(workflow.payloadSchema, { safe: true }) || emptyJsonSchema();
     }
 
@@ -79,7 +79,7 @@ export class BuildAvailableVariableSchemaUsecase {
         environmentId: command.environmentId,
         organizationId: command.organizationId,
         userId: command.userId,
-        workflowId: workflow._id,
+        workflowId: workflow?._id,
         ...(command.optimisticControlValues ? { controlValues: command.optimisticControlValues } : {}),
       })
     );

diff --git a/apps/api/src/app/workflows-v2/usecases/upsert-workflow/upsert-workflow.usecase.ts b/apps/api/src/app/workflows-v2/usecases/upsert-workflow/upsert-workflow.usecase.ts
@@ -30,7 +30,6 @@ import {
   WorkflowStatusEnum,
   StepIssues,
   ControlSchemas,
-  DigestUnitEnum,
 } from '@novu/shared';
 import {
   CreateWorkflow as CreateWorkflowGeneric,

diff --git a/apps/api/src/app/workflows-v2/workflow.controller.e2e.ts b/apps/api/src/app/workflows-v2/workflow.controller.e2e.ts
@@ -275,6 +275,39 @@ describe('Workflow Controller E2E API Testing', () => {
         await assertValuesInSteps(workflowCreated);
       }
     });
+
+    it('should generate a payload schema if only control values are provided during workflow creation', async () => {
+      const steps = [
+        {
+          ...buildEmailStep(),
+          controlValues: {
+            body: 'Welcome {{payload.name}}',
+            subject: 'Hello {{payload.name}}',
+          },
+        },
+      ];
+
+      const nameSuffix = `Test Workflow${new Date().toISOString()}`;
+
+      const createWorkflowDto: CreateWorkflowDto = buildCreateWorkflowDto(`${nameSuffix}`, { steps });
+      const res = await workflowsClient.createWorkflow(createWorkflowDto);
+      expect(res.isSuccessResult()).to.be.true;
+
+      const workflow = res.value as WorkflowResponseDto;
+      expect(workflow).to.be.ok;
+
+      expect(workflow.steps[0].variables).to.be.ok;
+
+      const stepData = await getStepData(workflow._id, workflow.steps[0]._id);
+      expect(stepData.variables).to.be.ok;
+
+      const { properties } = stepData.variables as JSONSchemaDto;
+      expect(properties).to.be.ok;
+
+      const payloadProperties = properties?.payload as JSONSchemaDto;
+      expect(payloadProperties).to.be.ok;
+      expect(payloadProperties.properties?.name).to.be.ok;
+    });
   });
 
   describe('Update Workflow Permutations', () => {