Add meta to bot.

prisma/migrations/20240403104825_add_meta_in_bot/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Bot" ADD COLUMN     "meta" JSONB;

prisma/schema.prisma

@@ -94,6 +94,7 @@ model Bot {
   status          BotStatus           @default(DRAFT)
   tags            String[]
   botImage        String?
+  meta            Json?
 }
 
 model UserSegment {

src/modules/bot/bot.controller.spec.ts

@@ -125,6 +125,7 @@ const mockBotData: Prisma.BotGetPayload<{
   "status": "ENABLED",
   "tags": [],
   "botImage": 'testBotImage',
+  "meta": {},
   "users": [
     {
       "id": "testUserId",
@@ -355,4 +356,15 @@ describe('BotController', () => {
     .rejects
     .toThrowError(new BadRequestException(`'botId' is required!`));
   });
+
+  it('update passes meta', async () => {
+    updateParametersPassed = [
+      'meta',
+    ];
+    const resp = await botController.update('testBotId', {
+      'meta': {'myKey': 'myValue'}
+    });
+    expect(resp).toBeTruthy();
+    updateParametersPassed = [];
+  });
 });

src/modules/bot/bot.controller.ts

@@ -325,7 +325,8 @@ export class BotController {
       "ownerID",
       "ownerOrgID",
       "purpose",
-      "description"
+      "description",
+      "meta"
     ];
     const updateBotDto = Object.entries(body).reduce((acc, [key, value]) => {
       if (value !== undefined && fieldsToInclude.includes(key)) {

src/modules/bot/bot.service.spec.ts

@@ -23,6 +23,8 @@ const MockPrismaService = {
         mockBotsDbCopy.description = createData.data.description;
       if (createData.data.status)
         mockBotsDbCopy.status = createData.data.status;
+      if (createData.data.meta)
+        mockBotsDbCopy.meta = createData.data.meta;
       return mockBotsDbCopy;
     },
     findUnique: (filter) => {
@@ -123,6 +125,7 @@ const mockCreateBotDto: CreateBotDto & { ownerID: string; ownerOrgID: string } =
   tags: [],
   ownerID: "",
   ownerOrgID: "",
+  meta: undefined
 };
 
 const mockFile: Express.Multer.File = {
@@ -776,4 +779,33 @@ describe('BotService', () => {
     expect(response!['status']).toStrictEqual('PINNED');
     fetchMock.restore();
   });
+
+  it('bot meta is passed to db', async () => {
+    fetchMock.postOnce(`${configService.get<string>('MINIO_MEDIA_UPLOAD_URL')}`, {
+      fileName: 'testFileName'
+    });
+    const mockCreateBotDtoCopy: CreateBotDto & { ownerID: string; ownerOrgID: string } = { ...mockCreateBotDto };
+    mockCreateBotDtoCopy.meta = { 'myKey': 'myValue' };
+    mockCreateBotDtoCopy.name = 'testBotNotExisting';
+    mockCreateBotDtoCopy.startingMessage = 'testBotStartingMessageNotExisting';
+    const response = await botService.create(mockCreateBotDtoCopy, mockFile);
+    assert(response != null);
+    expect(response!['meta']).toStrictEqual({ 'myKey': 'myValue' });
+    fetchMock.restore();
+  });
+
+  it('bot create throws when meta is of invalid type', async () => {
+    fetchMock.postOnce(`${configService.get<string>('MINIO_MEDIA_UPLOAD_URL')}`, {
+      fileName: 'testFileName'
+    });
+    const mockCreateBotDtoCopy: CreateBotDto & { ownerID: string; ownerOrgID: string } = { ...mockCreateBotDto };
+    //@ts-ignore
+    mockCreateBotDtoCopy.meta = "InvalidStringType";
+    mockCreateBotDtoCopy.name = 'testBotNotExisting';
+    mockCreateBotDtoCopy.startingMessage = 'testBotStartingMessageNotExisting';
+    expect(botService.create(mockCreateBotDtoCopy, mockFile))
+    .rejects
+    .toThrowError(`Required type for 'meta' is JSON, provided: 'string'`);
+    fetchMock.restore();
+  });
 });

src/modules/bot/bot.service.ts

@@ -170,6 +170,9 @@ export class BotService {
     if (!data.name || !data.startingMessage) {
       throw new BadRequestException('Bot name is required!');
     }
+    if (data.meta && typeof data.meta != 'object') {
+      throw new BadRequestException(`Required type for 'meta' is JSON, provided: '${typeof data.meta}'`);
+    }
     const name = data.name.trim();
     const startingMessage = data.startingMessage.trim();
     const alreadyExists = await this.prisma.bot.findFirst({
@@ -250,6 +253,7 @@ export class BotService {
             }),
           },
           botImage: resp.fileName,
+          meta: data.meta,
         };
         const prismaResult = await this.prisma.bot.create({ data: createData });
         this.logger.log(`BotService::create: Bot created successfully. Time taken: ${performance.now() - startTime} milliseconds.`)

src/modules/bot/dto/create-bot.dto.ts

@@ -24,4 +24,5 @@ export class CreateBotDto {
   ownerorgid: string;
   purpose: string | undefined;
   description: string | undefined;
+  meta: Record<string, any> | undefined;
 }