ghost 6.57.1 → 6.58.0

package/core/server/services/email-service/events/email-opened-event.js

@@ -1,49 +1,21 @@
-module.exports = class EmailOpenedEvent {
-    /**
-     * @readonly
-     * @type {string}
-     */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailOpenedEvent = void 0;
+class EmailOpenedEvent {
     email;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     memberId;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     emailId;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     emailRecipientId;
-
-    /**
-     * @readonly
-     * @type {Date}
-     */
     timestamp;
-
-    /**
-     * @private
-     */
-    constructor({email, memberId, emailId, emailRecipientId, timestamp}) {
+    constructor({ email, memberId, emailId, emailRecipientId, timestamp }) {
         this.memberId = memberId;
         this.emailId = emailId;
         this.emailRecipientId = emailRecipientId;
         this.email = email;
         this.timestamp = timestamp;
     }
-
     static create(data) {
-        return new EmailOpenedEvent({
-            ...data,
-            timestamp: data.timestamp || new Date
-        });
+        return new EmailOpenedEvent({ ...data, timestamp: data.timestamp || new Date() });
     }
-};
+}
+exports.EmailOpenedEvent = EmailOpenedEvent;

package/core/server/services/email-service/events/email-temporary-bounced-event.js

@@ -1,50 +1,15 @@
-module.exports = class EmailTemporaryBouncedEvent {
-    /**
-     * @readonly
-     * @type {string}
-     */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailTemporaryBouncedEvent = void 0;
+class EmailTemporaryBouncedEvent {
     id;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     email;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     memberId;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     emailId;
-
-    /**
-     * @readonly
-     * @type {{message: string, code: number, enhancedCode: string | null}|null}
-     */
     error;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     emailRecipientId;
-
-    /**
-     * @readonly
-     * @type {Date}
-     */
     timestamp;
-
-    /**
-     * @private
-     */
-    constructor({id, email, memberId, emailId, emailRecipientId, error, timestamp}) {
+    constructor({ id, email, memberId, emailId, emailRecipientId, error, timestamp }) {
         this.id = id;
         this.memberId = memberId;
         this.emailId = emailId;
@@ -53,11 +18,8 @@ module.exports = class EmailTemporaryBouncedEvent {
         this.emailRecipientId = emailRecipientId;
         this.timestamp = timestamp;
     }
-
     static create(data) {
-        return new EmailTemporaryBouncedEvent({
-            ...data,
-            timestamp: data.timestamp || new Date
-        });
+        return new EmailTemporaryBouncedEvent({ ...data, timestamp: data.timestamp || new Date() });
     }
-};
+}
+exports.EmailTemporaryBouncedEvent = EmailTemporaryBouncedEvent;

package/core/server/services/email-service/events/email-unsubscribed-event.js

@@ -1,42 +1,19 @@
-module.exports = class EmailUnsubscribedEvent {
-    /**
-     * @readonly
-     * @type {string}
-     */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailUnsubscribedEvent = void 0;
+class EmailUnsubscribedEvent {
     email;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     memberId;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     emailId;
-
-    /**
-     * @readonly
-     * @type {Date}
-     */
     timestamp;
-
-    /**
-     * @private
-     */
-    constructor({email, memberId, emailId, timestamp}) {
+    constructor({ email, memberId, emailId, timestamp }) {
         this.memberId = memberId;
         this.emailId = emailId;
         this.email = email;
         this.timestamp = timestamp;
     }
-
     static create(data) {
-        return new EmailUnsubscribedEvent({
-            ...data,
-            timestamp: data.timestamp || new Date
-        });
+        return new EmailUnsubscribedEvent({ ...data, timestamp: data.timestamp || new Date() });
     }
-};
+}
+exports.EmailUnsubscribedEvent = EmailUnsubscribedEvent;

package/core/server/services/email-service/events/spam-complaint-event.js

@@ -1,42 +1,19 @@
-module.exports = class SpamComplaintEvent {
-    /**
-     * @readonly
-     * @type {string}
-     */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpamComplaintEvent = void 0;
+class SpamComplaintEvent {
     email;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     memberId;
-
-    /**
-     * @readonly
-     * @type {string}
-     */
     emailId;
-
-    /**
-     * @readonly
-     * @type {Date}
-     */
     timestamp;
-
-    /**
-     * @private
-     */
-    constructor({email, memberId, emailId, timestamp}) {
+    constructor({ email, memberId, emailId, timestamp }) {
         this.memberId = memberId;
         this.emailId = emailId;
         this.email = email;
         this.timestamp = timestamp;
     }
-
     static create(data) {
-        return new SpamComplaintEvent({
-            ...data,
-            timestamp: data.timestamp || new Date
-        });
+        return new SpamComplaintEvent({ ...data, timestamp: data.timestamp || new Date() });
     }
-};
+}
+exports.SpamComplaintEvent = SpamComplaintEvent;

package/core/server/services/email-service/newsletter-email-event-storage.js

@@ -1,9 +1,9 @@
 const moment = require('moment-timezone');
 const errors = require('@tryghost/errors');
 const logging = require('@tryghost/logging');
-const config = require('../../../shared/config');
 
 class NewsletterEmailEventStorage {
+    #config;
     #db;
     #membersRepository;
     #models;
@@ -11,7 +11,8 @@ class NewsletterEmailEventStorage {
     #prometheusClient;
     #pendingUpdates;
 
-    constructor({db, models, membersRepository, emailSuppressionList, prometheusClient}) {
+    constructor({config, db, models, membersRepository, emailSuppressionList, prometheusClient}) {
+        this.#config = config;
         this.#db = db;
         this.#models = models;
         this.#membersRepository = membersRepository;
@@ -35,7 +36,7 @@ class NewsletterEmailEventStorage {
     }
 
     async handleDelivered(event) {
-        const useBatchProcessing = config.get('emailAnalytics:batchProcessing');
+        const useBatchProcessing = this.#config.get('emailAnalytics:batchProcessing');
 
         if (useBatchProcessing) {
             // Accumulate update for batch processing
@@ -61,7 +62,7 @@ class NewsletterEmailEventStorage {
     }
 
     async handleOpened(event) {
-        const useBatchProcessing = config.get('emailAnalytics:batchProcessing');
+        const useBatchProcessing = this.#config.get('emailAnalytics:batchProcessing');
 
         if (useBatchProcessing) {
             // Accumulate update for batch processing
@@ -87,7 +88,7 @@ class NewsletterEmailEventStorage {
     }
 
     async handlePermanentFailed(event) {
-        const useBatchProcessing = config.get('emailAnalytics:batchProcessing');
+        const useBatchProcessing = this.#config.get('emailAnalytics:batchProcessing');
 
         if (useBatchProcessing) {
             // Accumulate update for batch processing
@@ -119,7 +120,7 @@ class NewsletterEmailEventStorage {
     /**
      * @private
      * @param {'temporary'|'permanent'} severity
-     * @param {import('./events/email-temporary-bounced-event')|import('./events/email-bounced-event')} event
+     * @param {import('./events/email-temporary-bounced-event').EmailTemporaryBouncedEvent|import('./events/email-bounced-event').EmailBouncedEvent} event
      * @param {{transacting?: any}} options
      * @returns
      */
@@ -222,7 +223,7 @@ class NewsletterEmailEventStorage {
      */
 
     /**
-     * @param {import('./events/email-unsubscribed-event')} event
+     * @param {import('./events/email-unsubscribed-event').EmailUnsubscribedEvent} event
      * @returns {Promise<FindNewslettersToKeepResult>}
      */
     async findNewslettersToKeep(event) {

package/core/server/services/email-service/sending-service.js

@@ -88,7 +88,7 @@ class SendingService {
     }
 
     /**
-     * Returns the configured target delivery window in seconds
+     * Returns the configured target delivery window in milliseconds
      *
      * @returns {number}
      */

package/core/server/services/email-suppression-list/mailgun-email-suppression-list.js

@@ -1,6 +1,6 @@
 const {AbstractEmailSuppressionList, EmailSuppressionData, EmailSuppressedEvent} = require('./email-suppression-list');
-const SpamComplaintEvent = require('../email-service/events/spam-complaint-event');
-const EmailBouncedEvent = require('../email-service/events/email-bounced-event');
+const {SpamComplaintEvent} = require('../email-service/events/spam-complaint-event');
+const {EmailBouncedEvent} = require('../email-service/events/email-bounced-event');
 const DomainEvents = require('@tryghost/domain-events');
 const logging = require('@tryghost/logging');
 const models = require('../../models');

package/core/server/services/email-suppression-list/service.js

@@ -1,14 +1,12 @@
 const models = require('../../models');
 const configService = require('../../../shared/config');
 const settingsCache = require('../../../shared/settings-cache');
-const labs = require('../../../shared/labs');
 const MailgunClient = require('../lib/mailgun-client');
 const MailgunEmailSuppressionList = require('./mailgun-email-suppression-list');
 
 const mailgunClient = new MailgunClient({
     config: configService,
-    settings: settingsCache,
-    labs
+    settings: settingsCache
 });
 
 module.exports = new MailgunEmailSuppressionList({

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

@@ -4,17 +4,15 @@ exports.ExplorePingService = void 0;
 class ExplorePingService {
     settingsCache;
     config;
-    labs;
     logging;
     ghostVersion;
     request;
     posts;
     members;
     statsService;
-    constructor({ settingsCache, config, labs, logging, ghostVersion, request, posts, members, statsService }) {
+    constructor({ settingsCache, config, logging, ghostVersion, request, posts, members, statsService }) {
         this.settingsCache = settingsCache;
         this.config = config;
-        this.labs = labs;
         this.logging = logging;
         this.ghostVersion = ghostVersion;
         this.request = request;
@@ -96,9 +94,6 @@ class ExplorePingService {
         }
     }
     async ping() {
-        if (!this.labs.isSet('explore')) {
-            return;
-        }
         const exploreUrl = this.config.get('explore:update_url');
         if (!exploreUrl) {
             this.logging.warn('Explore URL not set');

package/core/server/services/explore-ping/index.js

@@ -4,7 +4,6 @@ exports.createService = createService;
 exports.init = init;
 const explore_ping_service_1 = require("./explore-ping-service");
 const config = require('../../../shared/config');
-const labs = require('../../../shared/labs');
 const logging = require('@tryghost/logging');
 const ghostVersion = require('@tryghost/version');
 const request = require('@tryghost/request');
@@ -17,7 +16,6 @@ function createService() {
     return new explore_ping_service_1.ExplorePingService({
         settingsCache,
         config,
-        labs,
         logging,
         ghostVersion,
         request,

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

@@ -1,3 +1,109 @@
-const GiftServiceWrapper = require('./gift-service-wrapper');
-
-module.exports = new GiftServiceWrapper();
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.service = exports.controller = void 0;
+exports.init = init;
+const gift_bookshelf_repository_1 = require("./gift-bookshelf-repository");
+const gift_service_1 = require("./gift-service");
+const gift_reminder_scheduler_1 = require("./gift-reminder-scheduler");
+const gift_email_service_1 = require("./gift-email-service");
+const gift_controller_1 = require("./gift-controller");
+async function init(options) {
+    if (exports.service) {
+        return;
+    }
+    const { Gift: GiftModel, MemberStripeCustomer: StripeCustomerModel } = require('../../models');
+    const GiftCheckoutAdapter = require('./gift-checkout-adapter');
+    const membersService = require('../members');
+    const tiersService = require('../tiers');
+    const staffService = require('../staff');
+    const DomainEvents = require('@tryghost/domain-events');
+    const logging = require('@tryghost/logging');
+    const { SubscriptionActivatedEvent } = require('../../../shared/events');
+    const StartGiftReminderFlushEvent = require('./events/start-gift-reminder-flush-event');
+    const StartGiftCleanupEvent = require('./events/start-gift-cleanup-event');
+    const jobs = require('./jobs');
+    const { GhostMailer } = require('../mail');
+    const settingsCache = require('../../../shared/settings-cache');
+    const labsService = require('../../../shared/labs');
+    const urlUtils = require('../../../shared/url-utils').default;
+    const settingsHelpers = require('../settings-helpers');
+    const EmailAddressParser = require('../email-address/email-address-parser');
+    const { blogIcon } = require('../../../server/lib/image');
+    const { t } = require('../i18n');
+    const repository = new gift_bookshelf_repository_1.GiftBookshelfRepository({
+        GiftModel
+    });
+    const checkoutAdapter = new GiftCheckoutAdapter({
+        StripeCustomerModel,
+        getStripeApi: () => require('../stripe').api
+    });
+    const giftEmailService = new gift_email_service_1.GiftEmailService({
+        mailer: new GhostMailer(),
+        settingsCache,
+        urlUtils,
+        getFromAddress: () => EmailAddressParser.stringify(settingsHelpers.getDefaultEmail()),
+        blogIcon,
+        t
+    });
+    const giftReminderScheduler = new gift_reminder_scheduler_1.GiftReminderScheduler({
+        apiUrl: options.apiUrl,
+        adapter: options.schedulerAdapter,
+        internalKeys: options.internalKeys,
+        findUnsentReminders: () => repository.findUnsentReminders()
+    });
+    const giftService = new gift_service_1.GiftService({
+        giftRepository: repository,
+        get memberRepository() {
+            return membersService.api.members;
+        },
+        tiersService,
+        giftEmailService,
+        get staffServiceEmails() {
+            return staffService.api.emails;
+        },
+        giftReminderScheduler,
+        checkoutAdapter,
+        labsService,
+        settingsCache
+    });
+    exports.service = giftService;
+    exports.controller = new gift_controller_1.GiftController({ service: giftService });
+    DomainEvents.subscribe(SubscriptionActivatedEvent, async (event) => {
+        try {
+            await giftService.handlePaidSubscriptionActivation(event.data.memberId);
+        }
+        catch (err) {
+            logging.error(err, 'Failed to consume gift on paid subscription activation');
+        }
+    });
+    DomainEvents.subscribe(StartGiftReminderFlushEvent, async () => {
+        const start = Date.now();
+        try {
+            const { remindedCount, skippedCount, failedCount } = await giftService.processReminders();
+            logging.info(`Sent ${remindedCount} gift reminders, skipped ${skippedCount}, failed ${failedCount} in ${Date.now() - start}ms`);
+        }
+        catch (err) {
+            logging.error(err, 'Failed to process gift reminders');
+        }
+    });
+    DomainEvents.subscribe(StartGiftCleanupEvent, async () => {
+        const consumedStart = Date.now();
+        try {
+            const { consumedCount, updatedMemberCount } = await giftService.processConsumed();
+            logging.info(`Consumed ${consumedCount} gifts, updated ${updatedMemberCount} members in ${Date.now() - consumedStart}ms`);
+        }
+        catch (err) {
+            logging.error(err, 'Failed to process consumed gifts');
+        }
+        const expiredStart = Date.now();
+        try {
+            const { expiredCount } = await giftService.processExpired();
+            logging.info(`Expired ${expiredCount} gifts in ${Date.now() - expiredStart}ms`);
+        }
+        catch (err) {
+            logging.error(err, 'Failed to process expired gifts');
+        }
+    });
+    jobs.scheduleGiftCleanupJob();
+    jobs.scheduleGiftReminderJob();
+}

package/core/server/services/gifts/jobs/clean-gifts-job.js

@@ -30,7 +30,7 @@ if (parentPort) {
 (async () => {
     if (parentPort) {
         // Bounce to the main thread via the JobManager's event bridge - the
-        // GiftServiceWrapper subscribes to this event and runs the work in the
+        // gifts service subscribes to this event and runs the work in the
         // already-initialised main process
         parentPort.postMessage({
             event: {

package/core/server/services/gifts/jobs/send-gift-reminders-job.js

@@ -30,7 +30,7 @@ if (parentPort) {
 (async () => {
     if (parentPort) {
         // Bounce to the main thread via the JobManager's event bridge - the
-        // GiftServiceWrapper subscribes to this event and runs the work in the
+        // gifts service subscribes to this event and runs the work in the
         // already-initialised main process
         parentPort.postMessage({
             event: {

package/core/server/services/jobs-service/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = init;
+exports.getInstance = getInstance;
+exports.shutdown = shutdown;
+const errors_1 = __importDefault(require("@tryghost/errors"));
+const jobs_service_1 = require("./jobs-service");
+let instance;
+function init() {
+    const adapterManager = require('../adapter-manager').default;
+    const logging = require('@tryghost/logging');
+    const sentry = require('../../../shared/sentry');
+    instance = new jobs_service_1.JobsService({
+        backend: adapterManager.getAdapter('jobs'),
+        logging,
+        sentry
+    });
+    return instance;
+}
+function getInstance() {
+    if (!instance) {
+        throw new errors_1.default.IncorrectUsageError({
+            message: 'Jobs service used before init(). Call init() from boot first.'
+        });
+    }
+    return instance;
+}
+function shutdown(options) {
+    if (!instance) {
+        return Promise.resolve();
+    }
+    return instance.shutdown(options);
+}

package/core/server/services/jobs-service/job.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+class Job {
+}
+exports.Job = Job;

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

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobsService = void 0;
+const errors_1 = __importDefault(require("@tryghost/errors"));
+const cron_validate_1 = __importDefault(require("cron-validate"));
+class JobsService {
+    #backend;
+    #logging;
+    #sentry;
+    #registry = new Map();
+    constructor({ backend, logging, sentry }) {
+        this.#backend = backend;
+        this.#logging = logging;
+        this.#sentry = sentry;
+    }
+    handle(JobClass, handler) {
+        const type = JobClass.type;
+        if (typeof type !== 'string' || type.length === 0) {
+            throw new errors_1.default.IncorrectUsageError({
+                message: `Cannot register a job handler: ${JobClass.name ?? 'job class'} is missing a static "type" string.`
+            });
+        }
+        if (this.#registry.has(type)) {
+            throw new errors_1.default.IncorrectUsageError({
+                message: `A handler for job type "${type}" is already registered.`
+            });
+        }
+        this.#registry.set(type, payload => handler(new JobClass(JSON.parse(payload))));
+    }
+    async dispatch(job) {
+        await this.#backend.enqueue(this.#buildEnvelope(job));
+    }
+    async scheduleRecurring(job, schedule) {
+        this.#assertValidCron(schedule.cron);
+        await this.#backend.scheduleRecurring(this.#buildEnvelope(job), schedule);
+    }
+    // later.parse.cron does not strictly validate: it silently coerces a
+    // malformed expression into a bogus schedule (garbage -> every minute,
+    // out-of-range -> clamped, an impossible date -> effectively never), so
+    // validate up front and fail loudly instead.
+    #assertValidCron(cron) {
+        const result = (0, cron_validate_1.default)(cron, {
+            preset: 'default', // the seconds field is not supported in the default preset
+            override: { useSeconds: true }
+        });
+        if (!result.isValid()) {
+            throw new errors_1.default.IncorrectUsageError({
+                message: `Invalid cron expression: ${JSON.stringify(cron)}.`
+            });
+        }
+    }
+    async start() {
+        await this.#backend.start({
+            processor: envelope => this.#process(envelope)
+        });
+    }
+    async shutdown(options) {
+        await this.#backend.shutdown(options);
+    }
+    #buildEnvelope(job) {
+        return { type: this.#typeOf(job), payload: JSON.stringify(job) };
+    }
+    #typeOf(job) {
+        const ctor = job.constructor;
+        const type = ctor.type;
+        if (typeof type !== 'string' || type.length === 0) {
+            throw new errors_1.default.IncorrectUsageError({
+                message: `Cannot dispatch job: ${ctor.name ?? 'job'} is missing a static "type" string.`
+            });
+        }
+        return type;
+    }
+    async #process(envelope) {
+        const deliver = this.#registry.get(envelope.type);
+        if (!deliver) {
+            this.#logging.error(`No handler registered for job type "${envelope.type}"; dropping delivery.`);
+            return;
+        }
+        try {
+            await deliver(envelope.payload);
+        }
+        catch (err) {
+            this.#sentry?.captureException(err, { tags: { job_type: envelope.type } });
+            throw err;
+        }
+    }
+}
+exports.JobsService = JobsService;

package/core/server/services/jobs-service/register-job-handlers.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = registerJobHandlers;
+function registerJobHandlers() {
+    // Job handlers are registered here as jobs migrate onto the class-based service.
+}

package/core/server/services/lib/mailgun-client.js

@@ -397,7 +397,7 @@ module.exports = class MailgunClient {
     }
 
     /**
-     * Returns the configured target delivery window in seconds
+     * Returns the configured target delivery window in milliseconds
      * Ghost will attempt to deliver emails evenly distributed over this window
      *
      * Defaults to 0 (no delay) if not set