refactor(api): after pr comments

novuhq · Sep 30, 2024 · bdaaa8e · bdaaa8e
1 parent ee35239
commit bdaaa8e
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 40 deletions.
diff --git a/apps/api/src/app/workflows-v1/notification-template.controller.ts b/apps/api/src/app/workflows-v1/notification-template.controller.ts
@@ -195,7 +195,7 @@ export class NotificationTemplateController {
         data: body.data,
         __source: query?.__source,
         type: WorkflowTypeEnum.REGULAR,
-        origin: WorkflowOriginEnum.NOVU,
+        origin: WorkflowOriginEnum.NOVU_CLOUD,
       })
     );
   }

diff --git a/apps/api/src/app/workflows-v1/workflow-v1.controller.ts b/apps/api/src/app/workflows-v1/workflow-v1.controller.ts
@@ -215,7 +215,7 @@ export class WorkflowControllerV1 {
         data: body.data,
         __source: query?.__source,
         type: WorkflowTypeEnum.REGULAR,
-        origin: WorkflowOriginEnum.NOVU,
+        origin: WorkflowOriginEnum.NOVU_CLOUD,
       })
     );
   }

diff --git a/apps/api/src/app/workflows-v2/customTypes.ts b/apps/api/src/app/workflows-v2/customTypes.ts
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
@@ -10,7 +10,7 @@ import {
 } from '../dto/workflow-commons-fields';
 import { WorkflowResponseDto } from '../dto/workflow-response-dto';
 
-function toResponseWorkflowDto(
+export function toResponseWorkflowDto(
   template: NotificationTemplateEntity,
   preferences: GetPreferencesResponseDto | undefined,
   stepIdToControlValuesMap: { [p: string]: ControlValuesEntity }
@@ -28,7 +28,7 @@ function toResponseWorkflowDto(
     steps: getSteps(template, stepIdToControlValuesMap),
     name: template.name,
     description: template.description,
-    origin: template.origin || WorkflowOriginEnum.NOVU,
+    origin: template.origin || WorkflowOriginEnum.NOVU_CLOUD,
     updatedAt: template.updatedAt || 'Missing Updated At',
     createdAt: template.createdAt || 'Missing Create At',
   };

diff --git a/apps/api/src/app/workflows-v2/usecases/delete-workflow/delete-workflow.command.ts b/apps/api/src/app/workflows-v2/usecases/delete-workflow/delete-workflow.command.ts
@@ -1,8 +1,6 @@
 import { EnvironmentWithUserObjectCommand } from '@novu/application-generic';
 import { IsDefined, IsString } from 'class-validator';
 
-export type RequiredProp<T, K extends keyof T> = T & { [P in K]-?: T[P] };
-
 export class DeleteWorkflowCommand extends EnvironmentWithUserObjectCommand {
   @IsString()
   @IsDefined()

diff --git a/apps/api/src/app/workflows-v2/usecases/get-workflow/get-workflow.usecase.ts b/apps/api/src/app/workflows-v2/usecases/get-workflow/get-workflow.usecase.ts
@@ -12,6 +12,7 @@ import { GetPreferences, GetPreferencesCommand, GetPreferencesResponseDto } from
 import { GetWorkflowCommand } from './get-workflow.command';
 import { WorkflowNotFoundException } from '../../exceptions/workflow-not-found-exception';
 import { WorkflowResponseDto } from '../../dto/workflow-response-dto';
+import { toResponseWorkflowDto } from '../../mappers/notification-template-mapper';
 
 @Injectable()
 export class GetWorkflowUseCase {

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,6 +30,7 @@ import { StepCreateDto, StepDto, StepUpdateDto } from '../../dto/workflow-common
 import { StepUpsertMechanismFailedMissingIdException } from '../../exceptions/step-upsert-mechanism-failed-missing-id.exception';
 import { CreateWorkflowDto } from '../../dto/create-workflow-dto';
 import { WorkflowResponseDto } from '../../dto/workflow-response-dto';
+import { toResponseWorkflowDto } from '../../mappers/notification-template-mapper';
 
 function buildUpsertControlValuesCommand(command: UpsertWorkflowCommand, persistedStep, persistedWorkflow, stepInDto) {
   return UpsertControlValuesCommand.create({
@@ -113,10 +114,10 @@ export class UpsertWorkflowUseCase {
     }
     await this.upsertPreferences(workflow, command);
 
-    return await this.getPresistedPreferences(workflow);
+    return await this.getPersistedPreferences(workflow);
   }
 
-  private async getPresistedPreferences(workflow) {
+  private async getPersistedPreferences(workflow) {
     return await this.getPreferencesUseCase.execute(
       GetPreferencesCommand.create({
         environmentId: workflow._environmentId,
@@ -172,7 +173,7 @@ export class UpsertWorkflowUseCase {
       name: workflowDto.name,
       __source: workflowDto.__source || WorkflowCreationSourceEnum.DASHBOARD,
       type: WorkflowTypeEnum.BRIDGE,
-      origin: WorkflowOriginEnum.NOVU,
+      origin: WorkflowOriginEnum.NOVU_CLOUD,
       steps: this.mapSteps(workflowDto.steps),
       payloadSchema: {},
       active: isWorkflowActive,
@@ -271,6 +272,7 @@ export class UpsertWorkflowUseCase {
     if (!persistedWorkflow?.steps) {
       return;
     }
+
     for (const persistedStep of persistedWorkflow.steps) {
       if (this.isStepUpdateDto(stepUpdateRequest) && persistedStep._templateId === stepUpdateRequest.stepUuid) {
         return persistedStep;

diff --git a/libs/application-generic/src/usecases/create-workflow/create-workflow.usecase.ts b/libs/application-generic/src/usecases/create-workflow/create-workflow.usecase.ts
@@ -53,7 +53,7 @@ export class CreateWorkflow {
     private createChange: CreateChange,
     @Inject(forwardRef(() => AnalyticsService))
     private analyticsService: AnalyticsService,
-    protected moduleRef: ModuleRef
+    protected moduleRef: ModuleRef,
   ) {}
 
   async execute(usecaseCommand: CreateWorkflowCommand) {
@@ -92,7 +92,7 @@ export class CreateWorkflow {
       command,
       templateSteps,
       trigger,
-      triggerIdentifier
+      triggerIdentifier,
     );
 
     await this.createWorkflowChange(command, storedWorkflow, parentChangeId);
@@ -107,12 +107,11 @@ export class CreateWorkflow {
         }
         const service = this.moduleRef.get(
           require('@novu/ee-shared-services')?.TranslationsService,
-          { strict: false }
+          { strict: false },
         );
 
-        const locales = await service.createTranslationAnalytics(
-          storedWorkflow
-        );
+        const locales =
+          await service.createTranslationAnalytics(storedWorkflow);
 
         this.analyticsService.track(
           'Locale used in workflow - [Translations]',
@@ -122,14 +121,14 @@ export class CreateWorkflow {
             _environment: command.environmentId,
             workflowId: storedWorkflow._id,
             locales,
-          }
+          },
         );
       }
     } catch (e) {
       Logger.error(
         e,
         `Unexpected error while importing enterprise modules`,
-        'TranslationsService'
+        'TranslationsService',
       );
     }
 
@@ -144,15 +143,15 @@ export class CreateWorkflow {
     for (const variant of variants) {
       if (isVariantEmpty(variant)) {
         throw new ApiException(
-          `Variant conditions are required, variant name ${variant.name} id ${variant._id}`
+          `Variant conditions are required, variant name ${variant.name} id ${variant._id}`,
         );
       }
     }
   }
 
   private async createNotificationTrigger(
     command: CreateWorkflowCommand,
-    triggerIdentifier: string
+    triggerIdentifier: string,
   ): Promise<INotificationTrigger> {
     const contentService = new ContentService();
     const { variables, reservedVariables } =
@@ -163,7 +162,7 @@ export class CreateWorkflow {
     const templateCheckIdentifier =
       await this.notificationTemplateRepository.findByTriggerIdentifier(
         command.environmentId,
-        triggerIdentifier
+        triggerIdentifier,
       );
 
     const trigger: INotificationTrigger = {
@@ -200,7 +199,7 @@ export class CreateWorkflow {
 
   private sendTemplateCreationEvent(
     command: CreateWorkflowCommand,
-    triggerIdentifier: string
+    triggerIdentifier: string,
   ) {
     if (
       command.name !== 'On-boarding notification' &&
@@ -215,15 +214,15 @@ export class CreateWorkflow {
           channels: command.steps?.map((i) => i.template?.type),
           __source: command.__source,
           triggerIdentifier,
-        }
+        },
       );
     }
   }
 
   private async createWorkflowChange(
     command: CreateWorkflowCommand,
     item,
-    parentChangeId: string
+    parentChangeId: string,
   ) {
     if (!isBridgeWorkflow(command.type)) {
       await this.createChange.execute(
@@ -234,7 +233,7 @@ export class CreateWorkflow {
           type: ChangeEntityTypeEnum.NOTIFICATION_TEMPLATE,
           item,
           changeId: parentChangeId,
-        })
+        }),
       );
     }
   }
@@ -243,7 +242,7 @@ export class CreateWorkflow {
     command: CreateWorkflowCommand,
     templateSteps: INotificationTemplateStep[],
     trigger: INotificationTrigger,
-    triggerIdentifier: string
+    triggerIdentifier: string,
   ) {
     const savedWorkflow = await this.notificationTemplateRepository.create({
       _organizationId: command.organizationId,
@@ -271,7 +270,7 @@ export class CreateWorkflow {
 
     const item = await this.notificationTemplateRepository.findById(
       savedWorkflow._id,
-      command.environmentId
+      command.environmentId,
     );
     if (!item)
       throw new NotFoundException(`Workflow ${savedWorkflow._id} is not found`);
@@ -283,7 +282,7 @@ export class CreateWorkflow {
 
   private async storeTemplateSteps(
     command: CreateWorkflowCommand,
-    parentChangeId: string
+    parentChangeId: string,
   ): Promise<INotificationTemplateStep[]> {
     let parentStepId: string | null = null;
     const templateSteps: INotificationTemplateStep[] = [];
@@ -317,7 +316,7 @@ export class CreateWorkflow {
             stepId: step.template.stepId,
             parentChangeId,
             workflowType: command.type,
-          })
+          }),
         ),
         await this.storeVariantSteps({
           variants: step.variants,
@@ -381,7 +380,7 @@ export class CreateWorkflow {
     for (const variant of variants) {
       if (!variant.template)
         throw new ApiException(
-          `Unexpected error: variants message template is missing`
+          `Unexpected error: variants message template is missing`,
         );
 
       const variantTemplate = await this.createMessageTemplate.execute(
@@ -404,7 +403,7 @@ export class CreateWorkflow {
           actor: variant.template.actor,
           parentChangeId,
           workflowType,
-        })
+        }),
       );
 
       variantsList.push({
@@ -450,13 +449,13 @@ export class CreateWorkflow {
       blueprintId: command.blueprintId,
       __source: command.__source,
       type: WorkflowTypeEnum.REGULAR,
-      origin: command.origin ?? WorkflowOriginEnum.NOVU,
+      origin: command.origin ?? WorkflowOriginEnum.NOVU_CLOUD,
     });
   }
 
   private normalizeSteps(commandSteps: NotificationStep[]): NotificationStep[] {
     const steps = JSON.parse(
-      JSON.stringify(commandSteps)
+      JSON.stringify(commandSteps),
     ) as NotificationStep[];
 
     return steps.map((step) => {
@@ -474,7 +473,7 @@ export class CreateWorkflow {
 
   private async handleFeeds(
     steps: NotificationStepEntity[],
-    command: CreateWorkflowCommand
+    command: CreateWorkflowCommand,
   ): Promise<NotificationStepEntity[]> {
     for (let i = 0; i < steps.length; i += 1) {
       const step = steps[i];
@@ -517,7 +516,7 @@ export class CreateWorkflow {
               organizationId: command.organizationId,
               userId: command.userId,
               changeId: FeedRepository.createObjectId(),
-            })
+            }),
           );
         }
       }
@@ -531,7 +530,7 @@ export class CreateWorkflow {
   }
 
   private async handleGroup(
-    command: CreateWorkflowCommand
+    command: CreateWorkflowCommand,
   ): Promise<NotificationGroupEntity> {
     if (!command.notificationGroup?.name)
       throw new NotFoundException(`Notification group was not provided`);
@@ -558,7 +557,7 @@ export class CreateWorkflow {
             userId: command.userId,
             type: ChangeEntityTypeEnum.NOTIFICATION_GROUP,
             changeId: NotificationGroupRepository.createObjectId(),
-          })
+          }),
         );
       }
     }

diff --git a/libs/dal/src/repositories/notification-template/notification-template.schema.ts b/libs/dal/src/repositories/notification-template/notification-template.schema.ts
@@ -28,7 +28,7 @@ const variantSchemePart = {
   },
   origin: {
     type: Schema.Types.String,
-    default: WorkflowOriginEnum.NOVU,
+    default: WorkflowOriginEnum.NOVU_CLOUD,
   },
   filters: [
     {

diff --git a/packages/shared/src/types/notification-templates/index.ts b/packages/shared/src/types/notification-templates/index.ts
@@ -44,11 +44,11 @@ export enum WorkflowTypeEnum {
  *
  * The `WorkflowOriginEnum` is used to specify the source of the workflow,
  * which helps determine which endpoint to call during the Preview & Execution phase.
- * * - 'novu' indicates that the workflow originates from Novu's platform, so the Novu-hosted endpoint is used.
+ * * - 'novu-cloud' indicates that the workflow originates from Novu's platform, so the Novu-hosted endpoint is used.
  * * - 'external' indicates that the workflow originates from an external source, requiring a call to a customer-hosted Bridge endpoint.
  */
 export enum WorkflowOriginEnum {
-  NOVU = 'novu',
+  NOVU_CLOUD = 'novu-cloud',
   EXTERNAL = 'external',
 }