Feat: custom worflow related APIs (#235)

* Feat: custom worflow related APIs

* Fix: naming of description

---------

Co-authored-by: Manoj K <saimanoj58@gmail.com>

Author: harshithmullapudi

apps/server/prisma/migrations/20240904065741_add_description_unique_fields_in_workflow/migration.sql

@@ -0,0 +1,11 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[name,teamId]` on the table `Workflow` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- AlterTable
+ALTER TABLE "Workflow" ADD COLUMN     "description" TEXT;
+
+-- CreateIndex
+CREATE UNIQUE INDEX "_ci" ON "Workflow"("name", "teamId");

apps/server/prisma/schema.prisma

@@ -561,13 +561,16 @@ model Workflow {
   updatedAt DateTime  @updatedAt
   deleted   DateTime?
 
-  name     String
-  position Int
-  color    String
-  category WorkflowCategory
+  name         String
+  description String?
+  position     Int
+  color        String
+  category     WorkflowCategory
 
   team   Team?  @relation(fields: [teamId], references: [id])
   teamId String
+
+  @@unique([name, teamId], map: "_ci")
 }
 
 model Workspace {
@@ -576,9 +579,9 @@ model Workspace {
   updatedAt DateTime  @updatedAt
   deleted   DateTime?
 
-  name         String
-  slug         String  @unique
-  icon         String?
+  name String
+  slug String  @unique
+  icon String?
 
   actionsEnabled Boolean @default(false)
 

apps/server/src/modules/logger/logger.service.ts

@@ -112,7 +112,9 @@ export class LoggerService {
       if (isConsoleFormat) {
         const consoleFormat = [
           chalk.green(loggerPrintFormat.timestamp),
-          chalk.green(loggerPrintFormat.lvl),
+          loggerPrintFormat.lvl === 'ERROR'
+            ? chalk.red(loggerPrintFormat.lvl)
+            : chalk.green(loggerPrintFormat.lvl),
           chalk.blue(loggerPrintFormat.ctx),
           chalk.cyan(loggerPrintFormat.msg),
         ];

apps/server/src/modules/workflows/workflows.controller.ts

@@ -7,15 +7,15 @@ import {
   Post,
   UseGuards,
 } from '@nestjs/common';
-import { Workflow } from '@tegonhq/types';
+import {
+  CreateWorkflowDTO,
+  UpdateWorkflowDTO,
+  Workflow,
+  WorkflowRequestParamsDto,
+} from '@tegonhq/types';
 
 import { AuthGuard } from 'modules/auth/auth.guard';
 
-import {
-  UpdateWorkflowInput,
-  WorkflowRequestIdBody,
-  TeamRequestIdBody,
-} from './workflows.interface';
 import WorkflowsService from './workflows.service';
 
 @Controller({
@@ -28,36 +28,51 @@ export class WorkflowsController {
   @Get()
   @UseGuards(AuthGuard)
   async getAllWorkflows(
-    @Param() teamId: TeamRequestIdBody,
+    @Param() workflowRequestParams: WorkflowRequestParamsDto,
   ): Promise<Workflow[]> {
-    return await this.workflowsService.getAllWorkflows(teamId);
+    return await this.workflowsService.getAllWorkflows(workflowRequestParams);
+  }
+
+  @Post()
+  @UseGuards(AuthGuard)
+  async createWorkflow(
+    @Param() workflowRequestParams: WorkflowRequestParamsDto,
+    @Body() workflowData: CreateWorkflowDTO,
+  ): Promise<Workflow> {
+    return await this.workflowsService.createWorkflow(
+      workflowRequestParams,
+      workflowData,
+    );
   }
 
   @Get(':workflowId')
   @UseGuards(AuthGuard)
   async getWorkflow(
     @Param()
-    workflowId: WorkflowRequestIdBody,
+    workflowRequestParams: WorkflowRequestParamsDto,
   ): Promise<Workflow> {
-    return await this.workflowsService.getWorkflow(workflowId);
+    return await this.workflowsService.getWorkflow(workflowRequestParams);
   }
 
   @Post(':workflowId')
   @UseGuards(AuthGuard)
   async updateWorkflow(
     @Param()
-    workflowId: WorkflowRequestIdBody,
-    @Body() workflowData: UpdateWorkflowInput,
+    workflowRequestParams: WorkflowRequestParamsDto,
+    @Body() workflowData: UpdateWorkflowDTO,
   ): Promise<Workflow> {
-    return await this.workflowsService.updateWorkflow(workflowId, workflowData);
+    return await this.workflowsService.updateWorkflow(
+      workflowRequestParams,
+      workflowData,
+    );
   }
 
   @Delete(':workflowId')
   @UseGuards(AuthGuard)
   async deleteWorkflow(
     @Param()
-    workflowId: WorkflowRequestIdBody,
+    workflowRequestParams: WorkflowRequestParamsDto,
   ): Promise<Workflow> {
-    return await this.workflowsService.deleteWorkflow(workflowId);
+    return await this.workflowsService.deleteWorkflow(workflowRequestParams);
   }
 }

apps/server/src/modules/workflows/workflows.interface.ts

@@ -1,57 +1,134 @@
-import { Injectable } from '@nestjs/common';
-import { Workflow } from '@tegonhq/types';
+import {
+  BadRequestException,
+  Injectable,
+  InternalServerErrorException,
+} from '@nestjs/common';
+import {
+  CreateWorkflowDTO,
+  TeamRequestParamsDto,
+  UpdateWorkflowDTO,
+  Workflow,
+  WorkflowRequestParamsDto,
+} from '@tegonhq/types';
 import { PrismaService } from 'nestjs-prisma';
 
-import {
-  TeamRequestIdBody,
-  UpdateWorkflowInput,
-  WorkflowRequestIdBody,
-} from './workflows.interface';
+import { LoggerService } from 'modules/logger/logger.service';
 
 @Injectable()
 export default class WorkflowsService {
   constructor(private prisma: PrismaService) {}
+  private readonly logger = new LoggerService(WorkflowsService.name);
 
   async getAllWorkflows(
-    teamRequestIdBody: TeamRequestIdBody,
+    workflowRequestParams: WorkflowRequestParamsDto,
   ): Promise<Workflow[]> {
+    this.logger.debug({
+      message: `Fetching all workflows for team ${workflowRequestParams.teamId}`,
+      where: `WorkflowsService.getAllWorkflows`,
+    });
+
     return await this.prisma.workflow.findMany({
       where: {
-        teamId: teamRequestIdBody.teamId,
+        teamId: workflowRequestParams.teamId,
       },
     });
   }
 
   async getWorkflow(
-    WorkflowRequestIdBody: WorkflowRequestIdBody,
+    workflowRequestParams: WorkflowRequestParamsDto,
   ): Promise<Workflow> {
+    this.logger.debug({
+      message: `Fetching workflow with id ${workflowRequestParams.workflowId}`,
+      where: `WorkflowsService.getWorkflow`,
+    });
+
     return await this.prisma.workflow.findUnique({
       where: {
-        id: WorkflowRequestIdBody.workflowId,
+        id: workflowRequestParams.workflowId,
       },
     });
   }
 
+  async createWorkflow(
+    workflowRequestParams: TeamRequestParamsDto,
+    workflowData: CreateWorkflowDTO,
+  ): Promise<Workflow> {
+    this.logger.debug({
+      message: `Creating new workflow for team ${workflowRequestParams.teamId}`,
+      payload: { teamId: workflowRequestParams.teamId, workflowData },
+      where: `WorkflowsService.createWorkflow`,
+    });
+
+    try {
+      return await this.prisma.workflow.create({
+        data: { teamId: workflowRequestParams.teamId, ...workflowData },
+      });
+    } catch (error) {
+      this.logger.error({
+        message: `Error while creating workflow`,
+        where: `WorkflowsService.createWorkflow`,
+        error,
+        payload: workflowData,
+      });
+      if (error.name === 'PrismaClientKnownRequestError') {
+        throw new BadRequestException(
+          'A workflow state with this name and type already exists for this team',
+        );
+      }
+      throw new InternalServerErrorException(
+        error,
+        `Error while creating workflow`,
+      );
+    }
+  }
+
   async updateWorkflow(
-    workflowRequestIdBody: WorkflowRequestIdBody,
-    workflowData: UpdateWorkflowInput,
+    workflowRequestParams: WorkflowRequestParamsDto,
+    workflowData: UpdateWorkflowDTO,
   ): Promise<Workflow> {
-    return await this.prisma.workflow.update({
-      data: {
-        ...workflowData,
-      },
-      where: {
-        id: workflowRequestIdBody.workflowId,
-      },
+    this.logger.debug({
+      message: `Updating workflow with id ${workflowRequestParams.workflowId}`,
+      payload: { workflowId: workflowRequestParams.workflowId, workflowData },
+      where: `WorkflowsService.updateWorkflow`,
     });
+
+    try {
+      return await this.prisma.workflow.update({
+        data: workflowData,
+        where: {
+          id: workflowRequestParams.workflowId,
+        },
+      });
+    } catch (error) {
+      this.logger.error({
+        message: `Error while updating workflow`,
+        where: `WorkflowsService.updateWorkflow`,
+        error,
+        payload: workflowData,
+      });
+      if (error.name === 'PrismaClientKnownRequestError') {
+        throw new BadRequestException(
+          'A workflow state with this name and type already exists for this team',
+        );
+      }
+      throw new InternalServerErrorException(
+        error,
+        `Error while creating workflow`,
+      );
+    }
   }
 
   async deleteWorkflow(
-    workflowRequestIdBody: WorkflowRequestIdBody,
+    workflowRequestParams: WorkflowRequestParamsDto,
   ): Promise<Workflow> {
+    this.logger.debug({
+      message: `Deleting workflow with id ${workflowRequestParams.workflowId}`,
+      where: `WorkflowsService.deleteWorkflow`,
+    });
+
     return await this.prisma.workflow.update({
       where: {
-        id: workflowRequestIdBody.workflowId,
+        id: workflowRequestParams.workflowId,
       },
       data: {
         deleted: new Date().toISOString(),

apps/server/src/modules/workflows/workflows.service.ts

@@ -61,7 +61,9 @@ export default class WorkspacesService {
       const workspace = await prisma.workspace.create({
         data: {
           name: workspaceData.workspaceName,
-          slug: workspaceData.workspaceName.toLowerCase().replace(/-/g, ''),
+          slug: workspaceData.workspaceName
+            .toLowerCase()
+            .replace(/[^a-z0-9]/g, ''),
           usersOnWorkspaces: {
             create: { userId },
           },

apps/server/src/modules/workspaces/workspaces.service.ts

@@ -0,0 +1,19 @@
+import {
+  CreateWorkflowDTO,
+  Workflow,
+  WorkflowRequestParamsDto,
+} from '@tegonhq/types';
+import axios from 'axios';
+
+export interface CreateWorkflowInput
+  extends WorkflowRequestParamsDto,
+    CreateWorkflowDTO {}
+
+export async function createWorkflows({
+  teamId,
+  ...data
+}: CreateWorkflowInput): Promise<Workflow[]> {
+  const response = await axios.post(`/api/v1/${teamId}/workflows`, data);
+
+  return response.data;
+}

packages/services/src/workflow/create-workflow.ts

@@ -1 +1,3 @@
 export * from './get-workflows';
+export * from './create-workflow';
+export * from './update-workflow';