ghost 4.42.1 → 4.43.0

package/core/server/data/migrations/versions/4.43/2022-04-01-10-13-add-post-newsletter-relation.js

@@ -0,0 +1,108 @@
+const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
+const commands = require('../../../schema/commands');
+const {createTransactionalMigration} = require('../../utils');
+
+const table = 'posts';
+const column = 'newsletter_id';
+const targetTable = 'newsletters';
+const targetColumn = 'id';
+
+const columnDefinition = {
+    type: 'string',
+    maxlength: 24,
+    nullable: true,
+    references: `${targetTable}.${targetColumn}`
+};
+
+/**
+ * This migration is adding a new column `newsletter_id` to the table posts
+ * that is a foreign key to `newsletters.id`.
+ *
+ * It isn't using the existing utils because of a performance issue. In MySQL,
+ * adding a new row without `algorithm=copy` uses the INPLACE algorithm which
+ * was too slow on big `posts` tables (~3 minutes for 10k posts). Switching to
+ * the COPY algorithm fixed the issue (~3 seconds for 10k posts).
+ */
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const hasColumn = await knex.schema.hasColumn(table, column);
+
+        if (hasColumn) {
+            logging.info(`Adding ${table}.${column} column - skipping as table is correct`);
+            return;
+        }
+
+        logging.info(`Adding ${table}.${column} column`);
+
+        // Use the default flow for SQLite because .toSQL() is tricky with SQLite
+        if (DatabaseInfo.isSQLite(knex)) {
+            await commands.addColumn(table, column, knex, columnDefinition);
+            return;
+        }
+
+        // Add the column
+
+        let sql = knex.schema.table(table, function (t) {
+            t.string(column, 24);
+        }).toSQL()[0].sql;
+
+        if (DatabaseInfo.isMySQL(knex)) {
+            // Guard against an ending semicolon
+            sql = sql.replace(/;\s*$/, '') + ', algorithm=copy';
+        }
+
+        await knex.raw(sql);
+
+        // Add the foreign key constraint
+
+        await commands.addForeign({
+            fromTable: table,
+            fromColumn: column,
+            toTable: targetTable,
+            toColumn: targetColumn,
+            cascadeDelete: false,
+            transaction: knex
+        });
+    },
+    async function down(knex) {
+        const hasColumn = await knex.schema.hasColumn(table, column);
+
+        if (!hasColumn) {
+            logging.info(`Removing ${table}.${column} column - skipping as table is correct`);
+            return;
+        }
+
+        logging.info(`Removing ${table}.${column} column`);
+
+        // Use the default flow for SQLite because .toSQL() is tricky with SQLite
+        if (DatabaseInfo.isSQLite(knex)) {
+            await commands.dropColumn(table, column, knex, columnDefinition);
+            return;
+        }
+
+        // Drop the foreign key constraint
+
+        await commands.dropForeign({
+            fromTable: table,
+            fromColumn: column,
+            toTable: targetTable,
+            toColumn: targetColumn,
+            transaction: knex
+        });
+
+        // Drop the column
+
+        let sql = knex.schema.table(table, function (t) {
+            t.dropColumn(column);
+        }).toSQL()[0].sql;
+
+        if (DatabaseInfo.isMySQL(knex)) {
+            // Guard against an ending semicolon
+            sql = sql.replace(/;\s*$/, '') + ', algorithm=copy';
+        }
+
+        await knex.raw(sql);
+    }
+);
+

package/core/server/data/migrations/versions/4.43/2022-04-06-09-47-add-type-column-to-paid-subscription-events.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_paid_subscription_events', 'type', {
+    type: 'string',
+    maxlength: '50',
+    nullable: true
+});

package/core/server/data/migrations/versions/4.43/2022-04-06-14-56-add-email-newsletter-relation.js

@@ -0,0 +1,8 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('emails', 'newsletter_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true,
+    references: 'newsletters.id'
+});

package/core/server/data/migrations/versions/4.43/2022-04-08-10-45-add-subscription-id-to-mrr-events.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_paid_subscription_events', 'subscription_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true
+});

package/core/server/data/schema/commands.js

@@ -65,7 +65,12 @@ function addColumn(tableName, column, transaction = db.knex, columnSpec) {
     });
 }
 
-function dropColumn(tableName, column, transaction = db.knex) {
+async function dropColumn(tableName, column, transaction = db.knex, columnSpec = {}) {
+    if (Object.prototype.hasOwnProperty.call(columnSpec, 'references')) {
+        const [toTable, toColumn] = columnSpec.references.split('.');
+        await dropForeign({fromTable: tableName, fromColumn: column, toTable, toColumn, transaction});
+    }
+
     return transaction.schema.table(tableName, function (table) {
         table.dropColumn(column);
     });

package/core/server/data/schema/index.js

@@ -1,5 +1,4 @@
 module.exports.tables = require('./schema');
-module.exports.checks = require('./checks');
 module.exports.commands = require('./commands');
 module.exports.defaultSettings = require('./default-settings');
 module.exports.validate = require('./validator');

package/core/server/data/schema/schema.js

@@ -8,6 +8,33 @@
  * Long text = length 1,000,000,000
  */
 module.exports = {
+    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}
+    },
     posts: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         uuid: {type: 'string', maxlength: 36, nullable: false, validations: {isUUID: true}},
@@ -56,6 +83,7 @@ module.exports = {
         codeinjection_foot: {type: 'text', maxlength: 65535, nullable: true},
         custom_template: {type: 'string', maxlength: 100, nullable: true},
         canonical_url: {type: 'text', maxlength: 2000, nullable: true},
+        newsletter_id: {type: 'string', maxlength: 24, nullable: true, references: 'newsletters.id'},
         '@@UNIQUE_CONSTRAINTS@@': [
             ['slug', 'type']
         ]
@@ -492,7 +520,9 @@ module.exports = {
     },
     members_paid_subscription_events: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+        type: {type: 'string', maxlength: 50, nullable: true},
         member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
+        subscription_id: {type: 'string', maxlength: 24, nullable: true},
         from_plan: {type: 'string', maxlength: 255, nullable: true},
         to_plan: {type: 'string', maxlength: 255, nullable: true},
         currency: {type: 'string', maxLength: 3, nullable: false},
@@ -630,6 +660,7 @@ module.exports = {
         plaintext: {type: 'text', maxlength: 1000000000, fieldtype: 'long', nullable: true},
         track_opens: {type: 'bool', nullable: false, defaultTo: false},
         submitted_at: {type: 'dateTime', nullable: false},
+        newsletter_id: {type: 'string', maxlength: 24, nullable: true, references: 'newsletters.id'},
         created_at: {type: 'dateTime', nullable: false},
         created_by: {type: 'string', maxlength: 24, nullable: false},
         updated_at: {type: 'dateTime', nullable: true},
@@ -712,22 +743,9 @@ module.exports = {
         },
         value: {type: 'text', maxlength: 65535, nullable: true}
     },
-    newsletters: {
+    members_newsletters: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-        name: {type: 'string', maxlength: 191, nullable: false},
-        description: {type: 'string', maxlength: 2000, nullable: true},
-        sender_name: {type: 'string', maxlength: 191, nullable: false},
-        sender_email: {type: 'string', maxlength: 191, nullable: false, validations: {isEmail: true}},
-        sender_reply_to: {type: 'string', maxlength: 191, nullable: false, validations: {isEmail: true}},
-        default: {type: 'bool', nullable: false, defaultTo: false},
-        status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
-        recipient_filter: {
-            type: 'text',
-            maxlength: 1000000000,
-            nullable: false,
-            defaultTo: ''
-        },
-        subscribe_on_signup: {type: 'bool', nullable: false, defaultTo: false},
-        sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0}
+        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}
     }
 };

package/core/server/models/base/bookshelf.js

@@ -78,7 +78,7 @@ ghostBookshelf.plugin('bookshelf-relations', {
                 };
 
                 // CASE: disable after hook for specific relations
-                if (['permissions_roles'].indexOf(existing.relatedData.joinTableName) !== -1) {
+                if (['permissions_roles', 'members_newsletters'].indexOf(existing.relatedData.joinTableName) !== -1) {
                     return Promise.resolve();
                 }
 

package/core/server/models/base/plugins/crud.js

@@ -137,6 +137,10 @@ module.exports = function (Bookshelf) {
                 options.columns = _.intersection(options.columns, this.prototype.permittedAttributes());
             }
 
+            if (options.transacting && options.forUpdate) {
+                options.lock = 'forUpdate';
+            }
+
             return model.fetch(options)
                 .catch((err) => {
                     // CASE: SQL syntax is incorrect
@@ -179,6 +183,10 @@ module.exports = function (Bookshelf) {
                 model.hasTimestamps = false;
             }
 
+            if (options.transacting) {
+                options.lock = 'forUpdate';
+            }
+
             const object = await model.fetch(options);
             if (object) {
                 options.method = 'update';

package/core/server/models/member.js

@@ -49,6 +49,13 @@ const Member = ghostBookshelf.Model.extend({
                 joinFrom: 'member_id',
                 joinTo: 'product_id'
             },
+            newsletters: {
+                tableName: 'newsletters',
+                type: 'manyToMany',
+                joinTable: 'members_newsletters',
+                joinFrom: 'member_id',
+                joinTo: 'newsletter_id'
+            },
             subscriptions: {
                 tableName: 'members_stripe_customers_subscriptions',
                 tableNameAs: 'subscriptions',
@@ -61,7 +68,7 @@ const Member = ghostBookshelf.Model.extend({
         };
     },
 
-    relationships: ['products', 'labels', 'stripeCustomers', 'email_recipients'],
+    relationships: ['products', 'labels', 'stripeCustomers', 'email_recipients', 'newsletters'],
 
     // do not delete email_recipients records when a member is destroyed. Recipient
     // records are used for analytics and historical records
@@ -73,6 +80,7 @@ const Member = ghostBookshelf.Model.extend({
 
     relationshipBelongsTo: {
         products: 'products',
+        newsletters: 'newsletters',
         labels: 'labels',
         stripeCustomers: 'members_stripe_customers',
         email_recipients: 'email_recipients'
@@ -94,6 +102,15 @@ const Member = ghostBookshelf.Model.extend({
             });
     },
 
+    newsletters() {
+        return this.belongsToMany('Newsletter', 'members_newsletters', 'member_id', 'newsletter_id')
+            .query((qb) => {
+                // avoids bookshelf adding a `DISTINCT` to the query
+                // we know the result set will already be unique and DISTINCT hurts query performance
+                qb.columns('newsletters.*');
+            });
+    },
+
     offerRedemptions() {
         return this.hasMany('OfferRedemption', 'member_id', 'id')
             .query('orderBy', 'created_at', 'DESC');

package/core/server/models/newsletter.js

@@ -1,7 +1,41 @@
 const ghostBookshelf = require('./base');
 
 const Newsletter = ghostBookshelf.Model.extend({
-    tableName: 'newsletters'
+    tableName: 'newsletters',
+
+    defaults: {
+        sender_reply_to: 'newsletter',
+        status: 'active',
+        visibility: 'members',
+        subscribe_on_signup: true,
+        sort_order: 0,
+        title_font_category: 'sans_serif',
+        title_alignment: 'center',
+        show_feature_image: true,
+        body_font_category: 'sans_serif',
+        show_badge: true
+    },
+
+    async onSaving(model, _attr, options) {
+        ghostBookshelf.Model.prototype.onSaving.apply(this, arguments);
+
+        if (model.get('name')) {
+            model.set('name', model.get('name').trim());
+        }
+
+        if (model.hasChanged('slug') || !model.get('slug')) {
+            const slug = model.get('slug') || model.get('name');
+
+            if (slug) {
+                const cleanSlug = await ghostBookshelf.Model.generateSlug(Newsletter, slug, {
+                    transacting: options.transacting
+                });
+
+                model.set({slug: cleanSlug});
+            }
+        }
+    }
+
 });
 
 module.exports = {

package/core/server/models/post.js

@@ -557,7 +557,7 @@ Post = ghostBookshelf.Model.extend({
                 if (!tag.id && !tag.tag_id && tag.slug) {
                     // Clean up the provided slugs before we do any matching with existing tags
                     tag.slug = await ghostBookshelf.Model.generateSlug(
-                        Tag, 
+                        Tag,
                         tag.slug,
                         {skipDuplicateChecks: true}
                     );
@@ -878,6 +878,9 @@ Post = ghostBookshelf.Model.extend({
         // CASE: never expose the revisions
         delete attrs.mobiledoc_revisions;
 
+        // CASE: hide the newsletter_id for now
+        delete attrs.newsletter_id;
+
         // If the current column settings allow it...
         if (!options.columns || (options.columns && options.columns.indexOf('primary_tag') > -1)) {
             // ... attach a computed property of primary_tag which is the first tag if it is public, else null

package/core/server/services/auth/setup.js

@@ -142,7 +142,10 @@ async function doFixtures(data) {
         mobiledoc = mobiledoc.replace(/{{date}}/, date);
 
         const post = await models.Post.findOne({slug: key});
-        await models.Post.edit({mobiledoc}, {id: post.id});
+
+        if (post) {
+            await models.Post.edit({mobiledoc}, {id: post.id});
+        }
     });
 
     return data;

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

@@ -13,6 +13,7 @@ const SingleUseTokenProvider = require('./SingleUseTokenProvider');
 const urlUtils = require('../../../shared/url-utils');
 const labsService = require('../../../shared/labs');
 const offersService = require('../offers');
+const getNewslettersServiceInstance = require('../newsletters');
 
 const MAGIC_LINK_TOKEN_VALIDITY = 24 * 60 * 60 * 1000;
 
@@ -195,7 +196,8 @@ function createApiInstance(config) {
         },
         stripeAPIService: stripeService.api,
         offersAPI: offersService.api,
-        labsService: labsService
+        labsService: labsService,
+        newslettersService: getNewslettersServiceInstance({NewsletterModel: models.Newsletter})
     });
 
     return membersApiInstance;

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

@@ -70,12 +70,12 @@ const getOfferData = async function (req, res) {
 
 const updateMemberData = async function (req, res) {
     try {
-        const data = _.pick(req.body, 'name', 'subscribed');
+        const data = _.pick(req.body, 'name', 'subscribed', 'newsletters');
         const member = await membersService.ssr.getMemberDataFromSession(req, res);
         if (member) {
             const options = {
                 id: member.id,
-                withRelated: ['stripeSubscriptions', 'stripeSubscriptions.customer', 'stripeSubscriptions.stripePrice']
+                withRelated: ['stripeSubscriptions', 'stripeSubscriptions.customer', 'stripeSubscriptions.stripePrice', 'newsletters']
             };
             const updatedMember = await membersService.api.members.update(data, options);
 
@@ -133,6 +133,11 @@ const getPortalProductPrices = async function () {
     };
 };
 
+const getSiteNewsletters = async function () {
+    const newsletters = await models.Newsletter.findAll();
+    return newsletters.toJSON();
+};
+
 const getMemberSiteData = async function (req, res) {
     const isStripeConfigured = membersService.config.isStripeConnected();
     const domain = urlUtils.urlFor('home', true).match(new RegExp('^https?://([^/:?#]+)(?:[/:?#]|$)', 'i'));
@@ -144,7 +149,7 @@ const getMemberSiteData = async function (req, res) {
     }
     const {products = [], prices = []} = await getPortalProductPrices() || {};
     const portalVersion = config.get('portal:version');
-
+    const newsletters = await getSiteNewsletters();
     const response = {
         title: settingsCache.get('title'),
         description: settingsCache.get('description'),
@@ -170,6 +175,11 @@ const getMemberSiteData = async function (req, res) {
         prices,
         products
     };
+
+    if (labsService.isSet('multipleNewsletters')) {
+        response.newsletters = newsletters;
+    }
+
     if (labsService.isSet('multipleProducts')) {
         response.portal_products = settingsCache.get('portal_products');
     }

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

@@ -1,8 +1,16 @@
+const labsService = require('../../../shared/labs');
+
+function formatNewsletterResponse(newsletters) {
+    return newsletters.map(({id, name, description, sort_order: sortOrder}) => {
+        return {id, name, description, sort_order: sortOrder};
+    });
+}
+
 module.exports.formattedMemberResponse = function formattedMemberResponse(member) {
     if (!member) {
         return null;
     }
-    return {
+    const data = {
         uuid: member.uuid,
         email: member.email,
         name: member.name,
@@ -12,4 +20,8 @@ module.exports.formattedMemberResponse = function formattedMemberResponse(member
         subscriptions: member.subscriptions || [],
         paid: member.status !== 'free'
     };
+    if (member.newsletters && labsService.isSet('multipleNewsletters')) {
+        data.newsletters = formatNewsletterResponse(member.newsletters);
+    }
+    return data;
 };

package/core/server/services/newsletters/index.js

@@ -0,0 +1,10 @@
+const NewslettersService = require('./service.js');
+
+/**
+ * @returns {NewslettersService} instance of the NewslettersService
+ */
+const getNewslettersServiceInstance = ({NewsletterModel}) => {
+    return new NewslettersService({NewsletterModel});
+};
+
+module.exports = getNewslettersServiceInstance;

package/core/server/services/newsletters/service.js

@@ -0,0 +1,24 @@
+class NewslettersService {
+    /**
+     *
+     * @param {Object} options
+     * @param {Object} options.NewsletterModel
+     */
+    constructor({NewsletterModel}) {
+        this.NewsletterModel = NewsletterModel;
+    }
+
+    /**
+     *
+     * @param {Object} options browse options
+     * @returns
+     */
+    async browse(options) {
+        let newsletters = await this.NewsletterModel.findAll(options);
+
+        return newsletters.toJSON();
+    }
+}
+
+module.exports = NewslettersService;
+

package/core/server/services/slack.js

@@ -6,7 +6,6 @@ const {blogIcon} = require('../lib/image');
 const urlUtils = require('../../shared/url-utils');
 const urlService = require('./url');
 const settingsCache = require('../../shared/settings-cache');
-const schema = require('../data/schema').checks;
 const moment = require('moment');
 
 // Used to receive post.published model event, but also the slack.test event from the API which iirc this was done to avoid circular deps a long time ago
@@ -37,6 +36,15 @@ function getSlackSettings() {
     };
 }
 
+/**
+ * @TODO: change this function to check for the properties we depend on
+ * @param {Object} data
+ * @returns {boolean}
+ */
+function hasPostProperties(data) {
+    return Object.prototype.hasOwnProperty.call(data, 'html') && Object.prototype.hasOwnProperty.call(data, 'title') && Object.prototype.hasOwnProperty.call(data, 'slug');
+}
+
 function ping(post) {
     let message;
     let title;
@@ -47,7 +55,7 @@ function ping(post) {
     let blogTitle = settingsCache.get('title');
 
     // If this is a post, we want to send the link of the post
-    if (schema.isPost(post)) {
+    if (hasPostProperties(post)) {
         message = urlService.getUrlByResourceId(post.id, {absolute: true});
         title = post.title ? post.title : null;
         author = post.authors ? post.authors[0] : null;
@@ -79,7 +87,7 @@ function ping(post) {
             return;
         }
 
-        if (schema.isPost(post)) {
+        if (hasPostProperties(post)) {
             slackData = {
                 // We are handling the case of test notification here by checking
                 // if it is a post or a test message to check webhook working.