@modern-js/server 1.1.2 → 1.1.4-rc.0

package/src/server/modern-server.ts

@@ -1,10 +1,10 @@
 /* eslint-disable max-lines */
-import { IncomingMessage, ServerResponse, Server } from 'http';
+import { IncomingMessage, ServerResponse, Server, createServer } from 'http';
 import util from 'util';
 import path from 'path';
 import { fs, ROUTE_SPEC_FILE } from '@modern-js/utils';
-import { Adapter } from '@modern-js/server-plugin';
-import { gather, createMiddlewareCollecter } from '@modern-js/server-utils';
+import { Adapter, APIServerStartInput } from '@modern-js/server-plugin';
+import { createMiddlewareCollecter } from '@modern-js/server-utils';
 import type { NormalizedConfig } from '@modern-js/core';
 import mime from 'mime-types';
 import axios from 'axios';
@@ -16,13 +16,18 @@ import {
   Logger,
   ReadyOptions,
   ConfWithBFF,
-} from '../type';
-import { RouteMatchManager, ModernRouteInterface } from '../libs/route';
-import { createRenderHandler } from '../libs/render';
-import { createStaticFileHandler } from '../libs/serve-file';
-import { createErrorDocument, mergeExtension, noop } from '../utils';
-import * as reader from '../libs/render/reader';
-import { createProxyHandler, ProxyOptions } from '../libs/proxy';
+} from '@/type';
+import {
+  RouteMatchManager,
+  ModernRouteInterface,
+  ModernRoute,
+  RouteMatcher,
+} from '@/libs/route';
+import { createRenderHandler } from '@/libs/render';
+import { createStaticFileHandler } from '@/libs/serve-file';
+import { createErrorDocument, mergeExtension, noop } from '@/utils';
+import * as reader from '@/libs/render/reader';
+import { createProxyHandler, ProxyOptions } from '@/libs/proxy';
 import { createContext, ModernServerContext } from '@/libs/context';
 import {
   AGGRED_DIR,
@@ -30,7 +35,8 @@ import {
   ERROR_DIGEST,
   ERROR_PAGE_TEXT,
 } from '@/constants';
-import { createTemplateAPI } from '@/libs/hook-api';
+import { createTemplateAPI } from '@/libs/hook-api/template';
+import { createRouteAPI } from '@/libs/hook-api/route';
 
 type ModernServerHandler = (
   context: ModernServerContext,
@@ -63,11 +69,13 @@ export class ModernServer {
 
   protected presetRoutes?: ModernRouteInterface[];
 
+  protected runner!: ServerHookRunner;
+
   protected readonly logger: Logger;
 
   protected readonly measure: Measure;
 
-  private readonly runner: ServerHookRunner;
+  protected readonly proxyTarget: ModernServerOptions['proxyTarget'];
 
   private readonly isDev: boolean = false;
 
@@ -85,30 +93,28 @@ export class ModernServer {
 
   private proxyHandler: ReturnType<typeof createProxyHandler> = null;
 
-  constructor(
-    {
-      pwd,
-      config,
-      dev,
-      routes,
-      staticGenerate,
-      logger,
-      measure,
-    }: ModernServerOptions,
-    runner: ServerHookRunner,
-  ) {
+  constructor({
+    pwd,
+    config,
+    dev,
+    routes,
+    staticGenerate,
+    logger,
+    measure,
+    proxyTarget,
+  }: ModernServerOptions) {
     require('ignore-styles');
     this.isDev = Boolean(dev);
 
     this.pwd = pwd;
-    this.distDir = path.join(pwd, config.output.path || '');
+    this.distDir = path.join(pwd, config.output.path || 'dist');
     this.workDir = this.isDev ? pwd : this.distDir;
     this.conf = config;
-    this.runner = runner;
     this.logger = logger!;
     this.measure = measure!;
     this.router = new RouteMatchManager();
     this.presetRoutes = routes;
+    this.proxyTarget = proxyTarget;
 
     if (staticGenerate) {
       this.staticGenerate = staticGenerate;
@@ -122,7 +128,9 @@ export class ModernServer {
   }
 
   // server prepare
-  public async init() {
+  public async init(runner: ServerHookRunner) {
+    this.runner = runner;
+
     const { distDir, isDev, staticGenerate, conf } = this;
 
     this.addHandler((ctx: ModernServerContext, next: NextFunction) => {
@@ -198,16 +206,14 @@ export class ModernServer {
     reader.close();
   }
 
-  // warmup ssr function
-  protected warmupSSRBundle() {
-    const { distDir } = this;
-    const bundles = this.router.getBundles();
-
-    bundles.forEach(bundle => {
-      const filepath = path.join(distDir, bundle!);
-      // if error, just throw and let process die
-      require(filepath);
-    });
+  public async createHTTPServer(
+    handler: (
+      req: IncomingMessage,
+      res: ServerResponse,
+      next?: () => void,
+    ) => void,
+  ) {
+    return createServer(handler);
   }
 
   // read route spec from route.json
@@ -241,9 +247,6 @@ export class ModernServer {
   protected async prepareFrameHandler() {
     const { workDir, runner } = this;
 
-    // inner tool, gather user inject
-    const { api: userAPIExt, web: userWebExt } = gather(workDir);
-
     // server hook, gather plugin inject
     const { getMiddlewares, ...collector } = createMiddlewareCollecter();
 
@@ -255,7 +258,7 @@ export class ModernServer {
 
     // get api or web server handler from server-framework plugin
     if (await fs.pathExists(path.join(serverDir))) {
-      const webExtension = mergeExtension(pluginWebExt, userWebExt);
+      const webExtension = mergeExtension(pluginWebExt);
       this.frameWebHandler = await this.prepareWebHandler(webExtension);
     }
 
@@ -265,14 +268,16 @@ export class ModernServer {
         : ApiServerMode.func;
 
       // if use lambda/, mean framework style of writing, then discard user extension
-      const apiExtension = mergeExtension(
-        pluginAPIExt,
-        mode === ApiServerMode.frame ? [] : userAPIExt,
-      );
+      const apiExtension = mergeExtension(pluginAPIExt);
       this.frameAPIHandler = await this.prepareAPIHandler(mode, apiExtension);
     }
   }
 
+  // Todo
+  protected async proxy() {
+    return null as any;
+  }
+
   /* —————————————————————— function will be overwrite —————————————————————— */
   protected async prepareWebHandler(
     extension: ReturnType<typeof mergeExtension>,
@@ -290,7 +295,7 @@ export class ModernServer {
 
   protected async prepareAPIHandler(
     mode: ApiServerMode,
-    extension: ReturnType<typeof mergeExtension>,
+    extension: APIServerStartInput['config'],
   ) {
     const { workDir, runner, conf } = this;
     const { bff } = conf as ConfWithBFF;
@@ -301,7 +306,7 @@ export class ModernServer {
         pwd: workDir,
         mode,
         config: extension,
-        prefix,
+        prefix: Array.isArray(prefix) ? prefix[0] : prefix,
       },
       { onLast: () => null as any },
     );
@@ -311,62 +316,89 @@ export class ModernServer {
     return routes;
   }
 
+  protected async emitRouteHook(
+    eventName: 'beforeMatch' | 'afterMatch' | 'beforeRender' | 'afterRender',
+    input: any,
+  ) {
+    return this.runner[eventName](input, { onLast: noop as any });
+  }
+
+  // warmup ssr function
+  protected warmupSSRBundle() {
+    const { distDir } = this;
+    const bundles = this.router.getBundles();
+
+    bundles.forEach(bundle => {
+      const filepath = path.join(distDir, bundle as string);
+      // if error, just throw and let process die
+      require(filepath);
+    });
+  }
+
   protected async preServerInit() {
-    const { conf } = this;
+    const { conf, runner } = this;
     const preMiddleware: ModernServerAsyncHandler[] =
-      await this.runner.preServerInit(conf);
+      await runner.preServerInit(conf);
 
-    preMiddleware.forEach(mid => {
+    preMiddleware.flat().forEach(mid => {
       this.addHandler(mid);
     });
   }
 
-  private prepareFavicons(
-    favicon: string | undefined,
-    faviconByEntries?: Record<string, string | undefined>,
-  ) {
-    const faviconNames = [];
-    if (favicon) {
-      faviconNames.push(favicon.substring(favicon.lastIndexOf('/') + 1));
-    }
-    if (faviconByEntries) {
-      Object.keys(faviconByEntries).forEach(f => {
-        const curFavicon = faviconByEntries[f];
-        if (curFavicon) {
-          faviconNames.push(
-            curFavicon.substring(curFavicon.lastIndexOf('/') + 1),
-          );
-        }
-      });
+  protected async handleAPI(context: ModernServerContext) {
+    const { req, res } = context;
+
+    if (!this.frameAPIHandler) {
+      throw new Error('can not found api hanlder');
     }
-    return faviconNames;
+
+    await this.frameAPIHandler(req, res);
   }
 
-  /* —————————————————————— private function —————————————————————— */
+  protected async handleWeb(context: ModernServerContext, route: ModernRoute) {
+    return this.routeRenderHandler(context, route);
+  }
+
+  protected verifyMatch(_c: ModernServerContext, _m: RouteMatcher) {
+    // empty
+  }
 
+  /* —————————————————————— private function —————————————————————— */
   // handler route.json, include api / csr / ssr
   // eslint-disable-next-line max-statements
   private async routeHandler(context: ModernServerContext) {
     const { req, res } = context;
 
+    await this.emitRouteHook('beforeMatch', { context });
+
     // match routes in the route spec
     const matched = this.router.match(context.url);
     if (!matched) {
       this.render404(context);
       return;
+    } else {
+      this.verifyMatch(context, matched);
     }
 
-    const route = matched.generate();
-    const params = matched.parseURLParams(context.url);
+    if (res.headersSent) {
+      return;
+    }
+
+    const routeAPI = createRouteAPI(matched, this.router);
+    await this.emitRouteHook('afterMatch', { context, routeAPI });
+
+    if (res.headersSent) {
+      return;
+    }
+
+    const { current } = routeAPI as any;
+    const route: ModernRoute = current.generate();
+    const params = current.parseURLParams(context.url);
     context.setParams(params);
 
     // route is api service
     if (route.isApi) {
-      if (!this.frameAPIHandler) {
-        throw new Error('can not found api hanlder');
-      }
-
-      await this.frameAPIHandler(req, res);
+      this.handleAPI(context);
       return;
     }
 
@@ -379,7 +411,11 @@ export class ModernServer {
       return;
     }
 
-    const file = await this.routeRenderHandler(context, route);
+    if (route.entryName) {
+      await this.emitRouteHook('beforeRender', { context });
+    }
+
+    const file = await this.handleWeb(context, route);
     if (!file) {
       this.render404(context);
       return;
@@ -395,10 +431,7 @@ export class ModernServer {
     let response = file.content;
     if (route.entryName) {
       const templateAPI = createTemplateAPI(file.content.toString());
-      await this.runner.afterRender(
-        { context, templateAPI },
-        { onLast: noop as any },
-      );
+      await this.emitRouteHook('afterRender', { context, templateAPI });
       await this.injectMicroFE(context, templateAPI);
       response = templateAPI.get();
     }
@@ -561,5 +594,26 @@ export class ModernServer {
     const text = ERROR_PAGE_TEXT[status] || ERROR_PAGE_TEXT[500];
     res.end(createErrorDocument(status, text));
   }
+
+  private prepareFavicons(
+    favicon: string | undefined,
+    faviconByEntries?: Record<string, string | undefined>,
+  ) {
+    const faviconNames = [];
+    if (favicon) {
+      faviconNames.push(favicon.substring(favicon.lastIndexOf('/') + 1));
+    }
+    if (faviconByEntries) {
+      Object.keys(faviconByEntries).forEach(f => {
+        const curFavicon = faviconByEntries[f];
+        if (curFavicon) {
+          faviconNames.push(
+            curFavicon.substring(curFavicon.lastIndexOf('/') + 1),
+          );
+        }
+      });
+    }
+    return faviconNames;
+  }
 }
 /* eslint-enable max-lines */

package/src/type.ts

@@ -49,7 +49,12 @@ export type ModernServerOptions = {
   logger?: Logger;
   measure?: Measure;
   apiOnly?: boolean;
+  ssrOnly?: boolean;
   webOnly?: boolean;
+  proxyTarget?: {
+    ssr?: string;
+    api?: string;
+  };
 };
 
 export type RenderResult = {

package/src/utils.ts

@@ -1,6 +1,6 @@
-export const mergeExtension = (users: any[], plugins: any[]) => {
+export const mergeExtension = (users: any[]) => {
   const output: any[] = [];
-  return { middleware: output.concat(users).concat(plugins) };
+  return { middleware: output.concat(users) };
 };
 
 export const toMessage = (dig: string, e: Error | string): string => {
@@ -49,3 +49,17 @@ export const createErrorDocument = (status: number, text: string) => {
   </html>
   `;
 };
+
+// This can live anywhere in your codebase:
+export function applyMixins(derivedCtor: any, constructors: any[]) {
+  constructors.forEach(baseCtor => {
+    Object.getOwnPropertyNames(baseCtor.prototype).forEach(name => {
+      Object.defineProperty(
+        derivedCtor.prototype,
+        name,
+        Object.getOwnPropertyDescriptor(baseCtor.prototype, name) ||
+          Object.create(null),
+      );
+    });
+  });
+}

package/dist/js/modern/server/api-server.js

@@ -1,36 +0,0 @@
-import { ModernDevServer } from "./dev-server";
-import { ModernServer } from "./modern-server";
-export class APIModernServer extends ModernServer {
-  prepareWebHandler(_) {
-    return null;
-  }
-
-  async prepareAPIHandler(mode, extension) {
-    return super.prepareAPIHandler(mode, extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.isApi);
-  }
-
-  async preServerInit() {// noop
-  }
-
-}
-export class APIModernDevServer extends ModernDevServer {
-  prepareWebHandler(_) {
-    return null;
-  }
-
-  async prepareAPIHandler(mode, extension) {
-    return super.prepareAPIHandler(mode, extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.isApi);
-  }
-
-  async preServerInit() {// noop
-  }
-
-}

package/dist/js/modern/server/web-server.js

@@ -1,30 +0,0 @@
-import { ModernDevServer } from "./dev-server";
-import { ModernServer } from "./modern-server";
-export class WebModernServer extends ModernServer {
-  prepareAPIHandler(_m, _) {
-    return null;
-  }
-
-  async prepareWebHandler(extension) {
-    return super.prepareWebHandler(extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.entryName);
-  }
-
-}
-export class WebModernDevServer extends ModernDevServer {
-  prepareAPIHandler(_m, _) {
-    return null;
-  }
-
-  async prepareWebHandler(extension) {
-    return super.prepareWebHandler(extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.entryName);
-  }
-
-}

package/dist/js/node/server/api-server.js

@@ -1,50 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.APIModernServer = exports.APIModernDevServer = void 0;
-
-var _devServer = require("./dev-server");
-
-var _modernServer = require("./modern-server");
-
-class APIModernServer extends _modernServer.ModernServer {
-  prepareWebHandler(_) {
-    return null;
-  }
-
-  async prepareAPIHandler(mode, extension) {
-    return super.prepareAPIHandler(mode, extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.isApi);
-  }
-
-  async preServerInit() {// noop
-  }
-
-}
-
-exports.APIModernServer = APIModernServer;
-
-class APIModernDevServer extends _devServer.ModernDevServer {
-  prepareWebHandler(_) {
-    return null;
-  }
-
-  async prepareAPIHandler(mode, extension) {
-    return super.prepareAPIHandler(mode, extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.isApi);
-  }
-
-  async preServerInit() {// noop
-  }
-
-}
-
-exports.APIModernDevServer = APIModernDevServer;

package/dist/js/node/server/web-server.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.WebModernServer = exports.WebModernDevServer = void 0;
-
-var _devServer = require("./dev-server");
-
-var _modernServer = require("./modern-server");
-
-class WebModernServer extends _modernServer.ModernServer {
-  prepareAPIHandler(_m, _) {
-    return null;
-  }
-
-  async prepareWebHandler(extension) {
-    return super.prepareWebHandler(extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.entryName);
-  }
-
-}
-
-exports.WebModernServer = WebModernServer;
-
-class WebModernDevServer extends _devServer.ModernDevServer {
-  prepareAPIHandler(_m, _) {
-    return null;
-  }
-
-  async prepareWebHandler(extension) {
-    return super.prepareWebHandler(extension);
-  }
-
-  filterRoutes(routes) {
-    return routes.filter(route => route.entryName);
-  }
-
-}
-
-exports.WebModernDevServer = WebModernDevServer;

package/dist/types/server/api-server.d.ts

@@ -1,17 +0,0 @@
-import { ModernDevServer } from './dev-server';
-import { ModernServer } from './modern-server';
-import { mergeExtension } from "../utils.d";
-import { ModernRouteInterface } from "../libs/route";
-import { ApiServerMode } from "../constants.d";
-export declare class APIModernServer extends ModernServer {
-  protected prepareWebHandler(_: ReturnType<typeof mergeExtension>): any;
-  protected prepareAPIHandler(mode: ApiServerMode, extension: ReturnType<typeof mergeExtension>): Promise<import("@modern-js/server-plugin").Adapter>;
-  protected filterRoutes(routes: ModernRouteInterface[]): ModernRouteInterface[];
-  protected preServerInit(): Promise<void>;
-}
-export declare class APIModernDevServer extends ModernDevServer {
-  protected prepareWebHandler(_: ReturnType<typeof mergeExtension>): any;
-  protected prepareAPIHandler(mode: ApiServerMode, extension: ReturnType<typeof mergeExtension>): Promise<import("@modern-js/server-plugin").Adapter>;
-  protected filterRoutes(routes: ModernRouteInterface[]): ModernRouteInterface[];
-  protected preServerInit(): Promise<void>;
-}

package/dist/types/server/web-server.d.ts

@@ -1,15 +0,0 @@
-import { ModernDevServer } from './dev-server';
-import { ModernServer } from './modern-server';
-import { mergeExtension } from "../utils.d";
-import { ModernRouteInterface } from "../libs/route";
-import { ApiServerMode } from "../constants.d";
-export declare class WebModernServer extends ModernServer {
-  protected prepareAPIHandler(_m: ApiServerMode, _: ReturnType<typeof mergeExtension>): any;
-  protected prepareWebHandler(extension: ReturnType<typeof mergeExtension>): Promise<import("@modern-js/server-plugin").Adapter>;
-  protected filterRoutes(routes: ModernRouteInterface[]): ModernRouteInterface[];
-}
-export declare class WebModernDevServer extends ModernDevServer {
-  protected prepareAPIHandler(_m: ApiServerMode, _: ReturnType<typeof mergeExtension>): any;
-  protected prepareWebHandler(extension: ReturnType<typeof mergeExtension>): Promise<import("@modern-js/server-plugin").Adapter>;
-  protected filterRoutes(routes: ModernRouteInterface[]): ModernRouteInterface[];
-}

package/src/server/api-server.ts

@@ -1,47 +0,0 @@
-import { ModernDevServer } from './dev-server';
-import { ModernServer } from './modern-server';
-import { mergeExtension } from '@/utils';
-import { ModernRouteInterface } from '@/libs/route';
-import { ApiServerMode } from '@/constants';
-
-export class APIModernServer extends ModernServer {
-  protected prepareWebHandler(_: ReturnType<typeof mergeExtension>) {
-    return null as any;
-  }
-
-  protected async prepareAPIHandler(
-    mode: ApiServerMode,
-    extension: ReturnType<typeof mergeExtension>,
-  ) {
-    return super.prepareAPIHandler(mode, extension);
-  }
-
-  protected filterRoutes(routes: ModernRouteInterface[]) {
-    return routes.filter(route => route.isApi);
-  }
-
-  protected async preServerInit() {
-    // noop
-  }
-}
-
-export class APIModernDevServer extends ModernDevServer {
-  protected prepareWebHandler(_: ReturnType<typeof mergeExtension>) {
-    return null as any;
-  }
-
-  protected async prepareAPIHandler(
-    mode: ApiServerMode,
-    extension: ReturnType<typeof mergeExtension>,
-  ) {
-    return super.prepareAPIHandler(mode, extension);
-  }
-
-  protected filterRoutes(routes: ModernRouteInterface[]) {
-    return routes.filter(route => route.isApi);
-  }
-
-  protected async preServerInit() {
-    // noop
-  }
-}