ghost 5.16.2 → 5.17.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.16%22%2C%22name%22%3A%22ghost-admin%22%7D%2C%22ember-simple-auth%22%3A%7B%7D%2C%22moment%22%3A%7B%22includeTimezone%22%3A%22all%22%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.17%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-733135cd6cbca8126c6fa223d63a5bf3.css">
-    <link integrity="" rel="stylesheet" href="assets/ghost-6491d134c450ca676911ea17e16cd7d4.css" title="light">
+    <link integrity="" rel="stylesheet" href="assets/ghost-597fb8e8b1b91dd0ac4d9f2d75bd67fb.css" title="light">
 
     
 </head>
@@ -56,9 +56,9 @@
 
     <div id="ember-basic-dropdown-wormhole"></div>
 
-    <script src="assets/vendor-b2375e2f383cbc3fd73340c4b656c993.js"></script>
-<script src="assets/chunk.579.d14c3688558f34afeb3e.js"></script>
-<script src="assets/chunk.143.4e48bf4e6c3d13258bb1.js"></script>
-    <script src="assets/ghost-5064a384fad1061ca77a8604e479da90.js"></script>
+    <script src="assets/vendor-325e038b8609f0979f6578cae7a87f9e.js"></script>
+<script src="assets/chunk.579.a9bccec4d650a7be727a.js"></script>
+<script src="assets/chunk.143.4ce1dcfd5c372638114d.js"></script>
+    <script src="assets/ghost-fa7772f8aa2522b3935efed71fa75619.js"></script>
 </body>
 </html>

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 (labs.isSet('memberAttribution')) {
+            if (settingsCache.get('members_enabled')) {
                 head.push(`<script defer src="${getAssetUrl('public/member-attribution.min.js')}"></script>`);
             }
 

package/core/frontend/src/member-attribution/member-attribution.js

@@ -87,9 +87,9 @@ const LIMIT = 15;
             console.error('[Member Attribution] Parsing referrer from querystring failed', e);
         }
 
-        const refSource = refParam || sourceParam || utmSourceParam || null;
-        const refMedium = utmMediumParam || null;
-        const refUrl = window.document.referrer || null;
+        const referrerSource = refParam || sourceParam || utmSourceParam || null;
+        const referrerMedium = utmMediumParam || null;
+        const referrerUrl = window.document.referrer || null;
 
         // Do we have attributions in the query string?
         try {
@@ -101,9 +101,9 @@ const LIMIT = 15;
                     time: currentTime,
                     id: params.get('attribution_id'),
                     type: params.get('attribution_type'),
-                    refSource,
-                    refMedium,
-                    refUrl
+                    referrerSource,
+                    referrerMedium,
+                    referrerUrl
                 });
 
                 // Remove attribution from query string
@@ -122,19 +122,19 @@ const LIMIT = 15;
             history.push({
                 path: currentPath,
                 time: currentTime,
-                refSource,
-                refMedium,
-                refUrl
+                referrerSource,
+                referrerMedium,
+                referrerUrl
             });
         } else if (history.length > 0) {
             history[history.length - 1].time = currentTime;
             // Update referrer information for same path if available (e.g. when opening a link on same path via external referrer)
-            if (refSource) {
-                history[history.length - 1].refSource = refSource;
-                history[history.length - 1].refMedium = refMedium;
+            if (referrerSource) {
+                history[history.length - 1].referrerSource = referrerSource;
+                history[history.length - 1].referrerMedium = referrerMedium;
             }
-            if (refUrl) {
-                history[history.length - 1].refUrl = refUrl;
+            if (referrerUrl) {
+                history[history.length - 1].referrerUrl = referrerUrl;
             }
         }
 

package/core/frontend/web/middleware/error-handler.js

@@ -7,7 +7,7 @@ const config = require('../../../shared/config');
 const renderer = require('../../services/rendering');
 
 // @TODO: make this properly shared code
-const {prepareError, prepareStack} = require('@tryghost/mw-error-handler');
+const {prepareError, prepareErrorCacheControl, prepareStack} = require('@tryghost/mw-error-handler');
 
 const messages = {
     oopsErrorTemplateHasError: 'Oops, seems there is an error in the error template.',
@@ -86,6 +86,8 @@ const themeErrorRenderer = (err, req, res, next) => {
 module.exports.handleThemeResponse = [
     // Make sure the error can be served
     prepareError,
+    // Add cache-control header
+    prepareErrorCacheControl(),
     // Handle the error in Sentry
     sentry.errorHandler,
     // Format the stack for the user

package/core/frontend/web/site.js

@@ -65,21 +65,21 @@ module.exports = function setupSiteApp(routerConfig) {
     siteApp.use(mw.serveFavicon());
 
     // Serve sitemap.xsl file
-    siteApp.use(mw.servePublicFile('static', 'sitemap.xsl', 'text/xsl', constants.ONE_DAY_S));
+    siteApp.use(mw.servePublicFile('static', 'sitemap.xsl', 'text/xsl', config.get('caching:sitemapXSL:maxAge')));
 
     // Serve stylesheets for default templates
-    siteApp.use(mw.servePublicFile('static', 'public/ghost.css', 'text/css', constants.ONE_HOUR_S));
-    siteApp.use(mw.servePublicFile('static', 'public/ghost.min.css', 'text/css', constants.ONE_YEAR_S));
+    siteApp.use(mw.servePublicFile('static', 'public/ghost.css', 'text/css', config.get('caching:publicAssets:maxAge')));
+    siteApp.use(mw.servePublicFile('static', 'public/ghost.min.css', 'text/css', config.get('caching:publicAssets:maxAge')));
 
     // Card assets
-    siteApp.use(mw.servePublicFile('built', 'public/cards.min.css', 'text/css', constants.ONE_YEAR_S));
-    siteApp.use(mw.servePublicFile('built', 'public/cards.min.js', 'application/javascript', constants.ONE_YEAR_S));
+    siteApp.use(mw.servePublicFile('built', 'public/cards.min.css', 'text/css', config.get('caching:publicAssets:maxAge')));
+    siteApp.use(mw.servePublicFile('built', 'public/cards.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
 
     // Comment counts
-    siteApp.use(mw.servePublicFile('built', 'public/comment-counts.min.js', 'application/javascript', constants.ONE_YEAR_S));
+    siteApp.use(mw.servePublicFile('built', 'public/comment-counts.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
 
     // Member attribution
-    siteApp.use(mw.servePublicFile('built', 'public/member-attribution.min.js', 'application/javascript', constants.ONE_YEAR_S));
+    siteApp.use(mw.servePublicFile('built', 'public/member-attribution.min.js', 'application/javascript', config.get('caching:publicAssets:maxAge')));
 
     // Serve site images using the storage adapter
     siteApp.use(STATIC_IMAGE_URL_PREFIX, mw.handleImageSizes, storage.getStorage('images').serve());
@@ -94,7 +94,7 @@ module.exports = function setupSiteApp(routerConfig) {
     // /member/.well-known/* serves files (e.g. jwks.json) so it needs to be mounted before the prettyUrl mw to avoid trailing slashes
     siteApp.use(
         '/members/.well-known',
-        shared.middleware.cacheControl('public', {maxAge: constants.ONE_DAY_S}),
+        shared.middleware.cacheControl('public', {maxAge: config.get('caching:wellKnown:maxAge')}),
         (req, res, next) => membersService.api.middleware.wellKnown(req, res, next)
     );
 
@@ -118,7 +118,7 @@ module.exports = function setupSiteApp(routerConfig) {
     debug('Themes done');
 
     // Serve robots.txt if not found in theme
-    siteApp.use(mw.servePublicFile('static', 'robots.txt', 'text/plain', constants.ONE_HOUR_S));
+    siteApp.use(mw.servePublicFile('static', 'robots.txt', 'text/plain', config.get('caching:robotstxt:maxAge')));
 
     // site map - this should probably be refactored to be an internal app
     sitemapHandler(siteApp);

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

@@ -2,7 +2,7 @@ const models = require('../../models');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const getPostServiceInstance = require('../../services/posts/posts-service');
-const ALLOWED_INCLUDES = ['tags', 'authors', 'authors.roles', 'tiers', 'count.signups', 'count.conversions'];
+const ALLOWED_INCLUDES = ['tags', 'authors', 'authors.roles', 'tiers', 'count.signups', 'count.paid_conversions'];
 const UNSAFE_ATTRS = ['status', 'authors', 'visibility'];
 
 const messages = {

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

@@ -10,7 +10,7 @@ const allowedIncludes = [
     'tiers',
     'newsletter',
     'count.signups',
-    'count.conversions',
+    'count.paid_conversions',
     'count.clicks'
 ];
 const unsafeAttrs = ['status', 'authors', 'visibility'];

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

@@ -24,7 +24,7 @@ function defaultRelations(frame) {
         return false;
     }
 
-    frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'tiers', 'count.signups', 'count.conversions'];
+    frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'tiers', 'count.signups', 'count.paid_conversions'];
 }
 
 function setDefaultOrder(frame) {

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

@@ -26,9 +26,9 @@ function defaultRelations(frame) {
     }
 
     if (labs.isSet('emailClicks')) {
-        frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.signups', 'count.conversions', 'count.clicks'];
+        frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.signups', 'count.paid_conversions', 'count.clicks'];
     } else {
-        frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.signups', 'count.conversions'];
+        frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter', 'count.signups', 'count.paid_conversions'];
     }
 }
 

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

@@ -49,12 +49,32 @@ const clickEventMapper = (json, frame) => {
         response.member = null;
     }
 
+    if (data.created_at) {
+        response.created_at = data.created_at;
+    }
+
     return {
         ...json,
         data: response
     };
 };
 
+function serializeAttribution(attribution) {
+    if (!attribution) {
+        return attribution;
+    }
+
+    return {
+        id: attribution?.id,
+        type: attribution?.type,
+        url: attribution?.url,
+        title: attribution?.title,
+        referrer_source: attribution?.referrerSource,
+        referrer_medium: attribution?.referrerMedium,
+        referrer_url: attribution.referrerUrl
+    };
+}
+
 const activityFeedMapper = (event, frame) => {
     if (event.type === 'comment_event') {
         return commentEventMapper(event, frame);
@@ -62,6 +82,9 @@ const activityFeedMapper = (event, frame) => {
     if (event.type === 'click_event') {
         return clickEventMapper(event, frame);
     }
+    if (event.data?.attribution) {
+        event.data.attribution = serializeAttribution(event.data.attribution);
+    }
     return event;
 };
 

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

@@ -96,6 +96,22 @@ function exportCSV(data) {
     return unparse(data.data);
 }
 
+function serializeAttribution(attribution) {
+    if (!attribution) {
+        return attribution;
+    }
+
+    return {
+        id: attribution?.id,
+        type: attribution?.type,
+        url: attribution?.url,
+        title: attribution?.title,
+        referrer_source: attribution?.referrerSource,
+        referrer_medium: attribution?.referrerMedium,
+        referrer_url: attribution.referrerUrl
+    };
+}
+
 /**
  * @param {import('bookshelf').Model} member
  * @param {object} options
@@ -129,7 +145,7 @@ function serializeMember(member, options) {
         email_recipients: json.email_recipients,
         status: json.status,
         last_seen_at: json.last_seen_at,
-        attribution: json.attribution
+        attribution: serializeAttribution(json.attribution)
     };
 
     if (json.products) {
@@ -141,15 +157,16 @@ function serializeMember(member, options) {
         if (!subscription.price) {
             continue;
         }
-        
+
         if (!subscription.price.tier && subscription.price.product) {
             subscription.price.tier = subscription.price.product;
-            
+
             if (!subscription.price.tier.tier_id) {
                 subscription.price.tier.tier_id = subscription.price.tier.product_id;
             }
             delete subscription.price.tier.product_id;
         }
+        subscription.attribution = serializeAttribution(subscription.attribution);
         delete subscription.price.product;
     }
 

package/core/server/api/endpoints/utils/validators/input/pages.js

@@ -5,7 +5,9 @@ const tpl = require('@tryghost/tpl');
 
 const messages = {
     invalidVisibilityFilter: 'Invalid filter in visibility_filter property',
-    onlySingleContentSource: 'It\'s only possible to save mobiledoc or lexical properties, not both'
+    onlySingleContentSource: 'Pages can have either a mobiledoc or a lexical property, never both.',
+    onlySingleContentSourceContext: 'Both the mobiledoc and lexical properties are set, one must be null',
+    onlySingleContentSourceHelp: 'https://ghost.org/docs/admin-api/#the-post-object'
 };
 
 const validateVisibility = async function (frame) {
@@ -43,6 +45,8 @@ const validateSingleContentSource = async function (frame) {
     if (page.mobiledoc && page.lexical) {
         return Promise.reject(new ValidationError({
             message: tpl(messages.onlySingleContentSource),
+            context: tpl(messages.onlySingleContentSourceContext),
+            help: tpl(messages.onlySingleContentSourceHelp),
             property: 'lexical'
         }));
     }

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

@@ -5,7 +5,9 @@ const tpl = require('@tryghost/tpl');
 
 const messages = {
     invalidVisibilityFilter: 'Invalid filter in visibility_filter property',
-    onlySingleContentSource: 'It\'s only possible to save mobiledoc or lexical properties, not both'
+    onlySingleContentSource: 'Posts can have either a mobiledoc or a lexical property, never both.',
+    onlySingleContentSourceContext: 'Both the mobiledoc and lexical properties are set, one must be null',
+    onlySingleContentSourceHelp: 'https://ghost.org/docs/admin-api/#the-post-object'
 };
 
 const validateVisibility = async function (frame) {
@@ -43,6 +45,8 @@ const validateSingleContentSource = async function (frame) {
     if (post.mobiledoc && post.lexical) {
         return Promise.reject(new ValidationError({
             message: tpl(messages.onlySingleContentSource),
+            context: tpl(messages.onlySingleContentSourceContext),
+            help: tpl(messages.onlySingleContentSourceHelp),
             property: 'lexical'
         }));
     }

package/core/server/data/exporter/table-lists.js

@@ -39,8 +39,8 @@ const BACKUP_TABLES = [
     'comment_likes',
     'comment_reports',
     'jobs',
-    'link_redirects',
-    'members_link_click_events'
+    'redirects',
+    'members_click_events'
 ];
 
 // NOTE: exposing only tables which are going to be included in a "default" export file

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

@@ -38,7 +38,7 @@ function addTable(name, tableSpec) {
 /**
  * Creates migration which will drop a table
  *
- * @param {[string]} names  - names of the tables to drop
+ * @param {string[]} names  - names of the tables to drop
  */
 function dropTables(names) {
     return createIrreversibleMigration(

package/core/server/data/migrations/versions/5.16/2022-09-19-09-04-add-link-redirects-table.js

@@ -1,10 +1,9 @@
-const {addTable} = require('../../utils');
-
-module.exports = addTable('link_redirects', {
-    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-    from: {type: 'string', maxlength: 2000, nullable: false},
-    to: {type: 'string', maxlength: 2000, nullable: false},
-    post_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'posts.id', setNullDelete: true},
-    created_at: {type: 'dateTime', nullable: false},
-    updated_at: {type: 'dateTime', nullable: true}
-});
+const logging = require('@tryghost/logging');
+module.exports = {
+    async up() {
+        logging.warn('Skipping migration - noop');
+    },
+    async down() {
+        logging.warn('Skipping migration - noop');
+    }
+};

package/core/server/data/migrations/versions/5.16/2022-09-19-09-05-add-members-link-click-events-table.js

@@ -1,8 +1,9 @@
-const {addTable} = require('../../utils');
-
-module.exports = addTable('members_link_click_events', {
-    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-    member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
-    link_id: {type: 'string', maxlength: 24, nullable: false, references: 'link_redirects.id', cascadeDelete: true},
-    created_at: {type: 'dateTime', nullable: false}
-});
+const logging = require('@tryghost/logging');
+module.exports = {
+    async up() {
+        logging.warn('Skipping migration - noop');
+    },
+    async down() {
+        logging.warn('Skipping migration - noop');
+    }
+};

package/core/server/data/migrations/versions/5.17/2022-09-27-13-53-remove-click-tracking-tables.js

@@ -0,0 +1,28 @@
+const {addTable, combineNonTransactionalMigrations} = require('../../utils');
+
+function reverseMigration({up, down, config}) {
+    return {
+        config,
+        up: down,
+        down: up
+    };
+}
+
+module.exports = reverseMigration(
+    combineNonTransactionalMigrations(
+        addTable('link_redirects', {
+            id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+            from: {type: 'string', maxlength: 2000, nullable: false},
+            to: {type: 'string', maxlength: 2000, nullable: false},
+            post_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'posts.id', setNullDelete: true},
+            created_at: {type: 'dateTime', nullable: false},
+            updated_at: {type: 'dateTime', nullable: true}
+        }),
+        addTable('members_link_click_events', {
+            id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+            member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
+            link_id: {type: 'string', maxlength: 24, nullable: false, references: 'link_redirects.id', cascadeDelete: true},
+            created_at: {type: 'dateTime', nullable: false}
+        })
+    )
+);

package/core/server/data/migrations/versions/5.17/2022-09-27-13-55-add-redirects-table.js

@@ -0,0 +1,10 @@
+const {addTable} = require('../../utils');
+
+module.exports = addTable('redirects', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    from: {type: 'string', maxlength: 2000, nullable: false},
+    to: {type: 'string', maxlength: 2000, nullable: false},
+    post_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'posts.id', setNullDelete: true},
+    created_at: {type: 'dateTime', nullable: false},
+    updated_at: {type: 'dateTime', nullable: true}
+});

package/core/server/data/migrations/versions/5.17/2022-09-27-13-56-add-members-click-events-table.js

@@ -0,0 +1,8 @@
+const {addTable} = require('../../utils');
+
+module.exports = addTable('members_click_events', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
+    redirect_id: {type: 'string', maxlength: 24, nullable: false, references: 'redirects.id', cascadeDelete: true},
+    created_at: {type: 'dateTime', nullable: false}
+});

package/core/server/data/migrations/versions/5.17/2022-09-27-16-49-set-track-clicks-based-on-opens.js

@@ -0,0 +1,31 @@
+const logging = require('@tryghost/logging');
+const {createTransactionalMigration} = require('../../utils');
+
+// Set email_track_clicks to the current value of email_track_opens
+module.exports = createTransactionalMigration(
+    async function up(connection) {
+        const reuseValueOfSetting = await connection('settings')
+            .where('key', '=', 'email_track_opens')
+            .first();
+
+        if (!reuseValueOfSetting) {
+            logging.warn(`Skipped setting email_track_clicks to current value of email_track_opens - email_track_opens not found`);
+            return;
+        }
+
+        const affectedRows = await connection('settings')
+            .update({
+                value: reuseValueOfSetting.value
+            })
+            .where('key', '=', 'email_track_clicks');
+
+        if (affectedRows === 1) {
+            logging.info(`Set email_track_clicks to ${reuseValueOfSetting.value} (current email_track_opens value)`);
+        } else {
+            logging.warn(`Tried setting email_track_clicks to ${reuseValueOfSetting.value} — ${affectedRows} changes`);
+        }
+    },
+    async function down() {
+        // no-op: we don't need to change it back
+    }
+);

package/core/server/data/migrations/versions/5.17/2022-09-29-12-39-add-track-clicks-column-to-emails.js

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

package/core/server/data/schema/schema.js

@@ -723,6 +723,7 @@ module.exports = {
         html: {type: 'text', maxlength: 1000000000, fieldtype: 'long', nullable: true},
         plaintext: {type: 'text', maxlength: 1000000000, fieldtype: 'long', nullable: true},
         track_opens: {type: 'bool', nullable: false, defaultTo: false},
+        track_clicks: {type: 'bool', nullable: false, defaultTo: false},
         submitted_at: {type: 'dateTime', nullable: false},
         newsletter_id: {type: 'string', maxlength: 24, nullable: true, references: 'newsletters.id'},
         created_at: {type: 'dateTime', nullable: false},
@@ -836,7 +837,7 @@ module.exports = {
         created_at: {type: 'dateTime', nullable: false},
         updated_at: {type: 'dateTime', nullable: true}
     },
-    link_redirects: {
+    redirects: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         from: {type: 'string', maxlength: 2000, nullable: false},
         to: {type: 'string', maxlength: 2000, nullable: false},
@@ -844,10 +845,10 @@ module.exports = {
         created_at: {type: 'dateTime', nullable: false},
         updated_at: {type: 'dateTime', nullable: true}
     },
-    members_link_click_events: {
+    members_click_events: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', cascadeDelete: true},
-        link_id: {type: 'string', maxlength: 24, nullable: false, references: 'link_redirects.id', cascadeDelete: true},
+        redirect_id: {type: 'string', maxlength: 24, nullable: false, references: 'redirects.id', cascadeDelete: true},
         created_at: {type: 'dateTime', nullable: false}
     }
 };

package/core/server/models/email.js

@@ -10,6 +10,7 @@ const Email = ghostBookshelf.Model.extend({
             status: 'pending',
             recipient_filter: 'status:-free',
             track_opens: false,
+            track_clicks: false,
             delivered_count: 0,
             opened_count: 0,
             failed_count: 0

package/core/server/models/{member-link-click-event.js → member-click-event.js}

@@ -1,11 +1,11 @@
 const errors = require('@tryghost/errors');
 const ghostBookshelf = require('./base');
 
-const MemberLinkClickEvent = ghostBookshelf.Model.extend({
-    tableName: 'members_link_click_events',
+const MemberClickEvent = ghostBookshelf.Model.extend({
+    tableName: 'members_click_events',
 
     link() {
-        return this.belongsTo('LinkRedirect', 'link_id');
+        return this.belongsTo('Redirect', 'link_id');
     },
 
     member() {
@@ -13,14 +13,14 @@ const MemberLinkClickEvent = ghostBookshelf.Model.extend({
     }
 }, {
     async edit() {
-        throw new errors.IncorrectUsageError({message: 'Cannot edit MemberLinkClickEvent'});
+        throw new errors.IncorrectUsageError({message: 'Cannot edit MemberClickEvent'});
     },
 
     async destroy() {
-        throw new errors.IncorrectUsageError({message: 'Cannot destroy MemberLinkClickEvent'});
+        throw new errors.IncorrectUsageError({message: 'Cannot destroy MemberClickEvent'});
     }
 });
 
 module.exports = {
-    MemberLinkClickEvent: ghostBookshelf.model('MemberLinkClickEvent', MemberLinkClickEvent)
+    MemberClickEvent: ghostBookshelf.model('MemberClickEvent', MemberClickEvent)
 };

package/core/server/models/member.js

@@ -46,6 +46,12 @@ const Member = ghostBookshelf.Model.extend({
         }, {
             key: 'conversion',
             replacement: 'conversions.attribution_id'
+        }, {
+            key: 'opened_emails.post_id',
+            replacement: 'emails.post_id',
+            // Currently we cannot expand on values such as null or a string in mongo-knex
+            // But the line below is essentially the same as: `email_recipients.opened_at:-null`
+            expansion: 'email_recipients.opened_at:>=0' 
         }];
     },
 
@@ -92,6 +98,22 @@ const Member = ghostBookshelf.Model.extend({
                 tableNameAs: 'conversions',
                 type: 'oneToOne',
                 joinFrom: 'member_id'
+            },
+            clicked_links: {
+                tableName: 'link_redirects',
+                tableNameAs: 'clicked_links',
+                type: 'manyToMany',
+                joinTable: 'members_link_click_events',
+                joinFrom: 'member_id',
+                joinTo: 'link_id'
+            },
+            emails: {
+                tableName: 'emails',
+                tableNameAs: 'emails',
+                type: 'manyToMany',
+                joinTable: 'email_recipients',
+                joinFrom: 'member_id',
+                joinTo: 'email_id'
             }
         };
     },

package/core/server/models/post.js

@@ -1338,20 +1338,20 @@ Post = ghostBookshelf.Model.extend({
                         .as('count__signups');
                 });
             },
-            conversions(modelOrCollection) {
+            paid_conversions(modelOrCollection) {
                 modelOrCollection.query('columns', 'posts.*', (qb) => {
                     qb.count('members_subscription_created_events.id')
                         .from('members_subscription_created_events')
                         .whereRaw('posts.id = members_subscription_created_events.attribution_id')
-                        .as('count__conversions');
+                        .as('count__paid_conversions');
                 });
             },
             clicks(modelOrCollection) {
                 modelOrCollection.query('columns', 'posts.*', (qb) => {
-                    qb.countDistinct('members_link_click_events.member_id')
-                        .from('members_link_click_events')
-                        .join('link_redirects', 'members_link_click_events.link_id', 'link_redirects.id')
-                        .whereRaw('posts.id = link_redirects.post_id')
+                    qb.countDistinct('members_click_events.member_id')
+                        .from('members_click_events')
+                        .join('redirects', 'members_click_events.redirect_id', 'redirects.id')
+                        .whereRaw('posts.id = redirects.post_id')
                         .as('count__clicks');
                 });
             }