refactor: correct context module

louis-jan · louis-jan · commit b4a5f0a7f7b5 · 2024-06-21T23:20:11.000+07:00
diff --git a/cortex-js/src/app.module.ts b/cortex-js/src/app.module.ts
@@ -15,7 +15,6 @@ import { AppLoggerMiddleware } from './infrastructure/middlewares/app.logger.mid
 import { TelemetryModule } from './usecases/telemetry/telemetry.module';
 import { APP_FILTER } from '@nestjs/core';
 import { GlobalExceptionFilter } from './infrastructure/exception/global.exception';
-import { UtilModule } from './util/util.module';
 import { EventEmitterModule } from '@nestjs/event-emitter';
 import { EventsController } from './infrastructure/controllers/events.controller';
 import { AssistantsController } from './infrastructure/controllers/assistants.controller';
@@ -26,6 +25,7 @@ import { ThreadsController } from './infrastructure/controllers/threads.controll
 import { StatusController } from './infrastructure/controllers/status.controller';
 import { ProcessController } from './infrastructure/controllers/process.controller';
 import { DownloadManagerModule } from './infrastructure/services/download-manager/download-manager.module';
+import { ContextModule } from './infrastructure/services/context/context.module';
 
 @Module({
   imports: [
@@ -48,7 +48,7 @@ import { DownloadManagerModule } from './infrastructure/services/download-manage
     ExtensionModule,
     FileManagerModule,
     TelemetryModule,
-    UtilModule,
+    ContextModule,
     DownloadManagerModule,
   ],
   controllers: [
diff --git a/cortex-js/src/command.module.ts b/cortex-js/src/command.module.ts
@@ -28,12 +28,12 @@ import { KillCommand } from './infrastructure/commanders/kill.command';
 import { PresetCommand } from './infrastructure/commanders/presets.command';
 import { TelemetryModule } from './usecases/telemetry/telemetry.module';
 import { TelemetryCommand } from './infrastructure/commanders/telemetry.command';
-import { UtilModule } from './util/util.module';
 import { EmbeddingCommand } from './infrastructure/commanders/embeddings.command';
 import { BenchmarkCommand } from './infrastructure/commanders/benchmark.command';
 import { EventEmitterModule } from '@nestjs/event-emitter';
 import { DownloadManagerModule } from './infrastructure/services/download-manager/download-manager.module';
 import { ServeStopCommand } from './infrastructure/commanders/sub-commands/serve-stop.command';
+import { ContextModule } from './infrastructure/services/context/context.module';
 
 @Module({
   imports: [
@@ -53,7 +53,7 @@ import { ServeStopCommand } from './infrastructure/commanders/sub-commands/serve
     MessagesModule,
     FileManagerModule,
     TelemetryModule,
-    UtilModule,
+    ContextModule,
     DownloadManagerModule,
   ],
   providers: [
diff --git a/cortex-js/src/command.ts b/cortex-js/src/command.ts
@@ -4,7 +4,7 @@ import { CommandModule } from './command.module';
 import { TelemetryUsecases } from './usecases/telemetry/telemetry.usecases';
 import { TelemetrySource } from './domain/telemetry/telemetry.interface';
 import { AsyncLocalStorage } from 'async_hooks';
-import { ContextService } from './util/context.service';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 export const asyncLocalStorage = new AsyncLocalStorage();
 
diff --git a/cortex-js/src/infrastructure/commanders/chat.command.ts b/cortex-js/src/infrastructure/commanders/chat.command.ts
@@ -9,8 +9,8 @@ import { exit } from 'node:process';
 import { PSCliUsecases } from './usecases/ps.cli.usecases';
 import { ModelsUsecases } from '@/usecases/models/models.usecases';
 import { SetCommandContext } from './decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
 import { ModelStat } from './types/model-stat.interface';
+import { ContextService } from '../services/context/context.service';
 
 type ChatOptions = {
   threadId?: string;
diff --git a/cortex-js/src/infrastructure/commanders/cortex-command.commander.ts b/cortex-js/src/infrastructure/commanders/cortex-command.commander.ts
@@ -11,11 +11,11 @@ import pkg from '@/../package.json';
 import { PresetCommand } from './presets.command';
 import { TelemetryCommand } from './telemetry.command';
 import { SetCommandContext } from './decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
 import { EmbeddingCommand } from './embeddings.command';
 import { BenchmarkCommand } from './benchmark.command';
 import chalk from 'chalk';
 import { printSlogan } from '@/utils/logo';
+import { ContextService } from '../services/context/context.service';
 
 @RootCommand({
   subCommands: [
diff --git a/cortex-js/src/infrastructure/commanders/kill.command.ts b/cortex-js/src/infrastructure/commanders/kill.command.ts
@@ -1,7 +1,7 @@
 import { CommandRunner, SubCommand } from 'nest-commander';
 import { CortexUsecases } from '@/usecases/cortex/cortex.usecases';
 import { SetCommandContext } from './decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '../services/context/context.service';
 
 @SubCommand({
   name: 'kill',
diff --git a/cortex-js/src/infrastructure/commanders/models/model-get.command.ts b/cortex-js/src/infrastructure/commanders/models/model-get.command.ts
@@ -1,8 +1,8 @@
 import { CommandRunner, SubCommand } from 'nest-commander';
 import { ModelsCliUsecases } from '@commanders/usecases/models.cli.usecases';
 import { exit } from 'node:process';
-import { ContextService } from '@/util/context.service';
 import { SetCommandContext } from '../decorators/CommandContext';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 @SubCommand({
   name: 'get',
diff --git a/cortex-js/src/infrastructure/commanders/models/model-list.command.ts b/cortex-js/src/infrastructure/commanders/models/model-list.command.ts
@@ -1,7 +1,7 @@
 import { CommandRunner, SubCommand, Option } from 'nest-commander';
 import { ModelsCliUsecases } from '../usecases/models.cli.usecases';
 import { SetCommandContext } from '../decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 interface ModelListOptions {
   format: 'table' | 'json';
diff --git a/cortex-js/src/infrastructure/commanders/models/model-pull.command.ts b/cortex-js/src/infrastructure/commanders/models/model-pull.command.ts
@@ -1,9 +1,9 @@
 import { CommandRunner, SubCommand } from 'nest-commander';
 import { exit } from 'node:process';
 import { SetCommandContext } from '../decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
 import { ModelsCliUsecases } from '@commanders/usecases/models.cli.usecases';
 import { ModelNotFoundException } from '@/infrastructure/exception/model-not-found.exception';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 @SubCommand({
   name: 'pull',
diff --git a/cortex-js/src/infrastructure/commanders/models/model-remove.command.ts b/cortex-js/src/infrastructure/commanders/models/model-remove.command.ts
@@ -1,8 +1,8 @@
 import { CommandRunner, SubCommand } from 'nest-commander';
 import { ModelsCliUsecases } from '@commanders/usecases/models.cli.usecases';
 import { exit } from 'node:process';
-import { ContextService } from '@/util/context.service';
 import { SetCommandContext } from '../decorators/CommandContext';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 @SubCommand({
   name: 'remove',
diff --git a/cortex-js/src/infrastructure/commanders/models/model-start.command.ts b/cortex-js/src/infrastructure/commanders/models/model-start.command.ts
@@ -8,7 +8,7 @@ import { exit } from 'node:process';
 import { ModelsCliUsecases } from '@commanders/usecases/models.cli.usecases';
 import { CortexUsecases } from '@/usecases/cortex/cortex.usecases';
 import { SetCommandContext } from '../decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 type ModelStartOptions = {
   attach: boolean;
diff --git a/cortex-js/src/infrastructure/commanders/models/model-stop.command.ts b/cortex-js/src/infrastructure/commanders/models/model-stop.command.ts
@@ -2,7 +2,7 @@ import { CommandRunner, SubCommand } from 'nest-commander';
 import { exit } from 'node:process';
 import { ModelsCliUsecases } from '../usecases/models.cli.usecases';
 import { SetCommandContext } from '../decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 @SubCommand({
   name: 'stop',
diff --git a/cortex-js/src/infrastructure/commanders/models/model-update.command.ts b/cortex-js/src/infrastructure/commanders/models/model-update.command.ts
@@ -2,8 +2,8 @@ import { CommandRunner, SubCommand, Option } from 'nest-commander';
 import { ModelsCliUsecases } from '@commanders/usecases/models.cli.usecases';
 import { exit } from 'node:process';
 import { SetCommandContext } from '../decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
 import { UpdateModelDto } from '@/infrastructure/dtos/models/update-model.dto';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 type UpdateOptions = {
   model?: string;
diff --git a/cortex-js/src/infrastructure/commanders/presets.command.ts b/cortex-js/src/infrastructure/commanders/presets.command.ts
@@ -3,7 +3,7 @@ import { readdirSync } from 'fs';
 import { CommandRunner, SubCommand } from 'nest-commander';
 import { join } from 'path';
 import { SetCommandContext } from './decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '../services/context/context.service';
 
 @SubCommand({
   name: 'presets',
diff --git a/cortex-js/src/infrastructure/commanders/ps.command.ts b/cortex-js/src/infrastructure/commanders/ps.command.ts
@@ -1,7 +1,7 @@
 import { CommandRunner, SubCommand } from 'nest-commander';
 import { PSCliUsecases } from './usecases/ps.cli.usecases';
 import { SetCommandContext } from './decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '../services/context/context.service';
 
 @SubCommand({
   name: 'ps',
diff --git a/cortex-js/src/infrastructure/commanders/serve.command.ts b/cortex-js/src/infrastructure/commanders/serve.command.ts
@@ -6,8 +6,8 @@ import {
 import { CommandRunner, SubCommand, Option } from 'nest-commander';
 import { join } from 'path';
 import { SetCommandContext } from './decorators/CommandContext';
-import { ContextService } from '@/util/context.service';
 import { ServeStopCommand } from './sub-commands/serve-stop.command';
+import { ContextService } from '../services/context/context.service';
 
 type ServeOptions = {
   address?: string;
diff --git a/cortex-js/src/infrastructure/controllers/models.controller.spec.ts b/cortex-js/src/infrastructure/controllers/models.controller.spec.ts
@@ -10,7 +10,7 @@ import { ModelRepositoryModule } from '../repositories/models/model.module';
 import { DownloadManagerModule } from '@/infrastructure/services/download-manager/download-manager.module';
 import { EventEmitterModule } from '@nestjs/event-emitter';
 import { TelemetryModule } from '@/usecases/telemetry/telemetry.module';
-import { UtilModule } from '@/util/util.module';
+import { ContextModule } from '../services/context/context.module';
 
 describe('ModelsController', () => {
   let controller: ModelsController;
@@ -28,7 +28,7 @@ describe('ModelsController', () => {
         DownloadManagerModule,
         EventEmitterModule.forRoot(),
         TelemetryModule,
-        UtilModule,
+        ContextModule,
       ],
       controllers: [ModelsController],
       providers: [ModelsUsecases, CortexUsecases],
diff --git a/cortex-js/src/infrastructure/middlewares/app.logger.middleware.ts b/cortex-js/src/infrastructure/middlewares/app.logger.middleware.ts
@@ -1,8 +1,8 @@
 import { TelemetrySource } from '@/domain/telemetry/telemetry.interface';
-import { ContextService } from '@/util/context.service';
 import { Injectable, NestMiddleware, Logger } from '@nestjs/common';
 
 import { Request, Response, NextFunction } from 'express';
+import { ContextService } from '../services/context/context.service';
 
 @Injectable()
 export class AppLoggerMiddleware implements NestMiddleware {
diff --git a/cortex-js/src/infrastructure/services/context/context.module.ts b/cortex-js/src/infrastructure/services/context/context.module.ts
@@ -6,4 +6,4 @@ import { ContextService } from './context.service';
   providers: [ContextService],
   exports: [ContextService],
 })
-export class UtilModule {}
+export class ContextModule {}
diff --git a/cortex-js/src/infrastructure/services/context/context.service.ts b/cortex-js/src/infrastructure/services/context/context.service.ts
diff --git a/cortex-js/src/usecases/models/models.module.ts b/cortex-js/src/usecases/models/models.module.ts
@@ -5,10 +5,10 @@ import { CortexModule } from '@/usecases/cortex/cortex.module';
 import { ExtensionModule } from '@/infrastructure/repositories/extensions/extension.module';
 import { HttpModule } from '@nestjs/axios';
 import { TelemetryModule } from '../telemetry/telemetry.module';
-import { UtilModule } from '@/util/util.module';
 import { FileManagerModule } from '@/infrastructure/services/file-manager/file-manager.module';
 import { ModelRepositoryModule } from '@/infrastructure/repositories/models/model.module';
 import { DownloadManagerModule } from '@/infrastructure/services/download-manager/download-manager.module';
+import { ContextModule } from '@/infrastructure/services/context/context.module';
 
 @Module({
   imports: [
@@ -18,7 +18,7 @@ import { DownloadManagerModule } from '@/infrastructure/services/download-manage
     HttpModule,
     FileManagerModule,
     TelemetryModule,
-    UtilModule,
+    ContextModule,
     ModelRepositoryModule,
     DownloadManagerModule,
   ],
diff --git a/cortex-js/src/usecases/models/models.usecases.spec.ts b/cortex-js/src/usecases/models/models.usecases.spec.ts
@@ -9,7 +9,7 @@ import { ModelRepositoryModule } from '@/infrastructure/repositories/models/mode
 import { DownloadManagerModule } from '@/infrastructure/services/download-manager/download-manager.module';
 import { EventEmitterModule } from '@nestjs/event-emitter';
 import { TelemetryModule } from '../telemetry/telemetry.module';
-import { UtilModule } from '@/util/util.module';
+import { ContextModule } from '@/infrastructure/services/context/context.module';
 
 describe('ModelsService', () => {
   let service: ModelsUsecases;
@@ -29,7 +29,7 @@ describe('ModelsService', () => {
         EventEmitterModule.forRoot(),
         TelemetryModule,
         TelemetryModule,
-        UtilModule,
+        ContextModule,
       ],
       providers: [ModelsUsecases],
       exports: [ModelsUsecases],
diff --git a/cortex-js/src/usecases/models/models.usecases.ts b/cortex-js/src/usecases/models/models.usecases.ts
@@ -21,7 +21,6 @@ import { FileManagerService } from '@/infrastructure/services/file-manager/file-
 import { AxiosError } from 'axios';
 import { TelemetryUsecases } from '../telemetry/telemetry.usecases';
 import { TelemetrySource } from '@/domain/telemetry/telemetry.interface';
-import { ContextService } from '@/util/context.service';
 import { ModelRepository } from '@/domain/repositories/model.interface';
 import { ModelParameterParser } from '@/utils/model-parameter.parser';
 import {
@@ -40,6 +39,7 @@ import { DownloadType } from '@/domain/models/download.interface';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { ModelEvent, ModelId, ModelStatus } from '@/domain/models/model.event';
 import { DownloadManagerService } from '@/infrastructure/services/download-manager/download-manager.service';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 
 @Injectable()
 export class ModelsUsecases {
@@ -146,7 +146,7 @@ export class ModelsUsecases {
    * Start a model by ID
    * @param modelId Model ID
    * @param settings Model settings
-   * @returns
+   * @returns Model start status
    */
   async startModel(
     modelId: string,
@@ -241,6 +241,11 @@ export class ModelsUsecases {
       });
   }
 
+  /**
+   * Stop a running model
+   * @param modelId Model Identifier
+   * @returns Model stop status
+   */
   async stopModel(modelId: string): Promise<StartModelSuccessDto> {
     const model = await this.getModelOrThrow(modelId);
     const engine = (await this.extensionRepository.findOne(
@@ -301,8 +306,8 @@ export class ModelsUsecases {
 
   /**
    * Download a remote model from HuggingFace or Jan's repo
-   * @param modelId
-   * @param callback
+   * @param modelId Model ID
+   * @param callback Callback function to track download progress
    * @returns
    */
   async downloadModel(modelId: string, callback?: (progress: number) => void) {
@@ -385,6 +390,10 @@ export class ModelsUsecases {
     }
   }
 
+  /**
+   * Abort a download
+   * @param downloadId Download ID
+   */
   async abortDownloadModel(downloadId: string) {
     this.downloadManagerService.abortDownload(downloadId);
   }
@@ -465,13 +474,17 @@ export class ModelsUsecases {
   /**
    * Fetches the model data from HuggingFace
    * @param modelId Model repo id. e.g. llama3, llama3:8b, janhq/llama3
-   * @returns
+   * @returns Model metadata
    */
   fetchModelMetadata(modelId: string): Promise<HuggingFaceRepoData> {
     if (modelId.includes('/')) return fetchHuggingFaceRepoData(modelId);
     else return fetchJanRepoData(modelId);
   }
 
+  /**
+   * Get the current status of the models
+   * @returns Model statuses
+   */
   getModelStatuses(): Record<ModelId, ModelStatus> {
     return this.activeModelStatuses;
   }
diff --git a/cortex-js/src/usecases/telemetry/telemetry.module.ts b/cortex-js/src/usecases/telemetry/telemetry.module.ts
@@ -2,11 +2,11 @@ import { Module } from '@nestjs/common';
 import { TelemetryUsecases } from './telemetry.usecases';
 import { HttpModule } from '@nestjs/axios';
 import { DatabaseModule } from '@/infrastructure/database/database.module';
-import { UtilModule } from '@/util/util.module';
 import { FileManagerModule } from '@/infrastructure/services/file-manager/file-manager.module';
+import { ContextModule } from '@/infrastructure/services/context/context.module';
 
 @Module({
-  imports: [HttpModule, DatabaseModule, FileManagerModule, UtilModule],
+  imports: [HttpModule, DatabaseModule, FileManagerModule, ContextModule],
   providers: [TelemetryUsecases],
   exports: [TelemetryUsecases],
 })
diff --git a/cortex-js/src/usecases/telemetry/telemetry.usecases.ts b/cortex-js/src/usecases/telemetry/telemetry.usecases.ts
@@ -4,7 +4,7 @@ import {
   Telemetry,
   TelemetrySource,
 } from '@/domain/telemetry/telemetry.interface';
-import { ContextService } from '@/util/context.service';
+import { ContextService } from '@/infrastructure/services/context/context.service';
 import { HttpException, Inject, Injectable, Scope } from '@nestjs/common';
 
 @Injectable({ scope: Scope.TRANSIENT })
