feat(api): add status (#6616)

novuhq · Oct 8, 2024 · 644c6f6 · 644c6f6
1 parent 6740e50
commit 644c6f6
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 21 deletions.
diff --git a/apps/api/src/app/workflows-v2/mappers/notification-template-mapper.ts b/apps/api/src/app/workflows-v2/mappers/notification-template-mapper.ts
@@ -8,6 +8,8 @@ import {
   WorkflowListResponseDto,
   WorkflowOriginEnum,
   WorkflowResponseDto,
+  WorkflowStatusEnum,
+  WorkflowTypeEnum,
 } from '@novu/shared';
 import { ControlValuesEntity, NotificationStepEntity, NotificationTemplateEntity } from '@novu/dal';
 import { GetPreferencesResponseDto } from '@novu/application-generic';
@@ -31,8 +33,10 @@ export function toResponseWorkflowDto(
     name: template.name,
     description: template.description,
     origin: template.origin || WorkflowOriginEnum.NOVU_CLOUD,
+    type: template.type || WorkflowTypeEnum.BRIDGE,
     updatedAt: template.updatedAt || 'Missing Updated At',
     createdAt: template.createdAt || 'Missing Create At',
+    status: WorkflowStatusEnum.ACTIVE,
   };
 }
 
@@ -52,12 +56,15 @@ function getSteps(template: NotificationTemplateEntity, controlValuesMap: { [p:
 
 function toMinifiedWorkflowDto(template: NotificationTemplateEntity): WorkflowListResponseDto {
   return {
+    origin: template.origin || WorkflowOriginEnum.NOVU_CLOUD,
+    type: template.type || WorkflowTypeEnum.BRIDGE,
     _id: template._id,
     name: template.name,
     tags: template.tags,
     updatedAt: template.updatedAt || 'Missing Updated At',
     stepTypeOverviews: template.steps.map(buildStepTypeOverview).filter((stepTypeEnum) => !!stepTypeEnum),
     createdAt: template.createdAt || 'Missing Create At',
+    status: WorkflowStatusEnum.ACTIVE,
   };
 }
 

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
@@ -2,7 +2,6 @@ import { BadRequestException, Injectable } from '@nestjs/common';
 
 import {
   ControlValuesEntity,
-  EnvironmentRepository,
   NotificationGroupRepository,
   NotificationStepEntity,
   NotificationTemplateEntity,
@@ -58,7 +57,6 @@ export class UpsertWorkflowUseCase {
     private notificationGroupRepository: NotificationGroupRepository,
     private upsertPreferencesUsecase: UpsertPreferences,
     private upsertControlValuesUseCase: UpsertControlValuesUseCase,
-    private environmentRepository: EnvironmentRepository,
     private getPreferencesUseCase: GetPreferences
   ) {}
   async execute(command: UpsertWorkflowCommand): Promise<WorkflowResponseDto> {

diff --git a/apps/api/src/app/workflows-v2/workflow.controller.e2e.ts b/apps/api/src/app/workflows-v2/workflow.controller.e2e.ts
@@ -194,21 +194,23 @@ function buildErrorMsg(createWorkflowDto: Omit<WorkflowCommonsFields, '_id'>, cr
 
 async function createWorkflowAndValidate(nameSuffix: string = ''): Promise<WorkflowResponseDto> {
   const createWorkflowDto: CreateWorkflowDto = buildCreateWorkflowDto(nameSuffix);
-  console.log('createWorkflowDto', JSON.stringify(createWorkflowDto, null, 2));
   const res = await session.testAgent.post(`${v2Prefix}/workflows`).send(createWorkflowDto);
   const workflowResponseDto: WorkflowResponseDto = res.body.data;
   expect(workflowResponseDto, JSON.stringify(res, null, 2)).to.be.ok;
   expect(workflowResponseDto._id, JSON.stringify(res, null, 2)).to.be.ok;
   expect(workflowResponseDto.updatedAt, JSON.stringify(res, null, 2)).to.be.ok;
   expect(workflowResponseDto.createdAt, JSON.stringify(res, null, 2)).to.be.ok;
   expect(workflowResponseDto.preferences, JSON.stringify(res, null, 2)).to.be.ok;
+  expect(workflowResponseDto.status, JSON.stringify(res, null, 2)).to.be.ok;
   const createdWorkflowWithoutUpdateDate = removeFields(
     workflowResponseDto,
     '_id',
     'origin',
     'preferences',
     'updatedAt',
-    'createdAt'
+    'createdAt',
+    'status',
+    'type'
   );
   createdWorkflowWithoutUpdateDate.steps = createdWorkflowWithoutUpdateDate.steps.map((step) =>
     removeFields(step, 'stepUuid')
@@ -249,9 +251,6 @@ function buildCreateWorkflowDto(nameSuffix: string): CreateWorkflowDto {
 }
 
 async function updateWorkflowRest(id: string, workflow: UpdateWorkflowDto): Promise<WorkflowResponseDto> {
-  console.log(`updateWorkflow- ${id}: 
-  ${JSON.stringify(workflow, null, 2)}`);
-
   return await safePut(`${v2Prefix}/workflows/${id}`, workflow);
 }
 
@@ -296,7 +295,14 @@ function validateUpdatedWorkflowAndRemoveResponseFields(
   workflowResponse: WorkflowResponseDto,
   workflowUpdateRequest: UpdateWorkflowDto
 ): UpdateWorkflowDto {
-  const updatedWorkflowWoUpdated: UpdateWorkflowDto = removeFields(workflowResponse, 'updatedAt', 'origin', '_id');
+  const updatedWorkflowWoUpdated: UpdateWorkflowDto = removeFields(
+    workflowResponse,
+    'updatedAt',
+    'origin',
+    '_id',
+    'status',
+    'type'
+  );
   const augmentedStep: (StepUpdateDto | StepCreateDto)[] = [];
   for (const stepInResponse of workflowResponse.steps) {
     expect(stepInResponse.stepUuid).to.be.ok;
@@ -318,7 +324,6 @@ async function updateWorkflowAndValidate(
   updatedAt: string,
   updateRequest: UpdateWorkflowDto
 ): Promise<void> {
-  console.log('updateRequest:::'.toUpperCase(), JSON.stringify(updateRequest.steps, null, 2));
   const updatedWorkflow: WorkflowResponseDto = await updateWorkflowRest(id, updateRequest);
   const updatedWorkflowWithResponseFieldsRemoved = validateUpdatedWorkflowAndRemoveResponseFields(
     updatedWorkflow,
@@ -542,24 +547,19 @@ function buildInAppStepWithValues() {
 }
 
 function convertResponseToUpdateDto(workflowCreated: WorkflowResponseDto): UpdateWorkflowDto {
-  return removeFields(workflowCreated, 'updatedAt', '_id', 'origin') as UpdateWorkflowDto;
+  return removeFields(workflowCreated, 'updatedAt', '_id', 'origin', 'type', 'status') as UpdateWorkflowDto;
 }
 
 function buildUpdateDtoWithValues(workflowCreated: WorkflowResponseDto): UpdateWorkflowDto {
   const updateDto = convertResponseToUpdateDto(workflowCreated);
   const updatedStep = addValueToExistingStep(updateDto.steps);
   const newStep = buildInAppStepWithValues();
-  console.log('newStep:::', JSON.stringify(newStep, null, 2));
 
-  const stoWithValues: UpdateWorkflowDto = {
+  return {
     ...updateDto,
     name: `${TEST_WORKFLOW_UPDATED_NAME}-${generateUUID()}`,
     steps: [updatedStep, newStep],
   };
-
-  console.log('updateDto:::', JSON.stringify(stoWithValues, null, 2));
-
-  return stoWithValues;
 }
 function createStep(): StepCreateDto {
   return {
@@ -576,7 +576,14 @@ function createStep(): StepCreateDto {
 
 function buildUpdateRequest(workflowCreated: WorkflowResponseDto): UpdateWorkflowDto {
   const steps = [createStep()];
-  const updateRequest = removeFields(workflowCreated, 'updatedAt', '_id', 'origin') as UpdateWorkflowDto;
+  const updateRequest = removeFields(
+    workflowCreated,
+    'updatedAt',
+    '_id',
+    'origin',
+    'status',
+    'type'
+  ) as UpdateWorkflowDto;
 
   return { ...updateRequest, name: TEST_WORKFLOW_UPDATED_NAME, steps };
 }
diff --git a/packages/shared/src/dto/workflows/index.ts b/packages/shared/src/dto/workflows/index.ts
@@ -5,3 +5,4 @@ export * from './update-workflow-deprecated.dto';
 export * from './workflow-commons-fields';
 export * from './workflow-response-dto';
 export * from './workflow.dto';
+export * from './workflow-status-enum';
diff --git a/packages/shared/src/dto/workflows/workflow-commons-fields.ts b/packages/shared/src/dto/workflows/workflow-commons-fields.ts
@@ -23,7 +23,10 @@ export type ListWorkflowResponse = {
   totalCount: number;
 };
 
-export type WorkflowListResponseDto = Pick<WorkflowResponseDto, 'name' | 'tags' | 'updatedAt' | 'createdAt' | '_id'> & {
+export type WorkflowListResponseDto = Pick<
+  WorkflowResponseDto,
+  'name' | 'tags' | 'updatedAt' | 'createdAt' | '_id' | 'status' | 'type' | 'origin'
+> & {
   stepTypeOverviews: StepTypeEnum[];
 };
 

diff --git a/packages/shared/src/dto/workflows/workflow-response-dto.ts b/packages/shared/src/dto/workflows/workflow-response-dto.ts
@@ -1,6 +1,7 @@
 import { IsArray, IsDefined, IsEnum, IsObject, IsString } from 'class-validator';
 import { PreferencesResponseDto, StepResponseDto, WorkflowCommonsFields } from './workflow-commons-fields';
-import { WorkflowOriginEnum } from '../../types';
+import { WorkflowOriginEnum, WorkflowTypeEnum } from '../../types';
+import { WorkflowStatusEnum } from './workflow-status-enum';
 
 export class WorkflowResponseDto extends WorkflowCommonsFields {
   @IsString()
@@ -22,4 +23,12 @@ export class WorkflowResponseDto extends WorkflowCommonsFields {
   @IsObject()
   @IsDefined()
   preferences: PreferencesResponseDto;
+
+  @IsEnum(WorkflowStatusEnum)
+  @IsDefined()
+  status: WorkflowStatusEnum;
+
+  @IsEnum(WorkflowTypeEnum)
+  @IsDefined()
+  type: WorkflowTypeEnum;
 }
diff --git a/packages/shared/src/dto/workflows/workflow-status-enum.ts b/packages/shared/src/dto/workflows/workflow-status-enum.ts
@@ -0,0 +1,5 @@
+export enum WorkflowStatusEnum {
+  ACTIVE = 'ACTIVE',
+  INACTIVE = 'INACTIVE',
+  ERROR = 'ERROR',
+}
diff --git a/packages/shared/src/types/notification-templates/index.ts b/packages/shared/src/types/notification-templates/index.ts
@@ -35,10 +35,9 @@ type ActiveIntegrationStatusWithPrimary = {
  */
 export enum WorkflowTypeEnum {
   REGULAR = 'REGULAR',
-  ECHO = 'ECHO',
+  ECHO = 'ECHO', // @deprecated
   BRIDGE = 'BRIDGE',
 }
-
 /**
  * Enum to define the origin of the workflow.
  *