🎨 Optimise theme load & remove validation (#7970)

closes #7854

- Remove the concept of validating themes. This can now be done with gscan
- Delay the loading of themes until after the server has started
- Use events to trigger behaviour after the server has started
- Load the active theme first
- Don't load apps - this is totally unneeded
  - this is not used anywhere at present
  - the framework/lifecycle for apps works without it
  - this was intended for use in an app listing and isn't needed at all

NOTE: this is pretty hacky, intended to slightly improve LTS boot times. A better solution should be added for 1.0

Author: ErisDS

core/server/api/settings.js

@@ -6,8 +6,10 @@ var _            = require('lodash'),
     config       = require('../config'),
     canThis      = require('../permissions').canThis,
     errors       = require('../errors'),
+    events       = require('../events'),
     utils        = require('./utils'),
     i18n         = require('../i18n'),
+    readThemes   = require('../utils/read-themes'),
 
     docName      = 'settings',
     settings,
@@ -30,6 +32,20 @@ var _            = require('lodash'),
      */
     settingsCache = {};
 
+// @TODO figure out a better way to do this in the alpha
+function initActiveTheme(theme) {
+    return readThemes.active(config.paths.themePath, theme).then(function (result) {
+        config.set({paths: {availableThemes: result}});
+    });
+}
+
+// @TODO figure out a better way to do this in the alpha
+events.on('server:start', function () {
+    config.loadExtras().then(function () {
+        updateSettingsCache();
+    });
+});
+
 /**
 * ### Updates Config Theme Settings
 * Maintains the cache of theme specific variables that are reliant on settings.
@@ -182,14 +198,16 @@ readSettingsResult = function (settingsModels) {
         apps = config.paths.availableApps,
         res;
 
-    if (settings.activeTheme && themes) {
+    if (settings.activeTheme && !_.isEmpty(themes)) {
         res = filterPaths(themes, settings.activeTheme.value);
 
         settings.availableThemes = {
             key: 'availableThemes',
             value: res,
             type: 'theme'
         };
+    } else if (settings.activeTheme) {
+        initActiveTheme(settings.activeTheme.value);
     }
 
     if (settings.activeApps && apps) {

core/server/config/index.js

@@ -9,7 +9,6 @@ var path          = require('path'),
 
     validator     = require('validator'),
     generateAssetHash = require('../utils/asset-hash'),
-    readDirectory = require('../utils/read-directory'),
     readThemes    = require('../utils/read-themes'),
     errors        = require('../errors'),
     configUrl     = require('./url'),
@@ -78,10 +77,13 @@ ConfigManager.prototype.init = function (rawConfig) {
     // just the object appropriate for this NODE_ENV
     self.set(rawConfig);
 
+    return Promise.resolve(self._config);
+};
+
+ConfigManager.prototype.loadExtras = function () {
+    var self = this;
+
     return self.loadThemes()
-        .then(function () {
-            return self.loadApps();
-        })
         .then(function () {
             return self._config;
         });
@@ -92,16 +94,7 @@ ConfigManager.prototype.loadThemes = function () {
 
     return readThemes(self._config.paths.themePath)
         .then(function (result) {
-            self._config.paths.availableThemes = result;
-        });
-};
-
-ConfigManager.prototype.loadApps = function () {
-    var self = this;
-
-    return readDirectory(self._config.paths.appPath)
-        .then(function (result) {
-            self._config.paths.availableApps = result;
+            self.set({paths: {availableThemes: result}});
         });
 };
 

core/server/ghost-server.js

@@ -4,6 +4,7 @@ var Promise = require('bluebird'),
     chalk = require('chalk'),
     fs = require('fs'),
     errors = require('./errors'),
+    events = require('./events'),
     config = require('./config'),
     i18n   = require('./i18n'),
     moment = require('moment');
@@ -76,6 +77,7 @@ GhostServer.prototype.start = function (externalApp) {
         });
         self.httpServer.on('connection', self.connection.bind(self));
         self.httpServer.on('listening', function () {
+            events.emit('server:start');
             self.logStartMessages();
             resolve(self);
         });

core/server/index.js

@@ -31,7 +31,6 @@ var express = require('express'),
     slack = require('./data/slack'),
     GhostServer = require('./ghost-server'),
     scheduling = require('./scheduling'),
-    validateThemes = require('./utils/validate-themes'),
     dbHash;
 
 function initDbHashAndFirstRun() {
@@ -163,7 +162,9 @@ function init(options) {
             return Promise.reject(response.error);
         }
     }).then(function () {
-        // Initialize the settings cache
+        // Initialize the settings cache now,
+        // This is an optimisation, so that further reads from settings are fast.
+        // We do also do this after boot
         return api.init();
     }).then(function () {
         // Initialize the permissions actions and objects
@@ -187,19 +188,6 @@ function init(options) {
         // ## Middleware and Routing
         middleware(parentApp);
 
-        // Log all theme errors and warnings
-        validateThemes(config.paths.themePath)
-            .catch(function (result) {
-                // TODO: change `result` to something better
-                result.errors.forEach(function (err) {
-                    errors.logError(err.message, err.context, err.help);
-                });
-
-                result.warnings.forEach(function (warn) {
-                    errors.logWarn(warn.message, warn.context, warn.help);
-                });
-            });
-
         return new GhostServer(parentApp);
     }).then(function (_ghostServer) {
         ghostServer = _ghostServer;

core/server/utils/read-themes.js

@@ -3,12 +3,27 @@
  */
 
 var readDirectory = require('./read-directory'),
+    _ = require('lodash'),
     Promise = require('bluebird'),
     join = require('path').join,
     fs = require('fs'),
 
     statFile = Promise.promisify(fs.stat);
 
+function readActiveTheme(dir, name) {
+    var toRead = join(dir, name),
+        themes = {};
+
+    return readDirectory(toRead)
+        .then(function (tree) {
+            if (!_.isEmpty(tree)) {
+                themes[name] = tree;
+            }
+
+            return themes;
+        });
+}
+
 /**
  * Read themes
  */
@@ -44,3 +59,4 @@ function readThemes(dir) {
  */
 
 module.exports = readThemes;
+module.exports.active = readActiveTheme;

core/server/utils/validate-themes.js

@@ -2,7 +2,6 @@ var should          = require('should'),
     sinon           = require('sinon'),
     nock            = require('nock'),
     parsePackageJson = require('../../server/utils/parse-package-json'),
-    validateThemes  = require('../../server/utils/validate-themes'),
     readDirectory   = require('../../server/utils/read-directory'),
     readThemes      = require('../../server/utils/read-themes'),
     gravatar        = require('../../server/utils/gravatar'),
@@ -367,67 +366,6 @@ describe('Server Utilities', function () {
         });
     });
 
-    describe('validate-themes', function () {
-        it('should return warnings for themes without package.json', function (done) {
-            var themesPath, pkgJson;
-
-            themesPath = tmp.dirSync({unsafeCleanup: true});
-            pkgJson = JSON.stringify({
-                name: 'casper',
-                version: '1.0.0'
-            });
-
-            fs.mkdirSync(join(themesPath.name, 'casper'));
-            fs.mkdirSync(join(themesPath.name, 'invalid-casper'));
-
-            fs.writeFileSync(join(themesPath.name, 'casper', 'package.json'), pkgJson);
-
-            validateThemes(themesPath.name)
-                .then(function () {
-                    done(new Error('validateThemes succeeded, but should\'ve failed'));
-                })
-                .catch(function (result) {
-                    result.errors.length.should.equal(0);
-                    result.warnings.should.eql([{
-                        message: 'Found a theme with no package.json file',
-                        context: 'Theme name: invalid-casper',
-                        help: 'This will be required in future. Please see http://docs.ghost.org/themes/'
-                    }]);
-
-                    done();
-                })
-                .catch(done)
-                .finally(themesPath.removeCallback);
-        });
-
-        it('should return warning for theme with invalid package.json', function (done) {
-            var themesPath, pkgJson;
-
-            themesPath = tmp.dirSync({unsafeCleanup: true});
-            pkgJson = '{"name":casper}';
-
-            fs.mkdirSync(join(themesPath.name, 'casper'));
-            fs.writeFileSync(join(themesPath.name, 'casper', 'package.json'), pkgJson);
-
-            validateThemes(themesPath.name)
-                .then(function () {
-                    done(new Error('validateThemes succeeded, but should\'ve failed'));
-                })
-                .catch(function (result) {
-                    result.errors.length.should.equal(0);
-                    result.warnings.should.eql([{
-                        message: 'Found a malformed package.json',
-                        context: 'Theme name: casper',
-                        help: 'Valid package.json will be required in future. Please see http://docs.ghost.org/themes/'
-                    }]);
-
-                    done();
-                })
-                .catch(done)
-                .finally(themesPath.removeCallback);
-        });
-    });
-
     describe('gravatar-lookup', function () {
         var currentEnv = process.env.NODE_ENV;