ghost 6.53.0 → 6.54.1

package/core/server/services/automations/automations-repository.ts

@@ -25,6 +25,7 @@ export interface WaitAction {
 }
 
 export interface AutomationEmailStats {
+    email_clicked_count: number;
     email_sent_count: number;
     email_opened_count: number;
     opened_rate: number | null;
@@ -81,6 +82,17 @@ export type AutomatedEmailEvents = {
     automationActionRevisionId: string;
 };
 
+export type RecordEmailSentOptions = Readonly<{
+    automationActionRevisionId: string;
+    mailgunMessageId?: string;
+    memberEmail: string;
+    memberId: string;
+    memberName: string | null;
+    memberUuid: string;
+    trackClicks: boolean;
+    trackOpens: boolean;
+}>;
+
 type AutomationStepBase = {
     id: string;
     locked_by: string;
@@ -167,6 +179,10 @@ export interface AutomationsRepository {
         step: Pick<AutomationStepToRun, 'id' | 'locked_by'>,
         retryAt: Readonly<Date>
     ): Promise<boolean>;
+    /**
+     * Record a sent email and increment its action revision's sent count.
+     */
+    recordEmailSent(options: RecordEmailSentOptions): Promise<void>;
     /**
      * Fetch sent emails by their Mailgun IDs.
      */

package/core/server/services/automations/database-automations-repository.js

@@ -94,6 +94,29 @@ function createDatabaseAutomationsRepository({ knex, fakeWaitHoursMultiplier })
         async retryStep(step, retryAt) {
             return await knex.transaction(trx => retryStep(trx, step, retryAt));
         },
+        async recordEmailSent(options) {
+            await knex.transaction(async (trx) => {
+                await trx('automation_action_revisions')
+                    .where('id', options.automationActionRevisionId)
+                    .update({
+                    email_sent_count: trx.raw('COALESCE(??, 0) + ?', ['email_sent_count', 1])
+                });
+                const now = toDatabaseDate(new Date());
+                await trx('automated_email_recipients').insert({
+                    id: (0, bson_objectid_1.default)().toHexString(),
+                    member_id: options.memberId,
+                    member_uuid: options.memberUuid,
+                    member_email: options.memberEmail,
+                    member_name: options.memberName,
+                    automation_action_revision_id: options.automationActionRevisionId,
+                    ...(options.mailgunMessageId ? { mailgun_message_id: options.mailgunMessageId } : {}),
+                    track_clicks: options.trackClicks,
+                    track_opens: options.trackOpens,
+                    created_at: now,
+                    updated_at: now
+                });
+            });
+        },
         async getAutomatedEmailRecipientsByMailgunIds(mailgunMessageIds) {
             if (mailgunMessageIds.length === 0) {
                 return [];
@@ -128,7 +151,10 @@ function createDatabaseAutomationsRepository({ knex, fakeWaitHoursMultiplier })
                         newOpensPerRevision.set(automationActionRevisionId, (newOpensPerRevision.get(automationActionRevisionId) ?? 0) + 1);
                     }
                 }
-                for (const [id, opens] of newOpensPerRevision) {
+                // Keep lock acquisition order consistent across concurrent transactions to avoid deadlocks.
+                const revisions = [...newOpensPerRevision.entries()]
+                    .sort(([left], [right]) => left.localeCompare(right));
+                for (const [id, opens] of revisions) {
                     await trx('automation_action_revisions')
                         .where({ id })
                         .update({
@@ -329,6 +355,7 @@ async function fetchAndLockSteps(trx, limit) {
         .innerJoin('automations as automation', 'automation.id', 'run.automation_id')
         .innerJoin('automation_action_revisions as revision', 'revision.id', 'step.automation_action_revision_id')
         .innerJoin('automation_actions as action', 'action.id', 'revision.action_id')
+        .whereIn('step.id', candidateIds)
         .where('step.locked_by', lockId)
         .orderBy([
         'step.ready_at',
@@ -342,13 +369,14 @@ async function fetchAndLockSteps(trx, limit) {
 }
 async function findNextPendingReadyAt(trx, staleLockCutoff) {
     const row = await trx('automation_run_steps')
-        .min({ next_ready_at: 'ready_at' })
+        .select({ next_ready_at: 'ready_at' })
         .where('status', 'pending')
         .where((builder) => {
         builder
             .whereNull('locked_by')
             .orWhere('locked_at', '<', toDatabaseDate(staleLockCutoff));
     })
+        .orderBy('ready_at')
         .first();
     return row?.next_ready_at ? new Date(row.next_ready_at) : null;
 }
@@ -874,6 +902,7 @@ async function loadActionStats(trx, actionIds) {
     const rows = await trx('automation_action_revisions')
         .select('action_id')
         .sum({
+        email_clicked_count: 'email_clicked_count',
         email_sent_count: 'email_sent_count',
         email_opened_count: 'email_opened_count'
     })
@@ -925,22 +954,26 @@ function buildActionPayload(row, stats) {
     }
 }
 const EMPTY_EMAIL_STATS = {
+    email_clicked_count: 0,
     email_sent_count: 0,
     email_opened_count: 0,
     opened_rate: null,
     clicked_rate: null
 };
 function buildEmailStats(row) {
+    const emailClickedCount = row.email_clicked_count ?? 0;
     const emailSentCount = row.email_sent_count ?? 0;
     const emailOpenedCount = row.email_opened_count ?? 0;
     return {
+        email_clicked_count: emailClickedCount,
         email_sent_count: emailSentCount,
         email_opened_count: emailOpenedCount,
         opened_rate: emailSentCount
             ? Math.round(emailOpenedCount / emailSentCount * 100)
             : null,
-        // TODO(NY-1387) Populate clicked_rate once click tracking is implemented.
-        clicked_rate: null
+        clicked_rate: emailSentCount
+            ? Math.round(emailClickedCount / emailSentCount * 100)
+            : null
     };
 }
 function requireValue(row, field) {

package/core/server/services/automations/database-automations-repository.ts

@@ -65,6 +65,7 @@ interface ActionRow {
 
 type ActionStatsRow = {
     action_id: string;
+    email_clicked_count: number | null;
     email_sent_count: number | null;
     email_opened_count: number | null;
 };
@@ -224,6 +225,31 @@ export function createDatabaseAutomationsRepository({
             return await knex.transaction(trx => retryStep(trx, step, retryAt));
         },
 
+        async recordEmailSent(options): Promise<void> {
+            await knex.transaction(async (trx) => {
+                await trx('automation_action_revisions')
+                    .where('id', options.automationActionRevisionId)
+                    .update({
+                        email_sent_count: trx.raw('COALESCE(??, 0) + ?', ['email_sent_count', 1])
+                    });
+
+                const now = toDatabaseDate(new Date());
+                await trx('automated_email_recipients').insert({
+                    id: ObjectId().toHexString(),
+                    member_id: options.memberId,
+                    member_uuid: options.memberUuid,
+                    member_email: options.memberEmail,
+                    member_name: options.memberName,
+                    automation_action_revision_id: options.automationActionRevisionId,
+                    ...(options.mailgunMessageId ? {mailgun_message_id: options.mailgunMessageId} : {}),
+                    track_clicks: options.trackClicks,
+                    track_opens: options.trackOpens,
+                    created_at: now,
+                    updated_at: now
+                });
+            });
+        },
+
         async getAutomatedEmailRecipientsByMailgunIds(mailgunMessageIds) {
             if (mailgunMessageIds.length === 0) {
                 return [];
@@ -266,7 +292,11 @@ export function createDatabaseAutomationsRepository({
                     }
                 }
 
-                for (const [id, opens] of newOpensPerRevision) {
+                // Keep lock acquisition order consistent across concurrent transactions to avoid deadlocks.
+                const revisions = [...newOpensPerRevision.entries()]
+                    .sort(([left], [right]) => left.localeCompare(right));
+
+                for (const [id, opens] of revisions) {
                     await trx('automation_action_revisions')
                         .where({id})
                         .update({
@@ -542,6 +572,7 @@ async function fetchAndLockSteps(trx: Knex.Transaction, limit: number): Promise<
         .innerJoin('automations as automation', 'automation.id', 'run.automation_id')
         .innerJoin('automation_action_revisions as revision', 'revision.id', 'step.automation_action_revision_id')
         .innerJoin('automation_actions as action', 'action.id', 'revision.action_id')
+        .whereIn('step.id', candidateIds)
         .where('step.locked_by', lockId)
         .orderBy([
             'step.ready_at',
@@ -557,13 +588,14 @@ async function fetchAndLockSteps(trx: Knex.Transaction, limit: number): Promise<
 
 async function findNextPendingReadyAt(trx: Knex.Transaction, staleLockCutoff: Readonly<Date>): Promise<Date | null> {
     const row = await trx('automation_run_steps')
-        .min({next_ready_at: 'ready_at'})
+        .select({next_ready_at: 'ready_at'})
         .where('status', 'pending')
         .where((builder) => {
             builder
                 .whereNull('locked_by')
                 .orWhere('locked_at', '<', toDatabaseDate(staleLockCutoff));
         })
+        .orderBy('ready_at')
         .first();
     return row?.next_ready_at ? new Date(row.next_ready_at) : null;
 }
@@ -1233,6 +1265,7 @@ async function loadActionStats(
     const rows: ActionStatsRow[] = await trx('automation_action_revisions')
         .select('action_id')
         .sum({
+            email_clicked_count: 'email_clicked_count',
             email_sent_count: 'email_sent_count',
             email_opened_count: 'email_opened_count'
         })
@@ -1288,6 +1321,7 @@ function buildActionPayload(row: ActionRow, stats: AutomationEmailStats | null):
 }
 
 const EMPTY_EMAIL_STATS: AutomationEmailStats = {
+    email_clicked_count: 0,
     email_sent_count: 0,
     email_opened_count: 0,
     opened_rate: null,
@@ -1295,16 +1329,19 @@ const EMPTY_EMAIL_STATS: AutomationEmailStats = {
 };
 
 function buildEmailStats(row: ActionStatsRow): AutomationEmailStats {
+    const emailClickedCount = row.email_clicked_count ?? 0;
     const emailSentCount = row.email_sent_count ?? 0;
     const emailOpenedCount = row.email_opened_count ?? 0;
     return {
+        email_clicked_count: emailClickedCount,
         email_sent_count: emailSentCount,
         email_opened_count: emailOpenedCount,
         opened_rate: emailSentCount
             ? Math.round(emailOpenedCount / emailSentCount * 100)
             : null,
-        // TODO(NY-1387) Populate clicked_rate once click tracking is implemented.
-        clicked_rate: null
+        clicked_rate: emailSentCount
+            ? Math.round(emailClickedCount / emailSentCount * 100)
+            : null
     };
 }
 

package/core/server/services/automations/poll.js

@@ -112,6 +112,7 @@ const processStep = async ({ automationsApi, memberWelcomeEmailService, schedule
                     break;
                 }
                 memberWelcomeEmailService.init();
+                const trackClicks = Boolean(settingsCache.get('email_track_clicks'));
                 const trackOpens = Boolean(settingsCache.get('email_track_opens'));
                 const sendResult = await memberWelcomeEmailService.api.sendAutomationEmail({
                     email: {
@@ -138,6 +139,7 @@ const processStep = async ({ automationsApi, memberWelcomeEmailService, schedule
                         memberId: step.member_id,
                         memberName: member.get('name'),
                         memberUuid: member.get('uuid'),
+                        trackClicks,
                         trackOpens: trackOpensForRecipient
                     });
                 }
@@ -151,18 +153,20 @@ const processStep = async ({ automationsApi, memberWelcomeEmailService, schedule
                         }
                     }, `[AUTOMATIONS] Failed to record automated email recipient for step ${step.id}`);
                 }
-                try {
-                    await scheduleAutomationEmailAnalyticsJob();
-                }
-                catch (err) {
-                    logging_1.default.error({
-                        err,
-                        system: {
-                            event: 'automations.poll.analytics_scheduling_failed',
-                            member_id: step.member_id,
-                            step_id: step.id
-                        }
-                    }, `[AUTOMATIONS] Failed to schedule email analytics job for step ${step.id}`);
+                if (mailgunMessageId) {
+                    try {
+                        await scheduleAutomationEmailAnalyticsJob();
+                    }
+                    catch (err) {
+                        logging_1.default.error({
+                            err,
+                            system: {
+                                event: 'automations.poll.analytics_scheduling_failed',
+                                member_id: step.member_id,
+                                step_id: step.id
+                            }
+                        }, `[AUTOMATIONS] Failed to schedule email analytics job for step ${step.id}`);
+                    }
                 }
                 break;
             }

package/core/server/services/automations/poll.ts

@@ -1,5 +1,4 @@
 import type {AutomationStepToRun, AutomationsRepository} from './automations-repository';
-import type {RecordEmailSentOptions} from './automations-api';
 import {getMailgunMessageId} from './mailgun-message-id';
 import logging from '@tryghost/logging';
 import errors from '@tryghost/errors';
@@ -44,10 +43,9 @@ type PollOptions = {
         'fetchAndLockSteps' |
         'finishStepAndEnqueueNext' |
         'markStepTerminal' |
+        'recordEmailSent' |
         'retryStep'
-    > & {
-        recordEmailSent(options: RecordEmailSentOptions): Promise<void>;
-    };
+    >;
     enqueueAnotherPollAt: (date: Readonly<Date>) => unknown;
     scheduleAutomationEmailAnalyticsJob: () => Promise<void>;
     memberWelcomeEmailService: MemberWelcomeEmailService;
@@ -185,6 +183,7 @@ const processStep = async ({
                 break;
             }
             memberWelcomeEmailService.init();
+            const trackClicks = Boolean(settingsCache.get('email_track_clicks'));
             const trackOpens = Boolean(settingsCache.get('email_track_opens'));
             const sendResult = await memberWelcomeEmailService.api.sendAutomationEmail({
                 email: {
@@ -211,6 +210,7 @@ const processStep = async ({
                     memberId: step.member_id,
                     memberName: member.get('name'),
                     memberUuid: member.get('uuid'),
+                    trackClicks,
                     trackOpens: trackOpensForRecipient
                 });
             } catch (err) {
@@ -223,17 +223,19 @@ const processStep = async ({
                     }
                 }, `[AUTOMATIONS] Failed to record automated email recipient for step ${step.id}`);
             }
-            try {
-                await scheduleAutomationEmailAnalyticsJob();
-            } catch (err) {
-                logging.error({
-                    err,
-                    system: {
-                        event: 'automations.poll.analytics_scheduling_failed',
-                        member_id: step.member_id,
-                        step_id: step.id
-                    }
-                }, `[AUTOMATIONS] Failed to schedule email analytics job for step ${step.id}`);
+            if (mailgunMessageId) {
+                try {
+                    await scheduleAutomationEmailAnalyticsJob();
+                } catch (err) {
+                    logging.error({
+                        err,
+                        system: {
+                            event: 'automations.poll.analytics_scheduling_failed',
+                            member_id: step.member_id,
+                            step_id: step.id
+                        }
+                    }, `[AUTOMATIONS] Failed to schedule email analytics job for step ${step.id}`);
+                }
             }
             break;
         }

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

@@ -45,7 +45,7 @@ const promises_1 = require("node:timers/promises");
 const soonest_timer_1 = require("../../lib/soonest-timer");
 // @ts-expect-error This module currently lacks type definitions.
 const jobs_1 = __importDefault(require("../email-analytics/jobs"));
-const urlUtils = require('../../../shared/url-utils');
+const urlUtils = require('../../../shared/url-utils').default;
 const logging = require('@tryghost/logging');
 const { getSignedAdminToken } = require('../../adapters/scheduling/utils');
 const StartAutomationsPollEvent = require('./events/start-automations-poll-event');

package/core/server/services/automations/service.ts

@@ -1,4 +1,5 @@
 import assert from 'node:assert/strict';
+import type {SchedulerAdapter} from '@tryghost/adapter-base-scheduling';
 import type {InternalKeys} from '../internal-keys';
 // @ts-expect-error @tryghost/domain-events currently lacks type declarations.
 import type DomainEvents from '@tryghost/domain-events';
@@ -10,29 +11,18 @@ import {SoonestTimer} from '../../lib/soonest-timer';
 // @ts-expect-error This module currently lacks type definitions.
 import emailAnalyticsJobs from '../email-analytics/jobs';
 
-const urlUtils = require('../../../shared/url-utils');
+const urlUtils = require('../../../shared/url-utils').default;
 const logging = require('@tryghost/logging');
 const {getSignedAdminToken} = require('../../adapters/scheduling/utils');
 const StartAutomationsPollEvent = require('./events/start-automations-poll-event');
 const {welcomeEmailAutomationPoll} = require('./welcome-email-automation-poll');
 const memberWelcomeEmailService = require('../member-welcome-emails/service');
 
-type SchedulerAdapter = {
-    schedule(job: {
-        extra: {
-            httpMethod: string;
-        };
-        time: number;
-        url: string;
-    }): void;
-    register(rescheduler: {rescheduleAll: () => unknown}): void;
-};
-
 type AutomationsServiceOptions = {
     apiUrl: string;
     domainEvents: Pick<DomainEvents, 'dispatch' | 'subscribe'>;
     internalKeys: InternalKeys;
-    schedulerAdapter: SchedulerAdapter;
+    schedulerAdapter: Pick<SchedulerAdapter, 'schedule' | 'register'>;
 };
 
 const scheduleAutomationEmailAnalyticsJob = () => (

package/core/server/services/automations/welcome-email-automation-poll.js

@@ -235,7 +235,8 @@ async function processRun({
                 member_uuid: member.get('uuid'),
                 member_email: member.get('email'),
                 member_name: member.get('name'),
-                track_opens: false
+                track_opens: false,
+                track_clicks: false
             }, {transacting});
 
             await markExited(run.id, 'finished', transacting);

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

@@ -26,7 +26,10 @@ class CommentsServiceEmails {
      */
     getPostUrl(post, commentId) {
         const postData = toPlain(post);
-        const baseUrl = this.urlService.facade.getUrlForResource({...postData, type: 'posts'}, {absolute: true});
+        // Comments live on pages as well as posts; the URL service routes by
+        // the passed type, so a page typed 'posts' resolves to /404/.
+        const routerType = postData.type === 'page' ? 'pages' : 'posts';
+        const baseUrl = this.urlService.facade.getUrlForResource({...postData, type: routerType}, {absolute: true});
         return `${baseUrl}#ghost-comments-${commentId}`;
     }
 

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

@@ -11,7 +11,7 @@ class CommentsServiceWrapper {
         const mailer = new GhostMailer();
         const settingsCache = require('../../../shared/settings-cache');
         const urlService = require('../url');
-        const urlUtils = require('../../../shared/url-utils');
+        const urlUtils = require('../../../shared/url-utils').default;
         const membersService = require('../members');
         const db = require('../../data/db');
         const settingsHelpers = require('../settings-helpers');

package/core/server/services/custom-redirects/index.js

@@ -1,6 +1,6 @@
 const config = require('../../../shared/config');
-const urlUtils = require('../../../shared/url-utils');
-const adapterManager = require('../adapter-manager');
+const urlUtils = require('../../../shared/url-utils').default;
+const adapterManager = require('../adapter-manager').default;
 
 const DynamicRedirectManager = require('../lib/dynamic-redirect-manager');
 const {RedirectsService} = require('./redirects-service');

package/core/server/services/email-analytics/email-analytics-service-wrapper.js

@@ -8,6 +8,7 @@ const domainEvents = require('@tryghost/domain-events');
 
 class EmailAnalyticsServiceWrapper {
     /** @type {string} */ #logName;
+    #fetching = false;
     #restoredSchedule = false;
 
     get #logPrefix() {
@@ -128,9 +129,9 @@ class EmailAnalyticsServiceWrapper {
             logging.warn(`${this.#logPrefix} Opened events processing is ${lagMinutes.toFixed(1)} minutes behind (threshold: ${lagThreshold})`);
         }
 
-        const fetchStartDate = new Date();
+        const fetchStartedAt = Date.now();
         const fetchResult = await this.service.fetchLatestOpenedEvents({maxEvents});
-        const totalDuration = Date.now() - fetchStartDate.getTime();
+        const totalDuration = Date.now() - fetchStartedAt;
 
         this._logJobCompletion('latest-opened', fetchResult, totalDuration);
 
@@ -138,9 +139,9 @@ class EmailAnalyticsServiceWrapper {
     }
 
     async fetchLatestNonOpenedEvents({maxEvents} = {maxEvents: Infinity}) {
-        const fetchStartDate = new Date();
+        const fetchStartedAt = Date.now();
         const fetchResult = await this.service.fetchLatestNonOpenedEvents({maxEvents});
-        const totalDuration = Date.now() - fetchStartDate.getTime();
+        const totalDuration = Date.now() - fetchStartedAt;
 
         this._logJobCompletion('latest', fetchResult, totalDuration);
 
@@ -148,9 +149,9 @@ class EmailAnalyticsServiceWrapper {
     }
 
     async fetchMissing({maxEvents} = {maxEvents: Infinity}) {
-        const fetchStartDate = new Date();
+        const fetchStartedAt = Date.now();
         const fetchResult = await this.service.fetchMissing({maxEvents});
-        const totalDuration = Date.now() - fetchStartDate.getTime();
+        const totalDuration = Date.now() - fetchStartedAt;
 
         this._logJobCompletion('missing', fetchResult, totalDuration);
 
@@ -162,9 +163,9 @@ class EmailAnalyticsServiceWrapper {
             return 0;
         }
 
-        const fetchStartDate = new Date();
+        const fetchStartedAt = Date.now();
         const fetchResult = await this.service.fetchScheduled({maxEvents});
-        const totalDuration = Date.now() - fetchStartDate.getTime();
+        const totalDuration = Date.now() - fetchStartedAt;
 
         this._logJobCompletion('scheduled', fetchResult, totalDuration);
 
@@ -177,11 +178,11 @@ class EmailAnalyticsServiceWrapper {
             await this.service.restoreScheduled();
         }
 
-        if (this.fetching) {
+        if (this.#fetching) {
             logging.info(`Email analytics fetch for ${this.#logName} already running, skipping`);
             return;
         }
-        this.fetching = true;
+        this.#fetching = true;
 
         // NOTE: Data shows we can process ~2500 events per minute on Pro for a large-ish db (150k members).
         //       This can vary locally, but we should be conservative with the number of events we fetch.
@@ -216,18 +217,18 @@ class EmailAnalyticsServiceWrapper {
                 logging.info(`${this.#logPrefix} Job complete - No events`);
             }
 
-            this.fetching = false;
+            this.#fetching = false;
         } catch (e) {
             logging.error(e, `Error while fetching email analytics for ${this.#logName}`);
 
             // Log again only the error, otherwise we lose the stack trace
             logging.error(e);
         }
-        this.fetching = false;
+        this.#fetching = false;
     }
 
     _restartFetch(reason) {
-        this.fetching = false;
+        this.#fetching = false;
         logging.info(`${this.#logPrefix} Restarting fetch due to ${reason}`);
         this.startFetch();
     }

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

@@ -105,7 +105,7 @@ module.exports = class EmailAnalyticsService {
      * @param {object} dependencies
      * @param {object} dependencies.queries
      * @param {object} dependencies.provider
-     * @param {PrometheusClient} dependencies.prometheusClient
+     * @param {PrometheusClient} [dependencies.prometheusClient]
      * @param {() => BatchEventProcessor} dependencies.createEventProcessor
      * @param {JobNames} dependencies.jobNames
      * @param {CursorSeed} dependencies.cursorSeed

package/core/server/services/email-analytics/events/start-email-analytics-job-event.js

@@ -1,22 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartEmailAnalyticsJobEvent = void 0;
 /**
  * This is an event that is used to circumvent the job manager that currently isn't able to run scheduled jobs on the main thread (not offloaded).
  * We simply emit this event in the job manager and listen for it on the main thread.
  */
-module.exports = class StartEmailAnalyticsJobEvent {
-    /**
-     * @param {any} data
-     * @param {Date} timestamp
-     */
-    constructor(data, timestamp) {
-        this.data = data;
+class StartEmailAnalyticsJobEvent {
+    timestamp;
+    constructor(timestamp) {
         this.timestamp = timestamp;
     }
-
-    /**
-     * @param {any} [data]
-     * @param {Date} [timestamp]
-     */
-    static create(data, timestamp) {
-        return new StartEmailAnalyticsJobEvent(data, timestamp ?? new Date);
+    static create(timestamp = new Date()) {
+        return new StartEmailAnalyticsJobEvent(timestamp);
     }
-};
+}
+exports.StartEmailAnalyticsJobEvent = StartEmailAnalyticsJobEvent;
+;

package/core/server/services/email-analytics/events/start-email-analytics-job-event.ts

@@ -0,0 +1,15 @@
+/**
+ * This is an event that is used to circumvent the job manager that currently isn't able to run scheduled jobs on the main thread (not offloaded).
+ * We simply emit this event in the job manager and listen for it on the main thread.
+ */
+export class StartEmailAnalyticsJobEvent {
+    readonly timestamp: Date;
+
+    constructor(timestamp: Date) {
+        this.timestamp = timestamp;
+    }
+
+    static create(timestamp = new Date()) {
+        return new StartEmailAnalyticsJobEvent(timestamp);
+    }
+};

package/core/server/services/email-analytics/index.js

@@ -59,8 +59,7 @@ const domain_events_1 = __importDefault(require("@tryghost/domain-events"));
 const prometheus_client_1 = __importDefault(require("../../../shared/prometheus-client"));
 // @ts-expect-error This module lacks type definitions.
 const queries_1 = __importDefault(require("./lib/queries"));
-// @ts-expect-error This module lacks type definitions.
-const start_email_analytics_job_event_1 = __importDefault(require("./events/start-email-analytics-job-event"));
+const start_email_analytics_job_event_1 = require("./events/start-email-analytics-job-event");
 const start_automation_email_analytics_job_event_1 = require("./events/start-automation-email-analytics-job-event");
 const constants_1 = require("../member-welcome-emails/constants");
 const automationsApi = __importStar(require("../automations/automations-api"));
@@ -93,7 +92,7 @@ const init = () => {
         newsletterMailgunTags.push(config_1.default.get('bulkEmail:mailgun:tag'));
     }
     exports.newsletters.init({
-        event: start_email_analytics_job_event_1.default,
+        event: start_email_analytics_job_event_1.StartEmailAnalyticsJobEvent,
         mailgunTags: newsletterMailgunTags,
         jobNames: {
             latestNonOpened: 'email-analytics-latest-others',

package/core/server/services/email-analytics/index.ts

@@ -20,8 +20,7 @@ import domainEvents from '@tryghost/domain-events';
 import prometheusClient from '../../../shared/prometheus-client';
 // @ts-expect-error This module lacks type definitions.
 import queries from './lib/queries';
-// @ts-expect-error This module lacks type definitions.
-import StartEmailAnalyticsJobEvent from './events/start-email-analytics-job-event';
+import {StartEmailAnalyticsJobEvent} from './events/start-email-analytics-job-event';
 import {StartAutomationEmailAnalyticsJobEvent} from './events/start-automation-email-analytics-job-event';
 import {AUTOMATION_EMAIL_TAG} from '../member-welcome-emails/constants';
 import * as automationsApi from '../automations/automations-api';