Merge pull request #88 from uniocjs/dev-groupguanfang

feat: add middleware customer (#21)

Author: Groupguanfang

.changeset/yellow-rocks-juggle.md

@@ -0,0 +1,5 @@
+---
+"@unioc/adapter-nestjs": patch
+---
+
+feat: add middleware customer (#21)

packages/adapter/adapter-nestjs/src/middleware/middleware-config-proxy.ts

@@ -0,0 +1,71 @@
+import type { MiddlewareConfigProxy, MiddlewareConsumer, NestMiddleware, RouteInfo, Type } from '@nestjs/common/interfaces'
+import type { IPluginContext } from '@unioc/core'
+import type { MiddlewareConsumerBuilder } from './middleware-customer'
+import { isClass } from '@unioc/shared'
+
+export interface IResolvedMiddleware {
+  handler(...args: any[]): any
+  instance?: NestMiddleware
+  routes: (string | Type<any> | RouteInfo)[]
+}
+
+export class MiddlewareConfigProxyBuilder implements MiddlewareConfigProxy {
+  private _excludedRoutes: (string | RouteInfo)[] = []
+  private _routes: (string | Type<any> | RouteInfo)[] = []
+  private _middleware: (Type<any> | ((...args: any[]) => any))[] = []
+
+  constructor(private readonly _middlewareConsumer: MiddlewareConsumerBuilder) {}
+
+  protected getMiddlewareConsumer(): MiddlewareConsumer {
+    this._middlewareConsumer.add(this)
+    return this._middlewareConsumer
+  }
+
+  exclude(...routes: (string | RouteInfo)[]): MiddlewareConfigProxy {
+    this._excludedRoutes = [...this._excludedRoutes, ...routes]
+    return this
+  }
+
+  forRoutes(...routes: (string | Type<any> | RouteInfo)[]): MiddlewareConsumer {
+    this._routes = [...this._routes, ...routes]
+    return this.getMiddlewareConsumer()
+  }
+
+  public getExcludedRoutes(): (string | RouteInfo)[] {
+    return this._excludedRoutes
+  }
+
+  public getRoutes(): (string | Type<any> | RouteInfo)[] {
+    return this._routes
+  }
+
+  public setMiddleware(middleware: (Type<any> | ((...args: any[]) => any))[]): void {
+    this._middleware = middleware
+  }
+
+  public async resolveMiddlewares(ctx: IPluginContext): Promise<IResolvedMiddleware[]> {
+    const handlers: IResolvedMiddleware[] = []
+
+    for (const middleware of this._middleware) {
+      if (isClass(middleware)) {
+        const instance: NestMiddleware = await ctx.createClass(middleware).resolve()
+        if (instance && typeof instance === 'object' && 'use' in instance && typeof instance.use === 'function') {
+          handlers.push({
+            handler: instance.use,
+            instance,
+            routes: this._routes,
+          })
+        }
+      }
+      else {
+        handlers.push({
+          handler: middleware,
+          instance: undefined,
+          routes: this._routes,
+        })
+      }
+    }
+
+    return handlers
+  }
+}

packages/adapter/adapter-nestjs/src/middleware/middleware-customer.ts

@@ -0,0 +1,22 @@
+import type { MiddlewareConsumer, Type } from '@nestjs/common'
+import type { MiddlewareConfigProxy } from '@nestjs/common/interfaces'
+import { MiddlewareConfigProxyBuilder } from './middleware-config-proxy'
+
+export class MiddlewareConsumerBuilder implements MiddlewareConsumer {
+  private _middlewareConfigs: MiddlewareConfigProxyBuilder[] = []
+
+  apply(...middleware: (Type<any> | ((...args: any[]) => any))[]): MiddlewareConfigProxy {
+    const config = new MiddlewareConfigProxyBuilder(this)
+    config.setMiddleware(middleware)
+    return config
+  }
+
+  add(...middlewareConfigs: MiddlewareConfigProxyBuilder[]): MiddlewareConsumer {
+    this._middlewareConfigs = [...this._middlewareConfigs, ...middlewareConfigs]
+    return this
+  }
+
+  public getMiddlewareConfigs(): MiddlewareConfigProxyBuilder[] {
+    return this._middlewareConfigs
+  }
+}

packages/adapter/adapter-nestjs/src/plugin.ts

@@ -1,9 +1,10 @@
-import type { InjectionToken, ModuleMetadata } from '@nestjs/common'
+import type { InjectionToken, ModuleMetadata, NestModule } from '@nestjs/common'
 import type { IPlugin } from '@unioc/core'
 import type { IClass } from '@unioc/shared'
 import { PROPERTY_DEPS_METADATA, SELF_DECLARED_DEPS_METADATA } from '@nestjs/common/constants.js'
 import { AbstractRestfulBootstrap } from '@unioc/web'
 import { ErrorCollector } from './error-collector'
+import { MiddlewareConsumerBuilder } from './middleware/middleware-customer'
 import { NestJSResolver } from './nest-resolver'
 import { NestJSRestfulHandler } from './restful/restful-handler'
 import { NestJSRestfulScanner } from './restful/restful-scanner'
@@ -47,6 +48,24 @@ export function NestJS(options: NestJS.Options = {}): IPlugin {
       bootstrap.addRestfulScanner(scanner)
       bootstrap.createValue(scanner, NestJSRestfulScanner)
       await scanner.resolveAll()
+
+      // apply restful middlewares
+      const modules = nestJSResolver.getResolvedModules()
+      const middlewareConsumer = new MiddlewareConsumerBuilder()
+
+      for (const moduleWrapper of modules) {
+        const resolvedInstance: NestModule = await moduleWrapper.resolve()
+        if (resolvedInstance && typeof resolvedInstance === 'object' && 'configure' in resolvedInstance && typeof resolvedInstance.configure === 'function') {
+          await resolvedInstance.configure(middlewareConsumer)
+        }
+      }
+
+      // apply middlewares
+      const middlewareConfigs = middlewareConsumer.getMiddlewareConfigs()
+      for (const middlewareConfig of middlewareConfigs) {
+        const _middlewares = await middlewareConfig.resolveMiddlewares(this)
+        // TODO
+      }
     },
 
     async resolve(ctx) {