ghost 5.20.0 → 5.21.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%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.20%22%2C%22name%22%3A%22ghost-admin%22%7D%2C%22ember-simple-auth%22%3A%7B%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%7D" />
+<meta name="ghost-admin/config/environment" content="%7B%22modulePrefix%22%3A%22ghost-admin%22%2C%22environment%22%3A%22production%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.21%22%2C%22name%22%3A%22ghost-admin%22%7D%2C%22ember-simple-auth%22%3A%7B%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%7D" />
 
     <meta name="HandheldFriendly" content="True" />
     <meta name="MobileOptimized" content="320" />
@@ -37,7 +37,7 @@
     </style>
 
     <link integrity="" rel="stylesheet" href="assets/vendor-3e6947aa681f0fb82b193090e520dc73.css">
-    <link integrity="" rel="stylesheet" href="assets/ghost-fd0480352bf27e013b2b00a1bf9ffe84.css" title="light">
+    <link integrity="" rel="stylesheet" href="assets/ghost-9873519a8ad69b5b23284f0a9e050bc6.css" title="light">
 
     
 </head>
@@ -56,9 +56,9 @@
 
     <div id="ember-basic-dropdown-wormhole"></div>
 
-    <script src="assets/vendor-518b03b02df9a55706d150627ef1004f.js"></script>
-<script src="assets/chunk.613.c4d89dc2d28c1b20348f.js"></script>
-<script src="assets/chunk.143.d245b085ad1efed4ee76.js"></script>
-    <script src="assets/ghost-07e4bbf5029630b3c8a8a50c4b9f2d9e.js"></script>
+    <script src="assets/vendor-26cca1d4d56660dc6e915a12ccc3b330.js"></script>
+<script src="assets/chunk.613.695f31829550fb00d43c.js"></script>
+<script src="assets/chunk.143.9cddfa7bd1a8b9cf3d4b.js"></script>
+    <script src="assets/ghost-192fee3b46a193df1e65c49a67a7d694.js"></script>
 </body>
 </html>

package/core/cli/generate-data.js

@@ -0,0 +1,51 @@
+const Command = require('./command');
+const DataGenerator = require('@tryghost/data-generator');
+
+module.exports = class REPL extends Command {
+    setup() {
+        this.help('Generates random data to populate the database for development & testing');
+        this.argument('--use-base-data', {type: 'boolean', defaultValue: false, desc: 'Only generate data outside of a defined base data set'});
+    }
+
+    initializeContext(context) {
+        const models = require('../server/models');
+        const knex = require('../server/data/db/connection');
+
+        models.init();
+
+        context.models = models;
+        context.m = models;
+        context.knex = knex;
+        context.k = knex;
+    }
+
+    permittedEnvironments() {
+        return ['development', 'local', 'staging', 'production'];
+    }
+
+    async handle(argv = {}) {
+        const knex = require('../server/data/db/connection');
+        const {tables: schema} = require('../server/data/schema/index');
+        const dataGenerator = new DataGenerator({
+            useBaseData: argv['use-base-data'],
+            knex,
+            schema,
+            logger: {
+                log: this.log,
+                ok: this.ok,
+                info: this.info,
+                warn: this.warn,
+                error: this.error,
+                fatal: this.fatal,
+                debug: this.debug
+            },
+            modelQuantities: {}
+        });
+        try {
+            await dataGenerator.importData();
+        } catch (error) {
+            this.fatal('Failed while generating data: ', error);
+        }
+        knex.destroy();
+    }
+};

package/core/frontend/helpers/ghost_head.js

@@ -234,7 +234,7 @@ module.exports = async function ghost_head(options) { // eslint-disable-line cam
                 head.push(`<script defer src="${getAssetUrl('public/comment-counts.min.js')}" data-ghost-comments-counts-api="${urlUtils.getSiteUrl(true)}members/api/comments/counts/"></script>`);
             }
 
-            if (settingsCache.get('members_enabled')) {
+            if (settingsCache.get('members_enabled') && settingsCache.get('members_track_sources')) {
                 head.push(`<script defer src="${getAssetUrl('public/member-attribution.min.js')}"></script>`);
             }
 

package/core/server/api/endpoints/links.js

@@ -1,4 +1,5 @@
 const linkTrackingService = require('../../services/link-tracking');
+const INVALIDATE_ALL_REDIRECTS = '/r/*';
 
 module.exports = {
     docName: 'links',
@@ -25,7 +26,7 @@ module.exports = {
     bulkEdit: {
         statusCode: 200,
         headers: {
-            cacheInvalidate: true
+            cacheInvalidate: INVALIDATE_ALL_REDIRECTS
         },
         options: [
             'filter'

package/core/server/api/endpoints/tiers-public.js

@@ -1,8 +1,4 @@
-// NOTE: We must not cache references to membersService.api
-// as it is a getter and may change during runtime.
-const membersService = require('../../services/members');
-
-const allowedIncludes = ['monthly_price', 'yearly_price', 'benefits'];
+const tiersService = require('../../services/tiers');
 
 module.exports = {
     docName: 'tiers',
@@ -11,22 +7,14 @@ module.exports = {
         options: [
             'limit',
             'fields',
-            'include',
             'filter',
             'order',
             'debug',
             'page'
         ],
         permissions: true,
-        validation: {
-            options: {
-                include: {
-                    values: allowedIncludes
-                }
-            }
-        },
         async query(frame) {
-            const page = await membersService.api.productRepository.list(frame.options);
+            const page = await tiersService.api.browse(frame.options);
 
             return page;
         }

package/core/server/api/endpoints/tiers.js

@@ -1,13 +1,4 @@
-const errors = require('@tryghost/errors');
-const membersService = require('../../services/members');
-
-const tpl = require('@tryghost/tpl');
-
-const allowedIncludes = ['monthly_price', 'yearly_price', 'benefits'];
-
-const messages = {
-    productNotFound: 'Tier not found.'
-};
+const tiersService = require('../../services/tiers');
 
 module.exports = {
     docName: 'tiers',
@@ -16,7 +7,6 @@ module.exports = {
         options: [
             'limit',
             'fields',
-            'include',
             'filter',
             'order',
             'debug',
@@ -25,48 +15,21 @@ module.exports = {
         permissions: {
             docName: 'products'
         },
-        validation: {
-            options: {
-                include: {
-                    values: allowedIncludes
-                }
-            }
-        },
         async query(frame) {
-            const page = await membersService.api.productRepository.list(frame.options);
-
+            const page = await tiersService.api.browse(frame.options);
             return page;
         }
     },
 
     read: {
-        options: [
-            'include'
-        ],
-        headers: {},
         data: [
             'id'
         ],
-        validation: {
-            options: {
-                include: {
-                    values: allowedIncludes
-                }
-            }
-        },
         permissions: {
             docName: 'products'
         },
         async query(frame) {
-            const model = await membersService.api.productRepository.get(frame.data, frame.options);
-
-            if (!model) {
-                throw new errors.NotFoundError({
-                    message: tpl(messages.productNotFound)
-                });
-            }
-
-            return model;
+            return await tiersService.api.read(frame.data.id);
         }
     },
 
@@ -84,11 +47,7 @@ module.exports = {
             docName: 'products'
         },
         async query(frame) {
-            const model = await membersService.api.productRepository.create(
-                frame.data,
-                frame.options
-            );
-            return model;
+            return await tiersService.api.add(frame.data);
         }
     },
 
@@ -111,12 +70,7 @@ module.exports = {
             docName: 'products'
         },
         async query(frame) {
-            const model = await membersService.api.productRepository.update(
-                frame.data,
-                frame.options
-            );
-
-            return model;
+            return await tiersService.api.edit(frame.options.id, frame.data);
         }
     }
 };

package/core/server/api/endpoints/utils/serializers/input/posts.js

@@ -45,7 +45,7 @@ function defaultRelations(frame) {
     }
 
     if (labs.isSet('audienceFeedback')) {
-        frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.conversions', 'count.clicks', 'count.sentiment', 'count.positive_feedback'];
+        frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.conversions', 'count.clicks', 'count.sentiment', 'count.positive_feedback', 'count.negative_feedback'];
     } else {
         frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.signups', 'count.paid_conversions', 'count.clicks'];
     }

package/core/server/api/endpoints/utils/serializers/input/settings.js

@@ -48,6 +48,7 @@ const EDITABLE_SETTINGS = [
     'mailgun_base_url',
     'email_track_opens',
     'email_track_clicks',
+    'members_track_sources',
     'amp',
     'amp_gtag_id',
     'slack_url',

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

@@ -1,5 +1,4 @@
 const localUtils = require('../../index');
-const labs = require('../../../../../../shared/labs');
 
 const forceActiveFilter = (frame) => {
     if (frame.options.filter) {
@@ -10,39 +9,31 @@ const forceActiveFilter = (frame) => {
 };
 
 function convertTierInput(input) {
-    const converted = {
-        id: input.id,
-        name: input.name,
-        description: input.description,
-        slug: input.slug,
-        active: input.active,
-        type: input.type,
-        welcome_page_url: input.welcome_page_url,
-        created_at: input.created_at,
-        updated_at: input.updated_at,
-        visibility: input.visibility
-    };
+    const converted = Object.assign({}, input);
 
-    if (labs.isSet('freeTrial')) {
-        converted.trial_days = input.trial_days || 0;
+    if (Reflect.has(converted, 'active')) {
+        converted.status = converted.active ? 'active' : 'archived';
+        delete converted.active;
     }
 
-    if (input.monthly_price && input.currency) {
-        converted.monthly_price = {
-            amount: input.monthly_price,
-            currency: input.currency
-        };
+    if (Reflect.has(converted, 'welcome_page_url')) {
+        converted.welcomePageURL = converted.welcome_page_url;
+        delete converted.welcome_page_url;
     }
 
-    if (input.yearly_price && input.currency) {
-        converted.yearly_price = {
-            amount: input.yearly_price,
-            currency: input.currency
-        };
+    if (Reflect.has(converted, 'trial_days')) {
+        converted.trialDays = converted.trial_days;
+        delete converted.trial_days;
     }
 
-    if (input.benefits) {
-        converted.benefits = input.benefits.map(name => ({name}));
+    if (Reflect.has(converted, 'monthly_price')) {
+        converted.monthlyPrice = converted.monthly_price;
+        delete converted.monthly_price;
+    }
+
+    if (Reflect.has(converted, 'yearly_price')) {
+        converted.yearlyPrice = converted.yearly_price;
+        delete converted.yearly_price;
     }
 
     return converted;

package/core/server/api/endpoints/utils/serializers/output/mappers/activity-feed-events.js

@@ -53,6 +53,38 @@ const clickEventMapper = (json, frame) => {
         response.created_at = data.created_at;
     }
 
+    if (data.id) {
+        response.id = data.id;
+    }
+
+    return {
+        ...json,
+        data: response
+    };
+};
+
+const aggregatedClickEventMapper = (json) => {
+    const data = json.data;
+    const response = {};
+
+    if (data.member) {
+        response.member = _.pick(data.member, memberFields);
+    } else {
+        response.member = null;
+    }
+
+    if (data.created_at) {
+        response.created_at = data.created_at;
+    }
+
+    if (data.id) {
+        response.id = data.id;
+    }
+
+    response.count = {
+        clicks: data.count?.clicks ?? 0
+    };
+
     return {
         ...json,
         data: response
@@ -111,12 +143,22 @@ const activityFeedMapper = (event, frame) => {
     if (event.type === 'click_event') {
         return clickEventMapper(event, frame);
     }
+    if (event.type === 'aggregated_click_event') {
+        return aggregatedClickEventMapper(event, frame);
+    }
     if (event.type === 'feedback_event') {
         return feedbackEventMapper(event, frame);
     }
     if (event.data?.attribution) {
         event.data.attribution = serializeAttribution(event.data.attribution);
     }
+    // TODO: add dedicated mappers for other event types
+    if (event.data?.batch_id) {
+        delete event.data.batch_id;
+    }
+    if (event.data?.subscriptionCreatedEvent) {
+        delete event.data.subscriptionCreatedEvent;
+    }
     return event;
 };
 

package/core/server/api/endpoints/utils/serializers/output/mappers/posts.js

@@ -111,10 +111,7 @@ module.exports = async (model, frame, options = {}) => {
 
     if (jsonModel.email && jsonModel.count) {
         jsonModel.email.opened_count = Math.min(
-            Math.max(
-                jsonModel.email.opened_count || 0,
-                jsonModel.count.clicks || 0
-            ),
+            jsonModel.email.opened_count || 0,
             jsonModel.email.email_count
         );
     }
@@ -140,5 +137,9 @@ module.exports = async (model, frame, options = {}) => {
         jsonModel.count.positive_feedback = 0;
     }
 
+    if (jsonModel.count && !jsonModel.count.negative_feedback) {
+        jsonModel.count.negative_feedback = 0;
+    }
+
     return jsonModel;
 };

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/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
+});