bump koishi

package.json

@@ -33,7 +33,7 @@
   "peerDependencies": {
     "@nestjs/common": "^8.2.6",
     "@nestjs/core": "^8.2.6",
-    "koishi": "^4.6.0",
+    "koishi": "^4.7.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.5.4"
   },
@@ -54,7 +54,7 @@
     "eslint-plugin-prettier": "^3.4.1",
     "express": "^4.17.1",
     "jest": "^27.4.4",
-    "koishi": "4.6.0",
+    "koishi": "4.7.1",
     "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
     "supertest": "^6.1.6",
@@ -64,13 +64,13 @@
   "dependencies": {
     "@nestjs/platform-ws": "^8.1.2",
     "@nestjs/websockets": "^8.1.2",
-    "@types/ws": "^8.2.0",
-    "koa": "^2.13.3",
+    "@types/ws": "^8.5.3",
+    "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
-    "koishi-decorators": "^2.0.0",
+    "koishi-decorators": "^2.1.0",
     "lodash": "^4.17.21",
     "typed-reflector": "^1.0.10",
-    "ws": "^8.2.3"
+    "ws": "^8.6.0"
   },
   "jest": {
     "moduleFileExtensions": [

src/koishi-exception-handler/koishi-exception-handler.service.spec.ts

@@ -9,7 +9,9 @@ describe('KoishiExceptionHandlerService', () => {
       providers: [KoishiExceptionHandlerService],
     }).compile();
 
-    service = module.get<KoishiExceptionHandlerService>(KoishiExceptionHandlerService);
+    service = module.get<KoishiExceptionHandlerService>(
+      KoishiExceptionHandlerService,
+    );
   });
 
   it('should be defined', () => {

src/koishi.service.ts

-import { App, Argv, Command, Context, Router } from 'koishi';
+import { App, Command, Context, Plugin } from 'koishi';
 import {
   Inject,
   Injectable,
-  OnApplicationBootstrap,
   OnModuleDestroy,
   OnModuleInit,
 } from '@nestjs/common';
@@ -20,16 +19,15 @@ import { KoishiHttpDiscoveryService } from './koishi-http-discovery/koishi-http-
 import { Filter, ReplacedContext } from './utility/replaced-context';
 import { applySelector } from 'koishi-decorators';
 import WebSocket from 'ws';
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-Router.prepare = () => {};
+import { KoishiNestRouter } from './utility/koa-router';
+import './utility/commander-with-interceptor';
 
 @Injectable()
 export class KoishiService
   extends App
   implements OnModuleInit, OnModuleDestroy
 {
-  private readonly globalInterceptors: KoishiCommandInterceptorRegistration[];
+  private readonly _interceptors: KoishiCommandInterceptorRegistration[];
   constructor(
     @Inject(KOISHI_MODULE_OPTIONS)
     private readonly koishiModuleOptions: KoishiModuleOptions,
@@ -42,8 +40,8 @@ export class KoishiService
       port: 0,
     });
     this.baseDir ??= process.cwd();
-    this.globalInterceptors = this.koishiModuleOptions.globalInterceptors || [];
-    this.router = new Router();
+    this._interceptors = this.koishiModuleOptions.globalInterceptors || [];
+    this.router = new KoishiNestRouter();
     this._nestKoaTmpInstance.use((ctx, next) => {
       ctx.request.ip = ctx.req[KoishiIpSym];
       return next();
@@ -103,58 +101,20 @@ export class KoishiService
 
   private cloneContext(
     filter: Filter,
-    interceptors: KoishiCommandInterceptorRegistration[] = [],
+    plugin: Plugin,
+    interceptors: KoishiCommandInterceptorRegistration[],
   ): Context {
-    return new ReplacedContext(filter, this, null, [
-      ...this.globalInterceptors,
-      ...interceptors,
-    ]);
+    return new ReplacedContext(filter, this, plugin, interceptors);
   }
 
   withInterceptors(interceptors: KoishiCommandInterceptorRegistration[]) {
-    return this.cloneContext(() => true, interceptors);
-  }
-
-  override any() {
-    return this.cloneContext(() => true);
-  }
-
-  override never() {
-    return this.cloneContext(() => false);
-  }
-
-  override union(arg: Filter | Context) {
-    const filter = typeof arg === 'function' ? arg : arg.filter;
-    return this.cloneContext((s) => this.filter(s) || filter(s));
-  }
-
-  override intersect(arg: Filter | Context) {
-    const filter = typeof arg === 'function' ? arg : arg.filter;
-    return this.cloneContext((s) => this.filter(s) && filter(s));
-  }
-
-  override except(arg: Filter | Context) {
-    const filter = typeof arg === 'function' ? arg : arg.filter;
-    return this.cloneContext((s) => this.filter(s) && !filter(s));
+    return this.cloneContext(this.filter, this.plugin, [
+      ...this._interceptors,
+      ...interceptors,
+    ]);
   }
 
-  override command<D extends string>(
-    def: D,
-    config?: Command.Config,
-  ): Command<never, never, Argv.ArgumentType<D>>;
-  override command<D extends string>(
-    def: D,
-    desc: string,
-    config?: Command.Config,
-  ): Command<never, never, Argv.ArgumentType<D>>;
-  override command(
-    def: string,
-    ...args: [Command.Config?] | [string, Command.Config?]
-  ) {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const cmd = super.command(def, ...args);
-    this.addInterceptors(cmd, this.globalInterceptors);
-    return cmd;
+  override fork(filter: Filter, _plugin: Plugin) {
+    return this.cloneContext(filter, _plugin, this._interceptors);
   }
 }

src/providers/koishi-metascan.service.ts

@@ -80,7 +80,7 @@ export class KoishiMetascanService {
     ctx: Context,
     instance: any,
     property: string,
-    name: keyof Context.Services,
+    name: keyof Context,
   ) {
     Object.defineProperty(instance, property, {
       enumerable: true,
@@ -89,6 +89,8 @@ export class KoishiMetascanService {
         return ctx[name];
       },
       set(val: any) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
         ctx[name] = val;
       },
     });
@@ -114,7 +116,7 @@ export class KoishiMetascanService {
       return;
     }
     for (const property of properties) {
-      const serviceName: keyof Context.Services = Reflect.getMetadata(
+      const serviceName: keyof Context = Reflect.getMetadata(
         KoishiServiceWireProperty,
         instanceClass,
         property,

src/utility/commander-with-interceptor.ts

+import { Command, Commander } from 'koishi';
+import { ReplacedContext } from './replaced-context';
+import { KoishiService } from '../koishi.service';
+
+const oldCommand = Commander.prototype.command;
+Commander.prototype.command = function (this: Commander, ...args: any[]) {
+  const command: Command = oldCommand.call(this, ...args);
+  const ctx = this.caller;
+  const interceptors = (ctx as ReplacedContext)._interceptors;
+  if (interceptors?.length) {
+    (ctx.app as KoishiService).addInterceptors(command, interceptors);
+  }
+  return command;
+};

src/utility/koa-router.ts

+import KoaRouter from '@koa/router';
+import { Context, MaybeArray, remove, WebSocketLayer } from 'koishi';
+import { IncomingMessage } from 'http';
+import WebSocket from 'ws';
+
+export class KoishiNestRouter extends KoaRouter {
+  wsStack: WebSocketLayer[] = [];
+
+  /**
+   * hack into router methods to make sure that koa middlewares are disposable
+   */
+  override register(...args: Parameters<KoaRouter['register']>) {
+    const layer = super.register(...args);
+    const context: Context = this[Context.current];
+    context?.state.disposables.push(() => {
+      remove(this.stack, layer);
+    });
+    return layer;
+  }
+
+  ws(
+    path: MaybeArray<string | RegExp>,
+    callback?: (socket: WebSocket, request: IncomingMessage) => void,
+  ) {
+    const layer = new WebSocketLayer(this, path, callback);
+    this.wsStack.push(layer);
+    const context: Context = this[Context.current];
+    context?.state.disposables.push(() => layer.close());
+    return layer;
+  }
+}

src/utility/koishi.constants.ts

@@ -15,7 +15,7 @@ export const KoishiServiceProvideSym = 'KoishiServiceProvideSym';
 // metadata map
 
 export interface MetadataArrayMap {
-  KoishiServiceProvideSym: keyof Context.Services;
+  KoishiServiceProvideSym: keyof Context;
   KoishiCommandInterceptorDef: KoishiCommandInterceptorRegistration;
 }
 

src/utility/koishi.decorators.ts

@@ -98,9 +98,7 @@ export { PluginDef } from 'koishi-decorators';
 
 // Service
 
-export function WireContextService(
-  name?: keyof Context.Services,
-): PropertyDecorator {
+export function WireContextService(name?: keyof Context): PropertyDecorator {
   return (obj, key) => {
     const objClass = obj.constructor;
     const properties: string[] =
@@ -116,9 +114,7 @@ export function WireContextService(
   };
 }
 
-export function ProvideContextService(
-  name: keyof Context.Services,
-): ClassDecorator {
+export function ProvideContextService(name: keyof Context): ClassDecorator {
   Context.service(name);
   return AppendMetadata(KoishiServiceProvideSym, name);
 }

src/utility/koishi.interfaces.ts

@@ -2,6 +2,7 @@ import { ModuleMetadata, Provider, Type } from '@nestjs/common';
 import { App, Channel, Command, User } from 'koishi';
 import { MetadataArrayMap, MetadataMap } from './koishi.constants';
 import { ContextSelector, PluginDefinition } from 'koishi-decorators';
+
 export * from 'koishi-decorators/dist/src/def/interfaces';
 
 export interface KoishiModuleSelection extends ContextSelector {

src/utility/replaced-context.ts

-import { Argv, Command, Context, Plugin, Session } from 'koishi';
+import { Context, Plugin, Session } from 'koishi';
 import { KoishiService } from '../koishi.service';
 import { KoishiCommandInterceptorRegistration } from './koishi.interfaces';
 
@@ -16,58 +16,20 @@ export class ReplacedContext extends Context {
 
   private cloneContext(
     filter: Filter,
-    interceptors: KoishiCommandInterceptorRegistration[] = [],
+    plugin: Plugin,
+    interceptors: KoishiCommandInterceptorRegistration[],
   ): Context {
-    return new ReplacedContext(filter, this._app, this.__plugin, [
-      ...this._interceptors,
-      ...interceptors,
-    ]);
+    return new ReplacedContext(filter, this._app, plugin, interceptors);
   }
 
   withInterceptors(interceptors: KoishiCommandInterceptorRegistration[]) {
-    return this.cloneContext(this.filter, interceptors);
-  }
-
-  override any() {
-    return this.cloneContext(() => true);
-  }
-
-  override never() {
-    return this.cloneContext(() => false);
-  }
-
-  override union(arg: Filter | Context) {
-    const filter = typeof arg === 'function' ? arg : arg.filter;
-    return this.cloneContext((s) => this.filter(s) || filter(s));
-  }
-
-  override intersect(arg: Filter | Context) {
-    const filter = typeof arg === 'function' ? arg : arg.filter;
-    return this.cloneContext((s) => this.filter(s) && filter(s));
-  }
-
-  override except(arg: Filter | Context) {
-    const filter = typeof arg === 'function' ? arg : arg.filter;
-    return this.cloneContext((s) => this.filter(s) && !filter(s));
+    return this.cloneContext(this.filter, this.plugin, [
+      ...this._interceptors,
+      ...interceptors,
+    ]);
   }
 
-  override command<D extends string>(
-    def: D,
-    config?: Command.Config,
-  ): Command<never, never, Argv.ArgumentType<D>>;
-  override command<D extends string>(
-    def: D,
-    desc: string,
-    config?: Command.Config,
-  ): Command<never, never, Argv.ArgumentType<D>>;
-  override command(
-    def: string,
-    ...args: [Command.Config?] | [string, Command.Config?]
-  ) {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const cmd = super.command(def, ...args);
-    this._app.addInterceptors(cmd, this._interceptors);
-    return cmd;
+  override fork(filter: Filter, _plugin: Plugin) {
+    return this.cloneContext(filter, _plugin, this._interceptors);
   }
 }

tests/fastify.spec.ts

@@ -6,7 +6,6 @@ import { KoishiService } from '../src/koishi.service';
 import { testingModule } from './utility/testing-module';
 import { KoishiWsAdapter } from '../src/koishi.ws-adapter';
 import http from 'http';
-import request from 'supertest';
 
 describe('Koishi module in Fastify adapter', () => {
   let app: NestFastifyApplication;

tests/koishi-tests.spec.ts

@@ -79,7 +79,7 @@ describe('Koishi in Nest.js', () => {
       platform: 'telegram',
     } as Session;
 
-    const methodCtx = command.context;
+    const methodCtx = command.ctx;
     expect(methodCtx.filter(correctSession)).toBe(true);
     expect(methodCtx.filter(wrongSession1)).toBe(false);
     expect(methodCtx.filter(wrongSession2)).toBe(false);

tests/utility/testing-module.ts

 import { Injectable, NotFoundException } from '@nestjs/common';
 import { KoishiCommandInterceptor } from '../../src/utility/koishi.interfaces';
-import { Argv, Context } from 'koishi';
+import { Argv } from 'koishi';
 import {
   CommandUsage,
   OnGuild,
   OnPlatform,
-  PluginDef,
   PutOption,
   UseCommand,
 } from 'koishi-decorators';