fix(api): Resolve circular import issue for workflow update validation (

#7151)

Co-authored-by: Richard Fontein <[email protected]>
Co-authored-by: George Desipris <[email protected]>
Co-authored-by: Dima Grossman <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>
Co-authored-by: Sokratis Vidros <[email protected]>

apps/api/src/app/workflows-v2/workflow.controller.e2e.ts

@@ -113,6 +113,25 @@ describe('Workflow Controller E2E API Testing', () => {
         expect(res.isSuccessResult()).to.be.false;
         expect(res.error?.responseText).to.include('description must be shorter than or equal to 256 characters');
       });
+      it('should respond with 400 when description is too long on an update call', async () => {
+        const createWorkflowDto: CreateWorkflowDto = buildCreateWorkflowDto('nameSuffix');
+
+        const res = await workflowsClient.createWorkflow(createWorkflowDto);
+        expect(res.isSuccessResult()).to.be.true;
+        if (res.isSuccessResult()) {
+          const updateWorkflowDto = {
+            ...buildUpdateRequest(res.value),
+            description: Array.from({ length: 260 }).join('X'),
+          };
+          const updateResult = await workflowsClient.updateWorkflow(res.value?._id, updateWorkflowDto);
+          expect(updateResult.isSuccessResult(), JSON.stringify(updateResult.value)).to.be.false;
+          if (!updateResult.isSuccessResult()) {
+            expect(updateResult.error?.responseText).to.include(
+              'description must be shorter than or equal to 256 characters'
+            );
+          }
+        }
+      });
 
       it('should respond with 400 when a tag is too long', async () => {
         const createWorkflowDto: CreateWorkflowDto = buildCreateWorkflowDto('nameSuffix', {

libs/application-generic/src/usecases/create-workflow/create-workflow.command.ts

@@ -17,32 +17,32 @@ import {
   BuilderFieldType,
   BuilderGroupValues,
   ChannelCTATypeEnum,
+  ContentIssue as ContentIssueDto,
   FilterParts,
   IMessageAction,
   INotificationGroup,
   IStepVariant,
-  StepIssuesDto,
-  StepIssue as StepIssueDto,
-  ContentIssue as ContentIssueDto,
   IWorkflowStepMetadata,
   JSONSchemaDto,
   NotificationTemplateCustomData,
-  WorkflowOriginEnum,
-  WorkflowTypeEnum,
-  StepIssueEnum,
   StepContentIssueEnum,
   StepCreateAndUpdateKeys,
+  StepIssue as StepIssueDto,
+  StepIssueEnum,
+  StepIssuesDto,
+  WorkflowOriginEnum,
   WorkflowStatusEnum,
+  WorkflowTypeEnum,
 } from '@novu/shared';
 
 import { Type } from 'class-transformer';
 import { EnvironmentWithUserCommand } from '../../commands';
 import { PreferencesRequired } from '../upsert-preferences';
-
-export const MAX_TAG_ELEMENTS = 16;
-export const MAX_TAG_LENGTH = 32;
-export const MAX_NAME_LENGTH = 64;
-export const MAX_DESCRIPTION_LENGTH = 256;
+import {
+  MAX_DESCRIPTION_LENGTH,
+  MAX_NAME_LENGTH,
+  MAX_TAG_LENGTH,
+} from '../workflow';
 
 export class CreateWorkflowCommand extends EnvironmentWithUserCommand {
   @IsDefined()

libs/application-generic/src/usecases/workflow/index.ts

@@ -1,5 +1,4 @@
-export * from './update-workflow/update-workflow.usecase';
-export * from './update-workflow/update-workflow.command';
+export * from './update-workflow';
 export * from './delete-workflow/delete-workflow.usecase';
 export * from './delete-workflow/delete-workflow.command';
 export * from './get-workflow-by-ids/get-workflow-by-ids.usecase';

libs/application-generic/src/usecases/workflow/update-workflow/index.ts

@@ -0,0 +1,3 @@
+export * from './upsert-validation-constants';
+export * from './update-workflow.command';
+export * from './update-workflow.usecase';

libs/application-generic/src/usecases/workflow/update-workflow/update-workflow.command.ts

@@ -24,14 +24,15 @@ import { Type } from 'class-transformer';
 import { EnvironmentWithUserCommand } from '../../../commands';
 import { PreferencesRequired } from '../../upsert-preferences';
 import {
-  ContentIssue,
-  IStepControl,
   MAX_DESCRIPTION_LENGTH,
   MAX_NAME_LENGTH,
-  MAX_TAG_ELEMENTS,
   MAX_TAG_LENGTH,
+} from './upsert-validation-constants';
+import {
+  ContentIssue,
+  IStepControl,
   NotificationStep,
-} from '../..';
+} from '../../create-workflow/create-workflow.command';
 
 export class UpdateWorkflowCommand extends EnvironmentWithUserCommand {
   @IsDefined()

libs/application-generic/src/usecases/workflow/update-workflow/upsert-validation-constants.ts

@@ -0,0 +1,4 @@
+export const MAX_TAG_ELEMENTS = 16;
+export const MAX_TAG_LENGTH = 32;
+export const MAX_NAME_LENGTH = 64;
+export const MAX_DESCRIPTION_LENGTH = 256;