ghost 5.7.0 → 5.7.1

package/core/shared/settings-cache/cache.js

@@ -4,77 +4,91 @@
 const debug = require('@tryghost/debug')('settings:cache');
 const _ = require('lodash');
 
-const publicSettings = require('./public');
-
-// Local function, only ever used for initializing
-// We deliberately call "set" on each model so that set is a consistent interface
-const updateSettingFromModel = function updateSettingFromModel(settingModel) {
-    debug('Auto updating', settingModel.get('key'));
-    module.exports.set(settingModel.get('key'), settingModel.toJSON());
-};
-
-const updateCalculatedField = function updateCalculatedField(field) {
-    return () => {
-        debug('Auto updating', field.key);
-        module.exports.set(field.key, field.getSetting());
-    };
-};
-
 /**
- * ## Cache
- * Holds cached settings
- * Keyed by setting.key
- * Contains the JSON version of the model
- * @type {{}} - object of objects
+ * Why hasn't this been moved to @tryghost/settings-cache yet?
+ *
+ * - It currently still couples the frontend and server together in a weird way via the event system
+ * - See the notes in core/server/lib/common/events
+ * - There's also a plan to introduce a proper caching layer, and rewrite this on top of that
  */
-let settingsCache = {};
-let _calculatedFields = [];
+class CacheManager {
+    /**
+     * @prop {Object} options
+     * @prop {{}} options.cache - object of objects. Holds cached settings, keyed by setting.key, contains the JSON version of the model
+     * @prop {Object} options.publicSettings - key/value pairs of settings which are publicly accessible
+     */
+    constructor({cache, publicSettings}) {
+        this.settingsCache = cache;
+        this.publicSettings = publicSettings;
+        this.calculatedFields = [];
+
+        this.get = this.get.bind(this);
+        this.set = this.set.bind(this);
+        this.getAll = this.getAll.bind(this);
+        this.getPublic = this.getPublic.bind(this);
+        this.reset = this.reset.bind(this);
+        this._doGet = this._doGet.bind(this);
+        this._updateSettingFromModel = this._updateSettingFromModel.bind(this);
+        this._updateCalculatedField = this._updateCalculatedField.bind(this);
+    }
 
-const doGet = (key, options) => {
-    if (!settingsCache[key]) {
-        return;
+    // Local function, only ever used for initializing
+    // We deliberately call "set" on each model so that set is a consistent interface
+    _updateSettingFromModel(settingModel) {
+        debug('Auto updating', settingModel.get('key'));
+        this.set(settingModel.get('key'), settingModel.toJSON());
     }
 
-    // Don't try to resolve to the value of the setting
-    if (options && options.resolve === false) {
-        return settingsCache[key];
+    _updateCalculatedField(field) {
+        return () => {
+            debug('Auto updating', field.key);
+            this.set(field.key, field.getSetting());
+        };
     }
 
-    // Default behaviour is to try to resolve the value and return that
-    try {
-        // CASE: handle literal false
-        if (settingsCache[key].value === false || settingsCache[key].value === 'false') {
-            return false;
+    _doGet(key, options) {
+        if (!this.settingsCache[key]) {
+            return;
         }
 
-        // CASE: if a string contains a number e.g. "1", JSON.parse will auto convert into integer
-        if (!isNaN(Number(settingsCache[key].value))) {
-            return settingsCache[key].value || null;
+        // Don't try to resolve to the value of the setting
+        if (options && options.resolve === false) {
+            return this.settingsCache[key];
         }
 
-        return JSON.parse(settingsCache[key].value) || null;
-    } catch (err) {
-        return settingsCache[key].value || null;
+        // Default behaviour is to try to resolve the value and return that
+        try {
+            // CASE: handle literal false
+            if (this.settingsCache[key].value === false || this.settingsCache[key].value === 'false') {
+                return false;
+            }
+
+            // CASE: if a string contains a number e.g. "1", JSON.parse will auto convert into integer
+            if (!isNaN(Number(this.settingsCache[key].value))) {
+                return this.settingsCache[key].value || null;
+            }
+
+            return JSON.parse(this.settingsCache[key].value) || null;
+        } catch (err) {
+            return this.settingsCache[key].value || null;
+        }
     }
-};
 
-/**
- *
- * IMPORTANT:
- * We store settings with a type and a key in the database.
- *
- * {
- *   type: core
- *   key: db_hash
- *   value: ...
- * }
- *
- * But the settings cache does not allow requesting a value by type, only by key.
- * e.g. settingsCache.get('db_hash')
- */
-module.exports = {
     /**
-     * Get a key from the settingsCache
+     *
+     * IMPORTANT:
+     * We store settings with a type and a key in the database.
+     *
+     * {
+     *   type: core
+     *   key: db_hash
+     *   value: ...
+     * }
+     *
+     * But the settings cache does not allow requesting a value by type, only by key.
+     * e.g. settingsCache.get('db_hash')
+     *
+     * Get a key from the this.settingsCache
      * Will resolve to the value, including parsing JSON, unless {resolve: false} is passed in as an option
      * In which case the full JSON version of the model will be resolved
      *
@@ -83,8 +97,9 @@ module.exports = {
      * @return {*}
      */
     get(key, options) {
-        return doGet(key, options);
-    },
+        return this._doGet(key, options);
+    }
+
     /**
      * Set a key on the cache
      * The only way to get an object into the cache
@@ -93,16 +108,17 @@ module.exports = {
      * @param {object} value json version of settings model
      */
     set(key, value) {
-        settingsCache[key] = _.cloneDeep(value);
-    },
+        this.settingsCache[key] = _.cloneDeep(value);
+    }
+
     /**
      * Get the entire cache object
      * Uses clone to prevent modifications from being reflected
      * @return {object} cache
      */
     getAll() {
-        return _.cloneDeep(settingsCache);
-    },
+        return _.cloneDeep(this.settingsCache);
+    }
 
     /**
      * Get all the publically accessible cache entries with their correct names
@@ -112,12 +128,13 @@ module.exports = {
     getPublic() {
         let settings = {};
 
-        _.each(publicSettings, (key, newKey) => {
-            settings[newKey] = doGet(key) ?? null;
+        _.each(this.publicSettings, (key, newKey) => {
+            settings[newKey] = this._doGet(key) ?? null;
         });
 
         return settings;
-    },
+    }
+
     /**
      * Initialise the cache
      *
@@ -134,45 +151,47 @@ module.exports = {
 
         // // if we have been passed a collection of settings, use this to populate the cache
         if (settingsCollection && settingsCollection.models) {
-            _.each(settingsCollection.models, updateSettingFromModel);
+            _.each(settingsCollection.models, this._updateSettingFromModel);
         }
 
-        _calculatedFields = Array.isArray(calculatedFields) ? calculatedFields : [];
+        this.calculatedFields = Array.isArray(calculatedFields) ? calculatedFields : [];
 
         // Bind to events to automatically keep up-to-date
-        events.on('settings.edited', updateSettingFromModel);
-        events.on('settings.added', updateSettingFromModel);
-        events.on('settings.deleted', updateSettingFromModel);
+        events.on('settings.edited', this._updateSettingFromModel);
+        events.on('settings.added', this._updateSettingFromModel);
+        events.on('settings.deleted', this._updateSettingFromModel);
 
         // set and bind calculated fields
-        _calculatedFields.forEach((field) => {
-            updateCalculatedField(field)();
+        this.calculatedFields.forEach((field) => {
+            this._updateCalculatedField(field)();
             field.dependents.forEach((dependent) => {
-                events.on(`settings.${dependent}.edited`, updateCalculatedField(field));
+                events.on(`settings.${dependent}.edited`, this._updateCalculatedField(field));
             });
         });
 
-        return settingsCache;
-    },
+        return this.settingsCache;
+    }
 
     /**
      * Reset both the cache and the listeners, must be called during init
      * @param {EventEmitter} events
      */
     reset(events) {
-        settingsCache = {};
+        this.settingsCache = {};
 
-        events.removeListener('settings.edited', updateSettingFromModel);
-        events.removeListener('settings.added', updateSettingFromModel);
-        events.removeListener('settings.deleted', updateSettingFromModel);
+        events.removeListener('settings.edited', this._updateSettingFromModel);
+        events.removeListener('settings.added', this._updateSettingFromModel);
+        events.removeListener('settings.deleted', this._updateSettingFromModel);
 
         //unbind calculated fields
-        _calculatedFields.forEach((field) => {
+        this.calculatedFields.forEach((field) => {
             field.dependents.forEach((dependent) => {
-                events.removeListener(`settings.${dependent}.edited`, updateCalculatedField(field));
+                events.removeListener(`settings.${dependent}.edited`, this._updateCalculatedField(field));
             });
         });
 
-        _calculatedFields = [];
+        this.calculatedFields = [];
     }
-};
+}
+
+module.exports = CacheManager;

package/core/shared/settings-cache/index.js

@@ -1,9 +1,7 @@
-/**
- * Why hasn't this been moved to @tryghost/settings-cache yet?
- *
- * - It currently still couples the frontend and server together in a weird way via the event system
- * - See the notes in core/server/lib/common/events
- * - There's also a plan to introduce a proper caching layer, and rewrite this on top of that
- * - Finally, I'm not sure if this shouldn't be two things - a cache, and a cache manager (the update system)
- */
-module.exports = require('./cache');
+const CacheManager = require('./cache');
+const publicSettings = require('./public');
+const cache = {};
+
+const cacheManager = new CacheManager({cache, publicSettings});
+
+module.exports = cacheManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ghost",
-  "version": "5.7.0",
+  "version": "5.7.1",
   "description": "The professional publishing platform",
   "author": "Ghost Foundation",
   "homepage": "https://ghost.org",
@@ -46,14 +46,15 @@
     "lint:test": "eslint -c test/.eslintrc.js --ignore-path test/.eslintignore 'test/**/*.js'",
     "lint:code": "yarn lint:server && yarn lint:shared && yarn lint:frontend",
     "lint": "yarn lint:server && yarn lint:shared && yarn lint:frontend && yarn lint:test",
-    "prepack": "grunt release"
+    "build:css": "postcss core/frontend/public/ghost.css --no-map --use cssnano -o core/frontend/public/ghost.min.css",
+    "prepack": "grunt release && yarn build:css"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0",
     "cli": "^1.17.0"
   },
   "dependencies": {
-    "@sentry/node": "7.8.0",
+    "@sentry/node": "7.8.1",
     "@tryghost/adapter-manager": "file:components/tryghost-adapter-manager-0.0.0.tgz",
     "@tryghost/admin-api-schema": "4.0.0",
     "@tryghost/api-version-compatibility-service": "file:components/tryghost-api-version-compatibility-service-0.0.0.tgz",
@@ -116,7 +117,7 @@
     "@tryghost/version": "0.1.15",
     "@tryghost/zip": "1.1.27",
     "amperize": "0.6.1",
-    "analytics-node": "6.1.0",
+    "analytics-node": "6.2.0",
     "bluebird": "3.7.2",
     "body-parser": "1.20.0",
     "bookshelf": "1.2.0",
@@ -126,6 +127,7 @@
     "bthreads": "0.5.1",
     "chalk": "4.1.2",
     "cheerio": "0.22.0",
+    "common-tags": "1.8.2",
     "compression": "1.7.4",
     "connect-slashes": "1.4.0",
     "cookie-session": "2.0.0",
@@ -142,7 +144,7 @@
     "ghost-storage-base": "1.0.0",
     "glob": "8.0.3",
     "got": "9.6.0",
-    "gscan": "4.32.0",
+    "gscan": "4.34.0",
     "html-to-text": "8.2.0",
     "human-number": "2.0.0",
     "image-size": "1.0.2",
@@ -156,7 +158,7 @@
     "knex": "2.2.0",
     "knex-migrator": "5.0.3",
     "lodash": "4.17.21",
-    "luxon": "2.5.0",
+    "luxon": "3.0.1",
     "mailgun-js": "0.22.0",
     "metascraper": "5.29.18",
     "metascraper-author": "5.29.15",
@@ -185,14 +187,14 @@
     "xml": "1.0.1"
   },
   "optionalDependencies": {
-    "@tryghost/html-to-mobiledoc": "1.8.6",
+    "@tryghost/html-to-mobiledoc": "1.8.7",
     "sqlite3": "5.0.11"
   },
   "devDependencies": {
-    "@lodder/grunt-postcss": "3.1.1",
     "@playwright/test": "1.24.2",
     "@tryghost/express-test": "0.11.1",
     "@tryghost/webhook-mock-receiver": "0.1.1",
+    "@types/common-tags": "1.8.1",
     "c8": "7.12.0",
     "cli-progress": "3.11.2",
     "coffeescript": "2.7.0",
@@ -202,7 +204,6 @@
     "grunt": "1.5.3",
     "grunt-bg-shell": "2.3.3",
     "grunt-contrib-clean": "2.0.1",
-    "grunt-contrib-copy": "1.0.0",
     "grunt-contrib-symlink": "1.0.0",
     "grunt-contrib-watch": "1.1.0",
     "grunt-express-server": "0.5.4",
@@ -216,6 +217,7 @@
     "nock": "13.2.9",
     "papaparse": "5.3.2",
     "postcss": "8.4.14",
+    "postcss-cli": "10.0.0",
     "rewire": "6.0.0",
     "should": "13.2.3",
     "sinon": "14.0.0",