fix(ui): add ghost instance version to debug error output (#1052)

TryGhost · Nov 7, 2019 · 185fb2c · 185fb2c
1 parent a7ba591
commit 185fb2c
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/lib/ui/index.js b/lib/ui/index.js
@@ -486,9 +486,13 @@ class UI {
      * @private
      */
     _formatDebug(system) {
+        const {version} = system.getInstance();
+        const ghostVersion = version ? `    Ghost Version: ${version}\n` : '';
+
         return 'Debug Information:\n' +
             `    OS: ${system.operatingSystem.os}, v${system.operatingSystem.version}\n` +
             `    Node Version: ${process.version}\n` +
+            ghostVersion +
             `    Ghost-CLI Version: ${system.cliVersion}\n` +
             `    Environment: ${system.environment}\n` +
             `    Command: 'ghost ${process.argv.slice(2).join(' ')}'`;

diff --git a/test/unit/ui/index-spec.js b/test/unit/ui/index-spec.js
@@ -947,14 +947,41 @@ describe('Unit: UI', function () {
             operatingSystem: {
                 os: 'Ubuntu',
                 version: '16'
-            }
+            },
+            getInstance: () => ({version: null})
+        };
+        const SPACES = '    ';
+        const UI = require(modulePath);
+        const ui = new UI();
+        const expected = ['Debug Information:',
+            `${SPACES}OS: Ubuntu, v16`,
+            `${SPACES}Node Version: ${process.version}`,
+            `${SPACES}Ghost-CLI Version: 0.9.1.8`,
+            `${SPACES}Environment: Earth`,
+            `${SPACES}Command: 'ghost ${process.argv.slice(2).join(' ')}'`
+        ];
+        const actual = ui._formatDebug(system).split('\n');
+
+        expect(expected).to.deep.equal(actual);
+    });
+
+    it('_formatDebug shows a ghost version if it exists', function () {
+        const system = {
+            cliVersion: '0.9.1.8',
+            environment: 'Earth',
+            operatingSystem: {
+                os: 'Ubuntu',
+                version: '16'
+            },
+            getInstance: () => ({version: '1.0.0'})
         };
         const SPACES = '    ';
         const UI = require(modulePath);
         const ui = new UI();
         const expected = ['Debug Information:',
             `${SPACES}OS: Ubuntu, v16`,
             `${SPACES}Node Version: ${process.version}`,
+            `${SPACES}Ghost Version: 1.0.0`,
             `${SPACES}Ghost-CLI Version: 0.9.1.8`,
             `${SPACES}Environment: Earth`,
             `${SPACES}Command: 'ghost ${process.argv.slice(2).join(' ')}'`