ghost 5.77.0 → 5.79.0

package/core/built/admin/index.html

@@ -8,7 +8,7 @@
     <title>Ghost Admin</title>
 
     
-<meta name="ghost-admin/config/environment" content="%7B%22modulePrefix%22%3A%22ghost-admin%22%2C%22environment%22%3A%22production%22%2C%22cdnUrl%22%3A%22%22%2C%22editorUrl%22%3A%22%22%2C%22rootURL%22%3A%22%22%2C%22locationType%22%3A%22trailing-hash%22%2C%22EmberENV%22%3A%7B%22FEATURES%22%3A%7B%7D%2C%22EXTEND_PROTOTYPES%22%3A%7B%22Date%22%3Afalse%2C%22Array%22%3Atrue%2C%22String%22%3Atrue%2C%22Function%22%3Afalse%7D%2C%22_APPLICATION_TEMPLATE_WRAPPER%22%3Afalse%2C%22_JQUERY_INTEGRATION%22%3Atrue%2C%22_TEMPLATE_ONLY_GLIMMER_COMPONENTS%22%3Atrue%7D%2C%22APP%22%3A%7B%22version%22%3A%225.77%22%2C%22name%22%3A%22ghost-admin%22%7D%2C%22ember-simple-auth%22%3A%7B%7D%2C%22ember-websockets%22%3A%7B%22socketIO%22%3Atrue%7D%2C%22%40sentry%2Fember%22%3A%7B%22disablePerformance%22%3Atrue%2C%22sentry%22%3A%7B%7D%7D%2C%22ember-cli-mirage%22%3A%7B%22usingProxy%22%3Afalse%2C%22useDefaultPassthroughs%22%3Atrue%7D%2C%22exportApplicationGlobal%22%3Afalse%2C%22ember-load%22%3A%7B%22loadingIndicatorClass%22%3A%22ember-load-indicator%22%7D%2C%22editorFilename%22%3A%22koenig-lexical.umd.js%22%2C%22editorHash%22%3A%22a9a58f16a8%22%2C%22adminXDemoFilename%22%3A%22admin-x-demo.js%22%2C%22adminXDemoHash%22%3A%2233d2c60ad0%22%2C%22adminXSettingsFilename%22%3A%22admin-x-settings.js%22%2C%22adminXSettingsHash%22%3A%22d07813452e%22%7D" />
+<meta name="ghost-admin/config/environment" content="%7B%22modulePrefix%22%3A%22ghost-admin%22%2C%22environment%22%3A%22production%22%2C%22cdnUrl%22%3A%22%22%2C%22editorUrl%22%3A%22%22%2C%22rootURL%22%3A%22%22%2C%22locationType%22%3A%22trailing-hash%22%2C%22EmberENV%22%3A%7B%22FEATURES%22%3A%7B%7D%2C%22EXTEND_PROTOTYPES%22%3A%7B%22Date%22%3Afalse%2C%22Array%22%3Atrue%2C%22String%22%3Atrue%2C%22Function%22%3Afalse%7D%2C%22_APPLICATION_TEMPLATE_WRAPPER%22%3Afalse%2C%22_JQUERY_INTEGRATION%22%3Atrue%2C%22_TEMPLATE_ONLY_GLIMMER_COMPONENTS%22%3Atrue%7D%2C%22APP%22%3A%7B%22version%22%3A%225.79%22%2C%22name%22%3A%22ghost-admin%22%7D%2C%22ember-simple-auth%22%3A%7B%7D%2C%22ember-websockets%22%3A%7B%22socketIO%22%3Atrue%7D%2C%22%40sentry%2Fember%22%3A%7B%22disablePerformance%22%3Atrue%2C%22sentry%22%3A%7B%7D%7D%2C%22ember-cli-mirage%22%3A%7B%22usingProxy%22%3Afalse%2C%22useDefaultPassthroughs%22%3Atrue%7D%2C%22exportApplicationGlobal%22%3Afalse%2C%22ember-load%22%3A%7B%22loadingIndicatorClass%22%3A%22ember-load-indicator%22%7D%2C%22editorFilename%22%3A%22koenig-lexical.umd.js%22%2C%22editorHash%22%3A%22f32944c498%22%2C%22adminXDemoFilename%22%3A%22admin-x-demo.js%22%2C%22adminXDemoHash%22%3A%22b6e4cf34df%22%2C%22adminXSettingsFilename%22%3A%22admin-x-settings.js%22%2C%22adminXSettingsHash%22%3A%22e10c30afc5%22%7D" />
 
     <meta name="HandheldFriendly" content="True" />
     <meta name="MobileOptimized" content="320" />
@@ -57,8 +57,8 @@
     <div id="ember-basic-dropdown-wormhole"></div>
 
     <script src="assets/vendor-6b83da0c6e6fede335947219c59e1543.js"></script>
-<script src="assets/chunk.664.99d0951b803d7ec00d8b.js"></script>
-<script src="assets/chunk.143.16228699a88898175515.js"></script>
-    <script src="assets/ghost-90accaf45b85c7bc55ca781472d27e8e.js"></script>
+<script src="assets/chunk.160.f064da019dcb493ba212.js"></script>
+<script src="assets/chunk.524.fe4143d694c7ab008a78.js"></script>
+    <script src="assets/ghost-74787e16c2e5229de6164ddfe7426882.js"></script>
 </body>
 </html>

package/core/server/data/db/ConnectionPoolInstrumentation.js

@@ -0,0 +1,142 @@
+class ConnectionPoolInstrumentation {
+    constructor({knex, logging, metrics, config}) {
+        this.knex = knex;
+        this.pool = this.knex.client.pool;
+        this.logging = logging;
+        this.metrics = metrics;
+        this.enabled = config.get('telemetry:connectionPool');
+        this.requestStartTimes = {};
+        this.createStartTimes = {};
+    }
+
+    // Get the number of pending creates and acquires plus free and used connections
+    getPoolMetrics() {
+        return {
+            numPendingCreates: this.pool.numPendingCreates(),
+            numPendingAcquires: this.pool.numPendingAcquires(),
+            numFree: this.pool.numFree(),
+            numUsed: this.pool.numUsed()
+        };
+    }
+
+    handleCreateRequest(eventId) {
+        // Track when the request was submitted for calculating wait time
+        this.createStartTimes[eventId] = Date.now();
+        const poolMetrics = this.getPoolMetrics();
+        this.logging.debug(`[ConnectionPool] Creating a connection. EventID: ${eventId} Pending Creates: ${poolMetrics.numPendingCreates} Free: ${poolMetrics.numFree} Used: ${poolMetrics.numUsed}`);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'create-request',
+            eventId,
+            ...poolMetrics
+        });
+    }
+
+    handleCreateSuccess(eventId, resource) {
+        // Calculate the time it took to create the connection
+        const timeToCreate = Date.now() - this.createStartTimes[eventId];
+        // Delete the start time so we don't leak memory
+        delete this.createStartTimes[eventId];
+        this.logging.debug(`[ConnectionPool] Created a connection. EventID: ${eventId} Connection ID: ${resource.connectionId} Knex ID: ${resource.__knexUid} Time to Create: ${timeToCreate}ms`);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'create-success',
+            eventId,
+            connectionId: resource.connectionId,
+            knexUid: resource.__knexUid,
+            timeToCreate
+        });
+    }
+
+    handleCreateFail(eventId, err) {
+        // Calculate the time it took to create the connection
+        const timeToFail = Date.now() - this.createStartTimes[eventId];
+        // Delete the start time so we don't leak memory
+        delete this.createStartTimes[eventId];
+        const poolMetrics = this.getPoolMetrics();
+        this.logging.error(`[ConnectionPool] Failed to create a connection. EventID: ${eventId} Time to Create: ${timeToFail}ms`, err);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'create-fail',
+            eventId,
+            timeToFail,
+            ...poolMetrics
+        });
+    }
+
+    handleAcquireRequest(eventId) {
+        // Track when the request was submitted for calculating wait time
+        this.requestStartTimes[eventId] = Date.now();
+        const poolMetrics = this.getPoolMetrics();
+        this.logging.debug(`[ConnectionPool] Acquiring a connection. EventID: ${eventId} Pending Acquires: ${poolMetrics.numPendingAcquires} Free: ${poolMetrics.numFree} Used: ${poolMetrics.numUsed}`);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'acquire-request',
+            eventId,
+            ...poolMetrics
+        });
+    }
+
+    handleAcquireSuccess(eventId, resource) {
+        // Calculate the time it took to acquire the connection
+        const timeToAcquire = Date.now() - this.requestStartTimes[eventId];
+        // Delete the start time so we don't leak memory
+        delete this.requestStartTimes[eventId];
+        // Track when the connection was acquired for calculating lifetime upon release
+        resource.connectionAcquired = Date.now();
+        this.logging.debug(`[ConnectionPool] Acquired a connection. EventID: ${eventId} Connection ID: ${resource.connectionId} Knex Id: ${resource.__knexUid} Time to Acquire: ${timeToAcquire}ms`);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'acquire-success',
+            eventId,
+            connectionId: resource.connectionId,
+            knexUid: resource.__knexUid,
+            timeToAcquire
+        });
+    }
+
+    handleAcquireFail(eventId, err) {
+        // Calculate the time it took to acquire the connection
+        const timeToFail = Date.now() - this.requestStartTimes[eventId];
+        // Delete the start time so we don't leak memory
+        delete this.requestStartTimes[eventId];
+        const poolMetrics = this.getPoolMetrics();
+        this.logging.error(`[ConnectionPool] Failed to acquire a connection. EventID: ${eventId} Time to Acquire: ${timeToFail}ms`, err);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'acquire-fail',
+            eventId,
+            timeToFail,
+            ...poolMetrics
+        });
+    }
+
+    handleRelease(resource) {
+        const lifetime = Date.now() - resource.connectionAcquired;
+        this.logging.debug(`[ConnectionPool] Released a connection. Connection ID: ${resource.connectionId} Lifetime: ${lifetime}ms`);
+        this.metrics.metric('metrics-connection-pool', {
+            event: 'release',
+            connectionId: resource.connectionId,
+            knexUid: resource.__knexUid,
+            lifetime
+        });
+    }
+
+    instrument() {
+        if (this.enabled) {
+            // Check to make sure these event listeners haven't already been added
+            if (this.pool.emitter.eventNames().length === 0) {
+                // Fires when a connection is requested to be created
+                this.pool.on('createRequest', eventId => this.handleCreateRequest(eventId));
+                // Fires when a connection is successfully created
+                this.pool.on('createSuccess', (eventId, resource) => this.handleCreateSuccess(eventId, resource));
+                // Fires when a connection fails to be created
+                this.pool.on('createFail', (eventId, err) => this.handleCreateFail(eventId, err));
+                // Fires when a connection is requested from the pool
+                this.pool.on('acquireRequest', eventId => this.handleAcquireRequest(eventId));
+                // Fires when a connection is allocated from the pool
+                this.pool.on('acquireSuccess', (eventId, resource) => this.handleAcquireSuccess(eventId, resource));
+                // Fires when a connection fails to be allocated from the pool
+                this.pool.on('acquireFail', (eventId, err) => this.handleAcquireFail(eventId, err));
+                // Fires when a connection is released back into the pool
+                this.pool.on('release', resource => this.handleRelease(resource));
+            }
+        }
+    }
+}
+
+module.exports = ConnectionPoolInstrumentation;

package/core/server/data/db/backup.js

@@ -42,9 +42,15 @@ const readBackup = async (filename) => {
  * Does an export, and stores this in a local file
  *
  * @param {Object} options
- * @returns {Promise<String>}
+ * @returns {Promise<String> | null}
  */
 const backup = async function backup(options = {}) {
+    // do not create backup if disabled in config (this is intended for large customers who will OOM node)
+    if (config.get('disableJSBackups')) {
+        logging.info('Database backup is disabled in Ghost config');
+        return null;
+    }
+
     logging.info('Creating database backup');
 
     const filename = await exporter.fileName(options);

package/core/server/data/db/connection.js

@@ -4,8 +4,10 @@ const os = require('os');
 const fs = require('fs');
 
 const logging = require('@tryghost/logging');
+const metrics = require('@tryghost/metrics');
 const config = require('../../../shared/config');
 const errors = require('@tryghost/errors');
+const ConnectionPoolInstrumentation = require('./ConnectionPoolInstrumentation');
 let knexInstance;
 
 // @TODO:
@@ -62,6 +64,10 @@ function configure(dbConfig) {
 
 if (!knexInstance && config.get('database') && config.get('database').client) {
     knexInstance = knex(configure(config.get('database')));
+    if (config.get('telemetry:connectionPool')) {
+        const instrumentation = new ConnectionPoolInstrumentation({knex: knexInstance, logging, metrics, config});
+        instrumentation.instrument();
+    }
 }
 
 module.exports = knexInstance;

package/core/server/data/db/index.js

@@ -1,3 +1,8 @@
+const logging = require('@tryghost/logging');
+const metrics = require('@tryghost/metrics');
+const config = require('../../../shared/config');
+const ConnectionPoolInstrumentation = require('./ConnectionPoolInstrumentation');
+
 let connection;
 
 Object.defineProperty(exports, 'knex', {
@@ -5,6 +10,10 @@ Object.defineProperty(exports, 'knex', {
     configurable: true,
     get: function get() {
         connection = connection || require('./connection');
+        if (config.get('telemetry:connectionPool')) {
+            const instrumentation = new ConnectionPoolInstrumentation({knex: connection, logging, metrics, config});
+            instrumentation.instrument();
+        }
         return connection;
     }
 });

package/core/server/data/migrations/versions/5.79/2024-01-30-19-36-44-fix-discrepancy-in-free-tier-visibility.js

@@ -0,0 +1,43 @@
+const {createTransactionalMigration} = require('../../utils');
+const logging = require('@tryghost/logging');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        const portalPlansRaw = await knex('settings').select('value').where('key', 'portal_plans').first();
+        const freeTier = await knex('products').select('visibility').where('type', 'free').first();
+
+        if (!portalPlansRaw || !freeTier) {
+            logging.warn('Could not read `portal_plans` setting or `visibility` of the free tier - skipping migration');
+            return;
+        }
+
+        let portalPlans;
+        try {
+            portalPlans = JSON.parse(portalPlansRaw.value);
+
+            if (!portalPlans || !Array.isArray(portalPlans)) {
+                logging.warn('`portal_plans` setting is not valid - skipping migration');
+                return;
+            }
+        } catch (err) {
+            logging.warn('Could not parse `portal_plans` setting - skipping migration');
+            return;
+        }
+
+        if (portalPlans.includes('free') && freeTier.visibility === 'none') {
+            logging.info('`portal_plans` setting contains "free", but free tier is not visible - updating free tier visibility to public');
+            await knex('products').update('visibility', 'public').where('type', 'free');
+            return;
+        }
+
+        if (!portalPlans.includes('free') && freeTier.visibility === 'public') {
+            logging.info('`portal_plans` setting does not contain "free", but free tier is visible - updating free tier visibility to none');
+            await knex('products').update('visibility', 'none').where('type', 'free');
+            return;
+        }
+    },
+
+    async function down() {
+        // noop, as this is a data discrepancy fix
+    }
+);

package/core/server/services/Users.js

@@ -148,9 +148,13 @@ class Users {
      * @returns
      */
     async destroyUser(frameOptions) {
+        let filename = null;
         const backupPath = await this.dbBackup.backup();
-        const parsedFileName = path.parse(backupPath);
-        const filename = `${parsedFileName.name}${parsedFileName.ext}`;
+
+        if (backupPath) {
+            const parsedFileName = path.parse(backupPath);
+            filename = `${parsedFileName.name}${parsedFileName.ext}`;
+        }
 
         return this.models.Base.transaction(async (t) => {
             frameOptions.transacting = t;

package/core/shared/config/defaults.json

@@ -228,5 +228,6 @@
         },
     "bulkEmail": {
         "batchSize": 1000
-    }
+    },
+    "disableJSBackups": false
 }

package/core/shared/labs.js

@@ -22,7 +22,8 @@ const GA_FEATURES = [
     'signupForm',
     'recommendations',
     'listUnsubscribeHeader',
-    'filterEmailDisabled'
+    'filterEmailDisabled',
+    'newEmailAddresses'
 ];
 
 // NOTE: this allowlist is meant to be used to filter out any unexpected
@@ -47,7 +48,6 @@ const ALPHA_FEATURES = [
     // 'adminXOffers',
     'filterEmailDisabled',
     'adminXDemo',
-    'newEmailAddresses',
     'portalImprovements'
 ];