@modern-js/server 1.3.0 → 1.3.1-beta.0

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

@@ -19,13 +19,13 @@ export default class Watcher {
     this.watcher = void 0;
   }
 
-  listen(files, callback) {
+  listen(files, options, callback) {
     const watched = files.filter(Boolean);
+    const filenames = watched.map(filename => filename.replace(/\\/g, '/')); // eslint-disable-next-line no-console
+
+    console.log('watched files:', filenames);
     const cache = new StatsCache();
-    const watcher = chokidar.watch(watched, {
-      // 初始化的时候不触发 add、addDir 事件
-      ignoreInitial: true
-    });
+    const watcher = chokidar.watch(filenames, options);
     watcher.on('ready', () => {
       cache.add(getWatchedFiles(watcher));
     });

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

@@ -121,9 +121,13 @@ export class ModernDevServer extends ModernServer {
     super.close();
     await this.watcher.close();
     await new Promise(resolve => {
-      this.devMiddleware.close(() => {
+      if (this.devMiddleware) {
+        this.devMiddleware.close(() => {
+          resolve();
+        });
+      } else {
         resolve();
-      });
+      }
     });
   }
 
@@ -239,16 +243,22 @@ export class ModernDevServer extends ModernServer {
     const {
       mock
     } = AGGRED_DIR;
-    const defaultWatched = [`${pwd}/${mock}/**/*`, `${pwd}/${SERVER_DIR}/**/*`, `${pwd}/${API_DIR}/!(typings)/**`, `${pwd}/${SHARED_DIR}/**/*`];
+    const defaultWatched = [`${mock}/**/*`, `${SERVER_DIR}/**/*`, `${API_DIR}/**`, `${SHARED_DIR}/**/*`];
+    const defaultWatchedPaths = defaultWatched.map(p => path.normalize(path.join(pwd, p)));
+    const mockPath = path.normalize(path.join(pwd, mock));
     const watcher = new Watcher();
     watcher.createDepTree(); // 监听文件变动，如果有变动则给 client，也就是 start 启动的插件发消息
 
-    watcher.listen(defaultWatched, filepath => {
+    watcher.listen(defaultWatchedPaths, {
+      // 初始化的时候不触发 add、addDir 事件
+      ignoreInitial: true,
+      ignored: /api\/typings\/.*/
+    }, filepath => {
       watcher.updateDepTree();
       watcher.cleanDepCache(filepath);
       this.runner.reset();
 
-      if (filepath.startsWith(`${pwd}/${mock}`)) {
+      if (filepath.startsWith(mockPath)) {
         this.mockHandler = createMockHandler({
           pwd
         });

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

@@ -30,14 +30,14 @@ class Watcher {
     this.watcher = void 0;
   }
 
-  listen(files, callback) {
+  listen(files, options, callback) {
     const watched = files.filter(Boolean);
+    const filenames = watched.map(filename => filename.replace(/\\/g, '/')); // eslint-disable-next-line no-console
+
+    console.log('watched files:', filenames);
     const cache = new _statsCache.StatsCache();
 
-    const watcher = _chokidar.default.watch(watched, {
-      // 初始化的时候不触发 add、addDir 事件
-      ignoreInitial: true
-    });
+    const watcher = _chokidar.default.watch(filenames, options);
 
     watcher.on('ready', () => {
       cache.add(getWatchedFiles(watcher));

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

@@ -150,9 +150,13 @@ class ModernDevServer extends _modernServer.ModernServer {
     super.close();
     await this.watcher.close();
     await new Promise(resolve => {
-      this.devMiddleware.close(() => {
+      if (this.devMiddleware) {
+        this.devMiddleware.close(() => {
+          resolve();
+        });
+      } else {
         resolve();
-      });
+      }
     });
   }
 
@@ -268,16 +272,24 @@ class ModernDevServer extends _modernServer.ModernServer {
     const {
       mock
     } = _constants.AGGRED_DIR;
-    const defaultWatched = [`${pwd}/${mock}/**/*`, `${pwd}/${_utils.SERVER_DIR}/**/*`, `${pwd}/${_utils.API_DIR}/!(typings)/**`, `${pwd}/${_utils.SHARED_DIR}/**/*`];
+    const defaultWatched = [`${mock}/**/*`, `${_utils.SERVER_DIR}/**/*`, `${_utils.API_DIR}/**`, `${_utils.SHARED_DIR}/**/*`];
+    const defaultWatchedPaths = defaultWatched.map(p => _path.default.normalize(_path.default.join(pwd, p)));
+
+    const mockPath = _path.default.normalize(_path.default.join(pwd, mock));
+
     const watcher = new _watcher.default();
     watcher.createDepTree(); // 监听文件变动，如果有变动则给 client，也就是 start 启动的插件发消息
 
-    watcher.listen(defaultWatched, filepath => {
+    watcher.listen(defaultWatchedPaths, {
+      // 初始化的时候不触发 add、addDir 事件
+      ignoreInitial: true,
+      ignored: /api\/typings\/.*/
+    }, filepath => {
       watcher.updateDepTree();
       watcher.cleanDepCache(filepath);
       this.runner.reset();
 
-      if (filepath.startsWith(`${pwd}/${mock}`)) {
+      if (filepath.startsWith(mockPath)) {
         this.mockHandler = (0, _mock.createMockHandler)({
           pwd
         });

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

@@ -1,7 +1,8 @@
+import { WatchOptions } from 'chokidar';
 export default class Watcher {
   private dependencyTree;
   private watcher;
-  listen(files: string[], callback: (changed: string) => void): void;
+  listen(files: string[], options: WatchOptions, callback: (changed: string) => void): void;
   createDepTree(): void;
   updateDepTree(): void;
   cleanDepCache(filepath: string): void;

package/jest.config.js

@@ -4,5 +4,6 @@ const sharedConfig = require('@scripts/jest-config');
 module.exports = {
   // eslint-disable-next-line node/no-unsupported-features/es-syntax
   ...sharedConfig,
+  testEnvironment: 'node',
   rootDir: __dirname,
 };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.3.0",
+  "version": "1.3.1-beta.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",

package/src/dev-tools/watcher/index.ts

@@ -1,4 +1,4 @@
-import chokidar, { FSWatcher } from 'chokidar';
+import chokidar, { FSWatcher, WatchOptions } from 'chokidar';
 import { DependencyTree } from './dependency-tree';
 import { StatsCache } from './stats-cache';
 
@@ -18,14 +18,18 @@ export default class Watcher {
 
   private watcher!: FSWatcher;
 
-  public listen(files: string[], callback: (changed: string) => void) {
+  public listen(
+    files: string[],
+    options: WatchOptions,
+    callback: (changed: string) => void,
+  ) {
     const watched = files.filter(Boolean);
+    const filenames = watched.map(filename => filename.replace(/\\/g, '/'));
+    // eslint-disable-next-line no-console
+    console.log('watched files:', filenames);
 
     const cache = new StatsCache();
-    const watcher = chokidar.watch(watched, {
-      // 初始化的时候不触发 add、addDir 事件
-      ignoreInitial: true,
-    });
+    const watcher = chokidar.watch(filenames, options);
 
     watcher.on('ready', () => {
       cache.add(getWatchedFiles(watcher));

package/src/server/dev-server/dev-server.ts

@@ -84,7 +84,6 @@ export class ModernDevServer extends ModernServer {
   // Complete the preparation of services
   public async init(runner: ServerHookRunner) {
     const { conf, pwd, compiler } = this;
-
     // mock handler
     this.mockHandler = createMockHandler({ pwd });
     this.addHandler((ctx: ModernServerContext, next: NextFunction) => {
@@ -150,9 +149,13 @@ export class ModernDevServer extends ModernServer {
     super.close();
     await this.watcher.close();
     await new Promise<void>(resolve => {
-      this.devMiddleware.close(() => {
+      if (this.devMiddleware) {
+        this.devMiddleware.close(() => {
+          resolve();
+        });
+      } else {
         resolve();
-      });
+      }
     });
   }
 
@@ -252,32 +255,45 @@ export class ModernDevServer extends ModernServer {
     const { pwd } = this;
     const { mock } = AGGRED_DIR;
     const defaultWatched = [
-      `${pwd}/${mock}/**/*`,
-      `${pwd}/${SERVER_DIR}/**/*`,
-      `${pwd}/${API_DIR}/!(typings)/**`,
-      `${pwd}/${SHARED_DIR}/**/*`,
+      `${mock}/**/*`,
+      `${SERVER_DIR}/**/*`,
+      `${API_DIR}/**`,
+      `${SHARED_DIR}/**/*`,
     ];
 
+    const defaultWatchedPaths = defaultWatched.map(p =>
+      path.normalize(path.join(pwd, p)),
+    );
+    const mockPath = path.normalize(path.join(pwd, mock));
+
     const watcher = new Watcher();
     watcher.createDepTree();
 
     // 监听文件变动，如果有变动则给 client，也就是 start 启动的插件发消息
-    watcher.listen(defaultWatched, (filepath: string) => {
-      watcher.updateDepTree();
-      watcher.cleanDepCache(filepath);
-
-      this.runner.reset();
-
-      if (filepath.startsWith(`${pwd}/${mock}`)) {
-        this.mockHandler = createMockHandler({ pwd });
-      } else {
-        try {
-          this.prepareFrameHandler();
-        } catch (e) {
-          this.logger.error(e as Error);
+    watcher.listen(
+      defaultWatchedPaths,
+      {
+        // 初始化的时候不触发 add、addDir 事件
+        ignoreInitial: true,
+        ignored: /api\/typings\/.*/,
+      },
+      (filepath: string) => {
+        watcher.updateDepTree();
+        watcher.cleanDepCache(filepath);
+
+        this.runner.reset();
+
+        if (filepath.startsWith(mockPath)) {
+          this.mockHandler = createMockHandler({ pwd });
+        } else {
+          try {
+            this.prepareFrameHandler();
+          } catch (e) {
+            this.logger.error(e as Error);
+          }
         }
-      }
-    });
+      },
+    );
 
     this.watcher = watcher;
   }

package/tests/server.test.ts

@@ -3,6 +3,7 @@ import { defaultsConfig, NormalizedConfig } from '@modern-js/core';
 import { ModernServerContext, NextFunction } from '@modern-js/types';
 import createServer, { Server } from '../src';
 import { ModernServer } from '../src/server/modern-server';
+import Watcher from '../src/dev-tools/watcher';
 
 describe('test server', () => {
   test('should throw error when ', resolve => {
@@ -99,3 +100,21 @@ describe('test server', () => {
     });
   });
 });
+
+describe('dev server', () => {
+  const pwd = path.join(__dirname, './fixtures/pure');
+  let devServer: Server;
+
+  test('watch', async () => {
+    devServer = await createServer({
+      config: defaultsConfig as NormalizedConfig,
+      pwd,
+      dev: true,
+    });
+
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    expect(devServer.server.watcher).toBeInstanceOf(Watcher);
+    await devServer.close();
+  });
+});

package/tests/watcher.test.ts

@@ -0,0 +1,96 @@
+import * as path from 'path';
+import { fs } from '@modern-js/utils';
+import Watcher from '../src/dev-tools/watcher';
+
+jest.useRealTimers();
+
+describe('watcher', () => {
+  let watcher: Watcher;
+  jest.setTimeout(25000);
+  beforeAll(() => {
+    watcher = new Watcher();
+  });
+
+  test('should emit change', done => {
+    const pwd = path.join(__dirname, './fixtures/pure');
+    const serverDir = path.normalize(path.join(pwd, './tmp-server'));
+
+    const callback = jest.fn();
+    if (fs.pathExistsSync(serverDir)) {
+      fs.removeSync(serverDir);
+    }
+    const writeFiles = () => {
+      fs.mkdirSync(serverDir);
+      fs.writeFileSync(
+        path.normalize(path.join(serverDir, 'index.js')),
+        'test',
+        'utf8',
+      );
+    };
+
+    const clear = () => {
+      fs.removeSync(serverDir);
+    };
+
+    watcher.listen(
+      [`${serverDir}/**/*`],
+      {
+        ignoreInitial: true,
+        ignored: /api\/typings\/.*/,
+      },
+      async () => {
+        callback();
+        expect(callback).toHaveBeenCalledTimes(1);
+        await watcher.close();
+        clear();
+        done();
+      },
+    );
+
+    setTimeout(writeFiles, 100);
+  });
+
+  test('should not emit change when typings file changed', done => {
+    const pwd = path.join(__dirname, './fixtures/pure');
+    const apiDir = path.normalize(path.join(pwd, './api'));
+
+    const callback = jest.fn();
+
+    if (fs.pathExistsSync(apiDir)) {
+      fs.removeSync(apiDir);
+    }
+
+    const writeFiles = () => {
+      fs.mkdirSync(path.normalize(path.join(apiDir, 'typings')), {
+        recursive: true,
+      });
+      fs.writeFileSync(
+        path.normalize(path.join(apiDir, 'typings/index.js')),
+        'test',
+        'utf8',
+      );
+    };
+
+    const clear = () => {
+      fs.removeSync(apiDir);
+    };
+
+    watcher.listen(
+      [`${apiDir}/**/*`],
+      {
+        ignoreInitial: true,
+        ignored: /api\/typings\/.*/,
+      },
+      callback,
+    );
+
+    setTimeout(async () => {
+      expect(callback).toHaveBeenCalledTimes(0);
+      await watcher.close();
+      clear();
+      done();
+    }, 1000);
+
+    setTimeout(writeFiles);
+  });
+});