the modules with controllers were modified to be dynamic

AngelVRodC · AngelVRodC · commit f1391ffbff70 · 2024-12-16T13:46:29.000-05:00
diff --git a/apps/api/src/app/chat/chat.config.ts b/apps/api/src/app/chat/chat.config.ts
@@ -13,10 +13,13 @@ export const assistantParams: AssistantCreateParams = {
 export const assistantConfig: AssistantConfigParams = {
   id: process.env['ASSISTANT_ID'] || '',
   params: assistantParams,
+  assistantPrefix: 'assistant-prefix',
   filesDir: './apps/api/src/app/knowledge',
   toolResources: {
     fileSearch: {
-      fileNames: ['33-things-to-ask-your-digital-product-development-partner.md'],
+      fileNames: [
+        '33-things-to-ask-your-digital-product-development-partner.md',
+      ],
     },
     codeInterpreter: {
       fileNames: [],
diff --git a/apps/api/src/app/chat/chat.module.ts b/apps/api/src/app/chat/chat.module.ts
@@ -5,7 +5,7 @@ import { AgentsModule } from './agents/agents.module';
 import { ChatSockets } from './chat.sockets';
 
 @Module({
-  imports: [AgentsModule, AssistantModule.forRoot(assistantConfig)],
+  imports: [AgentsModule, AssistantModule.register(assistantConfig)],
   providers: [ChatSockets],
 })
 export class ChatModule {}
diff --git a/libs/openai-assistant/src/lib/ai/ai.module.ts b/libs/openai-assistant/src/lib/ai/ai.module.ts
@@ -1,10 +1,26 @@
-import { Module } from '@nestjs/common';
+import { DynamicModule, Module } from '@nestjs/common';
 import { AiService } from './ai.service';
 import { AiController } from './ai.controller';
+import { createControllerWithPrefix } from '../../utils/controllers';
 
 @Module({
   providers: [AiService],
   controllers: [AiController],
   exports: [AiService],
 })
-export class AiModule {}
+export class AiModule {
+  static register(prefix: string): DynamicModule {
+    return {
+      module: AiModule,
+      providers: [
+        AiService,
+        {
+          provide: 'PREFIX',
+          useValue: prefix,
+        },
+      ],
+      controllers: [createControllerWithPrefix(AiController, prefix)],
+      exports: [AiService],
+    };
+  }
+}
diff --git a/libs/openai-assistant/src/lib/assistant/assistant-files.service.ts b/libs/openai-assistant/src/lib/assistant/assistant-files.service.ts
@@ -4,7 +4,6 @@ import { createReadStream } from 'fs';
 import { AiService } from '../ai';
 import { ConfigService } from '../config';
 import { AssistantCreateParams, VectorStore } from 'openai/resources/beta';
-import ToolResources = AssistantCreateParams.ToolResources;
 import { AssistantUpdateParams } from 'openai/resources/beta/assistants';
 import {
   AssistantCodeInterpreter,
@@ -41,7 +40,7 @@ export class AssistantFilesService {
   async getCodeInterpreterResources(
     data: AssistantCodeInterpreter,
     fileDir = '',
-  ): Promise<ToolResources.CodeInterpreter> {
+  ): Promise<AssistantCreateParams.ToolResources.CodeInterpreter> {
     const files = await this.getFiles(data?.fileNames, fileDir);
 
     return { file_ids: files.map(({ id }) => id) };
@@ -50,7 +49,7 @@ export class AssistantFilesService {
   async getFileSearchResources(
     data: AssistantFileSearch,
     fileDir = '',
-  ): Promise<ToolResources.FileSearch> {
+  ): Promise<AssistantCreateParams.ToolResources.FileSearch> {
     if (!data) {
       return { vector_store_ids: [] };
     }
diff --git a/libs/openai-assistant/src/lib/assistant/assistant.model.ts b/libs/openai-assistant/src/lib/assistant/assistant.model.ts
@@ -6,6 +6,7 @@ export interface AssistantConfigParams {
   params: AssistantCreateParams;
   options?: RequestOptions;
   filesDir?: string;
+  assistantPrefix?: string;
   toolResources?: AssistantToolResources | null;
 }
 
diff --git a/libs/openai-assistant/src/lib/assistant/assistant.module.ts b/libs/openai-assistant/src/lib/assistant/assistant.module.ts
@@ -26,20 +26,14 @@ const sharedServices = [
   AssistantMemoryService,
 ];
 
-const sharedModules = [
+const sharedModulesWithoutControllers = [AgentModule, RunModule];
+const sharedModulesWithControllers = [
   AiModule,
-  AgentModule,
-  RunModule,
-  FilesModule,
   ThreadsModule,
+  FilesModule,
   ChatModule,
 ];
 
-@Module({
-  imports: [ConfigModule, HttpModule, ...sharedModules],
-  providers: [...sharedServices],
-  exports: [...sharedServices, ...sharedModules],
-})
 export class AssistantModule implements OnModuleInit {
   constructor(
     private readonly assistantService: AssistantService,
@@ -56,14 +50,29 @@ export class AssistantModule implements OnModuleInit {
     await this.assistantService.init();
   }
 
-  static forRoot(config: AssistantConfigParams): DynamicModule {
+  static register(config: AssistantConfigParams): DynamicModule {
     return {
       module: AssistantModule,
+      imports: [
+        ConfigModule,
+        HttpModule,
+        ...sharedModulesWithoutControllers,
+        ...sharedModulesWithControllers.map(module =>
+          module.register(config?.assistantPrefix || ''),
+        ),
+      ],
       providers: [
         {
           provide: 'config',
           useValue: config,
         },
+        ...sharedServices,
+      ],
+
+      exports: [
+        ...sharedServices,
+        ...sharedModulesWithoutControllers,
+        ...sharedModulesWithControllers,
       ],
     };
   }
diff --git a/libs/openai-assistant/src/lib/chat/chat.controller.ts b/libs/openai-assistant/src/lib/chat/chat.controller.ts
@@ -1,4 +1,6 @@
 import { Body, Controller, Post } from '@nestjs/common';
+import { Type } from '@nestjs/common/interfaces';
+
 import { ApiBody, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { ChatCallDto, ChatCallResponseDto } from './chat.model';
 import { ChatService } from './chat.service';
diff --git a/libs/openai-assistant/src/lib/chat/chat.module.ts b/libs/openai-assistant/src/lib/chat/chat.module.ts
@@ -1,17 +1,28 @@
-import { Module } from '@nestjs/common';
+import { DynamicModule } from '@nestjs/common';
 import { AiModule } from '../ai';
 import { RunModule } from '../run';
 import { ChatHelpers } from './chat.helpers';
 import { ChatService } from './chat.service';
 import { SocketModule } from '@nestjs/websockets/socket-module';
 import { ChatController } from './chat.controller';
+import { createControllerWithPrefix } from '../../utils/controllers';
 
 export const sharedServices = [ChatHelpers, ChatService];
 
-@Module({
-  imports: [SocketModule, AiModule, RunModule],
-  providers: [...sharedServices],
-  controllers: [ChatController],
-  exports: [...sharedServices],
-})
-export class ChatModule {}
+export class ChatModule {
+  static register(prefix: string): DynamicModule {
+    return {
+      module: ChatModule,
+      imports: [SocketModule, AiModule, RunModule],
+      providers: [
+        ...sharedServices,
+        {
+          provide: 'PREFIX',
+          useValue: prefix,
+        },
+      ],
+      controllers: [createControllerWithPrefix(ChatController, prefix)],
+      exports: [...sharedServices],
+    };
+  }
+}
diff --git a/libs/openai-assistant/src/lib/files/files.module.ts b/libs/openai-assistant/src/lib/files/files.module.ts
@@ -1,12 +1,28 @@
-import { Module } from '@nestjs/common';
+import { DynamicModule, Module } from '@nestjs/common';
 import { FilesService } from './files.service';
 import { FilesController } from './files.controller';
 import { AiModule } from '../ai';
+import { createControllerWithPrefix } from '../../utils/controllers';
 
 @Module({
   imports: [AiModule],
   providers: [FilesService],
   controllers: [FilesController],
   exports: [FilesService],
 })
-export class FilesModule {}
+export class FilesModule {
+  static register(prefix: string): DynamicModule {
+    return {
+      module: FilesModule,
+      providers: [
+        AiModule,
+        {
+          provide: 'PREFIX',
+          useValue: prefix,
+        },
+      ],
+      controllers: [createControllerWithPrefix(FilesController, prefix)],
+      exports: [FilesService],
+    };
+  }
+}
diff --git a/libs/openai-assistant/src/lib/threads/threads.module.ts b/libs/openai-assistant/src/lib/threads/threads.module.ts
@@ -1,12 +1,28 @@
-import { Module } from '@nestjs/common';
+import { DynamicModule, Module } from '@nestjs/common';
 import { ThreadsController } from './threads.controller';
 import { ThreadsService } from './threads.service';
 import { AiModule } from '../ai';
+import { createControllerWithPrefix } from '../../utils/controllers';
 
 @Module({
   imports: [AiModule],
   providers: [ThreadsService],
   controllers: [ThreadsController],
   exports: [ThreadsService],
 })
-export class ThreadsModule {}
+export class ThreadsModule {
+  static register(prefix: string): DynamicModule {
+    return {
+      module: ThreadsModule,
+      providers: [
+        ThreadsService,
+        {
+          provide: 'PREFIX',
+          useValue: prefix,
+        },
+      ],
+      controllers: [createControllerWithPrefix(ThreadsController, prefix)],
+      exports: [ThreadsService],
+    };
+  }
+}
diff --git a/libs/openai-assistant/src/utils/controller.spec.ts b/libs/openai-assistant/src/utils/controller.spec.ts
@@ -0,0 +1,35 @@
+import { Controller, Get } from '@nestjs/common';
+import { createControllerWithPrefix } from './controllers';
+import 'reflect-metadata';
+
+@Controller('test')
+class TestController {
+  @Get()
+  getTest(): string {
+    return 'Original Controller';
+  }
+}
+
+describe('createControllerWithPrefix', () => {
+  it('should create a new controller with the prefixed route', () => {
+    const PrefixedController = createControllerWithPrefix(
+      TestController,
+      'api',
+    );
+
+    const originalPath = Reflect.getMetadata('path', TestController);
+    const prefixedPath = Reflect.getMetadata('path', PrefixedController);
+
+    expect(originalPath).toBe('test');
+
+    expect(prefixedPath).toBe('api/test');
+  });
+
+  it('should throw an error if the controller does not have @Controller decorator', () => {
+    class InvalidController {}
+
+    expect(() => createControllerWithPrefix(InvalidController, 'api')).toThrow(
+      'The provided controller does not have a @Controller decorator.',
+    );
+  });
+});
diff --git a/libs/openai-assistant/src/utils/controllers.ts b/libs/openai-assistant/src/utils/controllers.ts
@@ -0,0 +1,24 @@
+import { Controller } from '@nestjs/common';
+import { Type } from '@nestjs/common/interfaces';
+import 'reflect-metadata';
+
+export function createControllerWithPrefix<T extends object>(
+  controller: Type<T>,
+  prefix: string,
+): Type<T> {
+  const originalPath = Reflect.getMetadata('path', controller) as
+    | string
+    | undefined;
+
+  if (!originalPath) {
+    throw new Error(
+      'The provided controller does not have a @Controller decorator.',
+    );
+  }
+
+  const DynamicController = class extends controller {};
+
+  Controller(`${prefix}/${originalPath}`)(DynamicController);
+
+  return DynamicController;
+}
diff --git a/package-lock.json b/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ export interface AssistantConfigParams {`
`6`	`6`	`params: AssistantCreateParams;`
`7`	`7`	`options?: RequestOptions;`
`8`	`8`	`filesDir?: string;`
	`9`	`+ assistantPrefix?: string;`
`9`	`10`	`toolResources?: AssistantToolResources \| null;`
`10`	`11`	`}`
`11`	`12`