@modern-js/server 1.5.0-alpha.0 → 1.5.1

package/CHANGELOG.md

@@ -1,26 +1,43 @@
 # @modern-js/server
 
-## 1.5.0-alpha.0
+## 1.5.1
+
+### Patch Changes
+
+- a27ab8d: feat: add onApiChange hook for bff hot reload
+  feat: 为 BFF 热更新优化，添加 onApiChange 钩子
+- Updated dependencies [b74b0b6]
+- Updated dependencies [7b902b3]
+- Updated dependencies [3d64b2f]
+- Updated dependencies [8b2aa56]
+- Updated dependencies [3e4a34f]
+- Updated dependencies [33cebd2]
+  - @modern-js/webpack@1.12.0
+  - @modern-js/prod-server@1.2.0
+  - @modern-js/server-utils@1.2.11
+  - @modern-js/utils@1.7.12
+
+## 1.5.0
 
 ### Minor Changes
 
-- 77a8e9e1b: feat: support bff operators
+- 77a8e9e: feat: support bff operators
 
 ### Patch Changes
 
-- Updated dependencies [9cd364e06]
-- Updated dependencies [550e2bd18]
-- Updated dependencies [2b06fe3f3]
-- Updated dependencies [3050accbe]
-- Updated dependencies [f29e9bacf]
-- Updated dependencies [2dacc8929]
-- Updated dependencies [338496c6b]
-- Updated dependencies [a90bc96bd]
-  - @modern-js/utils@1.7.9-alpha.0
-  - @modern-js/webpack@1.11.3-alpha.0
-  - @modern-js/prod-server@1.1.9-alpha.0
-  - @modern-js/hmr-client@1.2.9-alpha.0
-  - @modern-js/server-utils@1.2.12-alpha.0
+- d9564f2: feat: add watchOptions for server watcher
+- Updated dependencies [550e2bd]
+- Updated dependencies [87eb9f8]
+- Updated dependencies [2b06fe3]
+- Updated dependencies [3050acc]
+- Updated dependencies [f29e9ba]
+- Updated dependencies [2dacc89]
+- Updated dependencies [338496c]
+- Updated dependencies [a90bc96]
+  - @modern-js/webpack@1.11.3
+  - @modern-js/prod-server@1.1.9
+  - @modern-js/utils@1.7.9
+  - @modern-js/server-utils@1.2.11
 
 ## 1.4.21
 

package/dist/js/modern/dev-tools/watcher/index.js

@@ -1,9 +1,18 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 import path from 'path';
 import { fs, chokidar } from '@modern-js/utils';
 import { DependencyTree } from "./dependency-tree";
 import { StatsCache } from "./stats-cache";
+export const defaultWatchOptions = {
+  // 初始化的时候不触发 add、addDir 事件
+  ignoreInitial: true,
+  ignored: /api\/typings\/.*/
+};
 export const getWatchedFiles = watcher => {
   const watched = watcher.getWatched();
   const files = [];
@@ -14,6 +23,24 @@ export const getWatchedFiles = watcher => {
   });
   return files;
 };
+export const mergeWatchOptions = options => {
+  const watchOptions = _objectSpread({}, options);
+
+  if (watchOptions) {
+    const {
+      ignored
+    } = watchOptions;
+    const finalIgnored = ignored ? [defaultWatchOptions.ignored, ...(Array.isArray(ignored) ? ignored : [ignored])] : ignored;
+
+    if (finalIgnored) {
+      watchOptions.ignored = finalIgnored;
+    }
+  }
+
+  const finalWatchOptions = _objectSpread(_objectSpread({}, defaultWatchOptions), watchOptions);
+
+  return finalWatchOptions;
+};
 export default class Watcher {
   constructor() {
     _defineProperty(this, "dependencyTree", null);
@@ -32,18 +59,18 @@ export default class Watcher {
     watcher.on('change', changed => {
       if (!fs.existsSync(changed) || cache.isDiff(changed)) {
         cache.refresh(changed);
-        callback(changed);
+        callback(changed, 'change');
       }
     });
     watcher.on('add', changed => {
       if (!cache.has(changed)) {
         cache.add([changed]);
-        callback(changed);
+        callback(changed, 'add');
       }
     });
     watcher.on('unlink', changed => {
       cache.del(changed);
-      callback(changed);
+      callback(changed, 'unlink');
     });
     this.watcher = watcher;
   }

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

@@ -15,7 +15,7 @@ import { createMockHandler } from "../dev-tools/mock";
 import SocketServer from "../dev-tools/socket-server";
 import DevServerPlugin from "../dev-tools/dev-server-plugin";
 import { enableRegister } from "../dev-tools/babel/register";
-import Watcher from "../dev-tools/watcher";
+import Watcher, { mergeWatchOptions } from "../dev-tools/watcher";
 export class ModernDevServer extends ModernServer {
   constructor(options) {
     super(options); // dev server should work in pwd
@@ -195,7 +195,8 @@ export class ModernDevServer extends ModernServer {
   }
 
   onServerChange({
-    filepath
+    filepath,
+    event
   }) {
     const {
       pwd
@@ -212,9 +213,19 @@ export class ModernDevServer extends ModernServer {
       });
     } else {
       try {
-        super.onServerChange({
-          filepath
-        });
+        const success = this.runner.onApiChange([{
+          filename: filepath,
+          event
+        }]); // onApiChange 钩子被调用，且返回 true，则表示无需重新编译
+        // onApiChange 的类型是 WaterFall,WaterFall 钩子的返回值类型目前有问题
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-expect-error
+
+        if (success !== true) {
+          super.onServerChange({
+            filepath
+          });
+        }
       } catch (e) {
         this.logger.error(e);
       }
@@ -349,19 +360,17 @@ export class ModernDevServer extends ModernServer {
       mock
     } = AGGRED_DIR;
     const defaultWatched = [`${mock}/**/*`, `${SERVER_DIR}/**/*`, `${API_DIR}/**`, `${SHARED_DIR}/**/*`];
+    const watchOptions = mergeWatchOptions(this.conf.server.watchOptions);
     const defaultWatchedPaths = defaultWatched.map(p => path.normalize(path.join(pwd, p)));
     const watcher = new Watcher();
     watcher.createDepTree(); // 监听文件变动，如果有变动则给 client，也就是 start 启动的插件发消息
 
-    watcher.listen(defaultWatchedPaths, {
-      // 初始化的时候不触发 add、addDir 事件
-      ignoreInitial: true,
-      ignored: /api\/typings\/.*/
-    }, filepath => {
+    watcher.listen(defaultWatchedPaths, watchOptions, (filepath, event) => {
       watcher.updateDepTree();
       watcher.cleanDepCache(filepath);
       this.onServerChange({
-        filepath
+        filepath,
+        event
       });
     });
     this.watcher = watcher;

package/dist/js/node/dev-tools/watcher/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getWatchedFiles = exports.default = void 0;
+exports.mergeWatchOptions = exports.getWatchedFiles = exports.defaultWatchOptions = exports.default = void 0;
 
 var _path = _interopRequireDefault(require("path"));
 
@@ -15,8 +15,19 @@ var _statsCache = require("./stats-cache");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+const defaultWatchOptions = {
+  // 初始化的时候不触发 add、addDir 事件
+  ignoreInitial: true,
+  ignored: /api\/typings\/.*/
+};
+exports.defaultWatchOptions = defaultWatchOptions;
+
 const getWatchedFiles = watcher => {
   const watched = watcher.getWatched();
   const files = [];
@@ -30,6 +41,27 @@ const getWatchedFiles = watcher => {
 
 exports.getWatchedFiles = getWatchedFiles;
 
+const mergeWatchOptions = options => {
+  const watchOptions = _objectSpread({}, options);
+
+  if (watchOptions) {
+    const {
+      ignored
+    } = watchOptions;
+    const finalIgnored = ignored ? [defaultWatchOptions.ignored, ...(Array.isArray(ignored) ? ignored : [ignored])] : ignored;
+
+    if (finalIgnored) {
+      watchOptions.ignored = finalIgnored;
+    }
+  }
+
+  const finalWatchOptions = _objectSpread(_objectSpread({}, defaultWatchOptions), watchOptions);
+
+  return finalWatchOptions;
+};
+
+exports.mergeWatchOptions = mergeWatchOptions;
+
 class Watcher {
   constructor() {
     _defineProperty(this, "dependencyTree", null);
@@ -50,18 +82,18 @@ class Watcher {
     watcher.on('change', changed => {
       if (!_utils.fs.existsSync(changed) || cache.isDiff(changed)) {
         cache.refresh(changed);
-        callback(changed);
+        callback(changed, 'change');
       }
     });
     watcher.on('add', changed => {
       if (!cache.has(changed)) {
         cache.add([changed]);
-        callback(changed);
+        callback(changed, 'add');
       }
     });
     watcher.on('unlink', changed => {
       cache.del(changed);
-      callback(changed);
+      callback(changed, 'unlink');
     });
     this.watcher = watcher;
   }

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

@@ -27,7 +27,11 @@ var _devServerPlugin = _interopRequireDefault(require("../dev-tools/dev-server-p
 
 var _register = require("../dev-tools/babel/register");
 
-var _watcher = _interopRequireDefault(require("../dev-tools/watcher"));
+var _watcher = _interopRequireWildcard(require("../dev-tools/watcher"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -216,7 +220,8 @@ class ModernDevServer extends _prodServer.ModernServer {
   }
 
   onServerChange({
-    filepath
+    filepath,
+    event
   }) {
     const {
       pwd
@@ -235,9 +240,19 @@ class ModernDevServer extends _prodServer.ModernServer {
       });
     } else {
       try {
-        super.onServerChange({
-          filepath
-        });
+        const success = this.runner.onApiChange([{
+          filename: filepath,
+          event
+        }]); // onApiChange 钩子被调用，且返回 true，则表示无需重新编译
+        // onApiChange 的类型是 WaterFall,WaterFall 钩子的返回值类型目前有问题
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-expect-error
+
+        if (success !== true) {
+          super.onServerChange({
+            filepath
+          });
+        }
       } catch (e) {
         this.logger.error(e);
       }
@@ -372,19 +387,17 @@ class ModernDevServer extends _prodServer.ModernServer {
       mock
     } = _prodServer.AGGRED_DIR;
     const defaultWatched = [`${mock}/**/*`, `${_utils.SERVER_DIR}/**/*`, `${_utils.API_DIR}/**`, `${_utils.SHARED_DIR}/**/*`];
+    const watchOptions = (0, _watcher.mergeWatchOptions)(this.conf.server.watchOptions);
     const defaultWatchedPaths = defaultWatched.map(p => _path.default.normalize(_path.default.join(pwd, p)));
     const watcher = new _watcher.default();
     watcher.createDepTree(); // 监听文件变动，如果有变动则给 client，也就是 start 启动的插件发消息
 
-    watcher.listen(defaultWatchedPaths, {
-      // 初始化的时候不触发 add、addDir 事件
-      ignoreInitial: true,
-      ignored: /api\/typings\/.*/
-    }, filepath => {
+    watcher.listen(defaultWatchedPaths, watchOptions, (filepath, event) => {
       watcher.updateDepTree();
       watcher.cleanDepCache(filepath);
       this.onServerChange({
-        filepath
+        filepath,
+        event
       });
     });
     this.watcher = watcher;

package/dist/types/dev-tools/watcher/index.d.ts

@@ -1,9 +1,31 @@
 import { FSWatcher, WatchOptions } from '@modern-js/utils';
+export declare type WatchEvent = 'add' | 'change' | 'unlink';
+export declare const defaultWatchOptions: {
+  ignoreInitial: boolean;
+  ignored: RegExp;
+};
 export declare const getWatchedFiles: (watcher: FSWatcher) => string[];
+export declare const mergeWatchOptions: (options?: WatchOptions) => {
+  persistent?: boolean | undefined;
+  ignored: import("@modern-js/utils/compiled/chokidar/anymatch").Matcher;
+  ignoreInitial: boolean;
+  followSymlinks?: boolean | undefined;
+  cwd?: string | undefined;
+  disableGlobbing?: boolean | undefined;
+  usePolling?: boolean | undefined;
+  useFsEvents?: boolean | undefined;
+  alwaysStat?: boolean | undefined;
+  depth?: number | undefined;
+  interval?: number | undefined;
+  binaryInterval?: number | undefined;
+  ignorePermissionErrors?: boolean | undefined;
+  atomic?: number | boolean | undefined;
+  awaitWriteFinish?: boolean | import("@modern-js/utils/compiled/chokidar").AwaitWriteFinishOptions | undefined;
+};
 export default class Watcher {
   private dependencyTree;
   private watcher;
-  listen(files: string[], options: WatchOptions, callback: (changed: string) => void): void;
+  listen(files: string[], options: WatchOptions, callback: (changed: string, event: WatchEvent) => void): void;
   createDepTree(): void;
   updateDepTree(): void;
   cleanDepCache(filepath: string): void;

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

@@ -2,6 +2,7 @@
 /// <reference types="node" />
 import http, { Server, IncomingMessage, ServerResponse } from 'http';
 import { ServerHookRunner, ModernServer, BuildOptions } from '@modern-js/prod-server';
+import { WatchEvent } from '../dev-tools/watcher';
 import { ModernDevServerOptions } from '../types';
 export declare class ModernDevServer extends ModernServer {
   private mockHandler;
@@ -19,9 +20,11 @@ export declare class ModernDevServer extends ModernServer {
   createHTTPServer(handler: (req: IncomingMessage, res: ServerResponse, next?: () => void) => void): Promise<http.Server | import("https").Server>;
   protected warmupSSRBundle(): void;
   protected onServerChange({
-    filepath
+    filepath,
+    event
   }: {
     filepath: string;
+    event: WatchEvent;
   }): void;
   private setupCompiler;
   private setupDevServerPlugin;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.5.0-alpha.0",
+  "version": "1.5.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -30,20 +30,20 @@
   "dependencies": {
     "@babel/core": "^7.18.0",
     "@babel/register": "^7.17.7",
-    "@modern-js/hmr-client": "^1.2.9-alpha.0",
-    "@modern-js/prod-server": "^1.1.9-alpha.0",
-    "@modern-js/server-utils": "^1.2.12-alpha.0",
-    "@modern-js/webpack": "^1.11.3-alpha.0",
-    "@modern-js/utils": "^1.7.9-alpha.0",
+    "@modern-js/hmr-client": "^1.2.8",
+    "@modern-js/prod-server": "^1.2.0",
+    "@modern-js/server-utils": "^1.2.11",
+    "@modern-js/webpack": "^1.12.0",
+    "@modern-js/utils": "^1.7.12",
     "devcert": "^1.2.2",
     "minimatch": "^3.0.4",
     "path-to-regexp": "^6.2.0",
     "ws": "^8.2.0"
   },
   "devDependencies": {
-    "@modern-js/core": "1.12.2-alpha.0",
-    "@modern-js/server-core": "1.4.0-alpha.0",
-    "@modern-js/types": "1.5.5-alpha.0",
+    "@modern-js/core": "1.13.0",
+    "@modern-js/server-core": "1.4.1",
+    "@modern-js/types": "1.6.0",
     "@scripts/build": "0.0.0",
     "@scripts/jest-config": "0.0.0",
     "@types/jest": "^27",