fix: dumpConfig support circular json (#2394)

lib/egg.js

@@ -7,6 +7,7 @@ const cluster = require('cluster-client');
 const extend = require('extend2');
 const ContextLogger = require('egg-logger').EggContextLogger;
 const ContextCookies = require('egg-cookies');
+const CircularJSON = require('circular-json');
 const ContextHttpClient = require('./core/context_httpclient');
 const Messenger = require('./core/messenger');
 const DNSCacheHttpClient = require('./core/dnscache_httpclient');
@@ -337,11 +338,11 @@ class EggApplication extends EggCore {
       const json = extend(true, {}, { config: this.config, plugins: this.plugins });
       utils.convertObject(json, ignoreList);
       const dumpFile = path.join(rundir, `${this.type}_config.json`);
-      fs.writeFileSync(dumpFile, JSON.stringify(json, null, 2));
+      fs.writeFileSync(dumpFile, CircularJSON.stringify(json, null, 2));
 
       // dump config meta
       const dumpMetaFile = path.join(rundir, `${this.type}_config_meta.json`);
-      fs.writeFileSync(dumpMetaFile, JSON.stringify(this.loader.configMeta, null, 2));
+      fs.writeFileSync(dumpMetaFile, CircularJSON.stringify(this.loader.configMeta, null, 2));
     } catch (err) {
       this.coreLogger.warn(`dumpConfig error: ${err.message}`);
     }

package.json

@@ -19,6 +19,7 @@
     "@types/urllib": "^2.25.0",
     "accepts": "^1.3.5",
     "agentkeepalive": "^3.4.1",
+    "circular-json": "^0.5.3",
     "cluster-client": "^2.0.0",
     "debug": "^3.1.0",
     "delegates": "^1.0.0",

test/fixtures/apps/dumpconfig-circular/app.js

@@ -0,0 +1,8 @@
+const sleep = require('mz-modules/sleep');
+
+module.exports = app => {
+  app.beforeStart(function*() {
+    yield sleep(500);
+    app.config.foo.push(app.config.foo);
+  });
+};

test/fixtures/apps/dumpconfig-circular/config/config.default.js

@@ -0,0 +1,4 @@
+exports.dynamic = 0;
+
+exports.keys = 'test key';
+exports.foo = [];

test/fixtures/apps/dumpconfig-circular/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "dumpconfig-circular"
+}

test/lib/egg.test.js

@@ -126,6 +126,24 @@ describe('test/lib/egg.test.js', () => {
     });
   });
 
+  describe('dumpConfig() with circular', () => {
+    let app;
+    before(() => {
+      app = utils.app('apps/dumpconfig-circular');
+    });
+    after(() => app.close());
+
+    it('should dump in config', async () => {
+      const baseDir = utils.getFilepath('apps/dumpconfig-circular');
+      await sleep(100);
+      await app.ready();
+
+      await sleep(100);
+      const json = readJson(path.join(baseDir, 'run/application_config.json'));
+      assert.deepEqual(json.config.foo, [ '~config~foo' ]);
+    });
+  });
+
   describe('dumpConfig() ignore error', () => {
     const baseDir = utils.getFilepath('apps/dump-ignore-error');
     let app;