feat(PM-1794): Update workflow implementation

.circleci/config.yml

@@ -76,6 +76,7 @@ workflows:
                               - develop
                               - feat/ai-workflows
                               - pm-1793
+                              - pm-1794
 
             - 'build-prod':
                   context: org-global

src/api/ai-workflow/ai-workflow.controller.ts

@@ -1,16 +1,31 @@
-import { Controller, Post, Body, Get, Param } from '@nestjs/common';
+import {
+  Controller,
+  Post,
+  Body,
+  Get,
+  Param,
+  Patch,
+  ValidationPipe,
+} from '@nestjs/common';
 import {
   ApiBearerAuth,
   ApiTags,
   ApiOperation,
   ApiResponse,
+  ApiParam,
+  ApiBody,
 } from '@nestjs/swagger';
 import { AiWorkflowService } from './ai-workflow.service';
-import { CreateAiWorkflowDto } from '../../dto/aiWorkflow.dto';
+import {
+  CreateAiWorkflowDto,
+  UpdateAiWorkflowDto,
+} from '../../dto/aiWorkflow.dto';
 import { Scopes } from 'src/shared/decorators/scopes.decorator';
 import { UserRole } from 'src/shared/enums/userRole.enum';
 import { Scope } from 'src/shared/enums/scopes.enum';
 import { Roles } from 'src/shared/guards/tokenRoles.guard';
+import { User } from 'src/shared/decorators/user.decorator';
+import { JwtUser } from 'src/shared/modules/global/jwt.service';
 
 @ApiTags('ai_workflow')
 @ApiBearerAuth()
@@ -40,4 +55,29 @@ export class AiWorkflowController {
   async getById(@Param('id') id: string) {
     return this.aiWorkflowService.getWorkflowById(id);
   }
+
+  @Patch('/:id')
+  @Scopes(Scope.UpdateWorkflow)
+  @Roles(UserRole.Admin)
+  @ApiOperation({ summary: 'Update an existing AI workflow' })
+  @ApiParam({
+    name: 'id',
+    description: 'The ID of the AI workflow',
+    example: '229c5PnhSKqsSu',
+  })
+  @ApiBody({ description: 'AI workflow data', type: UpdateAiWorkflowDto })
+  @ApiResponse({
+    status: 200,
+    description: 'AI workflow updated successfully.',
+  })
+  @ApiResponse({ status: 403, description: 'Forbidden.' })
+  @ApiResponse({ status: 404, description: 'AI workflow not found.' })
+  async update(
+    @Param('id') id: string,
+    @Body(new ValidationPipe({ whitelist: true, transform: true }))
+    updateDto: UpdateAiWorkflowDto,
+    @User() user: JwtUser,
+  ) {
+    return this.aiWorkflowService.updateWorkflow(id, updateDto, user.userId);
+  }
 }

src/api/ai-workflow/ai-workflow.service.ts

@@ -1,10 +1,19 @@
-import { Injectable, BadRequestException } from '@nestjs/common';
+import {
+  Injectable,
+  BadRequestException,
+  Logger,
+  NotFoundException,
+} from '@nestjs/common';
 import { PrismaService } from '../../shared/modules/global/prisma.service';
-import { CreateAiWorkflowDto } from '../../dto/aiWorkflow.dto';
+import {
+  CreateAiWorkflowDto,
+  UpdateAiWorkflowDto,
+} from '../../dto/aiWorkflow.dto';
 import { ScorecardStatus } from 'src/dto/scorecard.dto';
 
 @Injectable()
 export class AiWorkflowService {
+  private readonly logger: Logger = new Logger(AiWorkflowService.name);
   constructor(private readonly prisma: PrismaService) {}
 
   async scorecardExists(scorecardId: string): Promise<boolean> {
@@ -26,13 +35,17 @@ export class AiWorkflowService {
 
     const scorecardExists = await this.scorecardExists(scorecardId);
     if (!scorecardExists) {
+      this.logger.error(
+        `Active scorecard with id ${scorecardId} does not exist.`,
+      );
       throw new BadRequestException(
         `Scorecard with id ${scorecardId} does not exist or is not active.`,
       );
     }
 
     const llmExists = await this.llmModelExists(llmId);
     if (!llmExists) {
+      this.logger.error(`LLM model with id ${llmId} does not exist.`);
       throw new BadRequestException(
         `LLM model with id ${llmId} does not exist.`,
       );
@@ -60,8 +73,56 @@ export class AiWorkflowService {
       },
     });
     if (!workflow) {
-      throw new Error(`AI workflow with id ${id} not found.`);
+      this.logger.error(`AI workflow with id ${id} not found.`);
+      throw new NotFoundException(`AI workflow with id ${id} not found.`);
     }
     return workflow;
   }
+
+  async updateWorkflow(
+    id: string,
+    updateDto: UpdateAiWorkflowDto,
+    updatedBy?: string,
+  ) {
+    const existingWorkflow = await this.prisma.aiWorkflow.findUnique({
+      where: { id },
+    });
+    if (!existingWorkflow) {
+      this.logger.error(`AI workflow with id ${id} not found.`);
+      throw new NotFoundException(`AI workflow with id ${id} not found.`);
+    }
+
+    if (updateDto.scorecardId) {
+      const scorecardExists = await this.scorecardExists(updateDto.scorecardId);
+      if (!scorecardExists) {
+        this.logger.error(
+          `Active scorecard with id ${updateDto.scorecardId} does not exist.`,
+        );
+        throw new BadRequestException(
+          `Active scorecard with id ${updateDto.scorecardId} does not exist.`,
+        );
+      }
+    }
+
+    if (updateDto.llmId) {
+      const llmExists = await this.llmModelExists(updateDto.llmId);
+      if (!llmExists) {
+        this.logger.error(
+          `LLM model with id ${updateDto.llmId} does not exist.`,
+        );
+        throw new BadRequestException(
+          `LLM model with id ${updateDto.llmId} does not exist.`,
+        );
+      }
+    }
+
+    return this.prisma.aiWorkflow.update({
+      where: { id },
+      data: {
+        ...updateDto,
+        updatedBy,
+        updatedAt: new Date(),
+      },
+    });
+  }
 }

src/dto/aiWorkflow.dto.ts

@@ -1,4 +1,4 @@
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, PartialType } from '@nestjs/swagger';
 import { IsString, IsNotEmpty } from 'class-validator';
 
 export class CreateAiWorkflowDto {
@@ -42,3 +42,5 @@ export class CreateAiWorkflowDto {
   @IsNotEmpty()
   createdBy: string;
 }
+
+export class UpdateAiWorkflowDto extends PartialType(CreateAiWorkflowDto) {}

src/shared/enums/scopes.enum.ts

@@ -67,6 +67,7 @@ export enum Scope {
   // AI workflow scopes
   CreateWorkflow = 'create:workflow',
   ReadWorkflow = 'read:workflow',
+  UpdateWorkflow = 'update:workflow',
 }
 
 /**