feat: [BREAKING_CHANGE] check the status of app when start on daemon (#9)

Author: popomore

.eslintignore

@@ -1,2 +1 @@
-test/fixtures
 coverage

.gitignore

@@ -1,10 +1,8 @@
 logs/
 npm-debug.log
-node_modules/
+/node_modules
 coverage/
 .idea/
 run/
 .DS_Store
 *.swp
-!test/fixtures/example/node_modules
-

README.md

@@ -2,6 +2,8 @@
 
 deploy tool for egg project.
 
+**Note: Windows is not supported**
+
 ## Install
 
 ```bash
@@ -54,13 +56,11 @@ $ egg-scripts start [options] [baseDir]
 
 Stop egg gracefull.
 
-**Note:** **Windows is not supported yet**, try to kill master process which command contains `start-cluster` or `--title=egg-server` yourself, good luck.
-
 ```bash
 # stop egg
 $ egg-scripts stop [baseDir]
 # egg-scripts stop ./server
 ```
 
 - **Arguments**
-  - `baseDir` - directory of application, default to `process.cwd()`.
+  - `baseDir` - directory of application, default to `process.cwd()`.

lib/cmd/start.js

@@ -2,9 +2,11 @@
 
 const path = require('path');
 const mkdirp = require('mz-modules/mkdirp');
+const sleep = require('mz-modules/sleep');
 const homedir = require('node-homedir');
 const utils = require('egg-utils');
 const fs = require('mz/fs');
+const { exec } = require('mz/child_process');
 const moment = require('moment');
 const spawn = require('child_process').spawn;
 const Command = require('../command');
@@ -33,7 +35,7 @@ class StartCommand extends Command {
         default: process.env.PORT,
       },
       env: {
-        description: 'egg server env, default to `process.env.EGG_SERVER_ENV`',
+        description: 'server env, default to `process.env.EGG_SERVER_ENV`',
         default: process.env.EGG_SERVER_ENV,
       },
       framework: {
@@ -52,6 +54,11 @@ class StartCommand extends Command {
         description: 'A file that stderr redirect to',
         type: 'string',
       },
+      timeout: {
+        description: 'a timeout for start when daemon',
+        type: 'number',
+        default: 300 * 1000,
+      },
     };
   }
 
@@ -78,6 +85,8 @@ class StartCommand extends Command {
       baseDir,
     });
 
+    this.frameworkName = yield this.getFrameworkName(argv.framework);
+
     const pkgInfo = require(path.join(baseDir, 'package.json'));
     argv.title = argv.title || `egg-server-${pkgInfo.name}`;
 
@@ -120,27 +129,32 @@ class StartCommand extends Command {
       detached: false,
     };
 
-    this.logger.info(`starting egg application at ${baseDir}`);
+    this.logger.info('Starting %s application at %s', this.frameworkName, baseDir);
 
     const eggArgs = [ this.serverBin, JSON.stringify(argv), `--title=${argv.title}` ];
-    this.logger.info('run node %s', eggArgs.join(' '));
+    this.logger.info('Run node %s', eggArgs.join(' '));
 
     // whether run in the background.
     if (isDaemon) {
-      this.logger.info(`save log file to ${logDir}`);
+      this.logger.info(`Save log file to ${logDir}`);
       const [ stdout, stderr ] = yield [ getRotatelog(argv.stdout), getRotatelog(argv.stderr) ];
       options.stdio = [ 'ignore', stdout, stderr, 'ipc' ];
       options.detached = true;
 
       const child = this.child = spawn('node', eggArgs, options);
+      this.isReady = false;
       child.on('message', msg => {
         if (msg && msg.action === 'egg-ready') {
-          this.logger.info(`egg started on ${msg.data.address}`);
+          this.isReady = true;
+          this.logger.info('%s started on %s', this.frameworkName, msg.data.address);
           child.unref();
           child.disconnect();
           process.exit(0);
         }
       });
+
+      // check start status
+      yield this.checkStatus(argv);
     } else {
       // signal event had been handler at common-bin helper
       this.helper.spawn('node', eggArgs, options);
@@ -151,6 +165,52 @@ class StartCommand extends Command {
     return utils.getFrameworkPath(params);
   }
 
+  * getFrameworkName(framework) {
+    const pkgPath = path.join(framework, 'package.json');
+    let name = 'egg';
+    try {
+      const pkg = require(pkgPath);
+      if (pkg.name) name = pkg.name;
+    } catch (_) {
+      /* istanbul next */
+    }
+    return name;
+  }
+
+  * checkStatus({ stderr, timeout }) {
+    let count = 0;
+    let isSuccess = true;
+    timeout = timeout / 1000;
+    while (!this.isReady) {
+      try {
+        const stat = yield fs.stat(stderr);
+        if (stat && stat.size > 0) {
+          const [ stdout ] = yield exec('tail -n 100 ' + stderr);
+          this.logger.error(stdout);
+          this.logger.error('Start failed, see %s', stderr);
+          isSuccess = false;
+          break;
+        }
+      } catch (_) {
+        // nothing
+      }
+
+      if (count >= timeout) {
+        this.logger.error('Start failed, %ds timeout', timeout);
+        isSuccess = false;
+        break;
+      }
+
+      yield sleep(1000);
+      this.logger.log('Wait Start: %d...', ++count);
+    }
+
+    if (!isSuccess) {
+      this.child.kill('SIGTERM');
+      yield sleep(1000);
+      process.exit(1);
+    }
+  }
 }
 
 function* getRotatelog(logfile) {

package.json

@@ -7,25 +7,25 @@
     "egg-scripts": "bin/egg-scripts.js"
   },
   "dependencies": {
-    "common-bin": "^2.5.0",
+    "common-bin": "^2.7.1",
     "egg-utils": "^2.2.0",
-    "moment": "^2.18.1",
-    "mz": "^2.6.0",
-    "mz-modules": "^1.0.0",
-    "node-homedir": "^1.0.0",
+    "moment": "^2.19.1",
+    "mz": "^2.7.0",
+    "mz-modules": "^2.0.0",
+    "node-homedir": "^1.1.0",
     "runscript": "^1.3.0",
     "zlogger": "^1.1.0"
   },
   "devDependencies": {
-    "autod": "^2.9.0",
+    "autod": "^2.10.1",
     "coffee": "^4.1.0",
-    "egg": "^1.7.0",
-    "egg-bin": "^4.1.0",
+    "egg": "^1.9.0",
+    "egg-bin": "^4.3.5",
     "egg-ci": "^1.8.0",
-    "eslint": "^4.4.1",
-    "eslint-config-egg": "^5.0.0",
-    "mm": "^2.1.0",
-    "urllib": "^2.24.0",
+    "eslint": "^4.8.0",
+    "eslint-config-egg": "^5.1.1",
+    "mm": "^2.2.0",
+    "urllib": "^2.25.0",
     "webstorm-disable-index": "^1.2.0"
   },
   "engines": {

test/fixtures/cluster-config/config/config.prod.js

@@ -3,5 +3,5 @@
 exports.cluster = {
   listen: {
     port: 8000,
-  }
-}
+  },
+};

test/fixtures/egg-app/config/config.default.js

@@ -0,0 +1,8 @@
+'use strict';
+
+exports.keys = '123456';
+
+exports.logger = {
+  level: 'WARN',
+  consoleLevel: 'WARN',
+};

test/fixtures/egg-app/node_modules/egg/index.js

@@ -0,0 +1,6 @@
+{
+  "name": "example",
+  "dependencies": {
+    "egg": "^1.0.0"
+  }
+}