ghost 6.63.0 → 6.65.0

package/core/server/services/adapter-manager/base-classes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.baseClasses = void 0;
+exports.baseClassPackages = exports.baseClasses = void 0;
 const ghost_storage_base_1 = require("ghost-storage-base");
 const adapter_base_scheduling_1 = require("@tryghost/adapter-base-scheduling");
 const adapter_base_sso_1 = require("@tryghost/adapter-base-sso");
@@ -10,8 +10,7 @@ const adapter_base_route_settings_1 = require("@tryghost/adapter-base-route-sett
 const adapter_base_jobs_1 = require("@tryghost/adapter-base-jobs");
 /**
  * The base class every adapter of a given type must extend. Also read by
- * bin/validate-adapters.js, which checks adapter implementations at build time -
- * keep this the only place the mapping is declared.
+ * bin/validate-adapters.js, so keep this the only place the mapping is declared.
  */
 exports.baseClasses = {
     storage: ghost_storage_base_1.StorageBase,
@@ -22,3 +21,22 @@ exports.baseClasses = {
     'route-settings': adapter_base_route_settings_1.RouteSettingsStoreBase,
     jobs: adapter_base_jobs_1.JobsBackendBase,
 };
+/**
+ * The package each base class above is imported from. An adapter that installs
+ * one of these itself gets a second copy of the base class - a different function
+ * object, so `instanceof` fails and Ghost falls back to comparing class names.
+ * bin/validate-adapters.js fails a build on such a duplicate, where a duplicate
+ * of any other package is only reported.
+ *
+ * Keyed by adapter type so `satisfies` demands an entry per type in
+ * `baseClasses`; a unit test keeps the names matching the imports above.
+ */
+exports.baseClassPackages = {
+    storage: 'ghost-storage-base',
+    scheduling: '@tryghost/adapter-base-scheduling',
+    sso: '@tryghost/adapter-base-sso',
+    cache: '@tryghost/adapter-base-cache',
+    redirects: '@tryghost/adapter-base-redirects',
+    'route-settings': '@tryghost/adapter-base-route-settings',
+    jobs: '@tryghost/adapter-base-jobs',
+};

package/core/server/services/adapter-manager/utils.js

@@ -207,9 +207,14 @@ function normalizeAdapterPaths(config, key, defaultPathsByAdapter) {
  */
 function normalizeAdapterConfig(config) {
     const adapterConfig = config.get('adapters');
+    const storage = adapterConfig?.storage ?? config.get('storage');
     return {
         ...adapterConfig,
-        storage: adapterConfig?.storage ?? config.get('storage'),
+        // adapters.storage replaces the top-level storage config, defaults included, so carry
+        // storage:imports over: import files must never fall back to the store that serves images.
+        storage: adapterConfig?.storage
+            ? { imports: config.get('storage:imports'), ...storage }
+            : storage,
         scheduling: getSchedulingConfig(config),
         redirects: normalizeAdapterPaths(config, 'redirects', {
             FileStore: {

package/core/server/services/api-version-compatibility/legacy-api-path-match.js

@@ -1,8 +1,8 @@
 const pathMatch = require('path-match')();
 
 module.exports = (url) => {
-  let basePath = 'ghost/api';
-  let apiRouteMatcher = '/:version(v2|v3|v4|canary)?/:api(admin|content)/*';
+  const basePath = 'ghost/api';
+  const apiRouteMatcher = '/:version(v2|v3|v4|canary)?/:api(admin|content)/*';
   let urlToMatch = url;
 
   if (url.includes(basePath)) {

package/core/server/services/auth/api-key/admin.js

@@ -16,7 +16,7 @@ const messages = {
   invalidApiKeyType: 'Invalid API Key type',
 };
 
-let JWT_OPTIONS_DEFAULTS = {
+const JWT_OPTIONS_DEFAULTS = {
   /** @type import('jsonwebtoken').Algorithm[] */
   algorithms: ['HS256'],
   maxAge: '5m',
@@ -202,7 +202,7 @@ const authenticateWithToken = async function apiKeyAuthenticateWithToken(
   }
 
   // authenticated OK
-  let result = {
+  const result = {
     user: null,
     apiKey: apiKey,
   };

package/core/server/services/auth/api-key/content.js

@@ -24,7 +24,7 @@ const authenticateContentApiKey = async function authenticateContentApiKey(req,
     );
   }
 
-  let key = req.query.key;
+  const key = req.query.key;
 
   try {
     const apiKey = await models.ApiKey.findOne({ secret: key }, { withRelated: ['integration'] });

package/core/server/services/auth/passwordreset.js

@@ -115,7 +115,7 @@ function doReset(options, tokenParts, settingsAPI) {
         require: true,
       });
 
-      let compareResult = security.tokens.resetToken.compare({
+      const compareResult = security.tokens.resetToken.compare({
         token: resetToken,
         dbHash: dbHash,
         password: user.get('password'),

package/core/server/services/auth/setup.js

@@ -87,13 +87,11 @@ async function doSettings(data, settingsAPI) {
   const blogTitle = data.userData.blogTitle;
   const description = data.userData.description ? data.userData.description.trim() : null;
 
-  let userSettings;
-
   if (!blogTitle || typeof blogTitle !== 'string') {
     return user;
   }
 
-  userSettings = [
+  const userSettings = [
     { key: 'title', value: blogTitle.trim() },
     { key: 'description', value: description || tpl(messages.sampleBlogDescription) },
   ];

package/core/server/services/automations/README.md

@@ -0,0 +1,19 @@
+# Automations
+
+Automations run a series of actions for a member after signup. Each automation is currently one ordered path of `wait` and `send_email` actions. It can be active or inactive.
+
+## How a run moves forward
+
+The member repository calls `trigger()` after signup.
+
+The database repository creates run(s) and queues their first step. Ghost's boot process starts the service, which checks for ready steps. It checks again when a new run starts or a later step becomes ready. An in-memory timer handles checks while Ghost is running; the scheduler can wake Ghost after a restart.
+
+Each check locks ready steps, then runs up to 100 at once. A `wait` action advances when its time arrives. A `send_email` action checks the member's current status and email preference before sending. Disabled automations and ineligible members stop.
+
+## Where to look
+
+- [`automations-api.ts`](automations-api.ts) handles reads, edits, validation, and signup triggers. Edits require one path with no branches or loops.
+- [`database-automations-repository.ts`](database-automations-repository.ts) stores automations, runs, and steps.
+- [`service.ts`](service.ts) starts checks and schedules future ones.
+- [`poll.ts`](poll.ts) runs ready steps.
+- [`welcome-email-automation-poll.ts`](welcome-email-automation-poll.ts) processes older welcome email runs.

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

@@ -18,16 +18,22 @@ exports.getAutomatedEmailRecipientsByMailgunIds = getAutomatedEmailRecipientsByM
 exports.trackEmailDeliveredAndOpened = trackEmailDeliveredAndOpened;
 exports.trackEmailClicked = trackEmailClicked;
 const errors_1 = __importDefault(require("@tryghost/errors"));
+const logging_1 = __importDefault(require("@tryghost/logging"));
 const tpl_1 = __importDefault(require("@tryghost/tpl"));
 const bson_objectid_1 = __importDefault(require("bson-objectid"));
 const zod_1 = require("zod");
 const database_automations_repository_1 = require("./database-automations-repository");
 const fake_wait_hours_multiplier_1 = require("./fake-wait-hours-multiplier");
+const tinybird_automation_stats_1 = require("./tinybird-automation-stats");
 const start_automations_poll_event_1 = require("./events/start-automations-poll-event");
 const { knex } = require('../../data/db');
 const domainEvents = require('@tryghost/domain-events');
 const labs = require('../../../shared/labs');
 const config = require('../../../shared/config');
+const settingsCache = require('../../../shared/settings-cache');
+const requestExternal = require('../../lib/request-external');
+const TinybirdServiceWrapper = require('../tinybird');
+const { create: createTinybirdClient } = require('../stats/utils/tinybird');
 const lexicalLib = require('../../lib/lexical');
 const MAX_AUTOMATION_ACTIONS = 20;
 const messages = {
@@ -77,8 +83,47 @@ const repository = (0, database_automations_repository_1.createDatabaseAutomatio
     knex,
     fakeWaitHoursMultiplier: (0, fake_wait_hours_multiplier_1.parseFakeWaitHoursMultiplier)(config.get('automations:fakeWaitHoursMultiplier')),
 });
+function getTinybirdClient() {
+    if (!labs.isSet('automationsTinybirdSync') || !config.get('tinybird:stats')) {
+        return null;
+    }
+    try {
+        const tinybirdService = TinybirdServiceWrapper.instance;
+        if (!tinybirdService?.getToken()?.token) {
+            return null;
+        }
+        return createTinybirdClient({
+            config,
+            // Fall back to MySQL after the first failed attempt.
+            request: requestExternal.extend({ retry: { limit: 0 } }),
+            settingsCache,
+            tinybirdService,
+        });
+    }
+    catch (error) {
+        logging_1.default.error('Error preparing Tinybird automation stats client:', error);
+        return null;
+    }
+}
 async function browse() {
-    return await repository.browse({ includeStats: true });
+    const tinybirdClient = getTinybirdClient();
+    if (!tinybirdClient) {
+        return await repository.browse({ includeStats: true });
+    }
+    const [browseResult, stats] = await Promise.all([
+        repository.browse({ includeStats: false }),
+        (0, tinybird_automation_stats_1.fetchAutomationStats)(tinybirdClient),
+    ]);
+    if (stats === null) {
+        return await repository.browse({ includeStats: true });
+    }
+    return {
+        ...browseResult,
+        data: browseResult.data.map((automation) => ({
+            ...automation,
+            stats: stats.get(automation.id) ?? { ...tinybird_automation_stats_1.EMPTY_AUTOMATION_STATS },
+        })),
+    };
 }
 async function read(automationId) {
     const automation = await repository.getById(automationId);

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

@@ -64,7 +64,9 @@ const processStep = async ({ automationsApi, memberWelcomeEmailService, schedule
         return null;
     }
     // NOTE: This will change once we support additional automation triggers.
-    const memberStatus = slugToMemberStatus.get(step.automation_slug);
+    const memberStatus = step.automation_slug
+        ? slugToMemberStatus.get(step.automation_slug)
+        : undefined;
     if (!memberStatus) {
         logging_1.default.error({
             system: {

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

@@ -41,7 +41,7 @@ const strict_1 = __importDefault(require("node:assert/strict"));
 const one_at_a_time_1 = require("../../../shared/one-at-a-time");
 const poll_1 = require("./poll");
 const automationsApi = __importStar(require("./automations-api"));
-const get_scheduler_idempotency_key_1 = require("./get-scheduler-idempotency-key");
+const get_scheduler_idempotency_key_1 = require("../../adapters/scheduling/get-scheduler-idempotency-key");
 const build_signed_job_1 = require("../../adapters/scheduling/build-signed-job");
 const promises_1 = require("node:timers/promises");
 const soonest_timer_1 = require("../../lib/soonest-timer");
@@ -96,7 +96,7 @@ class AutomationsService {
                     path: ['automations', 'poll'],
                     time: schedulerPollTime.getTime(),
                     key,
-                    getIdempotencyKey: (url) => (0, get_scheduler_idempotency_key_1.getSchedulerIdempotencyKey)(date, url),
+                    getIdempotencyKey: (url) => (0, get_scheduler_idempotency_key_1.getSchedulerIdempotencyKey)({ namespace: 'automations', date, url }),
                 }));
             }
             catch (err) {

package/core/server/services/automations/tinybird-automation-stats.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EMPTY_AUTOMATION_STATS = void 0;
+exports.fetchAutomationStats = fetchAutomationStats;
+const logging_1 = __importDefault(require("@tryghost/logging"));
+const zod_1 = require("zod");
+exports.EMPTY_AUTOMATION_STATS = {
+    last_run_created_at: null,
+    total_run_count: 0,
+    in_progress_run_count: 0,
+};
+const runCountSchema = zod_1.z
+    .union([zod_1.z.number(), zod_1.z.string().regex(/^\d+$/)])
+    .pipe(zod_1.z.coerce.number().int().nonnegative());
+const statsRowSchema = zod_1.z.object({
+    automation_id: zod_1.z.string(),
+    last_run_created_at: zod_1.z.iso
+        .datetime()
+        .transform((value) => new Date(value))
+        .nullable(),
+    total_run_count: runCountSchema,
+    in_progress_run_count: runCountSchema,
+});
+async function fetchAutomationStats(client) {
+    let rows;
+    try {
+        // Override the traffic analytics version: this pipe has no version suffix.
+        rows = await client.fetch('api_automation_browse_stats', { version: '' });
+    }
+    catch (error) {
+        logging_1.default.error('Error fetching Tinybird automation stats:', error);
+        return null;
+    }
+    if (rows === null) {
+        return null;
+    }
+    const parsed = zod_1.z.array(statsRowSchema).safeParse(rows);
+    if (!parsed.success) {
+        logging_1.default.error({
+            system: { event: 'automations.stats.invalid_tinybird_response' },
+            issues: parsed.error.issues,
+        }, 'Unexpected response from the Tinybird automation stats pipe');
+        return null;
+    }
+    return new Map(parsed.data.map((row) => [
+        row.automation_id,
+        {
+            last_run_created_at: row.last_run_created_at,
+            total_run_count: row.total_run_count,
+            in_progress_run_count: row.in_progress_run_count,
+        },
+    ]));
+}