@midwayjs/web 3.0.0-beta.1 → 3.0.0-beta.13

package/CHANGELOG.md

@@ -3,6 +3,135 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.13](https://github.com/midwayjs/midway/compare/v3.0.0-beta.12...v3.0.0-beta.13) (2021-12-30)
+
+
+### Features
+
+* 404 error ([#1465](https://github.com/midwayjs/midway/issues/1465)) ([e7e8a9d](https://github.com/midwayjs/midway/commit/e7e8a9dedfa7198ac05b161b41024c2871f93965))
+
+
+
+
+
+# [3.0.0-beta.12](https://github.com/midwayjs/midway/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2021-12-28)
+
+
+### Features
+
+* custom error code & add @Files/@Fields ([#1438](https://github.com/midwayjs/midway/issues/1438)) ([b0032af](https://github.com/midwayjs/midway/commit/b0032afd2fa9ea0416fe69f4bd0c1a58bea5314e))
+* support throw err status ([#1440](https://github.com/midwayjs/midway/issues/1440)) ([7b98110](https://github.com/midwayjs/midway/commit/7b98110d65c5287a8fcb3eb5356dea2d7a32cee9))
+
+
+
+
+
+# [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
+
+**Note:** Version bump only for package @midwayjs/web
+
+
+
+
+
+# [3.0.0-beta.10](https://github.com/midwayjs/midway/compare/v3.0.0-beta.9...v3.0.0-beta.10) (2021-12-20)
+
+
+### Features
+
+* default add session  & bodyparser support for koa/express/faas ([#1420](https://github.com/midwayjs/midway/issues/1420)) ([cdaff31](https://github.com/midwayjs/midway/commit/cdaff317c3e862a95494a167995a28280af639bf))
+* implement i18n for validate ([#1426](https://github.com/midwayjs/midway/issues/1426)) ([4c7ed2f](https://github.com/midwayjs/midway/commit/4c7ed2ff2e7ccf10f88f62abad230f92f5e76b97))
+
+
+
+
+
+# [3.0.0-beta.9](https://github.com/midwayjs/midway/compare/v3.0.0-beta.8...v3.0.0-beta.9) (2021-12-09)
+
+**Note:** Version bump only for package @midwayjs/web
+
+
+
+
+
+# [3.0.0-beta.8](https://github.com/midwayjs/midway/compare/v3.0.0-beta.7...v3.0.0-beta.8) (2021-12-08)
+
+
+### Bug Fixes
+
+* express routing middleware takes effect at the controller level ([#1364](https://github.com/midwayjs/midway/issues/1364)) ([b9272e0](https://github.com/midwayjs/midway/commit/b9272e0971003443304b0c53815be31a0061b4bd))
+
+
+
+
+
+# [3.0.0-beta.7](https://github.com/midwayjs/midway/compare/v3.0.0-beta.6...v3.0.0-beta.7) (2021-12-03)
+
+
+### Bug Fixes
+
+* middleware with ctx.body ([#1389](https://github.com/midwayjs/midway/issues/1389)) ([77af5c0](https://github.com/midwayjs/midway/commit/77af5c0b456f1843f4dcfd3dbfd2c0aa244c51bd))
+
+
+
+
+
+# [3.0.0-beta.6](https://github.com/midwayjs/midway/compare/v3.0.0-beta.5...v3.0.0-beta.6) (2021-11-26)
+
+
+### Bug Fixes
+
+* class transformer method missing ([#1387](https://github.com/midwayjs/midway/issues/1387)) ([074e839](https://github.com/midwayjs/midway/commit/074e8393598dc95e2742f735df75a2191c5fe25d))
+
+
+
+
+
+# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
+
+**Note:** Version bump only for package @midwayjs/web
+
+
+
+
+
+# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
+
+
+### Bug Fixes
+
+* logger close before bootstrap close ([#1370](https://github.com/midwayjs/midway/issues/1370)) ([6cc2720](https://github.com/midwayjs/midway/commit/6cc2720ed3445e8ffccc96d124b80ed7e2517f08))
+
+
+### Features
+
+* add i18n ([#1375](https://github.com/midwayjs/midway/issues/1375)) ([bffefe0](https://github.com/midwayjs/midway/commit/bffefe07afe45777d49b5a76b9ab17fc2b9d9a55))
+* auto transform args to type ([#1372](https://github.com/midwayjs/midway/issues/1372)) ([bb3f7d2](https://github.com/midwayjs/midway/commit/bb3f7d2028a034e1926d9df554849332354c3762))
+* support global prefix url ([#1371](https://github.com/midwayjs/midway/issues/1371)) ([cc5fe44](https://github.com/midwayjs/midway/commit/cc5fe44e1d221590562dc71e1f33ae96093e0da7))
+
+
+
+
+
+# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
+
+
+### Features
+
+* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
+
+
+
+
+
+# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
+
+**Note:** Version bump only for package @midwayjs/web
+
+
+
+
+
 # [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
 
 

package/README.md

@@ -5,7 +5,7 @@
 
 this is a sub package for midway.
 
-Document: [https://midwayjs.org/midway](https://midwayjs.org/midway)
+Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 

package/app.js

@@ -24,10 +24,9 @@ class AppBootHook {
   async didLoad() {
     debug('[egg lifecycle]: app didLoad');
     if (this.app.loader['useEggSocketIO']) {
-      // socketio 下会提前加入 session 中间件，这里删除，防止重复加载
-      if (this.app.middleware.length && this.app.middleware[this.app.middleware.length - 1]._name === 'session') {
-        this.app.middleware.pop();
-      }
+      // egg socket.io 需要这个中间件
+      // const session = this.app.getMiddleware().findItem('session');
+      // this.app.middleware.push(session);
     }
   }
 

package/config/plugin.js

@@ -1,13 +1,14 @@
 'use strict';
 
 module.exports = {
+  onerror: true,
+  security: true,
   static: false,
   development: false,
   watcher: false,
-  onerror: true,
-  multipart: true,
-  security: true,
+  multipart: false,
   logrotator: false,
   view: false,
   schedule: false,
+  i18n: false,
 };

package/dist/configuration.d.ts

@@ -1,14 +1,12 @@
 import { IMidwayWebApplication } from './interface';
-import { MidwayWebFramework } from './framework/web';
 import { MidwayDecoratorService } from '@midwayjs/core';
 export declare class EggConfiguration {
     baseDir: any;
     appDir: any;
     app: IMidwayWebApplication;
-    webFramework: MidwayWebFramework;
     decoratorService: MidwayDecoratorService;
     init(): void;
-    onReady(container: any): Promise<void>;
+    onReady(): Promise<void>;
     onServerReady(): Promise<void>;
     onStop(): Promise<void>;
 }

package/dist/configuration.js

@@ -11,18 +11,20 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EggConfiguration = void 0;
 const decorator_1 = require("@midwayjs/decorator");
-const web_1 = require("./framework/web");
 const core_1 = require("@midwayjs/core");
 let EggConfiguration = class EggConfiguration {
     init() {
         this.decoratorService.registerParameterHandler(decorator_1.WEB_ROUTER_PARAM_KEY, options => {
-            return (0, core_1.extractKoaLikeValue)(options.metadata.type, options.metadata.propertyData)(options.originArgs[0], options.originArgs[1]);
+            return (0, core_1.extractKoaLikeValue)(options.metadata.type, options.metadata.propertyData, options.originParamType)(options.originArgs[0], options.originArgs[1]);
         });
     }
-    async onReady(container) { }
+    async onReady() {
+        // ps: 本想在这里清理掉egg添加的中间件，但是这里的数组已经只有一个 midway root middleware，其他的 getter 都是 egg 加进去的，但是不会被中间件执行，所以不需要清理
+        // 去掉为了 egg-socket.io 报错扫进去的 session
+        this.app.middleware = this.app.middleware.slice(0);
+    }
     async onServerReady() {
         // trigger server didReady
-        await this.webFramework.run();
         this.app.messenger.emit('egg-ready');
     }
     async onStop() {
@@ -41,10 +43,6 @@ __decorate([
     (0, decorator_1.App)(),
     __metadata("design:type", Object)
 ], EggConfiguration.prototype, "app", void 0);
-__decorate([
-    (0, decorator_1.Inject)(),
-    __metadata("design:type", web_1.MidwayWebFramework)
-], EggConfiguration.prototype, "webFramework", void 0);
 __decorate([
     (0, decorator_1.Inject)(),
     __metadata("design:type", core_1.MidwayDecoratorService)

package/dist/framework/web.d.ts

@@ -1,12 +1,19 @@
-import { BaseFramework, IMidwayBootstrapOptions } from '@midwayjs/core';
+import { BaseFramework, IMidwayBootstrapOptions, RouterInfo, WebControllerGenerator } from '@midwayjs/core';
 import { MidwayFrameworkType } from '@midwayjs/decorator';
 import { IMidwayWebConfigurationOptions } from '../interface';
+import { EggRouter } from '@eggjs/router';
 import { Application, Context, EggLogger } from 'egg';
+declare class EggControllerGenerator extends WebControllerGenerator<EggRouter> {
+    readonly app: any;
+    constructor(app: any);
+    createRouter(routerOptions: any): EggRouter;
+    generateController(routeInfo: RouterInfo): (ctx: any, next: any) => Promise<void>;
+}
 export declare class MidwayWebFramework extends BaseFramework<Application, Context, IMidwayWebConfigurationOptions> {
     protected loggers: {
         [name: string]: EggLogger;
     };
-    generator: any;
+    generator: EggControllerGenerator;
     private server;
     private agent;
     private isClusterMode;
@@ -20,7 +27,8 @@ export declare class MidwayWebFramework extends BaseFramework<Application, Conte
     run(): Promise<void>;
     getLogger(name?: string): any;
     setContextLoggerClass(BaseContextLogger: any): void;
-    generateMiddleware(middlewareId: string): Promise<any>;
+    generateMiddleware(middlewareId: any): Promise<any>;
     beforeStop(): Promise<void>;
 }
+export {};
 //# sourceMappingURL=web.d.ts.map

package/dist/framework/web.js

@@ -19,19 +19,17 @@ const util_1 = require("util");
 const logger_2 = require("../logger");
 const debug = (0, util_1.debuglog)('midway:debug');
 class EggControllerGenerator extends core_1.WebControllerGenerator {
-    constructor(app, applicationContext, logger) {
-        super(applicationContext, decorator_1.MidwayFrameworkType.WEB, logger);
+    constructor(app) {
+        super(app);
         this.app = app;
-        this.applicationContext = applicationContext;
-        this.logger = logger;
     }
     createRouter(routerOptions) {
         const router = new router_1.EggRouter(routerOptions, this.app);
         router.prefix(routerOptions.prefix);
         return router;
     }
-    generateController(controllerMapping, routeArgsInfo, routerResponseData) {
-        return this.generateKoaController(controllerMapping, routeArgsInfo, routerResponseData);
+    generateController(routeInfo) {
+        return this.generateKoaController(routeInfo);
     }
 }
 let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
@@ -66,43 +64,25 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
         application.agent = agent;
         agent.application = application;
         debug('[egg]: init single process egg end');
-        // https config
-        if (this.configurationOptions.key && this.configurationOptions.cert) {
-            this.configurationOptions.key = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.key);
-            this.configurationOptions.cert = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.cert);
-            this.configurationOptions.ca = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.ca);
-            if (this.configurationOptions.http2) {
-                this.server = require('http2').createSecureServer(this.configurationOptions, this.app.callback());
-            }
-            else {
-                this.server = require('https').createServer(this.configurationOptions, this.app.callback());
-            }
-        }
-        else {
-            if (this.configurationOptions.http2) {
-                this.server = require('http2').createServer(this.app.callback());
-            }
-            else {
-                this.server = require('http').createServer(this.app.callback());
-            }
-        }
     }
     async applicationInitialize(options) {
         if (!this.isClusterMode) {
             await this.initSingleProcessEgg();
         }
+        // not found middleware
+        const notFound = async (ctx, next) => {
+            await next();
+            if (!ctx._matchedRoute) {
+                throw new core_1.httpError.NotFoundError();
+            }
+        };
         // insert error handler
-        this.app.use(async (ctx, next) => {
+        const midwayRootMiddleware = async (ctx, next) => {
             // this.app.createAnonymousContext(ctx);
-            const { result, error } = await (await this.getMiddleware())(ctx, next);
-            if (error) {
-                throw error;
-            }
-            if (result) {
-                ctx.body = result;
-            }
-        });
-        this.generator = new EggControllerGenerator(this.app, this.applicationContext, this.appLogger);
+            await (await this.applyMiddleware(notFound))(ctx, next);
+        };
+        this.app.use(midwayRootMiddleware);
+        this.generator = new EggControllerGenerator(this.app);
         this.overwriteApplication('app');
         await new Promise(resolve => {
             this.app.once('application-ready', () => {
@@ -110,7 +90,7 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
                 resolve();
             });
             this.app.loader.loadOrigin();
-            // hack use method
+            // 这里拦截 app.use 方法，让他可以加到 midway 的 middlewareManager 中
             this.app.originUse = this.app.use;
             this.app.use = this.app.useMiddleware;
             this.app.ready();
@@ -136,7 +116,11 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
         debug(`[egg]: overwrite properties to "${processType}"`);
         this.defineApplicationProperties({
             generateController: (controllerMapping) => {
-                return this.generator.generateController(controllerMapping);
+                const [controllerId, methodName] = controllerMapping.split('.');
+                return this.generator.generateController({
+                    id: controllerId,
+                    method: methodName,
+                });
             },
             generateMiddleware: async (middlewareId) => {
                 return this.generateMiddleware(middlewareId);
@@ -156,19 +140,46 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
             logger_2.MidwayEggContextLogger);
     }
     async loadMidwayController() {
-        await this.generator.loadMidwayController(newRouter => {
-            this.app.use(newRouter.middleware());
+        await this.generator.loadMidwayController(this.configurationOptions.globalPrefix, newRouter => {
+            var _a;
+            const dispatchFn = newRouter.middleware();
+            dispatchFn._name = `midwayController(${((_a = newRouter === null || newRouter === void 0 ? void 0 : newRouter.opts) === null || _a === void 0 ? void 0 : _a.prefix) || '/'})`;
+            this.app.useMiddleware(dispatchFn);
         });
     }
     getFrameworkType() {
         return decorator_1.MidwayFrameworkType.WEB;
     }
     async run() {
+        var _a;
+        // move egg router to last
+        this.app.getMiddleware().findAndInsertLast('eggRouterMiddleware');
         // load controller
         await this.loadMidwayController();
         // restore use method
         this.app.use = this.app.originUse;
+        debug(`[egg]: current middleware = ${this.middlewareManager.getNames()}`);
         if (!this.isClusterMode) {
+            // https config
+            if (this.configurationOptions.key && this.configurationOptions.cert) {
+                this.configurationOptions.key = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.key);
+                this.configurationOptions.cert = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.cert);
+                this.configurationOptions.ca = core_1.PathFileUtil.getFileContentSync(this.configurationOptions.ca);
+                if (this.configurationOptions.http2) {
+                    this.server = require('http2').createSecureServer(this.configurationOptions, this.app.callback());
+                }
+                else {
+                    this.server = require('https').createServer(this.configurationOptions, this.app.callback());
+                }
+            }
+            else {
+                if (this.configurationOptions.http2) {
+                    this.server = require('http2').createServer(this.app.callback());
+                }
+                else {
+                    this.server = require('http').createServer(this.app.callback());
+                }
+            }
             // emit egg-ready message in agent and application
             this.app.messenger.broadcast('egg-ready', undefined);
             // emit `server` event in app
@@ -176,17 +187,21 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
             // register httpServer to applicationContext
             this.getApplicationContext().registerObject(core_1.HTTP_SERVER_KEY, this.server);
             const eggConfig = this.configService.getConfiguration('egg');
-            if (this.configService.getConfiguration('egg')) {
-                new Promise(resolve => {
-                    const args = [eggConfig.port];
-                    if (eggConfig.hostname) {
-                        args.push(eggConfig.hostname);
-                    }
-                    args.push(() => {
-                        resolve();
+            if (!this.isClusterMode && eggConfig) {
+                const customPort = (_a = process.env.MIDWAY_HTTP_PORT) !== null && _a !== void 0 ? _a : eggConfig.port;
+                if (customPort) {
+                    new Promise(resolve => {
+                        const args = [customPort];
+                        if (eggConfig.hostname) {
+                            args.push(eggConfig.hostname);
+                        }
+                        args.push(() => {
+                            resolve();
+                        });
+                        this.server.listen(...args);
+                        process.env.MIDWAY_HTTP_PORT = String(customPort);
                     });
-                    this.server.listen(...args);
-                });
+                }
             }
         }
     }

package/dist/interface.d.ts

@@ -1,28 +1,27 @@
 /// <reference types="node" />
-import { Context as EggContext, Application as EggApplication, EggLogger } from 'egg';
-import { IMidwayContainer, IMidwayContext, Context as IMidwayBaseContext, IMidwayApplication, IMidwayBaseApplication, IConfigurationOptions } from '@midwayjs/core';
-import { DefaultState, Middleware, Next } from 'koa';
+import { Context as EggContext, Application as EggApplication, EggAppConfig } from 'egg';
+import { IMidwayContainer, IMidwayContext, Context as IMidwayBaseContext, IMidwayApplication, IMidwayBaseApplication, IConfigurationOptions, NextFunction as BaseNextFunction } from '@midwayjs/core';
+import { DefaultState, Middleware } from 'koa';
 import { ILogger, LoggerOptions } from '@midwayjs/logger';
 export interface IMidwayWebBaseApplication {
     applicationContext: IMidwayContainer;
-    getLogger(name?: string): EggLogger & ILogger;
-    getCoreLogger(): EggLogger & ILogger;
-    generateController?(controllerMapping: string): any;
-    generateMiddleware?(middlewareId: string): Promise<Middleware<DefaultState, EggContext>>;
-    createLogger(name: string, options: LoggerOptions): EggLogger & ILogger;
+    getLogger(name?: string): ILogger;
+    getCoreLogger(): ILogger;
+    generateMiddleware?(middlewareId: any): Promise<Middleware<DefaultState, EggContext>>;
+    createLogger(name: string, options: LoggerOptions): ILogger;
 }
 declare module 'egg' {
     interface EggAppInfo {
         appDir: string;
     }
-    interface Application extends IMidwayBaseApplication, IMidwayWebBaseApplication {
+    interface Application extends IMidwayBaseApplication<Context>, IMidwayWebBaseApplication {
         createAnonymousContext(...args: any[]): EggContext;
         getCoreLogger(): EggLogger & ILogger;
         getLogger(name?: string): EggLogger & ILogger;
         createLogger(name: string, options: LoggerOptions): EggLogger & ILogger;
     }
     interface Context<ResponseBodyT = any> extends IMidwayBaseContext {
-        getLogger(name?: string): EggLogger & ILogger;
+        getLogger(name?: string): ILogger;
     }
     interface EggAppConfig {
         midwayFeature: {
@@ -36,7 +35,8 @@ export interface Application extends IMidwayWebApplication {
 export interface Context<ResponseBodyT = unknown> extends IMidwayWebContext<ResponseBodyT> {
 }
 export declare type IMidwayWebContext<ResponseBodyT = unknown> = IMidwayContext<EggContext<ResponseBodyT>>;
-export declare type IMidwayWebNext = Next;
+export declare type IMidwayWebNext = BaseNextFunction;
+export declare type NextFunction = BaseNextFunction;
 export interface IMidwayWebConfigurationOptions extends IConfigurationOptions {
     app?: IMidwayWebApplication;
     plugins?: {
@@ -73,9 +73,26 @@ export interface IMidwayWebConfigurationOptions extends IConfigurationOptions {
      * http2 support
      */
     http2?: boolean;
+    /**
+     * http global prefix
+     */
+    globalPrefix?: string;
 }
+/**
+ * @deprecated since version 3.0.0
+ * Please use IMiddleware from @midwayjs/core
+ */
 export declare type MidwayWebMiddleware = Middleware<DefaultState, Context>;
+/**
+ * @deprecated since version 3.0.0
+ * Please use IMiddleware from @midwayjs/core
+ */
 export interface IWebMiddleware {
     resolve(): MidwayWebMiddleware;
 }
+declare module '@midwayjs/core/dist/interface' {
+    interface MidwayConfig extends EggAppConfig {
+        egg?: IMidwayWebConfigurationOptions;
+    }
+}
 //# sourceMappingURL=interface.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/web",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.13",
   "description": "Midway Web Framework for Egg.js",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -27,8 +27,9 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-beta.1",
-    "@midwayjs/mock": "^3.0.0-beta.1",
+    "@midwayjs/decorator": "^3.0.0-beta.13",
+    "@midwayjs/logger": "^3.0.0-beta.13",
+    "@midwayjs/mock": "^3.0.0-beta.13",
     "dayjs": "^1.10.7",
     "egg-logger": "^2.4.2",
     "egg-mock": "^3.26.0",
@@ -43,8 +44,7 @@
   },
   "dependencies": {
     "@eggjs/router": "^2.0.0",
-    "@midwayjs/core": "^3.0.0-beta.1",
-    "@midwayjs/logger": "^3.0.0-beta.1",
+    "@midwayjs/core": "^3.0.0-beta.13",
     "egg": "^2.28.0",
     "extend2": "^1.0.0",
     "find-up": "^5.0.0",
@@ -58,5 +58,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "72e4d20c678e65a5440c4e9a6d3b70046daa497c"
+  "gitHead": "d3c47770fee9dce33a8d148882173fd7782864ad"
 }