Merge pull request #34 from topcoder-platform/pm-1793

feat(PM-1793): Create AI workflow api implementation

Author: hentrymartin

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

@@ -0,0 +1,33 @@
+import { Controller, Post, Body } from '@nestjs/common';
+import {
+  ApiBearerAuth,
+  ApiTags,
+  ApiOperation,
+  ApiResponse,
+} from '@nestjs/swagger';
+import { AiWorkflowService } from './ai-workflow.service';
+import { CreateAiWorkflowDto } 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';
+
+@ApiTags('ai_workflow')
+@ApiBearerAuth()
+@Controller('/workflows')
+export class AiWorkflowController {
+  constructor(private readonly aiWorkflowService: AiWorkflowService) {}
+
+  @Post()
+  @Roles(UserRole.Admin)
+  @Scopes(Scope.CreateWorkflow)
+  @ApiOperation({ summary: 'Create a new AI workflow' })
+  @ApiResponse({
+    status: 201,
+    description: 'The AI workflow has been successfully created.',
+  })
+  @ApiResponse({ status: 403, description: 'Forbidden.' })
+  async create(@Body() createAiWorkflowDto: CreateAiWorkflowDto) {
+    return this.aiWorkflowService.createWithValidation(createAiWorkflowDto);
+  }
+}

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

@@ -0,0 +1,58 @@
+import { Injectable, BadRequestException } from '@nestjs/common';
+import { PrismaService } from '../../shared/modules/global/prisma.service';
+import { CreateAiWorkflowDto } from '../../dto/aiWorkflow.dto';
+import { ScorecardStatus } from 'src/dto/scorecard.dto';
+
+@Injectable()
+export class AiWorkflowService {
+  constructor(private readonly prisma: PrismaService) {}
+
+  async scorecardExists(scorecardId: string): Promise<boolean> {
+    const count = await this.prisma.scorecard.count({
+      where: { id: scorecardId, status: ScorecardStatus.ACTIVE },
+    });
+    return count > 0;
+  }
+
+  async llmModelExists(llmId: string): Promise<boolean> {
+    const count = await this.prisma.llmModel.count({
+      where: { id: llmId },
+    });
+    return count > 0;
+  }
+
+  async createWithValidation(createAiWorkflowDto: CreateAiWorkflowDto) {
+    const { scorecardId, llmId, name, description, defUrl, gitId, gitOwner } =
+      createAiWorkflowDto;
+
+    const scorecardExists = await this.scorecardExists(scorecardId);
+    if (!scorecardExists) {
+      throw new BadRequestException(
+        `Scorecard with id ${scorecardId} does not exist or is not active.`,
+      );
+    }
+
+    const llmExists = await this.llmModelExists(llmId);
+    if (!llmExists) {
+      throw new BadRequestException(
+        `LLM model with id ${llmId} does not exist.`,
+      );
+    }
+
+    return this.prisma.aiWorkflow.create({
+      data: {
+        defUrl,
+        description,
+        gitId,
+        gitOwner,
+        name,
+        scorecardId,
+        llmId,
+        // TODO: This has to be removed once the prisma middleware is implemented
+        createdBy: '',
+        updatedAt: '',
+        updatedBy: '',
+      },
+    });
+  }
+}

src/api/api.module.ts

@@ -25,6 +25,8 @@ import { WebhookController } from './webhook/webhook.controller';
 import { WebhookService } from './webhook/webhook.service';
 import { GiteaWebhookAuthGuard } from '../shared/guards/gitea-webhook-auth.guard';
 import { ScoreCardService } from './scorecard/scorecard.service';
+import { AiWorkflowService } from './ai-workflow/ai-workflow.service';
+import { AiWorkflowController } from './ai-workflow/ai-workflow.controller';
 
 @Module({
   imports: [HttpModule, GlobalProvidersModule, FileUploadModule],
@@ -42,6 +44,7 @@ import { ScoreCardService } from './scorecard/scorecard.service';
     ReviewApplicationController,
     ReviewHistoryController,
     WebhookController,
+    AiWorkflowController,
   ],
   providers: [
     ReviewOpportunityService,
@@ -53,6 +56,7 @@ import { ScoreCardService } from './scorecard/scorecard.service';
     ScoreCardService,
     SubmissionService,
     ReviewSummationService,
+    AiWorkflowService,
   ],
 })
 export class ApiModule {}

src/dto/aiWorkflow.dto.ts

@@ -0,0 +1,39 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, IsNotEmpty } from 'class-validator';
+
+export class CreateAiWorkflowDto {
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  llmId: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  description: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  defUrl: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  gitId: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  gitOwner: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  scorecardId: string;
+}

src/shared/enums/scopes.enum.ts

@@ -63,6 +63,9 @@ export enum Scope {
   UpdateSubmission = 'update:submission',
   DeleteSubmission = 'delete:submission',
   AllSubmission = 'all:submission',
+
+  // AI workflow scopes
+  CreateWorkflow = 'create:workflow',
 }
 
 /**