fix(platform-http): update the adapter configuration to be aligned with DI convention

Author: Romakita

packages/platform/platform-express/src/components/PlatformExpress.ts

@@ -64,17 +64,6 @@ declare global {
 export class PlatformExpress extends PlatformAdapter<Express.Application> {
   readonly NAME = "express";
 
-  readonly providers = [
-    {
-      token: PlatformHandler,
-      useClass: PlatformExpressHandler
-    },
-    {token: PlatformResponse},
-    {token: PlatformRequest},
-    {token: PlatformApplication},
-    {token: Platform}
-  ];
-
   #multer: typeof multer;
 
   constructor() {
@@ -286,4 +275,9 @@ export class PlatformExpress extends PlatformAdapter<Express.Application> {
   }
 }
 
-adapter(PlatformExpress);
+adapter(PlatformExpress, [
+  {
+    token: PlatformHandler,
+    useClass: PlatformExpressHandler
+  }
+]);

packages/platform/platform-express/vitest.config.mts

@@ -10,12 +10,12 @@ export default defineConfig(
       coverage: {
         ...presets.test.coverage,
         thresholds: {
-          statements: 96.63,
+          statements: 96.61,
           branches: 95,
           functions: 100,
-          lines: 96.63
+          lines: 96.61
         }
       }
     }
   }
-);
+);

packages/platform/platform-http/src/common/fn/adapter.ts

@@ -1,20 +1,39 @@
 import {Type} from "@tsed/core";
-import {refValue} from "@tsed/di";
+import {GlobalProviders, injector, ProviderOpts, refValue} from "@tsed/di";
 
-import type {PlatformAdapter} from "../services/PlatformAdapter.js";
+import {PlatformAdapter} from "../services/PlatformAdapter.js";
 
 const ADAPTER = "platform.adapter";
 
 let globalAdapter: Type<PlatformAdapter<any>>;
 
 /**
- * Set the platform adapter
+ * Set the platform adapter token and his dependencies
  */
-export function adapter(adapter?: Type<PlatformAdapter<any>>): Type<PlatformAdapter<any>> {
+export function adapter(adapter: Type<PlatformAdapter<any>>, imports?: ProviderOpts[]): Type<PlatformAdapter<any>>;
+/**
+ * Get the platform adapter token
+ */
+export function adapter(): Type<PlatformAdapter<any>>;
+export function adapter(adapter?: Type<PlatformAdapter<any>>, imports: ProviderOpts[] = []): Type<PlatformAdapter<any>> {
   const ref = refValue<Type<PlatformAdapter<any>>>(ADAPTER);
 
   if (adapter) {
     globalAdapter ||= adapter;
+
+    imports?.forEach(({token, useClass}) => {
+      const provider = GlobalProviders.get(token);
+      if (useClass && provider) {
+        provider.useClass = useClass;
+        injector().set(token, provider);
+      }
+    });
+
+    injector()
+      .addProvider(PlatformAdapter, {
+        useClass: adapter
+      })
+      .alias(PlatformAdapter, "PlatformAdapter");
   }
 
   ref.value ||= globalAdapter;

packages/platform/platform-http/src/common/middlewares/PlatformMulterMiddleware.spec.ts

@@ -1,11 +1,13 @@
 import {catchAsyncError} from "@tsed/core";
+import {inject} from "@tsed/di";
 import {Exception} from "@tsed/exceptions";
 import {MulterError} from "multer";
 
 import {PlatformTest} from "../../testing/PlatformTest.js";
 import {MulterOptions} from "../decorators/multer/multerOptions.js";
 import {MultipartFile} from "../decorators/multer/multipartFile.js";
 import {EndpointMetadata} from "../domain/EndpointMetadata.js";
+import {PlatformAdapter} from "../services/PlatformAdapter.js";
 import {PlatformApplication} from "../services/PlatformApplication.js";
 import {PlatformMulterMiddleware} from "./PlatformMulterMiddleware.js";
 
@@ -19,20 +21,16 @@ async function build(options = {}) {
   const multer = {
     fields: vi.fn().mockReturnValue(multerMiddleware)
   };
-  const app = {
-    multer: vi.fn().mockReturnValue(multer)
-  };
 
-  const middleware = await PlatformTest.invoke<PlatformMulterMiddleware>(PlatformMulterMiddleware, [
-    {
-      token: PlatformApplication,
-      use: app
-    }
-  ]);
+  const middleware = inject(PlatformMulterMiddleware);
   const ctx: any = PlatformTest.createRequestContext();
   ctx.endpoint = EndpointMetadata.get(Test, "upload");
 
-  return {middleware, ctx, multer, app, multerMiddleware};
+  const adapter = inject(PlatformAdapter);
+
+  vi.spyOn(adapter, "multipart").mockReturnValue(multer as any);
+
+  return {middleware, ctx, multer, adapter, multerMiddleware};
 }
 
 describe("PlatformMulterMiddleware", () => {
@@ -45,24 +43,24 @@ describe("PlatformMulterMiddleware", () => {
   );
   afterEach(() => PlatformTest.reset());
   it("should create middleware", async () => {
-    const {middleware, ctx, multer, app, multerMiddleware} = await build({});
+    const {middleware, ctx, multer, adapter, multerMiddleware} = await build({});
 
     await middleware.use(ctx);
 
-    expect(app.multer).toHaveBeenCalledWith({
+    expect(adapter.multipart).toHaveBeenCalledWith({
       dest: "/dest"
     });
     expect(multer.fields).toHaveBeenCalledWith([{maxCount: undefined, name: "file1"}]);
     expect(multerMiddleware).toHaveBeenCalledWith(ctx.request.raw, ctx.response.raw);
   });
   it("should create middleware with storage", async () => {
-    const {middleware, ctx, multer, app, multerMiddleware} = await build({
+    const {middleware, ctx, multer, adapter, multerMiddleware} = await build({
       storage: "storage"
     });
 
     await middleware.use(ctx);
 
-    expect(app.multer).toHaveBeenCalledWith({
+    expect(adapter.multipart).toHaveBeenCalledWith({
       storage: "storage"
     });
     expect(multer.fields).toHaveBeenCalledWith([{maxCount: undefined, name: "file1"}]);

packages/platform/platform-http/src/common/middlewares/PlatformMulterMiddleware.ts

@@ -6,6 +6,7 @@ import type {MulterError} from "multer";
 
 import {PlatformMulterField, PlatformMulterSettings} from "../config/interfaces/PlatformMulterSettings.js";
 import {PlatformContext} from "../domain/PlatformContext.js";
+import {PlatformAdapter} from "../services/PlatformAdapter.js";
 import {PlatformApplication} from "../services/PlatformApplication.js";
 
 export interface MulterInputOptions {
@@ -24,8 +25,6 @@ export class MulterException extends BadRequest {
  * @middleware
  */
 export class PlatformMulterMiddleware implements MiddlewareMethods {
-  protected app = inject(PlatformApplication);
-
   async use(@Context() ctx: PlatformContext) {
     try {
       const {fields, options = {}} = ctx.endpoint.get(PlatformMulterMiddleware);
@@ -39,7 +38,7 @@ export class PlatformMulterMiddleware implements MiddlewareMethods {
         delete settings.dest;
       }
 
-      const multer = this.app.multer(settings);
+      const multer = inject(PlatformAdapter).multipart(settings);
 
       if (multer) {
         const middleware: any = multer.fields(this.getFields({fields}));

packages/platform/platform-http/src/common/services/PlatformAdapter.ts

@@ -1,7 +1,8 @@
 import {IncomingMessage, ServerResponse} from "node:http";
 
 import {Type} from "@tsed/core";
-import {injectable, ProviderOpts} from "@tsed/di";
+import {configuration, constant, inject, injectable} from "@tsed/di";
+import {$on} from "@tsed/hooks";
 import {PlatformHandlerMetadata, PlatformLayer} from "@tsed/platform-router";
 
 import {PlatformMulter, PlatformMulterSettings} from "../config/interfaces/PlatformMulterSettings.js";
@@ -10,17 +11,25 @@ import {application} from "../fn/application.js";
 import {createHttpServer} from "../utils/createHttpServer.js";
 import {createHttpsServer} from "../utils/createHttpsServer.js";
 import {CreateServerReturn} from "../utils/createServer.js";
-import type {PlatformApplication} from "./PlatformApplication.js";
+import {Platform} from "./Platform.js";
+import {PlatformApplication} from "./PlatformApplication.js";
+import {PlatformHandler} from "./PlatformHandler.js";
 
 export abstract class PlatformAdapter<App = TsED.Application> {
   abstract readonly NAME: string;
-  /**
-   * Load providers in top priority
-   */
-  providers: ProviderOpts[] = [];
 
-  get app(): PlatformApplication<App> {
-    return application();
+  readonly app = inject<PlatformApplication<App>>(PlatformApplication);
+
+  constructor() {
+    const platformApp = inject(PlatformApplication);
+
+    const {app, callback} = this.createApp();
+    platformApp.rawApp = app as any;
+    platformApp.rawCallback = callback;
+
+    $on("$afterInvoke", PlatformAdapter, () => {
+      configuration().set("PLATFORM_NAME", constant("PLATFORM_NAME") || this.NAME);
+    });
   }
 
   getServers(): CreateServerReturn[] {
@@ -87,4 +96,4 @@ export interface PlatformBuilderSettings<App = TsED.Application> extends Partial
   adapter?: Type<PlatformAdapter<App>>;
 }
 
-injectable(PlatformAdapter).alias("PlatformAdapter");
+injectable(PlatformAdapter).imports([PlatformApplication, Platform, PlatformHandler]).alias("PlatformAdapter");

packages/platform/platform-http/src/common/services/PlatformApplication.spec.ts

@@ -33,7 +33,6 @@ async function getPlatformApp() {
   ]);
   configuration().logger = {};
   platformApp.rawApp = createDriver() as any;
-  vi.spyOn(platformApp, "multer").mockReturnValue({} as never);
 
   return {platformApp, platformHandler};
 }
@@ -63,17 +62,6 @@ describe("PlatformApplication", () => {
       platformApp.statics("/", {root: "/root"});
     });
   });
-  describe("multer()", () => {
-    it("should call statics", async () => {
-      // GIVEN
-      const {platformApp} = await getPlatformApp();
-
-      vi.spyOn(console, "warn");
-
-      // WHEN
-      platformApp.multer({});
-    });
-  });
 
   describe("callback()", () => {
     it("should return the callback", async () => {

packages/platform/platform-http/src/common/services/PlatformApplication.ts

@@ -1,11 +1,8 @@
 import {IncomingMessage, ServerResponse} from "node:http";
 
-import {inject, injectable, ProviderScope} from "@tsed/di";
+import {injectable, ProviderScope} from "@tsed/di";
 import {PlatformRouter} from "@tsed/platform-router";
 
-import {PlatformMulterSettings} from "../config/interfaces/PlatformMulterSettings.js";
-import {PlatformAdapter} from "./PlatformAdapter.js";
-
 declare global {
   namespace TsED {
     // @ts-ignore
@@ -19,28 +16,14 @@ declare global {
  * @platform
  */
 export class PlatformApplication<App = TsED.Application> extends PlatformRouter {
-  adapter: PlatformAdapter<App> = inject(PlatformAdapter<App>);
-
   rawApp: App;
-  rawCallback: () => any;
 
-  constructor() {
-    super();
-
-    const {app, callback} = this.adapter.createApp();
-
-    this.rawApp = app;
-    this.rawCallback = callback;
-  }
+  rawCallback(): any {}
 
   getApp(): App {
     return this.rawApp;
   }
 
-  multer(options: PlatformMulterSettings) {
-    return this.adapter.multipart(options);
-  }
-
   callback(): (req: IncomingMessage, res: ServerResponse) => any;
   callback(req: IncomingMessage, res: ServerResponse): any;
   callback(req?: IncomingMessage, res?: ServerResponse) {

packages/platform/platform-http/src/common/services/PlatformHandler.ts

@@ -15,7 +15,7 @@ import {JsonOperationRoute} from "@tsed/schema";
 import {AnyToPromiseWithCtx} from "../domain/AnyToPromiseWithCtx.js";
 import {PlatformContext} from "../domain/PlatformContext.js";
 import {setResponseHeaders} from "../utils/setResponseHeaders.js";
-import {PlatformApplication} from "./PlatformApplication.js";
+import {PlatformAdapter} from "./PlatformAdapter.js";
 import {PlatformMiddlewaresChain} from "./PlatformMiddlewaresChain.js";
 
 /**
@@ -26,7 +26,6 @@ export class PlatformHandler {
   protected responseFilter = inject(PlatformResponseFilter);
   protected platformParams = inject(PlatformParams);
   protected platformExceptions = inject(PlatformExceptions);
-  protected platformApplication = inject(PlatformApplication);
   protected platformMiddlewaresChain = inject(PlatformMiddlewaresChain);
   protected platformRouters = inject(PlatformRouters);
 
@@ -43,7 +42,7 @@ export class PlatformHandler {
       .on("alterHandler", (handlerMetadata: PlatformHandlerMetadata) => {
         const handler = handlerMetadata.isInjectable() ? this.createHandler(handlerMetadata) : handlerMetadata.handler;
 
-        return this.platformApplication.adapter.mapHandler(handler, handlerMetadata);
+        return inject(PlatformAdapter).mapHandler(handler, handlerMetadata);
       });
   }
 

packages/platform/platform-http/src/common/services/PlatformMiddlewaresChain.ts

@@ -1,16 +1,14 @@
 import {isClass} from "@tsed/core";
-import {constant, inject, injectable} from "@tsed/di";
+import {constant, injectable} from "@tsed/di";
 import {ParamTypes} from "@tsed/platform-params";
 import {AlterEndpointHandlersArg} from "@tsed/platform-router";
 import {JsonEntityStore, JsonOperationRoute} from "@tsed/schema";
 
 import {PlatformAcceptMimesMiddleware} from "../middlewares/PlatformAcceptMimesMiddleware.js";
 import {PlatformMulterMiddleware} from "../middlewares/PlatformMulterMiddleware.js";
-import {PlatformAdapter} from "./PlatformAdapter.js";
 
 export class PlatformMiddlewaresChain {
   protected acceptMimes = constant<string[]>("acceptMimes", []);
-  protected adapter = inject(PlatformAdapter);
 
   get(handlers: AlterEndpointHandlersArg, operationRoute: JsonOperationRoute): AlterEndpointHandlersArg {
     const {ACCEPT_MIMES, FILE} = this.getParamTypes(handlers, operationRoute);