Add new workflow runs endpoint

Author: vas3a

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

@@ -70,6 +70,38 @@ export class AiWorkflowController {
     return this.aiWorkflowService.getWorkflows({ name: name?.trim() });
   }
 
+  @Get('/runs')
+  @Roles(
+    UserRole.Admin,
+    UserRole.Copilot,
+    UserRole.ProjectManager,
+    UserRole.Reviewer,
+    UserRole.Submitter,
+    UserRole.User,
+  )
+  @Scopes(Scope.ReadWorkflowRun)
+  @ApiOperation({
+    summary: 'Get all the AI workflow runs for a given submission ID',
+  })
+  @ApiQuery({
+    name: 'submissionId',
+    description: 'The ID of the submission to fetch AI workflow runs for',
+    required: true,
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'The AI workflow runs for the given submission ID.',
+  })
+  @ApiResponse({ status: 403, description: 'Forbidden.' })
+  getSubmissionRuns(
+    @Query('submissionId') submissionId: string,
+    @User() user: JwtUser,
+  ) {
+    return this.aiWorkflowService.getWorkflowRuns(user, {
+      submissionId,
+    });
+  }
+
   @Get(':id')
   @Roles(UserRole.Admin, UserRole.User, UserRole.Copilot, UserRole.Reviewer)
   @Scopes(Scope.ReadWorkflow)
@@ -130,7 +162,8 @@ export class AiWorkflowController {
   )
   @Scopes(Scope.ReadWorkflowRun)
   @ApiOperation({
-    summary: 'Get all the AI workflow runs for a given submission ID',
+    summary:
+      'Get all the AI workflow runs for a given submission ID & workflow ID',
   })
   @ApiQuery({
     name: 'submissionId',
@@ -142,12 +175,13 @@ export class AiWorkflowController {
     description: 'The AI workflow runs for the given submission ID.',
   })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
-  getRuns(
+  getWorkflowRuns(
     @Param('workflowId') workflowId: string,
     @Query('submissionId') submissionId: string,
     @User() user: JwtUser,
   ) {
-    return this.aiWorkflowService.getWorkflowRuns(workflowId, user, {
+    return this.aiWorkflowService.getWorkflowRuns(user, {
+      workflowId,
       submissionId,
     });
   }
@@ -180,13 +214,10 @@ export class AiWorkflowController {
     @Param('runId') runId: string,
     @User() user: JwtUser,
   ) {
-    const runs = await this.aiWorkflowService.getWorkflowRuns(
+    const runs = await this.aiWorkflowService.getWorkflowRuns(user, {
       workflowId,
-      user,
-      {
-        runId,
-      },
-    );
+      runId,
+    });
 
     return runs[0];
   }
@@ -358,6 +389,7 @@ export class AiWorkflowController {
   @Roles(
     UserRole.Admin,
     UserRole.Copilot,
+    UserRole.Reviewer,
     UserRole.ProjectManager,
     UserRole.User,
   )

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

@@ -510,21 +510,53 @@ export class AiWorkflowService {
   }
 
   async getWorkflowRuns(
-    workflowId: string,
     user: JwtUser,
-    filter: { submissionId?: string; runId?: string },
+    filter: { workflowId?: string; submissionId?: string; runId?: string },
   ) {
-    this.logger.log(
-      `fetching workflow runs for workflowId ${workflowId} and ${JSON.stringify(filter)}`,
-    );
+    this.logger.log(`fetching workflow runs for ${JSON.stringify(filter)}`);
+
+    const { workflowId, submissionId } = filter;
 
     // validate workflowId
-    try {
-      await this.getWorkflowById(workflowId);
-    } catch (e) {
-      if (e instanceof NotFoundException) {
-        throw new BadRequestException(
-          `Invalid workflow id provided! Workflow with id ${workflowId} does not exist!`,
+    if (workflowId !== undefined) {
+      console.log('here1');
+
+      try {
+        await this.getWorkflowById(workflowId);
+      } catch (e) {
+        if (e instanceof NotFoundException) {
+          throw new BadRequestException(
+            `Invalid workflow id provided! Workflow with id ${workflowId} does not exist!`,
+          );
+        }
+      }
+    }
+
+    // validate submissionId
+    if (workflowId === undefined && !submissionId?.trim()) {
+      throw new BadRequestException('Submission id is required!');
+    }
+
+    if (submissionId) {
+      try {
+        const submission = await this.prisma.submission.findUnique({
+          where: { id: submissionId },
+        });
+        if (!submission) {
+          throw new BadRequestException(
+            `Invalid submission id provided! Submission with id ${submissionId} does not exist!`,
+          );
+        }
+      } catch (e) {
+        if (e instanceof BadRequestException) {
+          throw e;
+        }
+        this.logger.error(
+          `Failed to validate submission id ${submissionId}`,
+          e,
+        );
+        throw new InternalServerErrorException(
+          'Failed to validate submission id',
         );
       }
     }
@@ -533,7 +565,7 @@ export class AiWorkflowService {
       where: {
         workflowId,
         id: filter.runId,
-        submissionId: filter.submissionId,
+        submissionId,
       },
       include: {
         submission: true,
@@ -729,6 +761,7 @@ export class AiWorkflowService {
     const isM2mOrAdmin = user.isMachine || user.roles?.includes(UserRole.Admin);
     if (!isM2mOrAdmin) {
       const requiredRoles = [
+        UserRole.Screener,
         UserRole.Reviewer,
         UserRole.ProjectManager,
         UserRole.Copilot,