feat: eggScriptsConfig support node-options (#54)

Author: atian25

README.md

@@ -79,11 +79,13 @@ $ eggctl stop [options]
 
 In addition to the command line specification, options can also be specified in `package.json`. However, the command line designation takes precedence.
 
-```json
+```js
 {
   "eggScriptsConfig": {
     "port": 1234,
-    "ignore-stderr": true
+    "ignore-stderr": true,
+    // will pass as `node --max-http-header-size=20000`
+    "node-options--max-http-header-size": "20000"
   }
 }
 ```
@@ -108,4 +110,4 @@ Please open an issue [here](https://github.com/eggjs/egg/issues?q=is%3Aissue+is%
 
 This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Tue Mar 08 2022 09:52:13 GMT+0800`.
 
-<!-- GITCONTRIBUTOR_END -->
+<!-- GITCONTRIBUTOR_END -->

lib/command.js

@@ -73,7 +73,19 @@ class Command extends BaseCommand {
       // read argv from eggScriptsConfig in package.json
       if (eggScriptsConfig && typeof eggScriptsConfig === 'object') {
         for (const key in pkgInfo.eggScriptsConfig) {
-          if (argv[key] == null) argv[key] = pkgInfo.eggScriptsConfig[key];
+          const v = pkgInfo.eggScriptsConfig[key];
+          // like https://github.com/node-modules/common-bin/blob/master/lib/helper.js#L180
+          if (key.startsWith('node-options--')) {
+            const newKey = key.replace('node-options--', '');
+            if (execArgvObj[newKey] == null) {
+              execArgvObj[newKey] = v;
+            }
+          } else {
+            if (argv[key] == null) {
+              // only set if key is not pass from command line
+              argv[key] = v;
+            }
+          }
         }
       }
 

test/fixtures/egg-scripts-node-options/app.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = () => {
+  console.log('process.execArgv:', process.execArgv);
+  console.log('maxHeaderSize:', require('http').maxHeaderSize);
+};

test/fixtures/egg-scripts-node-options/config/config.default.js

@@ -0,0 +1,3 @@
+'use strict';
+
+exports.keys = '123456';

test/fixtures/egg-scripts-node-options/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "dependencies": {
+    "egg": "^1.0.0"
+  },
+  "eggScriptsConfig": {
+    "workers": 1,
+    "node-options--max-http-header-size": "20000"
+  }
+}

test/start.test.js

@@ -548,6 +548,32 @@ describe('test/start.test.js', () => {
       });
     });
 
+    describe('read eggScriptsConfig', () => {
+      let app;
+      let fixturePath;
+
+      before(function* () {
+        fixturePath = path.join(__dirname, 'fixtures/egg-scripts-node-options');
+        yield utils.cleanup(fixturePath);
+      });
+
+      after(function* () {
+        app.proc.kill('SIGTERM');
+        yield utils.cleanup(fixturePath);
+      });
+
+      it('should start', function* () {
+        app = coffee.fork(eggBin, [ 'start', '--workers=1', fixturePath ]);
+        app.debug();
+        app.expect('code', 0);
+
+        yield sleep(waitTime);
+
+        assert(app.stderr === '');
+        assert(app.stdout.match(/maxHeaderSize: 20000/));
+      });
+    });
+
     describe('subDir as baseDir', () => {
       let app;
       const rootDir = path.join(__dirname, '..');