feat(api): add v2 workflow api crud (#6460)

Co-authored-by: GalT <[email protected]>

apps/api/src/.env.test

@@ -102,7 +102,6 @@ API_RATE_LIMIT_MAXIMUM_FREE_GLOBAL=
 API_RATE_LIMIT_MAXIMUM_UNLIMITED_TRIGGER=
 API_RATE_LIMIT_MAXIMUM_UNLIMITED_CONFIGURATION=
 API_RATE_LIMIT_MAXIMUM_UNLIMITED_GLOBAL=
-
 IS_USE_MERGED_DIGEST_ID_ENABLED=true
 
 HUBSPOT_INVITE_NUDGE_EMAIL_USER_LIST_ID=

apps/api/src/app.module.ts

@@ -1,5 +1,5 @@
 /* eslint-disable global-require */
-import { DynamicModule, HttpException, Module, Logger, Provider } from '@nestjs/common';
+import { DynamicModule, HttpException, Logger, Module, Provider } from '@nestjs/common';
 import { RavenInterceptor, RavenModule } from 'nest-raven';
 import { APP_INTERCEPTOR } from '@nestjs/core';
 import { Type } from '@nestjs/common/interfaces/type.interface';
@@ -15,7 +15,6 @@ import { HealthModule } from './app/health/health.module';
 import { OrganizationModule } from './app/organization/organization.module';
 import { EnvironmentsModule } from './app/environments/environments.module';
 import { ExecutionDetailsModule } from './app/execution-details/execution-details.module';
-import { WorkflowModule } from './app/workflows/workflow.module';
 import { EventsModule } from './app/events/events.module';
 import { WidgetsModule } from './app/widgets/widgets.module';
 import { NotificationModule } from './app/notifications/notification.module';
@@ -44,6 +43,8 @@ import { InboxModule } from './app/inbox/inbox.module';
 import { BridgeModule } from './app/bridge/bridge.module';
 import { PreferencesModule } from './app/preferences';
 import { StepSchemasModule } from './app/step-schemas/step-schemas.module';
+import { WorkflowModule } from './app/workflows-v2/workflow.module';
+import { WorkflowModuleV1 } from './app/workflows-v1/workflow-v1.module';
 
 const enterpriseImports = (): Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> => {
   const modules: Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> = [];
@@ -78,7 +79,7 @@ const baseModules: Array<Type | DynamicModule | Promise<DynamicModule> | Forward
   HealthModule,
   EnvironmentsModule,
   ExecutionDetailsModule,
-  WorkflowModule,
+  WorkflowModuleV1,
   EventsModule,
   WidgetsModule,
   InboxModule,
@@ -105,6 +106,7 @@ const baseModules: Array<Type | DynamicModule | Promise<DynamicModule> | Forward
   TracingModule.register(packageJson.name, packageJson.version),
   BridgeModule,
   PreferencesModule,
+  WorkflowModule,
 ];
 
 const enterpriseModules = enterpriseImports();

apps/api/src/app/blueprint/blueprint.module.ts

@@ -1,12 +1,12 @@
 import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
 
 import { SharedModule } from '../shared/shared.module';
-import { WorkflowModule } from '../workflows/workflow.module';
 import { USE_CASES } from './usecases';
 import { BlueprintController } from './blueprint.controller';
+import { WorkflowModuleV1 } from '../workflows-v1/workflow-v1.module';
 
 @Module({
-  imports: [SharedModule, WorkflowModule],
+  imports: [SharedModule, WorkflowModuleV1],
   controllers: [BlueprintController],
   providers: [...USE_CASES],
   exports: [...USE_CASES],

apps/api/src/app/blueprint/e2e/get-blueprints-by-id.e2e.ts

@@ -12,7 +12,7 @@ import {
 } from '@novu/shared';
 
 import { GroupedBlueprintResponse } from '../dto/grouped-blueprint.response.dto';
-import { CreateWorkflowRequestDto } from '../../workflows/dto';
+import { CreateWorkflowRequestDto } from '../../workflows-v1/dto';
 
 describe('Get blueprints by id - /blueprints/:templateId (GET)', async () => {
   let session: UserSession;

apps/api/src/app/blueprint/e2e/get-grouped-blueprints.e2e.ts

@@ -20,10 +20,10 @@ import {
 } from '@novu/application-generic';
 
 import { GroupedBlueprintResponse } from '../dto/grouped-blueprint.response.dto';
-import { CreateWorkflowRequestDto } from '../../workflows/dto';
 import { GetGroupedBlueprints, POPULAR_TEMPLATES_ID_LIST } from '../usecases/get-grouped-blueprints';
 // eslint-disable-next-line import/no-namespace
 import * as blueprintStaticModule from '../usecases/get-grouped-blueprints/consts';
+import { CreateWorkflowRequestDto } from '../../workflows-v1/dto';
 
 describe('Get grouped notification template blueprints - /blueprints/group-by-category (GET)', async () => {
   let session: UserSession;

apps/api/src/app/bridge/bridge.controller.ts

@@ -14,13 +14,13 @@ import {
   UseInterceptors,
 } from '@nestjs/common';
 
-import { UserSessionData, ControlVariablesLevelEnum, WorkflowTypeEnum } from '@novu/shared';
+import { ControlVariablesLevelEnum, UserSessionData, WorkflowTypeEnum } from '@novu/shared';
 import { AnalyticsService, ExternalApiAccessible, UserAuthGuard, UserSession } from '@novu/application-generic';
-import { EnvironmentRepository, NotificationTemplateRepository, ControlVariablesRepository } from '@novu/dal';
+import { ControlValuesRepository, EnvironmentRepository, NotificationTemplateRepository } from '@novu/dal';
 
 import { ApiExcludeController } from '@nestjs/swagger';
 
-import { StoreControlVariables, StoreControlVariablesCommand } from './usecases/store-control-variables';
+import { StoreControlVariablesCommand, StoreControlVariablesUseCase } from './usecases/store-control-variables';
 import { PreviewStep, PreviewStepCommand } from './usecases/preview-step';
 import { SyncCommand } from './usecases/sync';
 import { Sync } from './usecases/sync/sync.usecase';
@@ -40,8 +40,8 @@ export class BridgeController {
     private validateBridgeUrlUsecase: GetBridgeStatus,
     private environmentRepository: EnvironmentRepository,
     private notificationTemplateRepository: NotificationTemplateRepository,
-    private controlVariablesRepository: ControlVariablesRepository,
-    private storeControlVariables: StoreControlVariables,
+    private controlValuesRepository: ControlValuesRepository,
+    private storeControlVariablesUseCase: StoreControlVariablesUseCase,
     private previewStep: PreviewStep,
     private analyticsService: AnalyticsService
   ) {}
@@ -175,7 +175,7 @@ export class BridgeController {
       throw new NotFoundException('Workflow not found');
     }
 
-    const result = await this.controlVariablesRepository.findOne({
+    const result = await this.controlValuesRepository.findOne({
       _environmentId: user.environmentId,
       _organizationId: user.organizationId,
       _workflowId: workflowExist._id,
@@ -195,7 +195,7 @@ export class BridgeController {
     @UserSession() user: UserSessionData,
     @Body() body: any
   ) {
-    return this.storeControlVariables.execute(
+    return this.storeControlVariablesUseCase.execute(
       StoreControlVariablesCommand.create({
         stepId,
         workflowId,

apps/api/src/app/bridge/bridge.module.ts

@@ -7,6 +7,7 @@ import {
   UpdateChange,
   UpdateMessageTemplate,
   UpdateWorkflow,
+  UpsertControlValuesUseCase,
   UpsertPreferences,
 } from '@novu/application-generic';
 import { PreferencesRepository } from '@novu/dal';
@@ -24,6 +25,7 @@ const PROVIDERS = [
   UpdateChange,
   PreferencesRepository,
   UpsertPreferences,
+  UpsertControlValuesUseCase,
 ];
 
 @Module({

apps/api/src/app/bridge/shared/types.ts

@@ -21,6 +21,7 @@ export interface IWorkflowDefineStep {
   type: StepType;
 
   inputs: IStepControl;
+
   controls: IStepControl;
 
   outputs: IStepOutput;

apps/api/src/app/bridge/usecases/index.ts

@@ -1,7 +1,15 @@
+import { UpsertControlValuesUseCase } from '@novu/application-generic';
 import { DeleteWorkflow } from './delete-workflow';
 import { GetBridgeStatus } from './get-bridge-status';
 import { PreviewStep } from './preview-step';
-import { StoreControlVariables } from './store-control-variables';
+import { StoreControlVariablesUseCase } from './store-control-variables';
 import { Sync } from './sync';
 
-export const USECASES = [DeleteWorkflow, GetBridgeStatus, PreviewStep, StoreControlVariables, Sync];
+export const USECASES = [
+  DeleteWorkflow,
+  GetBridgeStatus,
+  PreviewStep,
+  StoreControlVariablesUseCase,
+  Sync,
+  UpsertControlValuesUseCase,
+];

apps/api/src/app/bridge/usecases/store-control-variables/store-control-variables.usecase.ts

@@ -1,33 +1,19 @@
 import { Injectable } from '@nestjs/common';
-import _ from 'lodash';
 import defaults from 'json-schema-defaults';
 
-import { NotificationTemplateRepository, ControlVariablesRepository } from '@novu/dal';
-import { ApiException } from '@novu/application-generic';
-import { ControlVariablesLevelEnum } from '@novu/shared';
+import { NotificationTemplateRepository } from '@novu/dal';
+import { JsonSchema } from '@novu/framework';
 
+import { ApiException, UpsertControlValuesCommand, UpsertControlValuesUseCase } from '@novu/application-generic';
 import { StoreControlVariablesCommand } from './store-control-variables.command';
 
 @Injectable()
-export class StoreControlVariables {
+export class StoreControlVariablesUseCase {
   constructor(
-    private controlVariablesRepository: ControlVariablesRepository,
-    private notificationTemplateRepository: NotificationTemplateRepository
+    private notificationTemplateRepository: NotificationTemplateRepository,
+    private upsertControlValuesUseCase: UpsertControlValuesUseCase
   ) {}
 
-  private difference(object, base) {
-    const changes = (objectControl, baseControl) => {
-      return _.transform(objectControl, function (result, value, key) {
-        if (!_.isEqual(value, base[key])) {
-          // eslint-disable-next-line no-param-reassign
-          result[key] = _.isObject(value) && _.isObject(baseControl[key]) ? changes(value, baseControl[key]) : value;
-        }
-      });
-    };
-
-    return changes(object, base);
-  }
-
   async execute(command: StoreControlVariablesCommand) {
     const workflowExist = await this.notificationTemplateRepository.findByTriggerIdentifier(
       command.environmentId,
@@ -40,60 +26,24 @@ export class StoreControlVariables {
 
     const step = workflowExist?.steps.find((item) => item.stepId === command.stepId);
 
-    if (!step) {
+    if (!step || !step._id) {
       throw new ApiException('Step not found');
     }
 
-    const stepDefault = defaults(
+    const stepDefaultControls = defaults(
       (step.template as any)?.controls?.schema || (step.template as any)?.inputs?.schema,
       {}
+    ) as JsonSchema;
+
+    return await this.upsertControlValuesUseCase.execute(
+      UpsertControlValuesCommand.create({
+        organizationId: command.organizationId,
+        environmentId: command.environmentId,
+        notificationStepEntity: step,
+        workflowId: workflowExist._id,
+        newControlValues: command.variables,
+        controlSchemas: { schema: stepDefaultControls },
+      })
     );
-
-    const variables = this.difference(command.variables, stepDefault);
-
-    const found = await this.controlVariablesRepository.findOne({
-      _environmentId: command.environmentId,
-      _workflowId: workflowExist._id,
-      level: ControlVariablesLevelEnum.STEP_CONTROLS,
-      priority: 0,
-      stepId: command.stepId,
-    });
-
-    if (found) {
-      await this.controlVariablesRepository.update(
-        {
-          _id: found._id,
-          _organizationId: command.organizationId,
-          _environmentId: command.environmentId,
-        },
-        {
-          level: ControlVariablesLevelEnum.STEP_CONTROLS,
-          priority: 0,
-          inputs: variables,
-          controls: variables,
-          workflowId: command.workflowId,
-          stepId: command.stepId,
-        }
-      );
-
-      return this.controlVariablesRepository.findOne({
-        _id: found._id,
-        _organizationId: command.organizationId,
-        _environmentId: command.environmentId,
-      });
-    }
-
-    return await this.controlVariablesRepository.create({
-      _organizationId: command.organizationId,
-      _environmentId: command.environmentId,
-      _workflowId: workflowExist._id,
-      _stepId: step._id,
-      level: ControlVariablesLevelEnum.STEP_CONTROLS,
-      priority: 0,
-      inputs: variables,
-      controls: variables,
-      workflowId: command.workflowId,
-      stepId: command.stepId,
-    });
   }
 }

apps/api/src/app/bridge/usecases/sync/sync.command.ts

@@ -1,8 +1,8 @@
-import { IsString, ValidateNested } from 'class-validator';
+import { IsDefined, IsOptional, IsString, ValidateNested } from 'class-validator';
 import { Type } from 'class-transformer';
 
 import { EnvironmentWithUserCommand, IStepControl } from '@novu/application-generic';
-import { NotificationTemplateCustomData, IPreferenceChannels, StepType } from '@novu/shared';
+import { IPreferenceChannels, NotificationTemplateCustomData, StepType } from '@novu/shared';
 
 import { IStepOutput, IWorkflowDefineStep } from '../../shared';
 
@@ -103,8 +103,16 @@ export interface ICreateBridges {
 }
 
 export class SyncCommand extends EnvironmentWithUserCommand implements ICreateBridges {
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => WorkflowDefine)
   workflows?: WorkflowDefine[];
+
+  @IsString()
+  @IsDefined()
   bridgeUrl: string;
 
+  @IsOptional()
+  @IsString()
   source?: string;
 }

apps/api/src/app/bridge/usecases/sync/sync.usecase.ts

@@ -1,25 +1,25 @@
 import { BadRequestException, Injectable } from '@nestjs/common';
 
 import {
-  NotificationTemplateRepository,
   EnvironmentRepository,
   NotificationGroupRepository,
   NotificationTemplateEntity,
+  NotificationTemplateRepository,
 } from '@novu/dal';
 import {
   AnalyticsService,
   CreateWorkflow,
   CreateWorkflowCommand,
+  ExecuteBridgeRequest,
+  GetFeatureFlag,
+  GetFeatureFlagCommand,
   NotificationStep,
   UpdateWorkflow,
   UpdateWorkflowCommand,
-  ExecuteBridgeRequest,
   UpsertPreferences,
   UpsertWorkflowPreferencesCommand,
-  GetFeatureFlag,
-  GetFeatureFlagCommand,
 } from '@novu/application-generic';
-import { FeatureFlagsKeysEnum, WorkflowTypeEnum } from '@novu/shared';
+import { FeatureFlagsKeysEnum, WorkflowCreationSourceEnum, WorkflowOriginEnum, WorkflowTypeEnum } from '@novu/shared';
 import { DiscoverOutput, DiscoverStepOutput, DiscoverWorkflowOutput, GetActionEnum } from '@novu/framework';
 
 import { SyncCommand } from './sync.command';
@@ -175,13 +175,14 @@ export class Sync {
 
           savedWorkflow = await this.createWorkflowUsecase.execute(
             CreateWorkflowCommand.create({
+              origin: WorkflowOriginEnum.EXTERNAL,
               notificationGroupId,
               draft: !isWorkflowActive,
               environmentId: command.environmentId,
               organizationId: command.organizationId,
               userId: command.userId,
               name: workflow.workflowId,
-              __source: 'bridge',
+              __source: WorkflowCreationSourceEnum.BRIDGE,
               type: WorkflowTypeEnum.BRIDGE,
               steps: this.mapSteps(workflow.steps),
               /** @deprecated */