feat(core): Ensure that Ghost was started

closes #472 - added port polling utility - general process manager class offers `ensureStarted` function - systemd extension makes use of `ensureStarted`
TryGhost · Feb 4, 2018 · 1ed5c93 · 1ed5c93
1 parent 76829e9
commit 1ed5c93
Show file tree

Hide file tree

Showing 7 changed files with 326 additions and 5 deletions.
diff --git a/extensions/systemd/systemd.js b/extensions/systemd/systemd.js
@@ -14,7 +14,18 @@ class SystemdProcessManager extends cli.ProcessManager {
         this._precheck();
 
         return this.ui.sudo(`systemctl start ${this.systemdName}`)
-            .catch((error) => Promise.reject(new cli.errors.ProcessError(error)));
+            .then(() => {
+                return this.ensureStarted({
+                    logSuggestion: `journalctl -u ${this.systemdName} -n 50`
+                });
+            })
+            .catch((error) => {
+                if (error instanceof cli.errors.CliError) {
+                    throw error;
+                }
+
+                throw new cli.errors.ProcessError(error);
+            });
     }
 
     stop() {
@@ -28,7 +39,16 @@ class SystemdProcessManager extends cli.ProcessManager {
         this._precheck();
 
         return this.ui.sudo(`systemctl restart ${this.systemdName}`)
-            .catch((error) => Promise.reject(new cli.errors.ProcessError(error)));
+            .then(() => {
+                return this.ensureStarted();
+            })
+            .catch((error) => {
+                if (error instanceof cli.errors.CliError) {
+                    throw error;
+                }
+
+                throw new cli.errors.ProcessError(error);
+            });
     }
 
     isEnabled() {

diff --git a/extensions/systemd/test/systemd-spec.js b/extensions/systemd/test/systemd-spec.js
@@ -32,6 +32,7 @@ describe('Unit: Systemd > Process Manager', function () {
         beforeEach(function () {
             ui = {sudo: sinon.stub().resolves()},
             ext = new Systemd(ui, null, instance);
+            ext.ensureStarted = sinon.stub().resolves();
             ext._precheck = () => true;
         });
 
@@ -68,6 +69,7 @@ describe('Unit: Systemd > Process Manager', function () {
         beforeEach(function () {
             ui = {sudo: sinon.stub().resolves()},
             ext = new Systemd(ui, null, instance);
+            ext.ensureStarted = sinon.stub().resolves();
             ext._precheck = () => true;
         });
 
@@ -104,6 +106,7 @@ describe('Unit: Systemd > Process Manager', function () {
         beforeEach(function () {
             ui = {sudo: sinon.stub().resolves()},
             ext = new Systemd(ui, null, instance);
+            ext.ensureStarted = sinon.stub().resolves();
             ext._precheck = () => true;
         });
 

diff --git a/lib/commands/run.js b/lib/commands/run.js
@@ -1,5 +1,6 @@
 'use strict';
 const spawn = require('child_process').spawn;
+const merge = require('lodash/merge');
 const Command = require('../command');
 
 class RunCommand extends Command {
@@ -54,7 +55,9 @@ class RunCommand extends Command {
         this.sudo = true;
     }
 
-    useDirect(instance) {
+    useDirect(instance, options) {
+        options = merge({delayErrorChaining: true}, options || {});
+
         this.child = spawn(process.execPath, ['current/index.js'], {
             cwd: instance.dir,
             stdio: [0, 1, 2, 'ipc']
@@ -71,7 +74,12 @@ class RunCommand extends Command {
                 return;
             }
 
-            instance.process.error(message.error);
+            if (!options.delayErrorChaining) {
+                instance.process.error(message.error);
+            } else {
+                // NOTE: Backwards compatibility of https://github.com/TryGhost/Ghost/pull/9440
+                setTimeout(() => {instance.process.error(message.error);}, 1000);
+            }
         });
     }
 

diff --git a/lib/process-manager.js b/lib/process-manager.js
@@ -1,5 +1,8 @@
 'use strict';
+
 const every = require('lodash/every');
+const merge = require('lodash/merge');
+const portPolling = require('./utils/port-polling');
 const requiredMethods = [
     'start',
     'stop',
@@ -60,6 +63,33 @@ class ProcessManager {
         // Base Implementation
     }
 
+    /**
+     * General implementation of figuring out if the Ghost blog has started successfully.
+     *
+     * @returns {Promise<any>}
+     */
+    ensureStarted(options) {
+        options = merge({
+            stopOnError: true,
+            port: this.instance.config.get('server.port')
+        }, options || {});
+
+        return portPolling(options)
+            .catch((err) => {
+                if (options.stopOnError) {
+                    return this.stop()
+                        .then(() => {
+                            throw err;
+                        })
+                        .catch(() => {
+                            throw err;
+                        });
+                }
+
+                throw err;
+            });
+    }
+
     /**
      * This function checks if this process manager can be used on this system
      *

diff --git a/lib/utils/port-polling.js b/lib/utils/port-polling.js
@@ -0,0 +1,99 @@
+'use strict';
+
+const net = require('net');
+const merge = require('lodash/merge');
+const errors = require('../errors');
+
+module.exports = function portPolling(options) {
+    options = merge({
+        timeoutInMS: 1000,
+        maxTries: 20,
+        delayOnConnectInMS: 3 * 1000,
+        logSuggestion: 'ghost log',
+        socketTimeoutInMS: 1000 * 30
+    }, options || {});
+
+    if (!options.port) {
+        return Promise.reject(new errors.CliError({
+            message: 'Port is required.'
+        }));
+    }
+
+    const connectToGhostSocket = (() => {
+        return new Promise((resolve, reject) => {
+            const ghostSocket = net.connect(options.port);
+
+            // inactivity timeout
+            ghostSocket.setTimeout(options.socketTimeoutInMS);
+            ghostSocket.on('timeout', (() => {
+                ghostSocket.destroy();
+
+                // force retry
+                const err = new Error();
+                err.retry = true;
+                reject(err);
+            }));
+
+            ghostSocket.on('connect', (() => {
+                if (options.delayOnConnectInMS) {
+                    let ghostDied = false;
+
+                    // CASE: client closes socket
+                    ghostSocket.on('close', (() => {
+                        ghostDied = true;
+                    }));
+
+                    setTimeout(() => {
+                        ghostSocket.destroy();
+
+                        if (ghostDied) {
+                            reject(new Error('Ghost died.'));
+                        } else {
+                            resolve();
+                        }
+                    }, options.delayOnConnectInMS);
+
+                    return;
+                }
+
+                ghostSocket.destroy();
+                resolve();
+            }));
+
+            ghostSocket.on('error', ((err) => {
+                ghostSocket.destroy();
+
+                err.retry = true;
+                reject(err);
+            }));
+        });
+    });
+
+    const startPolling = (() => {
+        return new Promise((resolve, reject) => {
+            let tries = 0;
+
+            (function retry() {
+                connectToGhostSocket()
+                    .then(() => {
+                        resolve();
+                    })
+                    .catch((err) => {
+                        if (err.retry && tries < options.maxTries) {
+                            tries = tries + 1;
+                            setTimeout(retry, options.timeoutInMS);
+                            return;
+                        }
+
+                        reject(new errors.GhostError({
+                            message: 'Ghost did not start.',
+                            suggestion: options.logSuggestion,
+                            err: err
+                        }));
+                    });
+            }());
+        });
+    });
+
+    return startPolling();
+};
diff --git a/test/unit/commands/run-spec.js b/test/unit/commands/run-spec.js
@@ -166,7 +166,7 @@ describe('Unit: Commands > Run', function () {
         const errorStub = sinon.stub();
         const exitStub = sinon.stub(process, 'exit');
 
-        instance.useDirect({dir: '/var/www/ghost', process: {success: successStub, error: errorStub}});
+        instance.useDirect({dir: '/var/www/ghost', process: {success: successStub, error: errorStub}}, {delayErrorChaining: false});
 
         expect(spawnStub.calledOnce).to.be.true;
         expect(spawnStub.calledWithExactly(process.execPath, ['current/index.js'], {