@modern-js/prod-server 1.0.6 → 1.1.1

package/dist/js/node/utils.js

@@ -3,10 +3,15 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.toPath = exports.toMessage = exports.prepareFavicons = exports.noop = exports.mergeExtension = exports.getStaticReg = exports.createMiddlewareCollecter = exports.createErrorDocument = void 0;
+exports.toPath = exports.toMessage = exports.prepareFavicons = exports.noop = exports.mergeExtension = exports.getStaticReg = exports.debug = exports.createMiddlewareCollecter = exports.createErrorDocument = void 0;
 
 var _pathToRegexp = require("path-to-regexp");
 
+var _utils = require("@modern-js/utils");
+
+const debug = (0, _utils.createDebugger)('prod-server');
+exports.debug = debug;
+
 const mergeExtension = users => {
   const output = [];
   return {

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 import { ModernServerOptions } from './type';
 import { Server } from './server';
 export { Server };
+export type { ServerConfig } from '@modern-js/server-core';
 export { ModernServer } from './server/modern-server';
 export { createProxyHandler } from './libs/proxy';
 export * from './type';

package/dist/types/libs/loadConfig.d.ts

@@ -0,0 +1,19 @@
+import type { NormalizedConfig } from '@modern-js/core';
+import type { ServerConfig } from '@modern-js/server-core';
+export declare const getServerConfigPath: (distDirectory: string, serverConfigFile?: string) => string;
+export declare const requireConfig: (serverConfigPath: string) => any;
+/**
+ * 对配置进行合并，开发环境下,cliConfig 与 serverConfig 进行深合并
+ * 生产环境下，resolvedConfig 与 serverConfig 进行深合并
+ * resolvedConfigPath: 构建序列化后的 modern.config.js 文件路径
+ */
+
+export declare const loadConfig: ({
+  cliConfig,
+  serverConfig,
+  resolvedConfigPath
+}: {
+  cliConfig: NormalizedConfig;
+  serverConfig: ServerConfig;
+  resolvedConfigPath: string;
+}) => any;

package/dist/types/server/index.d.ts

@@ -6,11 +6,42 @@ export declare class Server {
   private server;
   private app;
   private runner;
+  private serverConfig;
   constructor(options: ModernServerOptions);
+  /**
+   * 初始化顺序
+   * - 获取 server runtime config
+   * - 设置 context
+   * - 创建 hooksRunner
+   * - 合并插件，内置插件和 serverConfig 中配置的插件
+   * - 执行 config hook
+   * - 获取最终的配置
+   * - 设置配置到 context
+   * - 初始化 server
+   * - 执行 prepare hook
+   * - 执行 server init
+   */
+
   init(): Promise<this>;
+  /**
+   * Execute config hooks
+   * @param runner
+   * @param options
+   */
+
+  private runConfigHook;
+  private runPrepareHook;
+  private initServerConfig;
+  /**
+   *
+   * merge cliConfig and serverConfig
+   */
+
+  private initConfig;
   close(): Promise<void>;
   listen(port: number | undefined, listener: any): void;
   getRequestHandler(): (req: IncomingMessage, res: ServerResponse, next?: (() => void) | undefined) => void;
   private createHookRunner;
+  private injectContext;
   private initAppContext;
 }

package/dist/types/type.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { IncomingMessage, Server, ServerResponse } from 'http';
-import { serverManager, ServerPlugin } from '@modern-js/server-core';
+import { serverManager } from '@modern-js/server-core';
+import type { ServerPlugin } from '@modern-js/server-core';
 import type { NormalizedConfig } from '@modern-js/core';
 import type { Metrics, Logger, NextFunction } from '@modern-js/types/server';
 import { ModernRouteInterface } from './libs/route';

package/dist/types/utils.d.ts

@@ -1,4 +1,5 @@
 import type { NormalizedConfig } from '@modern-js/core';
+export declare const debug: any;
 export declare const mergeExtension: (users: any[]) => {
   middleware: any[];
 };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.0.6",
+  "version": "1.1.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -28,39 +28,41 @@
     }
   },
   "dependencies": {
-    "@modern-js/utils": "^1.3.7",
+    "@modern-js/utils": "^1.5.0",
     "@babel/compat-data": "^7.17.0",
-    "@modern-js/server-core": "^1.2.5",
+    "@modern-js/server-core": "^1.3.1",
     "axios": "^0.24.0",
     "compare-versions": "^3.6.0",
+    "cookie": "^0.4.2",
     "http-proxy-middleware": "^2.0.1",
     "ignore-styles": "^5.0.1",
+    "lodash.clone": "^4.5.0",
+    "lru-cache": "^6.0.0",
+    "merge-deep": "^3.0.3",
     "mime-types": "^2.1.32",
     "path-to-regexp": "^6.2.0",
     "serve-static": "^1.14.1",
-    "lru-cache": "^6.0.0",
-    "ua-parser-js": "^0.7.28",
-    "lodash.clone": "^4.5.0",
-    "cookie": "^0.4.2"
+    "ua-parser-js": "^0.7.28"
   },
   "devDependencies": {
-    "@modern-js/types": "^1.3.6",
-    "@modern-js/core": "1.6.1",
+    "@modern-js/types": "^1.5.0",
+    "@modern-js/core": "1.8.0",
     "@scripts/jest-config": "0.0.0",
     "@scripts/build": "0.0.0",
-    "del-cli": "^4.0.1",
+    "@types/cookie": "^0.4.1",
+    "@types/jest": "^26.0.9",
+    "@types/lodash.clone": "^4",
     "@types/lru-cache": "^5.1.1",
+    "@types/merge-deep": "^3.0.0",
     "@types/mime-types": "^2.1.0",
+    "@types/node": "^14",
     "@types/serve-static": "^1.13.10",
     "@types/ua-parser-js": "^0.7.36",
-    "@types/lodash.clone": "^4",
-    "@types/cookie": "^0.4.1",
-    "typescript": "^4",
-    "@types/jest": "^26.0.9",
-    "@types/node": "^14",
-    "node-mocks-http": "^1.11.0",
+    "del-cli": "^4.0.1",
     "jest": "^27",
-    "portfinder": "^1.0.28"
+    "node-mocks-http": "^1.11.0",
+    "portfinder": "^1.0.28",
+    "typescript": "^4"
   },
   "sideEffects": false,
   "modernConfig": {

package/src/index.ts

@@ -2,6 +2,7 @@ import { ModernServerOptions } from './type';
 import { Server } from './server';
 
 export { Server };
+export type { ServerConfig } from '@modern-js/server-core';
 export { ModernServer } from './server/modern-server';
 export { createProxyHandler } from './libs/proxy';
 export * from './type';

package/src/libs/loadConfig.ts

@@ -0,0 +1,65 @@
+import * as path from 'path';
+import { compatRequire, fs, DEFAULT_SERVER_CONFIG } from '@modern-js/utils';
+import type { NormalizedConfig } from '@modern-js/core';
+import type { ServerConfig } from '@modern-js/server-core';
+import mergeDeep from 'merge-deep';
+import { debug } from '../utils';
+
+export const getServerConfigPath = (
+  distDirectory: string,
+  serverConfigFile: string = DEFAULT_SERVER_CONFIG,
+) => {
+  const serverConfigPath = path.join(distDirectory, serverConfigFile);
+  return `${serverConfigPath}.js`;
+};
+
+export const requireConfig = (serverConfigPath: string) => {
+  if (fs.pathExistsSync(serverConfigPath)) {
+    try {
+      return compatRequire(serverConfigPath);
+    } catch (error) {
+      debug(error);
+      return {};
+    }
+  }
+
+  return {};
+};
+
+/**
+ * 对配置进行合并，开发环境下,cliConfig 与 serverConfig 进行深合并
+ * 生产环境下，resolvedConfig 与 serverConfig 进行深合并
+ * resolvedConfigPath: 构建序列化后的 modern.config.js 文件路径
+ */
+export const loadConfig = ({
+  cliConfig,
+  serverConfig,
+  resolvedConfigPath,
+}: {
+  cliConfig: NormalizedConfig;
+  serverConfig: ServerConfig;
+  resolvedConfigPath: string;
+}) => {
+  let config = null;
+  if (process.env.NODE_ENV === 'production') {
+    const resolvedConfig = requireConfig(resolvedConfigPath);
+    // cli config has a higher priority,because it's an argument passed in.
+    config = mergeDeep(
+      {
+        ...resolvedConfig,
+        plugins: [], // filter cli plugins
+      },
+      serverConfig,
+      cliConfig,
+    );
+  } else {
+    config = mergeDeep(
+      {
+        ...cliConfig,
+        plugins: [],
+      },
+      serverConfig,
+    );
+  }
+  return config;
+};

package/src/libs/proxy.ts

@@ -1,11 +1,13 @@
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import { NextFunction, BffProxyOptions } from '@modern-js/types';
 import { formatProxyOptions } from '@modern-js/utils';
+import { debug } from '../utils';
 import { ModernServerContext } from './context';
 
 export type { BffProxyOptions };
 
 export const createProxyHandler = (proxyOptions?: BffProxyOptions) => {
+  debug('createProxyHandler', proxyOptions);
   if (!proxyOptions) {
     return null;
   }

package/src/server/index.ts

@@ -5,8 +5,13 @@ import {
   AppContext,
   ConfigContext,
   loadPlugins,
+  ServerConfig,
 } from '@modern-js/server-core';
-import { logger as defaultLogger, SHARED_DIR } from '@modern-js/utils';
+import {
+  logger as defaultLogger,
+  SHARED_DIR,
+  OUTPUT_CONFIG_FILE,
+} from '@modern-js/utils';
 import type { UserConfig } from '@modern-js/core';
 import { ISAppContext } from '@modern-js/types';
 import {
@@ -16,6 +21,12 @@ import {
   ModernServerInterface,
 } from '../type';
 import { metrics as defaultMetrics } from '../libs/metrics';
+import {
+  loadConfig,
+  getServerConfigPath,
+  requireConfig,
+} from '../libs/loadConfig';
+import { debug } from '../utils';
 import { createProdServer } from './modern-server-split';
 
 export class Server {
@@ -29,31 +40,110 @@ export class Server {
 
   private runner!: ServerHookRunner;
 
+  private serverConfig: ServerConfig;
+
   constructor(options: ModernServerOptions) {
     options.logger = options.logger || defaultLogger;
     options.metrics = options.metrics || defaultMetrics;
 
     this.options = options;
+    this.serverConfig = {};
   }
 
+  /**
+   * 初始化顺序
+   * - 获取 server runtime config
+   * - 设置 context
+   * - 创建 hooksRunner
+   * - 合并插件，内置插件和 serverConfig 中配置的插件
+   * - 执行 config hook
+   * - 获取最终的配置
+   * - 设置配置到 context
+   * - 初始化 server
+   * - 执行 prepare hook
+   * - 执行 server init
+   */
   public async init() {
     const { options } = this;
 
+    this.initServerConfig(options);
+
+    await this.injectContext(this.runner, options);
+
+    // initialize server runner
+    this.runner = await this.createHookRunner();
+
+    // init config and execute config hook
+    await this.initConfig(this.runner, options);
+
+    await this.injectContext(this.runner, options);
+
     // initialize server
     this.server = this.serverImpl(options);
 
+    await this.runPrepareHook(this.runner);
+
     // create http-server
     this.app = await this.server.createHTTPServer(this.getRequestHandler());
 
-    // initialize server runner
-    this.runner = await this.createHookRunner();
-
     // runner can only be used after server init
     await this.server.onInit(this.runner);
 
     return this;
   }
 
+  /**
+   * Execute config hooks
+   * @param runner
+   * @param options
+   */
+  private runConfigHook(runner: ServerHookRunner, serverConfig: ServerConfig) {
+    const newServerConfig = runner.config(serverConfig || {});
+    return newServerConfig;
+  }
+
+  private async runPrepareHook(runner: ServerHookRunner) {
+    runner.prepare();
+  }
+
+  private initServerConfig(options: ModernServerOptions) {
+    const { pwd, serverConfigFile } = options;
+    const distDirectory = path.join(pwd, options.config.output?.path || 'dist');
+    const serverConfigPath = getServerConfigPath(
+      distDirectory,
+      serverConfigFile,
+    );
+    const serverConfig = requireConfig(serverConfigPath);
+    this.serverConfig = serverConfig;
+  }
+
+  /**
+   *
+   * merge cliConfig and serverConfig
+   */
+  private async initConfig(
+    runner: ServerHookRunner,
+    options: ModernServerOptions,
+  ) {
+    const { pwd, config } = options;
+
+    const { serverConfig } = this;
+
+    const finalServerConfig = this.runConfigHook(runner, serverConfig);
+
+    const resolvedConfigPath = path.join(
+      pwd,
+      config?.output?.path || 'dist',
+      OUTPUT_CONFIG_FILE,
+    );
+
+    options.config = loadConfig({
+      cliConfig: config,
+      serverConfig: finalServerConfig,
+      resolvedConfigPath,
+    });
+  }
+
   public async close() {
     await this.server.onClose();
     await new Promise<void>(resolve =>
@@ -85,15 +175,32 @@ export class Server {
     serverManager.clear();
 
     const { options } = this;
+    // TODO: 确认下这里是不是可以不从 options 中取插件，而是从 config 中取和过滤
     const { plugins = [], pwd, config } = options;
 
+    const serverPlugins = this.serverConfig.plugins || [];
+
     // server app context for serve plugin
-    const loadedPlugins = loadPlugins(plugins, pwd);
+    const loadedPlugins = loadPlugins(plugins.concat(serverPlugins), pwd);
+
+    debug('plugins', config.plugins, loadedPlugins);
     loadedPlugins.forEach(p => {
       serverManager.usePlugin(p);
     });
 
+    // create runner
+    const hooksRunner = await serverManager.init({});
+
+    return hooksRunner;
+  }
+
+  private async injectContext(
+    runner: ServerHookRunner,
+    options: ModernServerOptions,
+  ) {
     const appContext = this.initAppContext();
+    const { config, pwd } = options;
+
     serverManager.run(() => {
       ConfigContext.set(config as UserConfig);
       AppContext.set({
@@ -101,8 +208,6 @@ export class Server {
         distDirectory: path.join(pwd, config.output?.path || 'dist'),
       });
     });
-
-    return serverManager.init({});
   }
 
   private initAppContext(): ISAppContext {

package/src/server/modern-server.ts

@@ -33,6 +33,7 @@ import {
   getStaticReg,
   mergeExtension,
   noop,
+  debug,
 } from '../utils';
 import * as reader from '../libs/render/reader';
 import { createProxyHandler, BffProxyOptions } from '../libs/proxy';
@@ -120,6 +121,7 @@ export class ModernServer implements ModernServerInterface {
     this.distDir = path.join(pwd, config.output?.path || 'dist');
     this.workDir = this.distDir;
     this.conf = config;
+    debug('server conf', this.conf);
     this.logger = logger!;
     this.metrics = metrics!;
     this.router = new RouteMatchManager();
@@ -143,6 +145,7 @@ export class ModernServer implements ModernServerInterface {
       next();
     });
 
+    debug('final server conf', this.conf);
     // proxy handler, each proxy has own handler
     this.proxyHandler = createProxyHandler(conf.bff?.proxy as BffProxyOptions);
     if (this.proxyHandler) {
@@ -279,6 +282,7 @@ export class ModernServer implements ModernServerInterface {
         ? ApiServerMode.frame
         : ApiServerMode.func;
 
+      debug('exists api dir', mode);
       // if use lambda/, mean framework style of writing, then discard user extension
       const apiExtension = mergeExtension(pluginAPIExt);
       this.frameAPIHandler = await this.prepareAPIHandler(mode, apiExtension);
@@ -306,7 +310,6 @@ export class ModernServer implements ModernServerInterface {
     const { workDir, runner, conf } = this;
     const { bff } = conf as ConfWithBFF;
     const prefix = bff?.prefix || '/api';
-
     return runner.prepareApiServer(
       {
         pwd: workDir,
@@ -379,7 +382,6 @@ export class ModernServer implements ModernServerInterface {
 
   /* —————————————————————— private function —————————————————————— */
   // handler route.json, include api / csr / ssr
-  // eslint-disable-next-line max-statements
   private async routeHandler(context: ModernServerContext) {
     const { req, res } = context;
 
@@ -460,7 +462,6 @@ export class ModernServer implements ModernServerInterface {
     res.end(response);
   }
 
-  // eslint-disable-next-line max-statements
   private async injectMicroFE(
     context: ModernServerContext,
     templateAPI: ReturnType<typeof createTemplateAPI>,

package/src/type.ts

@@ -1,6 +1,7 @@
 import { Buffer } from 'buffer';
 import { IncomingMessage, Server, ServerResponse } from 'http';
-import { serverManager, ServerPlugin } from '@modern-js/server-core';
+import { serverManager } from '@modern-js/server-core';
+import type { ServerPlugin } from '@modern-js/server-core';
 import type { NormalizedConfig } from '@modern-js/core';
 import type { Metrics, Logger, NextFunction } from '@modern-js/types/server';
 import { ModernRouteInterface } from './libs/route';

package/src/utils.ts

@@ -1,5 +1,8 @@
 import type { NormalizedConfig } from '@modern-js/core';
 import { compile } from 'path-to-regexp';
+import { createDebugger } from '@modern-js/utils';
+
+export const debug = createDebugger('prod-server') as any;
 
 export const mergeExtension = (users: any[]) => {
   const output: any[] = [];

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/context.test.ts

@@ -1,52 +0,0 @@
-import EventEmitter from 'events';
-import { Readable } from 'stream';
-import httpMocks from 'node-mocks-http';
-import { createContext } from '../src/libs/context';
-
-describe('test server context', () => {
-  test('should route api work correctly', () => {
-    const req = httpMocks.createRequest({
-      url: '/pathname?foo=baz',
-      headers: {
-        host: 'modernjs.com',
-      },
-      eventEmitter: Readable,
-      method: 'GET',
-    });
-    const res = httpMocks.createResponse({ eventEmitter: EventEmitter });
-    const context = createContext(req, res);
-    const {
-      method,
-      url,
-      origin,
-      host,
-      path,
-      href,
-      query,
-      querystring,
-      protocol,
-      params,
-    } = context;
-
-    expect(method).toBe('GET');
-    expect(url).toBe('/pathname?foo=baz');
-    expect(origin).toBe('http://modernjs.com');
-    expect(host).toBe('modernjs.com');
-    expect(path).toBe('/pathname');
-    expect(href).toBe('http://modernjs.com/pathname?foo=baz');
-    expect(query).toEqual({ foo: 'baz' });
-    expect(querystring).toBe('foo=baz');
-    expect(protocol).toBe('http');
-    expect(params).toEqual({});
-
-    expect(context.serverData).toEqual({});
-    context.setServerData('foo', {
-      name: 'foo',
-    });
-    expect(context.serverData).toEqual({
-      foo: {
-        name: 'foo',
-      },
-    });
-  });
-});

package/tests/fixtures/hosting-files/static/index.js

@@ -1 +0,0 @@
-console.info('index.js');

package/tests/fixtures/pure/modern.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  server: {
-    ssr: true,
-  },
-};

package/tests/fixtures/pure/package.json

@@ -1,21 +0,0 @@
-{
-  "name": "prod-server-pure",
-  "version": "0.1.0",
-  "scripts": {
-    "reset": "del-cli node_modules",
-    "dev": "modern dev",
-    "build": "modern build",
-    "start": "modern start",
-    "new": "modern new",
-    "lint": "modern lint",
-    "deploy": "modern deploy"
-  },
-  "dependencies": {},
-  "devDependencies": {},
-  "modernConfig": {
-    "runtime": {
-      "router": true,
-      "state": true
-    }
-  }
-}