ghost 6.57.1 → 6.58.0

package/core/server/services/gifts/gift-email-service.ts

@@ -1,158 +0,0 @@
-import {GiftEmailRenderer, Translate} from './gift-email-renderer';
-import type {GiftCadence} from './gift-schema';
-
-const DEFAULT_DATE_LOCALE = 'en-gb';
-
-interface Mailer {
-    send(message: {
-        to: string;
-        subject: string;
-        html: string;
-        text: string;
-        from: string;
-        forceTextContent: boolean;
-    }): Promise<void>;
-}
-
-interface SettingsCache {
-    get(key: string, options?: unknown): string | undefined;
-}
-
-interface UrlUtils {
-    getSiteUrl(): string;
-}
-
-interface BlogIcon {
-    getIconUrl(options: {absolute: boolean; fallbackToDefault: boolean}): string | null;
-}
-
-interface PurchaseConfirmationData {
-    buyerEmail: string;
-    token: string;
-    tierName: string;
-    cadence: GiftCadence;
-    duration: number;
-    expiresAt: Date;
-}
-
-interface ReminderData {
-    memberEmail: string;
-    memberName: string | null;
-    tierName: string;
-    consumesAt: Date;
-}
-
-export class GiftEmailService {
-    private readonly mailer: Mailer;
-    private readonly settingsCache: SettingsCache;
-    private readonly urlUtils: UrlUtils;
-    private readonly getFromAddress: () => string;
-    private readonly blogIcon: BlogIcon;
-    private readonly renderer: GiftEmailRenderer;
-    private readonly t: Translate;
-
-    constructor({mailer, settingsCache, urlUtils, getFromAddress, blogIcon, t}: {mailer: Mailer; settingsCache: SettingsCache; urlUtils: UrlUtils; getFromAddress: () => string; blogIcon: BlogIcon; t: Translate}) {
-        this.mailer = mailer;
-        this.settingsCache = settingsCache;
-        this.urlUtils = urlUtils;
-        this.getFromAddress = getFromAddress;
-        this.blogIcon = blogIcon;
-        this.t = t;
-
-        this.renderer = new GiftEmailRenderer({t});
-    }
-
-    private get siteDomain(): string {
-        try {
-            return new URL(this.urlUtils.getSiteUrl()).hostname;
-        } catch {
-            return '';
-        }
-    }
-
-    private getCadenceLabel(cadence: GiftCadence, duration: number): string {
-        if (duration === 1) {
-            return cadence === 'year' ? this.t('one-year') : this.t('one-month');
-        }
-        if (cadence === 'year') {
-            return this.t('{count} year', {count: duration});
-        }
-        return this.t('{count} month', {count: duration});
-    }
-
-    private formatDate(date: Date): string {
-        const locale = this.settingsCache.get('locale') || DEFAULT_DATE_LOCALE;
-
-        return new Intl.DateTimeFormat(locale, {
-            day: 'numeric',
-            month: 'short',
-            year: 'numeric'
-        }).format(date);
-    }
-
-    async sendPurchaseConfirmation({buyerEmail, token, tierName, cadence, duration, expiresAt}: PurchaseConfirmationData): Promise<void> {
-        const siteDomain = this.siteDomain;
-        const siteUrl = this.urlUtils.getSiteUrl();
-        const siteTitle = this.settingsCache.get('title') ?? siteDomain;
-
-        const giftLink = `${siteUrl.replace(/\/$/, '')}/gift/${token}`;
-        const cadenceLabel = this.getCadenceLabel(cadence, duration);
-
-        const {html, text} = await this.renderer.renderPurchaseConfirmation({
-            siteTitle,
-            siteUrl,
-            siteIconUrl: this.blogIcon.getIconUrl({absolute: true, fallbackToDefault: false}),
-            siteDomain,
-            accentColor: this.settingsCache.get('accent_color'),
-            toEmail: buyerEmail,
-            gift: {
-                tierName,
-                cadenceLabel,
-                link: giftLink,
-                expiresAt: this.formatDate(expiresAt)
-            }
-        });
-
-        await this.mailer.send({
-            to: buyerEmail,
-            subject: this.t('Your gift is ready'),
-            html,
-            text,
-            from: this.getFromAddress(),
-            forceTextContent: true
-        });
-    }
-
-    async sendReminder({memberEmail, memberName, tierName, consumesAt}: ReminderData): Promise<void> {
-        const siteDomain = this.siteDomain;
-        const siteUrl = this.urlUtils.getSiteUrl();
-        const siteTitle = this.settingsCache.get('title') ?? siteDomain;
-
-        const manageSubscriptionUrl = new URL('#/portal/account', siteUrl).href;
-        const firstName = memberName?.trim().split(/\s+/)[0] || null;
-
-        const {html, text} = await this.renderer.renderReminder({
-            siteTitle,
-            siteUrl,
-            siteIconUrl: this.blogIcon.getIconUrl({absolute: true, fallbackToDefault: false}),
-            siteDomain,
-            accentColor: this.settingsCache.get('accent_color'),
-            memberEmail,
-            firstName,
-            gift: {
-                tierName,
-                consumesAt: this.formatDate(consumesAt),
-                manageSubscriptionUrl
-            }
-        });
-
-        await this.mailer.send({
-            to: memberEmail,
-            subject: this.t('Your gift subscription is ending soon'),
-            html,
-            text,
-            from: this.getFromAddress(),
-            forceTextContent: true
-        });
-    }
-}

package/core/server/services/gifts/gift-reminder-scheduler.ts

@@ -1,107 +0,0 @@
-import logging from '@tryghost/logging';
-import {Gift} from './gift';
-import type {SchedulerAdapter, SchedulerJob} from '@tryghost/adapter-base-scheduling';
-import type {InternalApiKey, InternalKeys} from '../internal-keys';
-import {GIFT_REMINDER_LEAD_DAYS} from './constants';
-// Same-domain (scheduling) primitives, used unconditionally.
-const urlUtils = require('../../../shared/url-utils').default;
-const {getSignedAdminToken} = require('../../adapters/scheduling/utils');
-
-const MS_PER_DAY = 24 * 60 * 60 * 1000;
-const GIFT_REMINDER_LEAD_MS = GIFT_REMINDER_LEAD_DAYS * MS_PER_DAY;
-
-interface GiftReminderSchedulerDeps {
-    apiUrl: string;
-    // Optional in deps so the JS wrapper can pass options.schedulerAdapter
-    // through without TS complaining at the JS/TS boundary. The class field
-    // below is non-optional; the constructor's adapter.register(this) call
-    // throws if undefined is passed through in practice.
-    adapter?: SchedulerAdapter;
-    internalKeys: InternalKeys;
-    findUnsentReminders(): Promise<Gift[]>;
-}
-
-export class GiftReminderScheduler {
-    readonly #apiUrl: string;
-    readonly #adapter: SchedulerAdapter;
-    readonly #internalKeys: InternalKeys;
-    readonly #findUnsentReminders: () => Promise<Gift[]>;
-
-    constructor({apiUrl, adapter, internalKeys, findUnsentReminders}: GiftReminderSchedulerDeps) {
-        this.#apiUrl = apiUrl;
-        this.#adapter = adapter!;
-        this.#internalKeys = internalKeys;
-        this.#findUnsentReminders = findUnsentReminders;
-        this.#adapter.register(this);
-    }
-
-    /**
-     * Queue a single reminder callback for a freshly-redeemed gift. The
-     * callback fires at consumesAt - GIFT_REMINDER_LEAD_DAYS. Already-due
-     * reminders are skipped — the daily cron picks them up.
-     */
-    async scheduleFor(gift: Gift): Promise<void> {
-        if (!gift.consumesAt) {
-            return;
-        }
-        const time = gift.consumesAt.getTime() - GIFT_REMINDER_LEAD_MS;
-        if (time <= Date.now()) {
-            return;
-        }
-
-        try {
-            const key = await this.#internalKeys.get('ghost-scheduler');
-            this.#adapter.schedule(this.#buildJob(time, key));
-        } catch (err) {
-            logging.error({
-                event: {name: 'gift_reminder_scheduler.schedule.failed'},
-                err,
-                giftToken: gift.token
-            }, 'Failed to schedule gift reminder');
-        }
-    }
-
-    /**
-     * Re-issue every queued reminder under the current scheduler key. Pass
-     * the pre-rotation secret as `previousKey` so each adapter-queued URL
-     * can be reconstructed for unschedule before resigning with the new
-     * key. Reminders whose fire time has already passed are skipped — the
-     * daily cron picks them up.
-     */
-    async rescheduleAll({previousKey}: {previousKey?: InternalApiKey} = {}): Promise<void> {
-        const currentKey = await this.#internalKeys.get('ghost-scheduler');
-        const unscheduleKey = previousKey ?? currentKey;
-        const pending = await this.#findUnsentReminders();
-
-        // Same-key rebuild (no previousKey, boot path) → URL signature is
-        // identical to the about-to-be-scheduled job. The default adapter
-        // implements unschedule via tombstones keyed by URL+time, so a same-URL
-        // unschedule poisons the scheduled job. Bootstrap mode skips the
-        // tombstone write. Rotation (previousKey provided) → URLs differ, so
-        // the tombstone correctly targets the old queued entry.
-        const bootstrap = !previousKey;
-
-        for (const gift of pending) {
-            if (!gift.consumesAt) {
-                continue;
-            }
-            const time = gift.consumesAt.getTime() - GIFT_REMINDER_LEAD_MS;
-            if (time <= Date.now()) {
-                continue;
-            }
-            this.#adapter.unschedule(this.#buildJob(time, unscheduleKey), {bootstrap});
-            this.#adapter.schedule(this.#buildJob(time, currentKey));
-        }
-    }
-
-    #buildJob(time: number, key: InternalApiKey): SchedulerJob {
-        const signedAdminToken = getSignedAdminToken({
-            publishedAt: new Date(time).toISOString(),
-            apiUrl: this.#apiUrl,
-            key
-        });
-        const url = new URL(urlUtils.urlJoin(this.#apiUrl, 'gifts', 'flush_reminders'));
-        url.searchParams.set('token', signedAdminToken);
-        return {time, url: url.toString(), extra: {httpMethod: 'PUT'}};
-    }
-}

package/core/server/services/gifts/gift-schema.ts

@@ -1,39 +0,0 @@
-import {z} from 'zod';
-import {DbDate} from '../../lib/db-date';
-import type {CamelKeys} from '../../lib/case-keys';
-
-export const GiftCadenceSchema = z.enum(['month', 'year']);
-export const GiftStatusSchema = z.enum(['purchased', 'redeemed', 'consumed', 'expired', 'refunded']);
-export type GiftCadence = z.infer<typeof GiftCadenceSchema>;
-export type GiftStatus = z.infer<typeof GiftStatusSchema>;
-
-/**
- * The persisted gift row. Bookshelf remains the persistence implementation, but
- * values read through it are still runtime data and are validated before they
- * become trusted gift-domain values.
- */
-export const DbGift = z.object({
-    token: z.string(),
-    buyer_email: z.string(),
-    buyer_member_id: z.string().nullable(),
-    redeemer_member_id: z.string().nullable(),
-    tier_id: z.string(),
-    cadence: GiftCadenceSchema,
-    duration: z.number().int().nonnegative(),
-    currency: z.string(),
-    amount: z.number().int().nonnegative(),
-    stripe_checkout_session_id: z.string(),
-    stripe_payment_intent_id: z.string(),
-    consumes_at: DbDate.nullable(),
-    expires_at: DbDate,
-    status: GiftStatusSchema,
-    purchased_at: DbDate,
-    redeemed_at: DbDate.nullable(),
-    consumed_at: DbDate.nullable(),
-    expired_at: DbDate.nullable(),
-    refunded_at: DbDate.nullable(),
-    consumes_soon_reminder_sent_at: DbDate.nullable().default(null)
-});
-
-export type GiftRow = z.output<typeof DbGift>;
-export type GiftData = CamelKeys<GiftRow>;

package/core/server/services/gifts/gift-service-wrapper.js

@@ -1,142 +0,0 @@
-/**
- * @typedef {object} SchedulerAdapter
- * @prop {(job: {time: number; url: string; extra: {httpMethod: string}}) => void} schedule
- */
-
-/**
- * @typedef {object} InitOptions
- * @prop {string} [apiUrl]
- * @prop {SchedulerAdapter} [schedulerAdapter]
- * @prop {import('../internal-keys').InternalKeys} [internalKeys]
- */
-
-class GiftServiceWrapper {
-    controller;
-    service;
-    #initialized = false;
-
-    /**
-     * @param {InitOptions} [options]
-     */
-    async init(options = {}) {
-        if (this.#initialized) {
-            return;
-        }
-
-        const {Gift: GiftModel, MemberStripeCustomer: StripeCustomerModel} = require('../../models');
-        const {GiftBookshelfRepository} = require('./gift-bookshelf-repository');
-        const {GiftService} = require('./gift-service');
-        const {GiftReminderScheduler} = require('./gift-reminder-scheduler');
-        const {GiftEmailService} = require('./gift-email-service');
-        const {GiftController} = require('./gift-controller');
-        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 GiftBookshelfRepository({
-            GiftModel
-        });
-        const checkoutAdapter = new GiftCheckoutAdapter({
-            StripeCustomerModel,
-            getStripeApi: () => require('../stripe').api
-        });
-
-        const giftEmailService = new GiftEmailService({
-            mailer: new GhostMailer(),
-            settingsCache,
-            urlUtils,
-            getFromAddress: () => EmailAddressParser.stringify(settingsHelpers.getDefaultEmail()),
-            blogIcon,
-            t
-        });
-
-        const giftReminderScheduler = new GiftReminderScheduler({
-            apiUrl: options.apiUrl,
-            adapter: options.schedulerAdapter,
-            internalKeys: options.internalKeys,
-            findUnsentReminders: () => repository.findUnsentReminders()
-        });
-
-        this.service = new GiftService({
-            giftRepository: repository,
-            get memberRepository() {
-                return membersService.api.members;
-            },
-            tiersService,
-            giftEmailService,
-            get staffServiceEmails() {
-                return staffService.api.emails;
-            },
-            giftReminderScheduler,
-            checkoutAdapter,
-            labsService,
-            settingsCache
-        });
-
-        this.controller = new GiftController({
-            service: this.service
-        });
-
-        DomainEvents.subscribe(SubscriptionActivatedEvent, async (event) => {
-            try {
-                await this.service.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 this.service.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 this.service.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 this.service.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();
-
-        this.#initialized = true;
-    }
-}
-
-module.exports = GiftServiceWrapper;