feat(cli): prevent reload when config is overwritten

koishijs · Jan 19, 2022 · 0c7f947 · 0c7f947
1 parent 80b3ea1
commit 0c7f947
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/packages/cli/src/addons/watcher.ts b/packages/cli/src/addons/watcher.ts
@@ -25,6 +25,8 @@ function unwrap(module: any) {
 const logger = new Logger('watch')
 
 export default class FileWatcher extends Service {
+  public suspend = false
+
   private root: string
   private watcher: FSWatcher
   private currentUpdate: Promise<void[]>
@@ -62,11 +64,14 @@ export default class FileWatcher extends Service {
     }
 
     this.watcher.on('change', (path) => {
-      if (!require.cache[path]) return
+      if (this.suspend) return
       logger.debug('change detected:', path)
 
+      const isEntry = path === this.ctx.app.loader.filename
+      if (!require.cache[path] && !isEntry) return
+
       // files independent from any plugins will trigger a full reload
-      if (path === this.ctx.app.loader.filename || this.externals.has(path)) {
+      if (isEntry || this.externals.has(path)) {
         return triggerFullReload()
       }
 
@@ -190,7 +195,6 @@ export default class FileWatcher extends Service {
 
     // delete module cache before re-require
     accepted.forEach((path) => {
-      logger.debug('cache deleted:', path)
       delete require.cache[path]
     })
 

diff --git a/packages/cli/src/addons/writer.ts b/packages/cli/src/addons/writer.ts
@@ -19,7 +19,11 @@ export default class ConfigWriter extends Service {
 
   writeConfig() {
     if (!this.allowWrite) return
+    // prevent hot reload when it's being written
+    const fileWatcher = this.ctx.fileWatcher
+    fileWatcher && (fileWatcher.suspend = true)
     writeFileSync(this.loader.filename, dump(this.config))
+    fileWatcher && (fileWatcher.suspend = false)
   }
 
   async loadPlugin(name: string, config: any) {

diff --git a/packages/cli/src/loader.ts b/packages/cli/src/loader.ts
@@ -55,6 +55,9 @@ export class Loader {
   loadConfig(): App.Config {
     if (['.yaml', '.yml'].includes(this.extname)) {
       return load(readFileSync(this.filename, 'utf8')) as any
+    } else if (['.json'].includes(this.extname)) {
+      // we do not use require here because it will pollute require.cache
+      return JSON.parse(readFileSync(this.filename, 'utf8')) as any
     } else {
       const module = require(this.filename)
       return module.default || module