ghost 5.9.4 → 5.10.0

package/core/server/models/label.js

@@ -13,6 +13,9 @@ Label = ghostBookshelf.Model.extend({
 
     tableName: 'labels',
 
+    actionsCollectCRUD: true,
+    actionsResourceType: 'label',
+
     emitChange: function emitChange(event, options) {
         const eventToTrigger = 'label' + '.' + event;
         ghostBookshelf.Model.prototype.emitChange.bind(this)(this, eventToTrigger, options);
@@ -62,24 +65,6 @@ Label = ghostBookshelf.Model.extend({
         const attrs = ghostBookshelf.Model.prototype.toJSON.call(this, options);
 
         return attrs;
-    },
-
-    getAction(event, options) {
-        const actor = this.getActor(options);
-
-        // @NOTE: we ignore internal updates (`options.context.internal`) for now
-        if (!actor) {
-            return;
-        }
-
-        // @TODO: implement context
-        return {
-            event: event,
-            resource_id: this.id || this.previous('id'),
-            resource_type: 'label',
-            actor_id: actor.id,
-            actor_type: actor.type
-        };
     }
 }, {
     orderDefaultOptions: function orderDefaultOptions() {

package/core/server/models/member-created-event.js

@@ -0,0 +1,26 @@
+const errors = require('@tryghost/errors');
+const ghostBookshelf = require('./base');
+
+const MemberCreatedEvent = ghostBookshelf.Model.extend({
+    tableName: 'members_created_events',
+
+    member() {
+        return this.belongsTo('Member', 'member_id', 'id');
+    },
+
+    attribution() {
+        return this.belongsTo('Post', 'attribution_id', 'id');
+    }
+}, {
+    async edit() {
+        throw new errors.IncorrectUsageError({message: 'Cannot edit MemberCreatedEvent'});
+    },
+
+    async destroy() {
+        throw new errors.IncorrectUsageError({message: 'Cannot destroy MemberCreatedEvent'});
+    }
+});
+
+module.exports = {
+    MemberCreatedEvent: ghostBookshelf.model('MemberCreatedEvent', MemberCreatedEvent)
+};

package/core/server/models/member.js

@@ -3,6 +3,7 @@ const uuid = require('uuid');
 const _ = require('lodash');
 const config = require('../../shared/config');
 const {gravatar} = require('../lib/image');
+const labs = require('../../shared/labs');
 
 const Member = ghostBookshelf.Model.extend({
     tableName: 'members',
@@ -102,12 +103,16 @@ const Member = ghostBookshelf.Model.extend({
 
     products() {
         return this.belongsToMany('Product', 'members_products', 'member_id', 'product_id')
-            .withPivot('sort_order')
+            .withPivot('sort_order', 'expiry_at')
             .query('orderBy', 'sort_order', 'ASC')
             .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('products.*');
+                if (labs.isSet('compExpiring')) {
+                    qb.columns('products.*', 'expiry_at');
+                } else {
+                    qb.columns('products.*');
+                }
             });
     },
 
@@ -155,6 +160,21 @@ const Member = ghostBookshelf.Model.extend({
         return this.hasMany('EmailRecipient', 'member_id', 'id');
     },
 
+    async updateTierExpiry(products = [], options = {}) {
+        if (!labs.isSet('compExpiring')) {
+            return;
+        }
+        for (const product of products) {
+            if (product?.expiry_at) {
+                const expiry = new Date(product.expiry_at);
+                const queryOptions = _.extend({}, options, {
+                    query: {where: {product_id: product.id}}
+                });
+                await this.products().updatePivot({expiry_at: expiry}, queryOptions);
+            }
+        }
+    },
+
     serialize(options) {
         const defaultSerializedObject = ghostBookshelf.Model.prototype.serialize.call(this, options);
 
@@ -344,7 +364,13 @@ const Member = ghostBookshelf.Model.extend({
                 return this.add(data, Object.assign({transacting}, unfilteredOptions));
             });
         }
-        return ghostBookshelf.Model.add.call(this, data, unfilteredOptions);
+
+        return ghostBookshelf.Model.add.call(this, data, unfilteredOptions).then(async (member) => {
+            if (data.products) {
+                await member.updateTierExpiry(data.products, _.pick(unfilteredOptions, 'transacting'));
+            }
+            return member;
+        });
     },
 
     edit(data, unfilteredOptions = {}) {
@@ -353,7 +379,13 @@ const Member = ghostBookshelf.Model.extend({
                 return this.edit(data, Object.assign({transacting}, unfilteredOptions));
             });
         }
-        return ghostBookshelf.Model.edit.call(this, data, unfilteredOptions);
+
+        return ghostBookshelf.Model.edit.call(this, data, unfilteredOptions).then(async (member) => {
+            if (data.products) {
+                await member.updateTierExpiry(data.products, _.pick(unfilteredOptions, 'transacting'));
+            }
+            return member;
+        });
     },
 
     destroy(unfilteredOptions = {}) {

package/core/server/models/post.js

@@ -38,6 +38,11 @@ Post = ghostBookshelf.Model.extend({
 
     tableName: 'posts',
 
+    actionsCollectCRUD: true,
+    actionsResourceType: function () {
+        return this.get('type') || this.previous('type');
+    },
+
     /**
      * @NOTE
      *
@@ -962,24 +967,6 @@ Post = ghostBookshelf.Model.extend({
 
         delete options.status;
         return filter;
-    },
-
-    getAction(event, options) {
-        const actor = this.getActor(options);
-
-        // @NOTE: we ignore internal updates (`options.context.internal`) for now
-        if (!actor) {
-            return;
-        }
-
-        // @TODO: implement context
-        return {
-            event: event,
-            resource_id: this.id || this.previous('id'),
-            resource_type: 'post',
-            actor_id: actor.id,
-            actor_type: actor.type
-        };
     }
 }, {
     allowedFormats: ['mobiledoc', 'html', 'plaintext'],
@@ -1262,6 +1249,27 @@ Post = ghostBookshelf.Model.extend({
         return Promise.reject(new errors.NoPermissionError({
             message: tpl(messages.notEnoughPermission)
         }));
+    },
+
+    countRelations() {
+        return {
+            signups(modelOrCollection) {
+                modelOrCollection.query('columns', 'posts.*', (qb) => {
+                    qb.count('members_created_events.id')
+                        .from('members_created_events')
+                        .whereRaw('posts.id = members_created_events.attribution_id')
+                        .as('count__signups');
+                });
+            },
+            conversions(modelOrCollection) {
+                modelOrCollection.query('columns', 'posts.*', (qb) => {
+                    qb.count('members_subscription_created_events.id')
+                        .from('members_subscription_created_events')
+                        .whereRaw('posts.id = members_subscription_created_events.attribution_id')
+                        .as('count__conversions');
+                });
+            }
+        };
     }
 });
 

package/core/server/models/subscription-created-event.js

@@ -0,0 +1,30 @@
+const errors = require('@tryghost/errors');
+const ghostBookshelf = require('./base');
+
+const SubscriptionCreatedEvent = ghostBookshelf.Model.extend({
+    tableName: 'members_subscription_created_events',
+
+    member() {
+        return this.belongsTo('Member', 'member_id', 'id');
+    },
+
+    subscription() {
+        return this.belongsTo('StripeCustomerSubscription', 'subscription_id', 'id');
+    },
+
+    attribution() {
+        return this.belongsTo('Post', 'attribution_id', 'id');
+    }
+}, {
+    async edit() {
+        throw new errors.IncorrectUsageError({message: 'Cannot edit SubscriptionCreatedEvent'});
+    },
+
+    async destroy() {
+        throw new errors.IncorrectUsageError({message: 'Cannot destroy SubscriptionCreatedEvent'});
+    }
+});
+
+module.exports = {
+    SubscriptionCreatedEvent: ghostBookshelf.model('SubscriptionCreatedEvent', SubscriptionCreatedEvent)
+};

package/core/server/models/tag.js

@@ -14,6 +14,9 @@ Tag = ghostBookshelf.Model.extend({
 
     tableName: 'tags',
 
+    actionsCollectCRUD: true,
+    actionsResourceType: 'tag',
+
     defaults: function defaults() {
         return {
             visibility: 'public'
@@ -138,24 +141,6 @@ Tag = ghostBookshelf.Model.extend({
         return attrs;
     },
 
-    getAction(event, options) {
-        const actor = this.getActor(options);
-
-        // @NOTE: we ignore internal updates (`options.context.internal`) for now
-        if (!actor) {
-            return;
-        }
-
-        // @TODO: implement context
-        return {
-            event: event,
-            resource_id: this.id || this.previous('id'),
-            resource_type: 'tag',
-            actor_id: actor.id,
-            actor_type: actor.type
-        };
-    },
-
     defaultColumnsToFetch() {
         return ['id'];
     }

package/core/server/models/user.js

@@ -57,6 +57,9 @@ User = ghostBookshelf.Model.extend({
 
     tableName: 'users',
 
+    actionsCollectCRUD: true,
+    actionsResourceType: 'user',
+
     defaults: function defaults() {
         return {
             password: security.identifier.uid(50),
@@ -363,24 +366,6 @@ User = ghostBookshelf.Model.extend({
         delete options.status;
 
         return filter;
-    },
-
-    getAction(event, options) {
-        const actor = this.getActor(options);
-
-        // @NOTE: we ignore internal updates (`options.context.internal`) for now
-        if (!actor) {
-            return;
-        }
-
-        // @TODO: implement context
-        return {
-            event: event,
-            resource_id: this.id || this.previous('id'),
-            resource_type: 'user',
-            actor_id: actor.id,
-            actor_type: actor.type
-        };
     }
 }, {
     orderDefaultOptions: function orderDefaultOptions() {

package/core/server/models/webhook.js

@@ -7,6 +7,9 @@ let Webhooks;
 Webhook = ghostBookshelf.Model.extend({
     tableName: 'webhooks',
 
+    actionsCollectCRUD: true,
+    actionsResourceType: 'webhook',
+
     defaults() {
         return {
             api_version: `v${ghostVersion.safe}`,

package/core/server/services/comments/emails.js

@@ -45,7 +45,7 @@ class CommentsServiceEmails {
                 accentColor: this.settingsCache.get('accent_color'),
                 fromEmail: this.notificationFromAddress,
                 toEmail: to,
-                staffUrl: `${this.urlUtils.getAdminUrl()}ghost/#/settings/staff/${author.get('slug')}`
+                staffUrl: this.urlUtils.urlJoin(this.urlUtils.urlFor('admin', true), '#', `/settings/staff/${author.get('slug')}`)
             };
 
             const {html, text} = await this.renderEmailTemplate('new-comment', templateData);
@@ -132,7 +132,7 @@ class CommentsServiceEmails {
             commentHtml: comment.get('html'),
             commentText: htmlToPlaintext.comment(comment.get('html')),
             commentDate: moment(comment.get('created_at')).tz(this.settingsCache.get('timezone')).format('D MMM YYYY'),
-            
+
             reporterName: reporter.name,
             reporterEmail: reporter.email,
             reporter: reporter.name ? `${reporter.name} (${reporter.email})` : reporter.email,
@@ -144,7 +144,7 @@ class CommentsServiceEmails {
             accentColor: this.settingsCache.get('accent_color'),
             fromEmail: this.notificationFromAddress,
             toEmail: to,
-            staffUrl: `${this.urlUtils.getAdminUrl()}ghost/#/settings/staff/${owner.get('slug')}`
+            staffUrl: this.urlUtils.urlJoin(this.urlUtils.urlFor('admin', true), '#', `/settings/staff/${owner.get('slug')}`)
         };
 
         const {html, text} = await this.renderEmailTemplate('report', templateData);

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

@@ -26,7 +26,7 @@ module.exports = class ExploreService {
         const totalMembers = await this.MembersService.stats.getTotalMembers();
         const mrrStats = await this.StatsService.getMRRHistory();
 
-        const {description, icon, title, url} = this.PublicConfigService.site;
+        const {description, icon, title, url, accent_color: accentColor} = this.PublicConfigService.site;
 
         const exploreProperties = {
             version: ghostVersion.full,
@@ -36,7 +36,8 @@ module.exports = class ExploreService {
                 description,
                 icon,
                 title,
-                url
+                url,
+                accentColor
             },
             stripe: {
                 configured: this.StripeService.api.configured,

package/core/server/services/member-attribution/index.js

@@ -0,0 +1,24 @@
+const urlService = require('../url');
+const labsService = require('../../../shared/labs');
+
+class MemberAttributionServiceWrapper {
+    init() {
+        if (this.service) {
+            // Prevent creating duplicate DomainEvents subscribers
+            return;
+        }
+
+        const MemberAttributionService = require('@tryghost/member-attribution');
+        const models = require('../../models');
+
+        // For now we don't need to expose anything (yet)
+        this.service = new MemberAttributionService({
+            MemberCreatedEvent: models.MemberCreatedEvent,
+            SubscriptionCreatedEvent: models.SubscriptionCreatedEvent,
+            urlService,
+            labsService
+        });
+    }
+}
+
+module.exports = new MemberAttributionServiceWrapper();

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

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

package/core/server/services/members/jobs/clean-expired-comped.js

@@ -0,0 +1,105 @@
+const {parentPort} = require('worker_threads');
+const ObjectId = require('bson-objectid').default;
+const {chunk: chunkArray} = require('lodash');
+const debug = require('@tryghost/debug')('jobs:clean-expired-comped');
+const moment = require('moment');
+
+// recurring job to clean expired complimentary subscriptions
+
+// Exit early when cancelled to prevent stalling shutdown. No cleanup needed when cancelling as everything is idempotent and will pick up
+// where it left off on next run
+function cancel() {
+    if (parentPort) {
+        parentPort.postMessage('Expired complimentary subscriptions cleanup cancelled before completion');
+        parentPort.postMessage('cancelled');
+    } else {
+        setTimeout(() => {
+            process.exit(0);
+        }, 1000);
+    }
+}
+
+if (parentPort) {
+    parentPort.once('message', (message) => {
+        if (message === 'cancel') {
+            return cancel();
+        }
+    });
+}
+
+(async () => {
+    const cleanupStartDate = new Date();
+    const db = require('../../../data/db');
+    debug(`Starting cleanup of expired comp subscriptions`);
+    const expiredCompedRows = await db.knex('members_products')
+        .where('expiry_at', '<', moment.utc().startOf('day').toISOString())
+        .select('*');
+
+    let deletedExpiredSubs = 0;
+    let updatedMembers = 0;
+
+    // Run cleanup for expired comp subscriptions
+    // Removes expired comped entries from members_products table
+    // Updates affected members status to free from comped
+    // Adds member status event for going from comped to free
+    if (expiredCompedRows?.length) {
+        const rowIds = expiredCompedRows.map(d => d.id);
+        const memberIds = expiredCompedRows.map(d => d.member_id);
+
+        // Delete all expired comped rows
+        deletedExpiredSubs = await db.knex('members_products')
+            .whereIn('id', rowIds)
+            .del();
+
+        // fetch all comped members to update
+        const membersToUpdate = await db.knex('members')
+            .whereIn('id', memberIds)
+            .andWhere('status', 'comped');
+
+        const updateMemberIds = membersToUpdate.map(d => d.id);
+
+        // Update all comped members to free
+        updatedMembers = await db.knex('members')
+            .whereIn('id', updateMemberIds)
+            .update({
+                status: 'free'
+            });
+
+        const statusEvents = membersToUpdate.map((member) => {
+            const now = db.knex.raw('CURRENT_TIMESTAMP');
+
+            return {
+                id: ObjectId().toHexString(),
+                member_id: member.id,
+                from_status: member.status,
+                to_status: 'free',
+                created_at: now
+            };
+        });
+
+        // SQLite >= 3.32.0 can support 32766 host parameters
+        // each row uses 5 variables so ⌊32766/5⌋ = 6553
+        const chunkSize = 6553;
+
+        const chunks = chunkArray(statusEvents, chunkSize);
+
+        // Adds status event for members going comped->free
+        for (const chunk of chunks) {
+            await db.knex('members_status_events').insert(chunk);
+        }
+    }
+
+    let cleanupEndDate = new Date();
+
+    debug(`Removed ${deletedExpiredSubs} expired subscriptions, updated ${updatedMembers} members in ${cleanupEndDate.valueOf() - cleanupStartDate.valueOf()}ms`);
+
+    if (parentPort) {
+        parentPort.postMessage(`Removed ${deletedExpiredSubs} expired subscriptions, updated ${updatedMembers} members in ${cleanupEndDate.valueOf() - cleanupStartDate.valueOf()}ms`);
+        parentPort.postMessage('done');
+    } else {
+        // give the logging pipes time finish writing before exit
+        setTimeout(() => {
+            process.exit(0);
+        }, 1000);
+    }
+})();

package/core/server/services/members/jobs/index.js

@@ -0,0 +1,27 @@
+const path = require('path');
+const jobsService = require('../../jobs');
+
+let hasScheduled = false;
+
+module.exports = {
+    async scheduleExpiredCompCleanupJob() {
+        if (
+            !hasScheduled &&
+            !process.env.NODE_ENV.startsWith('test')
+        ) {
+            // use a random seconds value to avoid spikes to external APIs on the minute
+            const s = Math.floor(Math.random() * 60); // 0-59
+
+            // Run everyday at 12:05:X AM to clean all expired complimentary subscriptions
+            jobsService.addJob({
+                at: `${s} 5 0 * * *`,
+                job: path.resolve(__dirname, 'clean-expired-comped.js'),
+                name: 'clean-expired-comped'
+            });
+
+            hasScheduled = true;
+        }
+
+        return hasScheduled;
+    }
+};

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

@@ -6,6 +6,7 @@ const db = require('../../data/db');
 const MembersConfigProvider = require('./config');
 const MembersCSVImporter = require('@tryghost/members-importer');
 const MembersStats = require('./stats/members-stats');
+const memberJobs = require('./jobs');
 const createMembersSettingsInstance = require('./settings');
 const logging = require('@tryghost/logging');
 const urlUtils = require('../../../shared/url-utils');
@@ -148,16 +149,21 @@ module.exports = {
             }
         })();
 
-        const membersMigrationJobName = 'members-migrations';
-        if (!(await jobsService.hasExecutedSuccessfully(membersMigrationJobName))) {
-            jobsService.addOneOffJob({
-                name: membersMigrationJobName,
-                offloaded: false,
-                job: stripeService.migrations.execute.bind(stripeService.migrations)
-            });
+        if (!env?.startsWith('testing')) {
+            const membersMigrationJobName = 'members-migrations';
+            if (!(await jobsService.hasExecutedSuccessfully(membersMigrationJobName))) {
+                jobsService.addOneOffJob({
+                    name: membersMigrationJobName,
+                    offloaded: false,
+                    job: stripeService.migrations.execute.bind(stripeService.migrations)
+                });
 
-            await jobsService.awaitCompletion(membersMigrationJobName);
+                await jobsService.awaitCompletion(membersMigrationJobName);
+            }
         }
+
+        // Schedule daily cron job to clean expired comp subs
+        memberJobs.scheduleExpiredCompCleanupJob();
     },
     contentGating: require('./content-gating'),
 

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

@@ -67,7 +67,7 @@ module.exports = {
      * Initialize the cache, used in boot and in testing
      */
     async init() {
-        const cacheStore = adapterManager.getAdapter('cache');
+        const cacheStore = adapterManager.getAdapter('cache:settings');
         const settingsCollection = await models.Settings.populateDefaults();
         SettingsCache.init(events, settingsCollection, this.getCalculatedFields(), cacheStore);
     },

package/core/shared/config/defaults.json

@@ -25,7 +25,11 @@
             "active": "Default"
         },
         "cache": {
-            "active": "Memory"
+            "active": "Memory",
+            "settings": "SettingsCacheSyncInMemory",
+            "SettingsCacheSyncInMemory": {},
+            "imageSizes": "ImageSizesCacheSyncInMemory",
+            "ImageSizesCacheSyncInMemory": {}
         }
     },
     "storage": {
@@ -137,7 +141,7 @@
     },
     "portal": {
         "url": "https://cdn.jsdelivr.net/npm/@tryghost/portal@~{version}/umd/portal.min.js",
-        "version": "2.8"
+        "version": "2.9"
     },
     "sodoSearch": {
         "url": "https://cdn.jsdelivr.net/npm/@tryghost/sodo-search@~{version}/umd/sodo-search.min.js",

package/core/shared/labs.js

@@ -28,7 +28,10 @@ const ALPHA_FEATURES = [
     'auditLog',
     'urlCache',
     'beforeAfterCard',
-    'freeTrial'
+    'freeTrial',
+    'memberAttribution',
+    'searchHelper',
+    'compExpiring'
 ];
 
 module.exports.GA_KEYS = [...GA_FEATURES];