ghost 5.6.0 → 5.8.0

package/core/server/services/mega/post-email-serializer.js

@@ -8,7 +8,7 @@ const api = require('../../api').endpoints;
 const apiShared = require('../../api').shared;
 const {URL} = require('url');
 const mobiledocLib = require('../../lib/mobiledoc');
-const htmlToPlaintext = require('../../../shared/html-to-plaintext');
+const htmlToPlaintext = require('@tryghost/html-to-plaintext');
 const membersService = require('../members');
 const {isUnsplashImage, isLocalContentImage} = require('@tryghost/kg-default-cards/lib/utils');
 const {textColorForBackgroundColor, darkenToContrastThreshold} = require('@tryghost/color-utils');
@@ -351,8 +351,8 @@ function renderPaywallCTA(post) {
     <h2
         style="margin-top: 0; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; line-height: 1.11em; font-weight: 700; text-rendering: optimizeLegibility; margin: 1.5em 0 0.5em 0; font-size: 26px;">
         Subscribe to <span style="white-space: nowrap; font-size: 26px !important;">continue reading.</span></h2>
-    <p style="margin: 0 auto 1.5em auto; line-height: 1.6em; max-width: 440px;">Become a paid member of ${siteTitle} to get access to 
-    <span style="white-space: nowrap;">all subscriber-only content.</span></p>
+    <p style="margin: 0 auto 1.5em auto; line-height: 1.6em; max-width: 440px;">Become a paid member of ${siteTitle} to get access to all 
+    <span style="white-space: nowrap;">subscriber-only content.</span></p>
     <div class="btn btn-accent" style="box-sizing: border-box; width: 100%; display: table;">
         <table border="0" cellspacing="0" cellpadding="0" align="center"
             style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: auto;">

package/core/server/services/members/middleware.js

@@ -116,7 +116,7 @@ const updateMemberNewsletters = async function (req, res) {
 
 const updateMemberData = async function (req, res) {
     try {
-        const data = _.pick(req.body, 'name', 'subscribed', 'newsletters', 'enable_comment_notifications');
+        const data = _.pick(req.body, 'name', 'bio', 'subscribed', 'newsletters', 'enable_comment_notifications');
         const member = await membersService.ssr.getMemberDataFromSession(req, res);
         if (member) {
             const options = {

package/core/server/services/members/utils.js

@@ -13,6 +13,7 @@ module.exports.formattedMemberResponse = function formattedMemberResponse(member
         email: member.email,
         name: member.name,
         firstname: member.name && member.name.split(' ')[0],
+        bio: member.bio,
         avatar_image: member.avatar_image,
         subscribed: !!member.subscribed,
         subscriptions: member.subscriptions || [],

package/core/server/services/settings/settings-service.js

@@ -9,6 +9,7 @@ const events = require('../../lib/common/events');
 const models = require('../../models');
 const labs = require('../../../shared/labs');
 const config = require('../../../shared/config');
+const adapterManager = require('../adapter-manager');
 const SettingsCache = require('../../../shared/settings-cache');
 const SettingsBREADService = require('./settings-bread-service');
 const {obfuscatedSetting, isSecretSetting, hideValueIfSecret} = require('./settings-utils');
@@ -66,8 +67,9 @@ module.exports = {
      * Initialize the cache, used in boot and in testing
      */
     async init() {
+        const cacheStore = adapterManager.getAdapter('cache');
         const settingsCollection = await models.Settings.populateDefaults();
-        SettingsCache.init(events, settingsCollection, this.getCalculatedFields());
+        SettingsCache.init(events, settingsCollection, this.getCalculatedFields(), cacheStore);
     },
 
     /**

package/core/server/services/url/Resources.js

@@ -159,7 +159,7 @@ class Resources {
      * @description Call the model layer to fetch a single resource via raw knex queries.
      *
      * This function was invented, because the model event is a generic event, which is independent of any
-     * api version behaviour. We have to ensure that a model matches the conditions of the configured api version
+     * api version behavior. We have to ensure that a model matches the conditions of the configured api version
      * in the theme.
      *
      * See https://github.com/TryGhost/Ghost/issues/10124.

package/core/server/web/admin/app.js

@@ -1,4 +1,5 @@
 const debug = require('@tryghost/debug')('web:admin:app');
+const path = require('path');
 const express = require('../../../shared/express');
 const serveStatic = express.static;
 const config = require('../../../shared/config');
@@ -17,7 +18,7 @@ module.exports = function setupAdminApp() {
     // @TODO ensure this gets a local 404 error handler
     const configMaxAge = config.get('caching:admin:maxAge');
     adminApp.use('/assets', serveStatic(
-        config.get('paths').adminAssets,
+        path.join(config.get('paths').adminAssets, 'assets'),
         {maxAge: (configMaxAge || configMaxAge === 0) ? configMaxAge : constants.ONE_YEAR_MS, fallthrough: false}
     ));
 

package/core/server/web/admin/controller.js

@@ -29,8 +29,7 @@ module.exports = function adminController(req, res) {
     // CASE: trigger update check unit and let it run in background, don't block the admin rendering
     updateCheck();
 
-    const defaultTemplate = config.get('env') === 'production' ? 'default-prod.html' : 'default.html';
-    const templatePath = path.resolve(config.get('paths').adminViews, defaultTemplate);
+    const templatePath = path.resolve(config.get('paths').adminAssets, 'index.html');
     const headers = {};
 
     try {

package/core/shared/config/defaults.json

@@ -23,6 +23,9 @@
     "adapters": {
         "sso": {
             "active": "Default"
+        },
+        "cache": {
+            "active": "Memory"
         }
     },
     "storage": {
@@ -134,7 +137,7 @@
     },
     "portal": {
         "url": "https://cdn.jsdelivr.net/npm/@tryghost/portal@~{version}/umd/portal.min.js",
-        "version": "2.3"
+        "version": "2.5"
     },
     "sodoSearch": {
         "url": "https://cdn.jsdelivr.net/npm/@tryghost/sodo-search@~{version}/umd/sodo-search.min.js",
@@ -144,13 +147,13 @@
     "comments": {
         "url": "https://cdn.jsdelivr.net/npm/@tryghost/comments-ui@~{version}/umd/comments-ui.min.js",
         "styles": "https://cdn.jsdelivr.net/npm/@tryghost/comments-ui@~{version}/umd/main.css",
-        "version": "0.2"
+        "version": "0.4"
     },
     "editor": {
-        "url": "https://cdn.jsdelivr.net/npm/@tryghost/koenig-react/dist/umd/koenig-react.min.js"
+        "url": "https://unpkg.com/@tryghost/koenig-react/dist/umd/koenig-react.min.js"
     },
     "tenor": {
-        "publicReadOnlyApiKey": null,
+        "googleApiKey": null,
         "contentFilter": "off"
     },
     "opensea": {

package/core/shared/config/overrides.json

@@ -2,10 +2,9 @@
     "paths": {
         "appRoot": ".",
         "corePath": "core/",
-        "adminAssets": "core/built/assets",
+        "adminAssets": "core/built/admin",
         "adminAuthAssets": "content/public/admin-auth",
         "helperTemplates": "core/frontend/helpers/tpl/",
-        "adminViews": "core/server/web/admin/views/",
         "defaultViews": "core/server/views/",
         "defaultRouteSettings": "core/server/services/route-settings/",
         "internalAppPath": "core/frontend/apps/",

package/core/shared/labs.js

@@ -14,7 +14,9 @@ const messages = {
 };
 
 // flags in this list always return `true`, allows quick global enable prior to full flag removal
-const GA_FEATURES = [];
+const GA_FEATURES = [
+    'newsletterPaywall'
+];
 
 // NOTE: this allowlist is meant to be used to filter out any unexpected
 //       input for the "labs" setting value
@@ -26,8 +28,7 @@ const ALPHA_FEATURES = [
     'urlCache',
     'beforeAfterCard',
     'comments',
-    'newsletterPaywall',
-    'explore'
+    'freeTrial'
 ];
 
 module.exports.GA_KEYS = [...GA_FEATURES];

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

@@ -4,77 +4,94 @@
 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 {Object} options.publicSettings - key/value pairs of settings which are publicly accessible
+     */
+    constructor({publicSettings}) {
+        // settingsCache holds cached settings, keyed by setting.key, contains the JSON version of the model
+        this.settingsCache;
+        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) {
+        // NOTE: "!this.settingsCache" is for when setting's cache is used
+        //       before it had a chance to initialize. Should be fixed when
+        //       it is decoupled from the model layer
+        if (!this.settingsCache || !this.settingsCache.get(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.get(key);
         }
 
-        return JSON.parse(settingsCache[key].value) || null;
-    } catch (err) {
-        return settingsCache[key].value || null;
+        // Default behavior is to try to resolve the value and return that
+        try {
+            // CASE: handle literal false
+            if (this.settingsCache.get(key).value === false || this.settingsCache.get(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.get(key).value))) {
+                return this.settingsCache.get(key).value || null;
+            }
+
+            return JSON.parse(this.settingsCache.get(key).value) || null;
+        } catch (err) {
+            return this.settingsCache.get(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 +100,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 +111,28 @@ module.exports = {
      * @param {object} value json version of settings model
      */
     set(key, value) {
-        settingsCache[key] = _.cloneDeep(value);
-    },
+        this.settingsCache.set(key, _.cloneDeep(value));
+    }
+
     /**
      * Get the entire cache object
      * Uses clone to prevent modifications from being reflected
+     * This method is dangerous in case the cache is "lazily" initialized
+     * could result in returning only a partially filled cache
      * @return {object} cache
+     * @deprecated this method is not "cache-friendly" and should be avoided from furhter usage
+     *             instead using multiple "get" calls
      */
     getAll() {
-        return _.cloneDeep(settingsCache);
-    },
+        const keys = this.settingsCache.keys();
+        const all = {};
+
+        keys.forEach((key) => {
+            all[key] = _.cloneDeep(this.settingsCache.get(key));
+        });
+
+        return all;
+    }
 
     /**
      * Get all the publically accessible cache entries with their correct names
@@ -112,67 +142,74 @@ 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
+     * Initialize the cache
      *
      * Optionally takes a collection of settings & can populate the cache with these.
      *
      * @param {EventEmitter} events
      * @param {Bookshelf.Collection<Settings>} settingsCollection
      * @param {Array} calculatedFields
-     * @return {object}
+     * @param {Object} cacheStore - cache storage instance base on Cache Base Adapter
+     * @return {Object} - filled out instance for Cache Base Adapter
      */
-    init(events, settingsCollection, calculatedFields) {
+    init(events, settingsCollection, calculatedFields, cacheStore) {
+        this.settingsCache = cacheStore;
         // First, reset the cache and
         this.reset(events);
 
         // // 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 = {};
+        if (this.settingsCache) {
+            this.settingsCache.reset();
+        }
 
-        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,6 @@
-/**
- * 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 cacheManager = new CacheManager({publicSettings});
+
+module.exports = cacheManager;

package/loggingrc.js

@@ -18,7 +18,7 @@ loggingConfig.metrics.metadata = {
     // Undefined if unavailable
     siteId: config.get('hostSettings:siteId'),
     domain: config.get('url'),
-    version: ghostVersion.safe
+    version: ghostVersion.original
 };
 
 module.exports = loggingConfig;