ghost 6.47.0 → 6.48.0

package/core/server/lib/post-revisions.ts

@@ -31,7 +31,6 @@ type PostRevisionsDeps = {
         max_revisions: number;
         revision_interval_ms: number;
     },
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     model: any
 }
 
@@ -44,7 +43,6 @@ type RevisionResult = {
 
 export class PostRevisions {
     config: PostRevisionsDeps['config'];
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     model: any;
 
     constructor(deps: PostRevisionsDeps) {
@@ -128,7 +126,6 @@ export class PostRevisions {
         };
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async removeAuthorFromRevisions(authorId: string, options: any): Promise<void> {
         const revisions = await this.model.findAll({
             filter: `author_id:'${authorId}'`,

package/core/server/models/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-lines */
 
 /**
  * Dependencies
@@ -49,7 +48,6 @@ const {MobiledocRevision} = require('./mobiledoc-revision');
 const {Newsletter} = require('./newsletter');
 const {OfferRedemption} = require('./offer-redemption');
 const {Offer} = require('./offer');
-const {Outbox} = require('./outbox');
 const {Permission, Permissions} = require('./permission');
 const {PostRevision} = require('./post-revision');
 const {Post, Posts} = require('./post');
@@ -147,7 +145,6 @@ exports.MobiledocRevision = MobiledocRevision;
 exports.Newsletter = Newsletter;
 exports.OfferRedemption = OfferRedemption;
 exports.Offer = Offer;
-exports.Outbox = Outbox;
 exports.Permission = Permission;
 exports.Permissions = Permissions;
 exports.PostRevision = PostRevision;

package/core/server/services/auth/reset-authentication.js

@@ -5,9 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = resetAuthentication;
 const internal_keys_1 = __importDefault(require("../internal-keys"));
-// eslint-disable-next-line @typescript-eslint/no-require-imports
 const modelsDefault = require('../../models');
-// eslint-disable-next-line @typescript-eslint/no-require-imports
 const { deleteAllSessions: deleteAllSessionsDefault } = require('./session');
 /**
  * Rotation, user lock and the audit row commit in a single transaction so

package/core/server/services/auth/reset-authentication.ts

@@ -1,10 +1,7 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import type {Knex} from 'knex';
 import type {InternalApiKey, InternalKeys} from '../internal-keys';
 import internalKeysDefault from '../internal-keys';
-// eslint-disable-next-line @typescript-eslint/no-require-imports
 const modelsDefault = require('../../models');
-// eslint-disable-next-line @typescript-eslint/no-require-imports
 const {deleteAllSessions: deleteAllSessionsDefault} = require('./session');
 
 interface ResetAuthenticationArgs {

package/core/server/services/auth/session/index.js

@@ -15,7 +15,6 @@ const {blogIcon} = require('../../../lib/image');
 const url = require('url');
 
 // TODO: We have too many lines here, should move functions out into a utils module
-/* eslint-disable max-lines */
 
 function getOriginOfRequest(req) {
     const getHeader = (name) => {

package/core/server/services/automations/automations-api.js

@@ -12,7 +12,6 @@ exports.fetchAndLockSteps = fetchAndLockSteps;
 exports.finishStepAndEnqueueNext = finishStepAndEnqueueNext;
 exports.markStepTerminal = markStepTerminal;
 exports.retryStep = retryStep;
-/* eslint-disable @typescript-eslint/no-require-imports */
 const errors_1 = __importDefault(require("@tryghost/errors"));
 const tpl_1 = __importDefault(require("@tryghost/tpl"));
 const bson_objectid_1 = __importDefault(require("bson-objectid"));
@@ -23,6 +22,7 @@ const { knex } = require('../../data/db');
 const domainEvents = require('@tryghost/domain-events');
 const labs = require('../../../shared/labs');
 const config = require('../../../shared/config');
+const lexicalLib = require('../../lib/lexical');
 const StartAutomationsPollEvent = require('./events/start-automations-poll-event');
 const MAX_AUTOMATION_ACTIONS = 20;
 const messages = {
@@ -35,7 +35,8 @@ const messages = {
     invalidAutomationEdge: 'Automation edges cannot connect an action to itself.',
     invalidAutomationGraphShape: 'Automation graph must be a single linear path without branches or cycles.',
     emptyEmailSubjectWhenActive: 'Active automations require a subject line for every email.',
-    emptyEmailBodyWhenActive: 'Active automations require a body for every email.'
+    emptyEmailBodyWhenActive: 'Active automations require a body for every email.',
+    invalidEmailLexical: 'Email lexical must be a well-formed Lexical document.'
 };
 const objectIdSchema = zod_1.z.string().refine(value => bson_objectid_1.default.isValid(value));
 const waitActionSchema = zod_1.z.object({
@@ -50,15 +51,7 @@ const sendEmailActionSchema = zod_1.z.object({
     type: zod_1.z.literal('send_email'),
     data: zod_1.z.object({
         email_subject: zod_1.z.string(),
-        email_lexical: zod_1.z.string().refine((value) => {
-            try {
-                JSON.parse(value);
-                return true;
-            }
-            catch {
-                return false;
-            }
-        }),
+        email_lexical: zod_1.z.string(),
         email_design_setting_id: zod_1.z.string().min(1)
     }).strict()
 }).strict();
@@ -91,7 +84,7 @@ async function read(automationId) {
     return automation;
 }
 async function edit(automationId, data) {
-    const parsedData = validateEditData(data);
+    const parsedData = await validateEditData(data);
     const automation = await repository.edit(automationId, parsedData);
     if (!automation) {
         throw new errors_1.default.NotFoundError({
@@ -100,7 +93,7 @@ async function edit(automationId, data) {
     }
     return automation;
 }
-function validateEditData(data) {
+async function validateEditData(data) {
     const result = editAutomationDataSchema.safeParse(data);
     if (!result.success) {
         if (result.error.issues.some(issue => issue.path[0] === 'status')) {
@@ -109,9 +102,29 @@ function validateEditData(data) {
         throwValidationError(buildInvalidAutomationPayloadMessage(result.error.issues));
     }
     validateGraph(result.data.actions, result.data.edges);
+    await validateEmailLexical(result.data.actions);
     validateActiveEmailSteps(result.data.status, result.data.actions);
     return result.data;
 }
+async function validateEmailLexical(actions) {
+    await Promise.all(actions.map(async (action) => {
+        if (action.type !== 'send_email') {
+            return;
+        }
+        const lexical = action.data.email_lexical;
+        // Empty editor documents are valid draft state and are classified by
+        // active-body validation below. Invalid JSON is not skipped here.
+        if (isValidEmptyLexical(lexical)) {
+            return;
+        }
+        if (isMalformedEmptyLexical(lexical)) {
+            throwValidationError(messages.invalidEmailLexical, 'actions');
+        }
+        if (!await lexicalLib.validate(lexical)) {
+            throwValidationError(messages.invalidEmailLexical, 'actions');
+        }
+    }));
+}
 // Drafts may persist empty email steps, but an active automation must have a
 // complete subject and body for every email it sends — mirroring the editor's
 // publish-time validation.
@@ -134,15 +147,44 @@ function validateActiveEmailSteps(status, actions) {
 function isEmptyLexical(lexical) {
     try {
         const parsed = JSON.parse(lexical);
-        const children = parsed?.root?.children;
-        if (!children || children.length === 0) {
-            return true;
+        return isEmptyParsedLexical(parsed);
+    }
+    catch {
+        return true;
+    }
+}
+function isValidEmptyLexical(lexical) {
+    try {
+        return isEmptyParsedLexical(JSON.parse(lexical));
+    }
+    catch {
+        return false;
+    }
+}
+function isMalformedEmptyLexical(lexical) {
+    try {
+        const children = JSON.parse(lexical)?.root?.children;
+        if (!Array.isArray(children) || children.length !== 1 || children[0].type !== 'paragraph') {
+            return false;
         }
-        return children.length === 1 && children[0].type === 'paragraph' && (!children[0].children || children[0].children.length === 0);
+        return !Array.isArray(children[0].children);
     }
     catch {
+        return false;
+    }
+}
+function isEmptyParsedLexical(parsed) {
+    const children = parsed?.root?.children;
+    if (!Array.isArray(children)) {
+        return false;
+    }
+    if (children.length === 0) {
         return true;
     }
+    if (children.length !== 1 || children[0].type !== 'paragraph') {
+        return false;
+    }
+    return Array.isArray(children[0].children) && children[0].children.length === 0;
 }
 function buildInvalidAutomationPayloadMessage(issues) {
     if (!issues.length) {

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

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-require-imports */
 import errors from '@tryghost/errors';
 import tpl from '@tryghost/tpl';
 import ObjectId from 'bson-objectid';
@@ -14,6 +13,7 @@ const {knex} = require('../../data/db');
 const domainEvents = require('@tryghost/domain-events');
 const labs = require('../../../shared/labs');
 const config = require('../../../shared/config');
+const lexicalLib = require('../../lib/lexical');
 const StartAutomationsPollEvent = require('./events/start-automations-poll-event');
 
 const MAX_AUTOMATION_ACTIONS = 20;
@@ -28,7 +28,8 @@ const messages = {
     invalidAutomationEdge: 'Automation edges cannot connect an action to itself.',
     invalidAutomationGraphShape: 'Automation graph must be a single linear path without branches or cycles.',
     emptyEmailSubjectWhenActive: 'Active automations require a subject line for every email.',
-    emptyEmailBodyWhenActive: 'Active automations require a body for every email.'
+    emptyEmailBodyWhenActive: 'Active automations require a body for every email.',
+    invalidEmailLexical: 'Email lexical must be a well-formed Lexical document.'
 };
 
 const objectIdSchema = z.string().refine(value => ObjectId.isValid(value));
@@ -46,14 +47,7 @@ const sendEmailActionSchema = z.object({
     type: z.literal('send_email'),
     data: z.object({
         email_subject: z.string(),
-        email_lexical: z.string().refine((value) => {
-            try {
-                JSON.parse(value);
-                return true;
-            } catch {
-                return false;
-            }
-        }),
+        email_lexical: z.string(),
         email_design_setting_id: z.string().min(1)
     }).strict()
 }).strict();
@@ -94,7 +88,7 @@ export async function read(automationId: string) {
 }
 
 export async function edit(automationId: string, data: unknown) {
-    const parsedData = validateEditData(data);
+    const parsedData = await validateEditData(data);
 
     const automation = await repository.edit(automationId, parsedData);
 
@@ -107,7 +101,7 @@ export async function edit(automationId: string, data: unknown) {
     return automation;
 }
 
-function validateEditData(data: unknown): EditAutomationData {
+async function validateEditData(data: unknown): Promise<EditAutomationData> {
     const result = editAutomationDataSchema.safeParse(data);
 
     if (!result.success) {
@@ -119,10 +113,35 @@ function validateEditData(data: unknown): EditAutomationData {
     }
 
     validateGraph(result.data.actions, result.data.edges);
+    await validateEmailLexical(result.data.actions);
     validateActiveEmailSteps(result.data.status, result.data.actions);
     return result.data;
 }
 
+async function validateEmailLexical(actions: EditAutomationData['actions']) {
+    await Promise.all(actions.map(async (action) => {
+        if (action.type !== 'send_email') {
+            return;
+        }
+
+        const lexical = action.data.email_lexical;
+
+        // Empty editor documents are valid draft state and are classified by
+        // active-body validation below. Invalid JSON is not skipped here.
+        if (isValidEmptyLexical(lexical)) {
+            return;
+        }
+
+        if (isMalformedEmptyLexical(lexical)) {
+            throwValidationError(messages.invalidEmailLexical, 'actions');
+        }
+
+        if (!await lexicalLib.validate(lexical)) {
+            throwValidationError(messages.invalidEmailLexical, 'actions');
+        }
+    }));
+}
+
 // Drafts may persist empty email steps, but an active automation must have a
 // complete subject and body for every email it sends — mirroring the editor's
 // publish-time validation.
@@ -149,16 +168,50 @@ function validateActiveEmailSteps(status: EditAutomationData['status'], actions:
 function isEmptyLexical(lexical: string): boolean {
     try {
         const parsed = JSON.parse(lexical);
-        const children = parsed?.root?.children;
+        return isEmptyParsedLexical(parsed);
+    } catch {
+        return true;
+    }
+}
 
-        if (!children || children.length === 0) {
-            return true;
+function isValidEmptyLexical(lexical: string): boolean {
+    try {
+        return isEmptyParsedLexical(JSON.parse(lexical));
+    } catch {
+        return false;
+    }
+}
+
+function isMalformedEmptyLexical(lexical: string): boolean {
+    try {
+        const children = JSON.parse(lexical)?.root?.children;
+
+        if (!Array.isArray(children) || children.length !== 1 || children[0].type !== 'paragraph') {
+            return false;
         }
 
-        return children.length === 1 && children[0].type === 'paragraph' && (!children[0].children || children[0].children.length === 0);
+        return !Array.isArray(children[0].children);
     } catch {
+        return false;
+    }
+}
+
+function isEmptyParsedLexical(parsed: {root?: {children?: Array<{type?: string; children?: unknown}>}}): boolean {
+    const children = parsed?.root?.children;
+
+    if (!Array.isArray(children)) {
+        return false;
+    }
+
+    if (children.length === 0) {
         return true;
     }
+
+    if (children.length !== 1 || children[0].type !== 'paragraph') {
+        return false;
+    }
+
+    return Array.isArray(children[0].children) && children[0].children.length === 0;
 }
 
 function buildInvalidAutomationPayloadMessage(issues: z.core.$ZodIssue[]) {

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

@@ -11,7 +11,7 @@ const bson_objectid_1 = __importDefault(require("bson-objectid"));
 const dequal_1 = require("dequal");
 const moment_1 = __importDefault(require("moment"));
 const constants_1 = require("../member-welcome-emails/constants");
-const constants_2 = require("./constants");
+const stale_lock_cutoff_1 = require("./stale-lock-cutoff");
 const HOUR_MS = 60 * 60 * 1000;
 const DATABASE_DATE_FORMAT = 'YYYY-MM-DD HH:mm:ss';
 const DEFAULT_WELCOME_EMAIL_AUTOMATIONS = [{
@@ -60,12 +60,16 @@ function createDatabaseAutomationsRepository({ knex, fakeWaitHoursMultiplier })
                 if (!automation) {
                     return null;
                 }
+                const now = new Date();
                 const updatedAutomation = await updateAutomation(trx, {
                     ...automation,
                     status: data.status,
-                    updated_at: toDatabaseDate(new Date())
+                    updated_at: toDatabaseDate(now)
                 });
                 await replaceAutomationGraph(trx, updatedAutomation.id, data.actions, data.edges);
+                if (updatedAutomation.status === 'inactive') {
+                    await cancelCancelablePendingStepsForAutomation(trx, updatedAutomation.id, now);
+                }
                 return await buildAutomation(trx, updatedAutomation);
             });
         },
@@ -210,7 +214,7 @@ async function fetchAndLockSteps(trx, limit) {
     // 3. Select any rows we successfully locked.
     const now = new Date();
     const nowString = toDatabaseDate(now);
-    const staleLockCutoff = new Date(now.getTime() - constants_2.LOCK_TIMEOUT_MS);
+    const staleLockCutoff = (0, stale_lock_cutoff_1.getStaleLockCutoff)(now);
     const staleLockCutoffString = toDatabaseDate(staleLockCutoff);
     const lockId = node_crypto_1.default.randomUUID();
     // 1. Select up to `limit` candidate rows.
@@ -349,6 +353,9 @@ async function finishStepAndEnqueueNext(trx, options) {
     if (!didFinish) {
         return null;
     }
+    if (!await isRunAutomationActive(trx, step.automation_run_id)) {
+        return null;
+    }
     const next = await findNextActionRevision(trx, step.action_id);
     if (!next) {
         return null;
@@ -387,6 +394,10 @@ async function markStepTerminal(trx, step, status) {
     });
 }
 async function retryStep(trx, step, retryAt) {
+    if (!await isStepRunAutomationActive(trx, step.id)) {
+        await markStepTerminal(trx, step, 'automation disabled');
+        return false;
+    }
     const nowString = toDatabaseDate(new Date());
     return await updateStep(trx, step, {
         status: 'pending',
@@ -416,6 +427,50 @@ function getReadyAtForAction(action, now, fakeWaitHoursMultiplier) {
         }
     }
 }
+async function cancelCancelablePendingStepsForAutomation(trx, automationId, now) {
+    const nowString = toDatabaseDate(now);
+    const staleLockCutoff = toDatabaseDate((0, stale_lock_cutoff_1.getStaleLockCutoff)(now));
+    await trx('automation_run_steps')
+        .update({
+        status: 'automation disabled',
+        finished_at: nowString,
+        updated_at: nowString,
+        locked_by: null,
+        locked_at: null
+    })
+        .where('status', 'pending')
+        .whereIn('automation_run_id', trx('automation_runs')
+        .select('id')
+        .where('automation_id', automationId))
+        .where((builder) => {
+        builder
+            .whereNull('locked_by')
+            .orWhere('locked_at', '<', staleLockCutoff);
+    });
+}
+async function isStepRunAutomationActive(trx, stepId) {
+    const query = trx('automation_run_steps as step')
+        .select(trx.raw('1'))
+        .innerJoin('automation_runs as run', 'run.id', 'step.automation_run_id')
+        .innerJoin('automations as automation', 'automation.id', 'run.automation_id')
+        .where('step.id', stepId)
+        .where('automation.status', 'active');
+    return await selectExists(trx, query);
+}
+async function isRunAutomationActive(trx, automationRunId) {
+    const query = trx('automation_runs as run')
+        .select(trx.raw('1'))
+        .innerJoin('automations as automation', 'automation.id', 'run.automation_id')
+        .where('run.id', automationRunId)
+        .where('automation.status', 'active');
+    return await selectExists(trx, query);
+}
+async function selectExists(trx, query) {
+    const row = await trx
+        .select(trx.raw('exists ? as `exists`', [query]))
+        .first();
+    return Boolean(Number(row?.exists));
+}
 /**
  * Update a step. Returns whether the update succeeded.
  *

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

@@ -17,7 +17,7 @@ import type {
     EditAutomationData,
     Page
 } from './automations-repository';
-import {LOCK_TIMEOUT_MS} from './constants';
+import {getStaleLockCutoff} from './stale-lock-cutoff';
 import type {ExclusifyUnion, ReadonlyDeep} from 'type-fest';
 
 const HOUR_MS = 60 * 60 * 1000;
@@ -165,14 +165,20 @@ export function createDatabaseAutomationsRepository({
                     return null;
                 }
 
+                const now = new Date();
+
                 const updatedAutomation = await updateAutomation(trx, {
                     ...automation,
                     status: data.status,
-                    updated_at: toDatabaseDate(new Date())
+                    updated_at: toDatabaseDate(now)
                 });
 
                 await replaceAutomationGraph(trx, updatedAutomation.id, data.actions, data.edges);
 
+                if (updatedAutomation.status === 'inactive') {
+                    await cancelCancelablePendingStepsForAutomation(trx, updatedAutomation.id, now);
+                }
+
                 return await buildAutomation(trx, updatedAutomation);
             });
         },
@@ -375,7 +381,7 @@ async function fetchAndLockSteps(trx: Knex.Transaction, limit: number): Promise<
 
     const now = new Date();
     const nowString = toDatabaseDate(now);
-    const staleLockCutoff = new Date(now.getTime() - LOCK_TIMEOUT_MS);
+    const staleLockCutoff = getStaleLockCutoff(now);
     const staleLockCutoffString = toDatabaseDate(staleLockCutoff);
     const lockId = crypto.randomUUID();
 
@@ -561,6 +567,10 @@ async function finishStepAndEnqueueNext(
         return null;
     }
 
+    if (!await isRunAutomationActive(trx, step.automation_run_id)) {
+        return null;
+    }
+
     const next = await findNextActionRevision(trx, step.action_id);
 
     if (!next) {
@@ -620,6 +630,11 @@ async function retryStep(
     step: Pick<AutomationStepToRun, 'id' | 'locked_by'>,
     retryAt: Readonly<Date>
 ): Promise<boolean> {
+    if (!await isStepRunAutomationActive(trx, step.id)) {
+        await markStepTerminal(trx, step, 'automation disabled');
+        return false;
+    }
+
     const nowString = toDatabaseDate(new Date());
     return await updateStep(trx, step, {
         status: 'pending',
@@ -655,6 +670,58 @@ function getReadyAtForAction(
     }
 }
 
+async function cancelCancelablePendingStepsForAutomation(
+    trx: Knex.Transaction,
+    automationId: string,
+    now: Readonly<Date>
+): Promise<void> {
+    const nowString = toDatabaseDate(now);
+    const staleLockCutoff = toDatabaseDate(getStaleLockCutoff(now));
+    await trx('automation_run_steps')
+        .update({
+            status: 'automation disabled',
+            finished_at: nowString,
+            updated_at: nowString,
+            locked_by: null,
+            locked_at: null
+        })
+        .where('status', 'pending')
+        .whereIn('automation_run_id', trx('automation_runs')
+            .select('id')
+            .where('automation_id', automationId))
+        .where((builder) => {
+            builder
+                .whereNull('locked_by')
+                .orWhere('locked_at', '<', staleLockCutoff);
+        });
+}
+
+async function isStepRunAutomationActive(trx: Knex.Transaction, stepId: string): Promise<boolean> {
+    const query = trx('automation_run_steps as step')
+        .select(trx.raw('1'))
+        .innerJoin('automation_runs as run', 'run.id', 'step.automation_run_id')
+        .innerJoin('automations as automation', 'automation.id', 'run.automation_id')
+        .where('step.id', stepId)
+        .where('automation.status', 'active');
+    return await selectExists(trx, query);
+}
+
+async function isRunAutomationActive(trx: Knex.Transaction, automationRunId: string): Promise<boolean> {
+    const query = trx('automation_runs as run')
+        .select(trx.raw('1'))
+        .innerJoin('automations as automation', 'automation.id', 'run.automation_id')
+        .where('run.id', automationRunId)
+        .where('automation.status', 'active');
+    return await selectExists(trx, query);
+}
+
+async function selectExists(trx: Knex.Transaction, query: Knex.QueryBuilder): Promise<boolean> {
+    const row = await trx
+        .select<{exists: boolean | number | string}>(trx.raw('exists ? as `exists`', [query]))
+        .first();
+    return Boolean(Number(row?.exists));
+}
+
 /**
  * Update a step. Returns whether the update succeeded.
  *

package/core/server/services/automations/stale-lock-cutoff.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStaleLockCutoff = getStaleLockCutoff;
+const constants_1 = require("./constants");
+function getStaleLockCutoff(now) {
+    return new Date(now.getTime() - constants_1.LOCK_TIMEOUT_MS);
+}

package/core/server/services/automations/stale-lock-cutoff.ts

@@ -0,0 +1,5 @@
+import {LOCK_TIMEOUT_MS} from './constants';
+
+export function getStaleLockCutoff(now: Readonly<Date>): Date {
+    return new Date(now.getTime() - LOCK_TIMEOUT_MS);
+}

package/core/server/services/email-address/email-address-parser.js.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable ghost/filenames/match-exported-class */
 
 export interface EmailAddress {
     address: string;