ghost 4.42.1 → 4.44.0

package/core/frontend/services/{routing/helpers → rendering}/render-entries.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('services:routing:helpers:render-entries');
+const debug = require('@tryghost/debug')('services:routing:renderer:render-entries');
 const formatResponse = require('./format-response');
 const renderer = require('./renderer');
 

package/core/frontend/services/{routing/helpers → rendering}/render-entry.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('services:routing:helpers:render-post');
+const debug = require('@tryghost/debug')('services:routing:renderer:render-post');
 const formatResponse = require('./format-response');
 const renderer = require('./renderer');
 /**

package/core/frontend/services/{routing/helpers → rendering}/renderer.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('services:routing:helpers:renderer');
+const debug = require('@tryghost/debug')('services:routing:renderer:renderer');
 const setContext = require('./context');
 const templates = require('./templates');
 

package/core/frontend/services/{routing/helpers → rendering}/templates.js

@@ -6,8 +6,8 @@ const _ = require('lodash');
 
 const path = require('path');
 const url = require('url');
-const config = require('../../../../shared/config');
-const themeEngine = require('../../theme-engine');
+const config = require('../../../shared/config');
+const themeEngine = require('../theme-engine');
 const _private = {};
 
 /**

package/core/frontend/services/routing/CollectionRouter.js

@@ -30,7 +30,7 @@ class CollectionRouter extends ParentRouter {
             value: object.permalink
         };
 
-        // @NOTE: see helpers/templates - we use unshift to prepend the templates
+        // @NOTE: see renderer/templates - we use unshift to prepend the templates
         this.templates = (object.templates || []).reverse();
 
         this.filter = object.filter;

package/core/frontend/services/routing/controllers/channel.js

@@ -4,7 +4,8 @@ const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const security = require('@tryghost/security');
 const themeEngine = require('../../theme-engine');
-const helpers = require('../helpers');
+const dataService = require('../../data');
+const renderer = require('../../rendering');
 
 const messages = {
     pageNotFound: 'Page not found.'
@@ -50,7 +51,7 @@ module.exports = function channelController(req, res, next) {
         }
     }
 
-    return helpers.fetchData(pathOptions, res.routerOptions, res.locals)
+    return dataService.fetchData(pathOptions, res.routerOptions, res.locals)
         .then(function handleResult(result) {
             // CASE: requested page is greater than number of pages we have
             if (pathOptions.page > result.meta.pagination.pages) {
@@ -60,16 +61,15 @@ module.exports = function channelController(req, res, next) {
             }
 
             // Format data 1
-            // @TODO: See helpers/secure for explanation.
-            helpers.secure(req, result.posts);
+            // @TODO: See renderer/secure for explanation.
+            renderer.secure(req, result.posts);
 
-            // @TODO: See helpers/secure for explanation.
+            // @TODO: See renderer/secure for explanation.
             _.each(result.data, function (data) {
-                helpers.secure(req, data);
+                renderer.secure(req, data);
             });
 
-            const renderer = helpers.renderEntries(req, res);
-            return renderer(result);
+            return renderer.renderEntries(req, res)(result);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/collection.js

@@ -5,7 +5,8 @@ const errors = require('@tryghost/errors');
 const security = require('@tryghost/security');
 const {routerManager} = require('../');
 const themeEngine = require('../../theme-engine');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
+const dataService = require('../../data');
 
 const messages = {
     pageNotFound: 'Page not found.'
@@ -49,7 +50,7 @@ module.exports = function collectionController(req, res, next) {
     }
 
     debug('fetching data');
-    return helpers.fetchData(pathOptions, res.routerOptions, res.locals)
+    return dataService.fetchData(pathOptions, res.routerOptions, res.locals)
         .then(function handleResult(result) {
             // CASE: requested page is greater than number of pages we have
             if (pathOptions.page > result.meta.pagination.pages) {
@@ -80,16 +81,15 @@ module.exports = function collectionController(req, res, next) {
             });
 
             // Format data 1
-            // @TODO: See helpers/secure for explanation.
-            helpers.secure(req, result.posts);
+            // @TODO: See renderer/secure for explanation.
+            renderer.secure(req, result.posts);
 
-            // @TODO: See helpers/secure for explanation.
+            // @TODO: See renderer/secure for explanation.
             _.each(result.data, function (data) {
-                helpers.secure(req, data);
+                renderer.secure(req, data);
             });
 
-            const renderer = helpers.renderEntries(req, res);
-            return renderer(result);
+            return renderer.renderEntries(req, res)(result);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/email-post.js

@@ -2,7 +2,7 @@ const debug = require('@tryghost/debug')('services:routing:controllers:emailpost
 const config = require('../../../../shared/config');
 const {routerManager} = require('../');
 const urlUtils = require('../../../../shared/url-utils');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
 
 /**
  * @description Email Post Controller.
@@ -55,11 +55,10 @@ module.exports = function emailPostController(req, res, next) {
                 post.access = !!post.html;
             }
 
-            // @TODO: See helpers/secure
-            helpers.secure(req, post);
+            // @TODO: See renderer/secure
+            renderer.secure(req, post);
 
-            const renderer = helpers.renderEntry(req, res);
-            return renderer(post);
+            return renderer.renderEntry(req, res)(post);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/entry.js

@@ -3,7 +3,8 @@ const url = require('url');
 const config = require('../../../../shared/config');
 const {routerManager} = require('../');
 const urlUtils = require('../../../../shared/url-utils');
-const helpers = require('../helpers');
+const dataService = require('../../data');
+const renderer = require('../../rendering');
 
 /**
  * @description Entry controller.
@@ -15,7 +16,7 @@ const helpers = require('../helpers');
 module.exports = function entryController(req, res, next) {
     debug('entryController', res.routerOptions);
 
-    return helpers.entryLookup(req.path, res.routerOptions, res.locals)
+    return dataService.entryLookup(req.path, res.routerOptions, res.locals)
         .then(function then(lookup) {
             // Format data 1
             const entry = lookup ? lookup.entry : false;
@@ -83,10 +84,9 @@ module.exports = function entryController(req, res, next) {
                 }));
             }
 
-            helpers.secure(req, entry);
+            renderer.secure(req, entry);
 
-            const renderer = helpers.renderEntry(req, res);
-            return renderer(entry);
+            return renderer.renderEntry(req, res)(entry);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/preview.js

@@ -2,7 +2,7 @@ const debug = require('@tryghost/debug')('services:routing:controllers:preview')
 const config = require('../../../../shared/config');
 const {routerManager} = require('../');
 const urlUtils = require('../../../../shared/url-utils');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
 
 /**
  * @description Preview Controller.
@@ -57,11 +57,10 @@ module.exports = function previewController(req, res, next) {
                 post.access = !!post.html;
             }
 
-            // @TODO: See helpers/secure
-            helpers.secure(req, post);
+            // @TODO: See renderer/secure
+            renderer.secure(req, post);
 
-            const renderer = helpers.renderEntry(req, res);
-            return renderer(post);
+            return renderer.renderEntry(req, res)(post);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/rss.js

@@ -4,7 +4,8 @@ const url = require('url');
 const security = require('@tryghost/security');
 const settingsCache = require('../../../../shared/settings-cache');
 const rssService = require('../../rss');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
+const dataService = require('../../data');
 
 // @TODO: is this really correct? Should we be using meta data title?
 function getTitle(relatedData) {
@@ -35,7 +36,7 @@ module.exports = function rssController(req, res, next) {
     // @TODO: This belongs to the rss service O_o
     const baseUrl = url.parse(req.originalUrl).pathname;
 
-    helpers.fetchData(pathOptions, res.routerOptions, res.locals)
+    dataService.fetchData(pathOptions, res.routerOptions, res.locals)
         .then(function formatResult(result) {
             const response = _.pick(result, ['posts', 'meta']);
 
@@ -47,5 +48,5 @@ module.exports = function rssController(req, res, next) {
         .then(function (data) {
             return rssService.render(res, baseUrl, data);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/static.js

@@ -1,7 +1,7 @@
 const _ = require('lodash');
 const Promise = require('bluebird');
 const debug = require('@tryghost/debug')('services:routing:controllers:static');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
 
 function processQuery(query, locals) {
     const api = require('../../proxy').api[locals.apiVersion];
@@ -60,12 +60,12 @@ module.exports = function staticController(req, res, next) {
                 });
             }
 
-            // @TODO: See helpers/secure for more context.
+            // @TODO: See renderer/secure for more context.
             _.each(response.data, function (data) {
-                helpers.secure(req, data);
+                renderer.secure(req, data);
             });
 
-            helpers.renderer(req, res, helpers.formatResponse.entries(response));
+            renderer.renderer(req, res, renderer.formatResponse.entries(response));
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/unsubscribe.js

@@ -1,7 +1,7 @@
 const debug = require('@tryghost/debug')('services:routing:controllers:unsubscribe');
 const path = require('path');
 const megaService = require('../../../../server/services/mega');
-const helpers = require('../../../services/routing/helpers');
+const renderer = require('../../rendering');
 
 module.exports = async function unsubscribeController(req, res) {
     debug('unsubscribeController');
@@ -22,5 +22,5 @@ module.exports = async function unsubscribeController(req, res) {
         defaultTemplate: path.resolve(__dirname, '../../../views/', templateName)
     };
 
-    return helpers.renderer(req, res, data);
+    return renderer.renderer(req, res, data);
 };

package/core/frontend/services/routing/index.js

@@ -7,9 +7,5 @@ module.exports = {
 
     get registry() {
         return registry;
-    },
-
-    get helpers() {
-        return require('./helpers');
     }
 };

package/core/frontend/web/middleware/error-handler.js

@@ -4,7 +4,7 @@ const tpl = require('@tryghost/tpl');
 const sentry = require('../../../shared/sentry');
 
 const config = require('../../../shared/config');
-const helpers = require('../../services/routing/helpers');
+const renderer = require('../../services/rendering');
 
 // @TODO: make this properly shared code
 const {prepareError, prepareStack} = require('@tryghost/mw-error-handler');
@@ -55,7 +55,7 @@ const themeErrorRenderer = (err, req, res, next) => {
 
     // Template
     // @TODO: very dirty !!!!!!
-    helpers.templates.setTemplate(req, res);
+    renderer.templates.setTemplate(req, res);
 
     // It can be that something went wrong with the theme or otherwise loading handlebars
     // This ensures that no matter what res.render will work here

package/core/server/api/canary/authentication.js

@@ -51,14 +51,14 @@ module.exports = {
                 })
                 .then((data) => {
                     try {
-                        return auth.setup.doFixtures(data, api.products);
+                        return auth.setup.doFixtures(data);
                     } catch (e) {
                         return data;
                     }
                 })
                 .then((data) => {
                     try {
-                        return auth.setup.doProduct(data, api.products);
+                        return auth.setup.doProductAndNewsletter(data, api);
                     } catch (e) {
                         return data;
                     }

package/core/server/api/canary/posts.js

@@ -129,6 +129,7 @@ module.exports = {
             'formats',
             'source',
             'email_recipient_filter',
+            'newsletter_id',
             'send_email_when_published',
             'force_rerender',
             // NOTE: only for internal context

package/core/server/api/canary/stats.js

@@ -10,5 +10,14 @@ module.exports = {
         async query() {
             return await statsService.members.getCountHistory();
         }
+    },
+    mrr: {
+        permissions: {
+            docName: 'members',
+            method: 'browse'
+        },
+        async query() {
+            return await statsService.mrr.getHistory();
+        }
     }
 };

package/core/server/api/canary/utils/serializers/output/members.js

@@ -1,6 +1,7 @@
 //@ts-check
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:members');
 const {unparse} = require('@tryghost/members-csv');
+const labsService = require('../../../../../../shared/labs');
 
 module.exports = {
     hasActiveStripeSubscriptions: createSerializer('hasActiveStripeSubscriptions', passthrough),
@@ -131,6 +132,13 @@ function serializeMember(member, options) {
         serialized.products = json.products;
     }
 
+    if (json.newsletters && labsService.isSet('multipleNewsletters')) {
+        json.newsletters.sort((a, b) => {
+            return a.sort_order - b.sort_order;
+        });
+        serialized.newsletters = json.newsletters;
+    }
+
     return serialized;
 }
 

package/core/server/api/canary/utils/validators/input/index.js

@@ -1,3 +1,9 @@
+// ESLint Override Notice
+// This is a valid index.js file - it just exports a lot of stuff!
+// Long term we would like to change the API architecture to reduce this file,
+// but that's not the problem the index.js max - line eslint "proxy" rule is there to solve.
+/* eslint-disable max-lines */
+
 module.exports = {
     get passwordreset() {
         return require('./passwordreset');

package/core/server/api/shared/http.js

@@ -13,7 +13,7 @@ const models = require('../../models');
  * @return {Function}
  */
 const http = (apiImpl) => {
-    return (req, res, next) => {
+    return async (req, res, next) => {
         debug(`External API request to ${req.url}`);
         let apiKey = null;
         let integration = null;
@@ -60,69 +60,70 @@ const http = (apiImpl) => {
             data: apiImpl.data
         });
 
-        apiImpl(frame)
-            .then((result) => {
-                debug(`External API request to ${frame.docName}.${frame.method}`);
-                return shared.headers.get(result, apiImpl.headers, frame)
-                    .then(headers => ({result, headers}));
-            })
-            .then(({result, headers}) => {
-                // CASE: api ctrl wants to handle the express response (e.g. streams)
-                if (typeof result === 'function') {
-                    debug('ctrl function call');
-                    return result(req, res, next);
-                }
+        try {
+            const result = await apiImpl(frame);
 
-                let statusCode = 200;
-                if (typeof apiImpl.statusCode === 'function') {
-                    statusCode = apiImpl.statusCode(result);
-                } else if (apiImpl.statusCode) {
-                    statusCode = apiImpl.statusCode;
-                }
+            debug(`External API request to ${frame.docName}.${frame.method}`);
+            const headers = await shared.headers.get(result, apiImpl.headers, frame) || {};
 
-                res.status(statusCode);
+            // CASE: api ctrl wants to handle the express response (e.g. streams)
+            if (typeof result === 'function') {
+                debug('ctrl function call');
+                return result(req, res, next);
+            }
 
-                // CASE: generate headers based on the api ctrl configuration
-                res.set(headers);
+            let statusCode = 200;
+            if (typeof apiImpl.statusCode === 'function') {
+                statusCode = apiImpl.statusCode(result);
+            } else if (apiImpl.statusCode) {
+                statusCode = apiImpl.statusCode;
+            }
 
-                const send = (format) => {
-                    if (format === 'plain') {
-                        debug('plain text response');
-                        return res.send(result);
-                    }
+            res.status(statusCode);
 
-                    debug('json response');
-                    res.json(result || {});
-                };
+            // CASE: generate headers based on the api ctrl configuration
+            if (req && req.headers && req.headers['accept-version'] && res.locals) {
+                headers['Content-Version'] = `v${res.locals.safeVersion}`;
+            }
+            res.set(headers);
 
-                let responseFormat;
+            const send = (format) => {
+                if (format === 'plain') {
+                    debug('plain text response');
+                    return res.send(result);
+                }
 
-                if (apiImpl.response){
-                    if (typeof apiImpl.response.format === 'function') {
-                        const apiResponseFormat = apiImpl.response.format();
+                debug('json response');
+                res.json(result || {});
+            };
+
+            let responseFormat;
+
+            if (apiImpl.response){
+                if (typeof apiImpl.response.format === 'function') {
+                    const apiResponseFormat = apiImpl.response.format();
 
-                        if (apiResponseFormat.then) { // is promise
-                            return apiResponseFormat.then((formatName) => {
-                                send(formatName);
-                            });
-                        } else {
-                            responseFormat = apiResponseFormat;
-                        }
+                    if (apiResponseFormat.then) { // is promise
+                        return apiResponseFormat.then((formatName) => {
+                            send(formatName);
+                        });
                     } else {
-                        responseFormat = apiImpl.response.format;
+                        responseFormat = apiResponseFormat;
                     }
+                } else {
+                    responseFormat = apiImpl.response.format;
                 }
+            }
 
-                send(responseFormat);
-            })
-            .catch((err) => {
-                req.frameOptions = {
-                    docName: frame.docName,
-                    method: frame.method
-                };
+            send(responseFormat);
+        } catch (err) {
+            req.frameOptions = {
+                docName: frame.docName,
+                method: frame.method
+            };
 
-                next(err);
-            });
+            next(err);
+        }
     };
 };
 

package/core/server/data/exporter/table-lists.js

@@ -40,6 +40,7 @@ const BACKUP_TABLES = [
     'members_paid_subscription_events',
     'members_subscribe_events',
     'members_product_events',
+    'members_newsletters',
     'offers',
     'offer_redemptions'
 ];

package/core/server/data/migrations/utils.js

@@ -65,6 +65,36 @@ function dropTables(names) {
     );
 }
 
+/**
+ * Creates a migration which will drop an existing table and then re-add a new table based on provided spec
+ * @param {string} name - table name
+ * @param {Object} tableSpec - copy of table schema definition as defined in schema.js at the moment of writing the migration,
+ * this parameter MUST be present, otherwise @daniellockyer will hunt you down
+ *
+ * @returns {Object} migration object returning config/up/down properties
+ */
+function recreateTable(name, tableSpec) {
+    return createNonTransactionalMigration(
+        async function up(connection) {
+            const exists = await connection.schema.hasTable(name);
+
+            if (!exists) {
+                logging.warn(`Failed to drop table: ${name} - table does not exist`);
+            } else {
+                logging.info(`Dropping table: ${name}`);
+                await commands.deleteTable(name, connection);
+                logging.info(`Re-adding table: ${name}`);
+                await commands.createTable(name, connection, tableSpec);
+            }
+        },
+        async function down() {
+            // noop: we cannot go back to old table schema
+            logging.warn(`Ignoring rollback for table recreate: ${name}`);
+            return Promise.resolve();
+        }
+    );
+}
+
 /**
  * Creates a migration which will add a permission to the database
  *
@@ -375,7 +405,8 @@ function createAddColumnMigration(table, column, columnDefinition) {
             column,
             dbIsInCorrectState: hasColumn => hasColumn === false,
             operation: commands.dropColumn,
-            operationVerb: 'Removing'
+            operationVerb: 'Removing',
+            columnDefinition
         })
     );
 }
@@ -462,6 +493,7 @@ function addSetting({key, value, type, group}) {
 module.exports = {
     addTable,
     dropTables,
+    recreateTable,
     addPermission,
     addPermissionToRole,
     addPermissionWithRoles,

package/core/server/data/migrations/versions/4.42/2022-03-21-17-17-add.js

@@ -1,3 +1,8 @@
+// ESLint Override Notice
+// This file was named incorrectly and it didn't flag up in our eslint rules.
+// The ESLint match-regex rule has now been updated to catch this, but this file has to be excluded.
+/* eslint-disable ghost/filenames/match-regex */
+
 const {addTable} = require('../../utils');
 
 module.exports = addTable('newsletters', {

package/core/server/data/migrations/versions/4.43/2022-03-28-19-26-recreate-newsletter-table.js

@@ -0,0 +1,29 @@
+const {recreateTable} = require('../../utils');
+
+module.exports = recreateTable('newsletters', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    name: {type: 'string', maxlength: 191, nullable: false, unique: true},
+    description: {type: 'string', maxlength: 2000, nullable: true},
+    slug: {type: 'string', maxlength: 191, nullable: false, unique: true},
+    sender_name: {type: 'string', maxlength: 191, nullable: false},
+    sender_email: {type: 'string', maxlength: 191, nullable: true},
+    sender_reply_to: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'newsletter', validations: {isIn: [['newsletter', 'support']]}},
+    status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
+    visibility: {
+        type: 'string',
+        maxlength: 50,
+        nullable: false,
+        defaultTo: 'members'
+    },
+    subscribe_on_signup: {type: 'bool', nullable: false, defaultTo: true},
+    sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0},
+    header_image: {type: 'string', maxlength: 2000, nullable: true},
+    show_header_icon: {type: 'bool', nullable: false, defaultTo: true},
+    show_header_title: {type: 'bool', nullable: false, defaultTo: true},
+    title_font_category: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'sans_serif', validations: {isIn: [['serif', 'sans_serif']]}},
+    title_alignment: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'center', validations: {isIn: [['center', 'left']]}},
+    show_feature_image: {type: 'bool', nullable: false, defaultTo: true},
+    body_font_category: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'sans_serif', validations: {isIn: [['serif', 'sans_serif']]}},
+    footer_content: {type: 'text', maxlength: 1000000000, nullable: true},
+    show_badge: {type: 'bool', nullable: false, defaultTo: true}
+});

package/core/server/data/migrations/versions/4.43/2022-03-29-14-45-add-members-newsletters-table.js

@@ -0,0 +1,7 @@
+const {addTable} = require('../../utils');
+
+module.exports = addTable('members_newsletters', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
+    newsletter_id: {type: 'string', maxlength: 24, nullable: false, references: 'newsletters.id', cascadeDelete: true}
+});