ghost 5.19.3 → 5.21.0

package/core/server/api/endpoints/utils/serializers/output/members.js

@@ -76,11 +76,12 @@ function bulkAction(bulkActionResult, _apiConfig, frame) {
 
 /**
  *
- * @returns {{events: any[]}}
+ * @returns {{events: any[], meta: any}}
  */
 function activityFeed(data, _apiConfig, frame) {
     return {
-        events: data.events.map(e => mappers.activityFeedEvents(e, frame))
+        events: data.events.map(e => mappers.activityFeedEvents(e, frame)),
+        meta: data.meta
     };
 }
 
@@ -216,15 +217,15 @@ function createSerializer(debugString, serialize) {
  * @prop {string} id
  * @prop {string} uuid
  * @prop {string} email
- * @prop {string=} name
- * @prop {string=} note
+ * @prop {string} [name]
+ * @prop {string} [note]
  * @prop {null|string} geolocation
  * @prop {boolean} subscribed
  * @prop {string} created_at
  * @prop {string} updated_at
  * @prop {string[]} labels
  * @prop {SerializedMemberStripeSubscription[]} subscriptions
- * @prop {SerializedMemberProduct[]=} products
+ * @prop {SerializedMemberProduct[]} [products]
  * @prop {string} avatar_image
  * @prop {boolean} comped
  * @prop {number} email_count

package/core/server/api/endpoints/utils/serializers/output/tiers.js

@@ -1,11 +1,6 @@
 //@ts-check
 const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:tiers');
 
-const allowedIncludes = ['monthly_price', 'yearly_price'];
-const localUtils = require('../../index');
-const {utils} = require('@tryghost/api-framework');
-const labs = require('../../../../../../shared/labs');
-
 module.exports = {
     browse: createSerializer('browse', paginatedTiers),
     read: createSerializer('read', singleTier),
@@ -49,11 +44,10 @@ function singleTier(model, _apiConfig, frame) {
 /**
  * @param {import('bookshelf').Model} tier
  * @param {object} options
- * @param {object} frame
  *
  * @returns {SerializedTier}
  */
-function serializeTier(tier, options, frame) {
+function serializeTier(tier, options) {
     const json = tier.toJSON(options);
 
     const serialized = {
@@ -61,66 +55,32 @@ function serializeTier(tier, options, frame) {
         name: json.name,
         description: json.description,
         slug: json.slug,
-        active: json.active,
+        active: json.status === 'active',
         type: json.type,
-        welcome_page_url: json.welcome_page_url,
-        created_at: json.created_at,
-        updated_at: json.updated_at,
+        welcome_page_url: json.welcomePageURL,
+        created_at: json.createdAt,
+        updated_at: json.updatedAt,
         visibility: json.visibility,
-        benefits: null
+        benefits: json.benefits,
+        currency: json.currency,
+        monthly_price: json.monthlyPrice,
+        yearly_price: json.yearlyPrice,
+        trial_days: json.trialDays
     };
 
-    if (labs.isSet('freeTrial')) {
-        serialized.trial_days = json.trial_days;
-    }
-
-    if (Array.isArray(json.benefits)) {
-        serialized.benefits = json.benefits.map(benefit => benefit.name);
-    } else {
+    if (!Array.isArray(serialized.benefits)) {
         serialized.benefits = null;
     }
 
-    if (serialized.type === 'paid') {
-        serialized.currency = json.monthlyPrice?.currency;
-        serialized.monthly_price = json.monthlyPrice?.amount;
-        serialized.yearly_price = json.yearlyPrice?.amount;
-    }
-
-    if (!localUtils.isContentAPI(frame)) {
-        const requestedQueryIncludes = frame.original && frame.original.query && frame.original.query.include && frame.original.query.include.split(',') || [];
-        const requestedOptionsIncludes = utils.options.trimAndLowerCase(frame.original && frame.original.options && frame.original.options.include || []);
-
-        return cleanIncludes(
-            allowedIncludes,
-            requestedQueryIncludes.concat(requestedOptionsIncludes),
-            serialized
-        );
+    if (serialized.type === 'free') {
+        delete serialized.currency;
+        delete serialized.monthly_price;
+        delete serialized.yearly_price;
     }
 
     return serialized;
 }
 
-/**
- * @template Data
- *
- * @param {string[]} allowed
- * @param {string[]} requested
- * @param {Data & Object<string, any>} data
- *
- * @returns {Data}
- */
-function cleanIncludes(allowed, requested, data) {
-    const cleaned = {
-        ...data
-    };
-    for (const include of allowed) {
-        if (!requested.includes(include)) {
-            delete cleaned[include];
-        }
-    }
-    return cleaned;
-}
-
 /**
  * @template Data
  * @template Response

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

@@ -9,12 +9,21 @@ const logging = require('@tryghost/logging');
 const urlUtils = require('../../../shared/url-utils');
 const exporter = require('../exporter');
 
-const writeExportFile = function writeExportFile(exportResult) {
+/**
+ * @param {object} exportResult
+ * @param {string} exportResult.filename
+ * @param {object} exportResult.data
+ */
+const writeExportFile = async (exportResult) => {
     const filename = path.resolve(urlUtils.urlJoin(config.get('paths').contentPath, 'data', exportResult.filename));
 
-    return Promise.resolve(fs.writeFile(filename, JSON.stringify(exportResult.data))).return(filename);
+    await fs.writeFile(filename, JSON.stringify(exportResult.data));
+    return filename;
 };
 
+/**
+ * @param {string} filename
+ */
 const readBackup = async (filename) => {
     const parsedFileName = path.parse(filename);
     const sanitized = `${parsedFileName.name}${parsedFileName.ext}`;
@@ -35,21 +44,19 @@ const readBackup = async (filename) => {
  * does an export, and stores this in a local file
  * @returns {Promise<*>}
  */
-const backup = function backup(options) {
+const backup = async function backup(options = {}) {
     logging.info('Creating database backup');
-    options = options || {};
 
     const props = {
         data: exporter.doExport(options),
         filename: exporter.fileName(options)
     };
 
-    return Promise.props(props)
-        .then(writeExportFile)
-        .then(function successMessage(filename) {
-            logging.info('Database backup written to: ' + filename);
-            return filename;
-        });
+    const exportResult = await Promise.props(props);
+    const filename = await writeExportFile(exportResult);
+
+    logging.info('Database backup written to: ' + filename);
+    return filename;
 };
 
 module.exports = {

package/core/server/data/importer/importers/data/custom-theme-settings.js

@@ -0,0 +1,81 @@
+const _ = require('lodash');
+const Promise = require('bluebird');
+const debug = require('@tryghost/debug')('importer:roles');
+const BaseImporter = require('./base');
+const models = require('../../../../models');
+const {activate} = require('../../../../services/themes/activate');
+
+class CustomThemeSettingsImporter extends BaseImporter {
+    constructor(allDataFromFile) {
+        super(allDataFromFile, {
+            modelName: 'CustomThemeSetting',
+            dataKeyToImport: 'custom_theme_settings'
+        });
+    }
+
+    beforeImport() {
+        debug('beforeImport');
+        return super.beforeImport();
+    }
+
+    doImport(options, importOptions) {
+        debug('doImport', this.modelName, this.dataToImport.length);
+
+        let ops = [];
+
+        _.each(this.dataToImport, (item) => {
+            ops.push(models.CustomThemeSetting.findOne({theme: item.theme, key: item.key}, options)
+                .then((setting) => {
+                    if (_.isObject(item.value)) {
+                        item.value = JSON.stringify(item.value);
+                    }
+                    
+                    if (setting) {
+                        setting.set('value', item.value);
+                        if (setting.hasChanged()) {
+                            return setting.save(null, options)
+                                .then((importedModel) => {
+                                    if (importOptions.returnImportedData) {
+                                        this.importedDataToReturn.push(importedModel.toJSON());
+                                    }
+                                    return importedModel;
+                                })
+                                .catch((err) => {
+                                    return this.handleError(err, item);
+                                });
+                        }
+
+                        return Promise.resolve();
+                    }
+
+                    return models.CustomThemeSetting.add(item, options)
+                        .then((importedModel) => {
+                            if (importOptions.returnImportedData) {
+                                this.importedDataToReturn.push(importedModel.toJSON());
+                            }
+                            return importedModel;
+                        })
+                        .catch((err) => {
+                            return this.handleError(err, item);
+                        });
+                })
+                .reflect());
+        });
+        
+        const opsPromise = Promise.all(ops);
+
+        // activate function is called to refresh cache when importing custom theme settings for active theme
+        opsPromise.then(() => {
+            models.Settings.findOne({key: 'active_theme'})
+                .then((theme) => {
+                    const currentTheme = theme.get('value');
+                    if (this.dataToImport.some(themeSetting => themeSetting.theme === currentTheme)) {
+                        activate(currentTheme);
+                    }
+                });
+        });
+
+        return opsPromise;
+    }
+}
+module.exports = CustomThemeSettingsImporter;

package/core/server/data/importer/importers/data/data-importer.js

@@ -13,6 +13,7 @@ const NewslettersImporter = require('./newsletters');
 const ProductsImporter = require('./products');
 const StripeProductsImporter = require('./stripe-products');
 const StripePricesImporter = require('./stripe-prices');
+const CustomThemeSettingsImporter = require('./custom-theme-settings');
 const RolesImporter = require('./roles');
 let importers = {};
 let DataImporter;
@@ -35,6 +36,7 @@ DataImporter = {
         importers.stripe_products = new StripeProductsImporter(importData.data);
         importers.stripe_prices = new StripePricesImporter(importData.data);
         importers.posts = new PostsImporter(importData.data);
+        importers.custom_theme_settings = new CustomThemeSettingsImporter(importData.data);
 
         return importData;
     },

package/core/server/data/migrations/utils/permissions.js

@@ -10,6 +10,10 @@ const messages = {
     permissionRoleActionError: 'Cannot {action} permission({permission}) with role({role}) - {resource} does not exist'
 };
 
+/**
+ * @param {import('knex').Knex} connection
+ * @param {PermissionConfig} config
+ */
 async function addPermissionHelper(connection, config) {
     const existingPermission = await connection('permissions').where({
         name: config.name,
@@ -38,6 +42,10 @@ async function addPermissionHelper(connection, config) {
     });
 }
 
+/**
+ * @param {import('knex').Knex} connection
+ * @param {PermissionConfig} config
+ */
 async function removePermissionHelper(connection, config) {
     const existingPermission = await connection('permissions').where({
         name: config.name,
@@ -61,10 +69,7 @@ async function removePermissionHelper(connection, config) {
 /**
  * Creates a migration which will add a permission to the database
  *
- * @param {Object} config
- * @param {string} config.name - The name of the permission
- * @param {string} config.action - The action_type of the permission
- * @param {string} config.object - The object_type of the permission
+ * @param {PermissionConfig} config
  *
  * @returns {Migration}
  */
@@ -82,10 +87,7 @@ function addPermission(config) {
 /**
  * Creates a migration which will remove a permission from the database
  *
- * @param {Object} config
- * @param {string} config.name - The name of the permission
- * @param {string} config.action - The action_type of the permission
- * @param {string} config.object - The object_type of the permission
+ * @param {PermissionConfig} config
  *
  * @returns {Migration}
  */
@@ -100,6 +102,10 @@ function removePermission(config) {
     );
 }
 
+/**
+ * @param {import('knex').Knex} connection
+ * @param {PermissionRoleConfig} config
+ */
 async function addPermissionToRoleHelper(connection, config) {
     const permission = await connection('permissions').where({
         name: config.permission
@@ -149,6 +155,10 @@ async function addPermissionToRoleHelper(connection, config) {
     });
 }
 
+/**
+ * @param {import('knex').Knex} connection
+ * @param {PermissionRoleConfig} config
+ */
 async function removePermissionFromRoleHelper(connection, config) {
     const permission = await connection('permissions').where({
         name: config.permission
@@ -188,9 +198,7 @@ async function removePermissionFromRoleHelper(connection, config) {
 /**
  * Creates a migration which will link a permission to a role in the database
  *
- * @param {Object} config
- * @param {string} config.permission - The name of the permission
- * @param {string} config.role - The name of the role
+ * @param {PermissionRoleConfig} config
  *
  * @returns {Migration}
  */
@@ -208,9 +216,7 @@ function addPermissionToRole(config) {
 /**
  * Creates a migration which will remove the permission from roles
  *
- * @param {Object} config
- * @param {string} config.permission - The name of the permission
- * @param {string} config.role - The name of the role
+ * @param {PermissionRoleConfig} config
  *
  * @returns {Migration}
  */
@@ -228,11 +234,7 @@ function removePermissionFromRole(config) {
 /**
  * Creates a migration which will add a permission to the database, and then link it to roles
  *
- * @param {Object} config
- * @param {string} config.name - The name of the permission
- * @param {string} config.action - The action_type of the permission
- * @param {string} config.object - The object_type of the permission
- *
+ * @param {PermissionConfig} config
  * @param {string[]} roles - A list of role names
  *
  * @returns {Migration}
@@ -247,11 +249,7 @@ function addPermissionWithRoles(config, roles) {
 /**
  * Creates a migration which will remove permissions from roles, and then remove the permission
  *
- * @param {Object} config
- * @param {string} config.name - The name of the permission
- * @param {string} config.action - The action_type of the permission
- * @param {string} config.object - The object_type of the permission
- *
+ * @param {PermissionConfig} config
  * @param {string[]} roles - A list of role names
  *
  * @returns {Migration}
@@ -270,6 +268,19 @@ module.exports = {
     createRemovePermissionMigration
 };
 
+/**
+ * @typedef {Object} PermissionConfig
+ * @prop {string} config.name - The name of the permission
+ * @prop {string} config.action - The action_type of the permission
+ * @prop {string} config.object - The object_type of the permission
+ */
+
+/**
+ * @typedef {Object} PermissionRoleConfig
+ * @prop {string} config.permission - The name of the permission
+ * @prop {string} config.role - The role to assign the Permission to
+ */
+
 /**
  * @typedef {Object} TransactionalMigrationFunctionOptions
  *

package/core/server/data/migrations/versions/5.20/2022-10-18-05-39-drop-nullable-tier-id.js

@@ -0,0 +1,3 @@
+const {createDropNullableMigration} = require('../../utils');
+
+module.exports = createDropNullableMigration('subscriptions', 'tier_id');

package/core/server/data/migrations/versions/5.20/2022-10-18-10-13-add-ghost-subscription-id-column-to-mscs.js

@@ -0,0 +1,10 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_stripe_customers_subscriptions', 'ghost_subscription_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true,
+    references: 'subscriptions.id',
+    constraintName: 'mscs_ghost_subscription_id_foreign',
+    cascadeDelete: true
+});

package/core/server/data/migrations/versions/5.20/2022-10-19-11-17-add-link-browse-permissions.js

@@ -0,0 +1,10 @@
+const {addPermissionWithRoles} = require('../../utils');
+
+module.exports = addPermissionWithRoles({
+    name: 'Browse links',
+    action: 'browse',
+    object: 'link'
+}, [
+    'Administrator',
+    'Admin Integration'
+]);

package/core/server/data/migrations/versions/5.20/2022-10-20-02-52-add-link-edit-permissions.js

@@ -0,0 +1,10 @@
+const {addPermissionWithRoles} = require('../../utils');
+
+module.exports = addPermissionWithRoles({
+    name: 'Edit links',
+    action: 'edit',
+    object: 'link'
+}, [
+    'Administrator',
+    'Admin Integration'
+]);

package/core/server/data/migrations/versions/5.21/2022-10-24-07-23-disable-feedback-enabled.js

@@ -0,0 +1,20 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(connection) {
+        const affectedRows = await connection('newsletters')
+            .update({
+                feedback_enabled: false
+            })
+            .where('feedback_enabled', true);
+
+        if (affectedRows > 0) {
+            // Only log if this site was affected by the issue.
+            logging.info(`Disabled feedback for ${affectedRows} newsletter(s)`);
+        }
+    },
+    async function down() {
+        // no-op: we don't need to change it back
+    }
+);

package/core/server/data/migrations/versions/5.21/2022-10-25-12-05-backfill-missed-products-columns.js

@@ -0,0 +1,35 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info(`Fixing currency/monthly_price/yearly_price values for default paid tiers`);
+
+        const currencyUpdated = await knex('products')
+            .update('currency', 'usd')
+            .where({
+                currency: null,
+                type: 'paid'
+            });
+        logging.info(`Updated ${currencyUpdated} tier(s) where currency=null, type=paid to currency=USD`);
+
+        const monthlyPriceUpdated = await knex('products')
+            .update('monthly_price', 500)
+            .where({
+                monthly_price: null,
+                type: 'paid'
+            });
+        logging.info(`Updated ${monthlyPriceUpdated} tier(s) where monthly_price=null, type=paid to monthly_price=500`);
+
+        const yearlyPriceUpdated = await knex('products')
+            .update('yearly_price', 5000)
+            .where({
+                yearly_price: null,
+                type: 'paid'
+            });
+        logging.info(`Updated ${yearlyPriceUpdated} tier(s) where yearly_price=null, type=paid to yearly_price=5000`);
+    },
+    async function down(/* knex */) {
+        // no-op: we don't want to revert to bad data
+    }
+);

package/core/server/data/migrations/versions/5.21/2022-10-26-04-49-add-batch-id-members-created-events.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_created_events', 'batch_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true
+});

package/core/server/data/migrations/versions/5.21/2022-10-26-04-49-add-batch-id-subscription-created-events.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('members_subscription_created_events', 'batch_id', {
+    type: 'string',
+    maxlength: 24,
+    nullable: true
+});

package/core/server/data/migrations/versions/5.21/2022-10-26-04-50-member-subscription-created-batch-id.js

@@ -0,0 +1,72 @@
+const _ = require('lodash');
+const logging = require('@tryghost/logging');
+const ObjectId = require('bson-objectid').default;
+const {createTransactionalMigration} = require('../../utils');
+const DatabaseInfo = require('@tryghost/database-info');
+
+// This migration links together members_created_events and members_subscription_created_events
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        if (DatabaseInfo.isSQLite(knex)) {
+            logging.info('Skipped linking members_created_events and members_subscription_created_events on SQLite');
+            return;
+        }
+
+        // All events that happened within 15 minutes of each other will be linked
+        const rows = await knex('members_created_events as m')
+            .select('m.id as m_id', 's.id as s_id', 'm.member_id as member_id', 's.subscription_id as subscription_id')
+            .join('members_subscription_created_events AS s', 's.member_id', 'm.member_id')
+            .whereRaw('TIMESTAMPDIFF(MINUTE, s.created_at, m.created_at) between -15 and 15');
+
+        if (!rows.length) {
+            logging.info('Did not find linkable members_created_events and members_subscription_created_events');
+            return;
+        }
+
+        // Attach a unique id to each row
+        for (const row of rows) { // eslint-disable-line no-restricted-syntax
+            row.batch_id = ObjectId().toHexString();
+        }
+
+        // Create batches (insertBatch doesn't support the onConflict option)
+        const batches = _.chunk(rows, 1000);
+    
+        for (const batch of batches) { // eslint-disable-line no-restricted-syntax
+            // Update the members_created_events table using INSERT ON DUPLICATE KEY UPDATE trick
+            const response1 = await knex('members_created_events').insert(batch.map((r) => {
+                return {
+                    id: r.m_id,
+                    batch_id: r.batch_id,
+                    member_id: r.member_id, // added to make the insert work
+                    source: '', // added to make the insert work
+                    created_at: knex.raw('NOW()') // added to make the insert work
+                };
+            })).onConflict('id').merge(['batch_id']);
+
+            if (response1[0] !== 0) {
+                logging.error(`Inserted ${response1[0]} members_created_events, expected 0`);
+                throw new Error('Rolling back');
+            }
+
+            const response2 = await knex('members_subscription_created_events').insert(batch.map((r) => {
+                return {
+                    id: r.s_id,
+                    batch_id: r.batch_id,
+                    member_id: r.member_id, // added to make the insert work
+                    subscription_id: r.subscription_id, // added to make the insert work
+                    created_at: knex.raw('NOW()') // added to make the insert work
+                };
+            })).onConflict('id').merge(['batch_id']);
+
+            if (response2[0] !== 0) {
+                logging.error(`Inserted ${response1[0]} members_subscription_created_events, expected 0`);
+                throw new Error('Rolling back');
+            }
+        }
+        logging.info(`Linked ${rows.length} members_created_events and members_subscription_created_events`);
+    },
+    async function down() {
+        // noop
+    }
+);

package/core/server/data/migrations/versions/5.21/2022-10-26-09-32-add-feedback-enabled-column-to-emails.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('emails', 'feedback_enabled', {
+    type: 'boolean',
+    nullable: false,
+    defaultTo: false
+});

package/core/server/data/migrations/versions/5.21/2022-10-27-09-50-add-member-track-source-setting.js

@@ -0,0 +1,8 @@
+const {addSetting} = require('../../utils');
+
+module.exports = addSetting({
+    key: 'members_track_sources',
+    value: 'true',
+    type: 'boolean',
+    group: 'members'
+});