@modern-js/server 1.1.3 → 1.1.5-beta.1

package/src/server/modern-server-split.ts

@@ -1,13 +1,26 @@
 import { APIServerStartInput } from '@modern-js/server-plugin';
 import { ModernServer } from './modern-server';
 import { mergeExtension } from '@/utils';
-import { ModernRouteInterface } from '@/libs/route';
+import { ModernRoute, ModernRouteInterface, RouteMatcher } from '@/libs/route';
 import { ApiServerMode } from '@/constants';
+import { ModernServerContext } from '@/libs/context';
+
+export class ModernSSRServer extends ModernServer {
+  // Todo should not invoke any route hook in modernSSRServer
+
+  protected async warmupSSRBundle() {
+    // empty
+  }
+
+  protected verifyMatch(context: ModernServerContext, matched: RouteMatcher) {
+    if (matched.generate().isApi) {
+      this.render404(context);
+    }
+  }
 
-export class WebModernServer extends ModernServer {
   protected prepareAPIHandler(
     _m: ApiServerMode,
-    _: ReturnType<typeof mergeExtension>,
+    _: APIServerStartInput['config'],
   ) {
     return null as any;
   }
@@ -18,12 +31,24 @@ export class WebModernServer extends ModernServer {
     return super.prepareWebHandler(extension);
   }
 
-  protected filterRoutes(routes: ModernRouteInterface[]) {
-    return routes.filter(route => route.entryName);
+  // protected filterRoutes(routes: ModernRouteInterface[]) {
+  //   return routes.filter(route => route.entryName);
+  // }
+
+  protected async preServerInit() {
+    // empty
   }
 }
 
-export class APIModernServer extends ModernServer {
+export class ModernAPIServer extends ModernServer {
+  protected async emitRouteHook(_: string, _input: any) {
+    // empty
+  }
+
+  protected async warmupSSRBundle() {
+    // empty
+  }
+
   protected prepareWebHandler(_: ReturnType<typeof mergeExtension>) {
     return null as any;
   }
@@ -40,6 +65,33 @@ export class APIModernServer extends ModernServer {
   }
 
   protected async preServerInit() {
-    // noop
+    // empty
+  }
+}
+
+export class ModernWebServer extends ModernServer {
+  protected async warmupSSRBundle() {
+    // empty
+  }
+
+  protected async handleAPI(context: ModernServerContext) {
+    const { proxyTarget } = this;
+    if (!proxyTarget?.api) {
+      this.proxy();
+    } else {
+      this.render404(context);
+    }
+  }
+
+  protected async handleWeb(context: ModernServerContext, route: ModernRoute) {
+    const { proxyTarget } = this;
+
+    if (route.isSSR && proxyTarget?.ssr) {
+      return this.proxy();
+    } else {
+      // if no proxyTarget but access web server, degradation to csr
+      route.isSSR = false;
+      return super.handleWeb(context, route);
+    }
   }
 }

package/src/server/modern-server.ts

@@ -12,17 +12,22 @@ import {
   ModernServerOptions,
   NextFunction,
   ServerHookRunner,
-  Measure,
+  Metrics,
   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,
@@ -68,7 +73,9 @@ export class ModernServer {
 
   protected readonly logger: Logger;
 
-  protected readonly measure: Measure;
+  protected readonly metrics: Metrics;
+
+  protected readonly proxyTarget: ModernServerOptions['proxyTarget'];
 
   private readonly isDev: boolean = false;
 
@@ -93,19 +100,21 @@ export class ModernServer {
     routes,
     staticGenerate,
     logger,
-    measure,
+    metrics,
+    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.logger = logger!;
-    this.measure = measure!;
+    this.metrics = metrics!;
     this.router = new RouteMatchManager();
     this.presetRoutes = routes;
+    this.proxyTarget = proxyTarget;
 
     if (staticGenerate) {
       this.staticGenerate = staticGenerate;
@@ -207,18 +216,6 @@ export class ModernServer {
     return createServer(handler);
   }
 
-  // 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);
-    });
-  }
-
   // read route spec from route.json
   protected readRouteSpec() {
     const file = path.join(this.distDir, ROUTE_SPEC_FILE);
@@ -276,6 +273,11 @@ export class ModernServer {
     }
   }
 
+  // Todo
+  protected async proxy() {
+    return null as any;
+  }
+
   /* —————————————————————— function will be overwrite —————————————————————— */
   protected async prepareWebHandler(
     extension: ReturnType<typeof mergeExtension>,
@@ -314,75 +316,93 @@ 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.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({
+      ctx: context,
+      route,
+      runner: this.runner,
+    });
+  }
+
+  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.runner.beforeMatch({ context }, { onLast: noop as any });
+    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);
+    }
+
+    if (res.headersSent) {
+      return;
     }
 
     const routeAPI = createRouteAPI(matched, this.router);
-    await this.runner.afterMatch(
-      { context, routeAPI },
-      { onLast: noop as any },
-    );
+    await this.emitRouteHook('afterMatch', { context, routeAPI });
 
     if (res.headersSent) {
       return;
     }
 
     const { current } = routeAPI as any;
-    const route = current.generate();
+    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;
     }
 
@@ -395,8 +415,11 @@ export class ModernServer {
       return;
     }
 
-    await this.runner.beforeRender({ context }, { onLast: noop as any });
-    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;
@@ -412,10 +435,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();
     }
@@ -532,7 +552,7 @@ export class ModernServer {
     res.statusCode = 200;
     const context: ModernServerContext = createContext(req, res, {
       logger: this.logger,
-      measure: this.measure,
+      metrics: this.metrics,
     });
 
     try {
@@ -564,7 +584,11 @@ export class ModernServer {
       // check entryName, aviod matched '/' route
       if (entryName === status.toString() || entryName === '_error') {
         try {
-          const file = await this.routeRenderHandler(context, route);
+          const file = await this.routeRenderHandler({
+            route,
+            ctx: context,
+            runner: this.runner,
+          });
           if (file) {
             context.res.end(file.content);
             return;
@@ -578,5 +602,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

@@ -2,7 +2,7 @@ import { Buffer } from 'buffer';
 import type Webpack from 'webpack';
 import { serverManager } from '@modern-js/server-plugin';
 import type { NormalizedConfig } from '@modern-js/core';
-import type { Measure, Logger, NextFunction } from '@modern-js/types/server';
+import type { Metrics, Logger, NextFunction } from '@modern-js/types/server';
 import { ModernRouteInterface } from './libs/route';
 
 declare module '@modern-js/core' {
@@ -26,6 +26,8 @@ export type DevServerOptions = {
   dev: {
     writeToDisk: boolean | ((filename: string) => boolean);
   };
+  // 是否监听文件变化
+  watch: boolean;
   // 是否开启 hot reload
   hot: boolean | string;
   // 是否开启 page reload
@@ -39,17 +41,22 @@ export type ModernServerOptions = {
   pwd: string;
   config: NormalizedConfig;
   plugins?: any[];
-  dev?: boolean | DevServerOptions;
+  dev?: boolean | Partial<DevServerOptions>;
   compiler?: Webpack.MultiCompiler | Webpack.Compiler;
   routes?: ModernRouteInterface[];
   staticGenerate?: boolean;
   customServer?: boolean;
   loggerOptions?: Record<string, string>;
-  measureOptions?: Record<string, string>;
+  metricsOptions?: Record<string, string>;
   logger?: Logger;
-  measure?: Measure;
+  metrics?: Metrics;
   apiOnly?: boolean;
+  ssrOnly?: boolean;
   webOnly?: boolean;
+  proxyTarget?: {
+    ssr?: string;
+    api?: string;
+  };
 };
 
 export type RenderResult = {
@@ -71,4 +78,4 @@ export type ServerHookRunner = Then<ReturnType<typeof serverManager.init>>;
 
 export type ReadyOptions = { routes?: ModernRouteInterface[] };
 
-export type { Measure, Logger, NextFunction };
+export type { Metrics, Logger, NextFunction };

package/src/utils.ts

@@ -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/types/libs/measure.d.ts

@@ -1,3 +0,0 @@
-import { Measure } from "../type.d";
-declare const measure: Measure;
-export { measure };