ghost 4.37.0 → 4.38.0

package/core/server/api/canary/utils/serializers/output/pages.js

@@ -1,5 +1,6 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:pages');
 const mapper = require('./utils/mapper');
+const membersService = require('../../../../../services/members');
 
 module.exports = {
     async all(models, apiConfig, frame) {
@@ -10,9 +11,15 @@ module.exports = {
             return;
         }
         let pages = [];
+
+        const tiersModels = await membersService.api.productRepository.list({
+            withRelated: ['monthlyPrice', 'yearlyPrice']
+        });
+        const tiers = tiersModels.data ? tiersModels.data.map(tierModel => tierModel.toJSON()) : [];
+
         if (models.meta) {
             for (let model of models.data) {
-                let page = await mapper.mapPage(model, frame);
+                let page = await mapper.mapPage(model, frame, {tiers});
                 pages.push(page);
             }
             frame.response = {
@@ -22,7 +29,7 @@ module.exports = {
 
             return;
         }
-        let page = await mapper.mapPage(models, frame);
+        let page = await mapper.mapPage(models, frame, {tiers});
         frame.response = {
             pages: [page]
         };

package/core/server/api/canary/utils/serializers/output/posts.js

@@ -1,5 +1,6 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:posts');
 const mapper = require('./utils/mapper');
+const membersService = require('../../../../../services/members');
 
 module.exports = {
     async all(models, apiConfig, frame) {
@@ -10,9 +11,14 @@ module.exports = {
             return;
         }
         let posts = [];
+
+        const tiersModels = await membersService.api.productRepository.list({
+            withRelated: ['monthlyPrice', 'yearlyPrice']
+        });
+        const tiers = tiersModels.data ? tiersModels.data.map(tierModel => tierModel.toJSON()) : [];
         if (models.meta) {
             for (let model of models.data) {
-                let post = await mapper.mapPost(model, frame);
+                let post = await mapper.mapPost(model, frame, {tiers});
                 posts.push(post);
             }
             frame.response = {
@@ -22,7 +28,7 @@ module.exports = {
 
             return;
         }
-        let post = await mapper.mapPost(models, frame);
+        let post = await mapper.mapPost(models, frame, {tiers});
         frame.response = {
             posts: [post]
         };

package/core/server/api/canary/utils/serializers/output/preview.js

@@ -1,8 +1,14 @@
 const mapper = require('./utils/mapper');
+const membersService = require('../../../../../services/members');
 
 module.exports = {
     async all(model, apiConfig, frame) {
-        const data = await mapper.mapPost(model, frame);
+        const tiersModels = await membersService.api.productRepository.list({
+            withRelated: ['monthlyPrice', 'yearlyPrice']
+        });
+        const tiers = tiersModels.data ? tiersModels.data.map(tierModel => tierModel.toJSON()) : [];
+
+        const data = await mapper.mapPost(model, frame, {tiers});
         frame.response = {
             preview: [data]
         };

package/core/server/api/canary/utils/serializers/output/products.js

@@ -1,6 +1,7 @@
 //@ts-check
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:products');
 const _ = require('lodash');
+const utils = require('../../../../shared/utils');
 
 const allowedIncludes = ['stripe_prices', 'monthly_price', 'yearly_price'];
 
@@ -22,7 +23,7 @@ module.exports = {
  */
 function paginatedProducts(page, _apiConfig, frame) {
     const requestedQueryIncludes = frame.original && frame.original.query && frame.original.query.include && frame.original.query.include.split(',') || [];
-    const requestedOptionsIncludes = frame.original && frame.original.options && frame.original.options.include || [];
+    const requestedOptionsIncludes = utils.options.trimAndLowerCase(frame.original && frame.original.options && frame.original.options.include || []);
     return {
         products: page.data.map((model) => {
             return cleanIncludes(
@@ -74,6 +75,7 @@ function serializeProduct(product, options, apiType) {
         description: json.description,
         slug: json.slug,
         active: json.active,
+        visibility: json.visibility,
         type: json.type,
         welcome_page_url: json.welcome_page_url,
         created_at: json.created_at,

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

@@ -3,6 +3,7 @@ const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:ti
 const _ = require('lodash');
 
 const allowedIncludes = ['monthly_price', 'yearly_price'];
+const utils = require('../../../../shared/utils');
 
 module.exports = {
     browse: createSerializer('browse', paginatedTiers),
@@ -22,7 +23,7 @@ module.exports = {
  */
 function paginatedTiers(page, _apiConfig, frame) {
     const requestedQueryIncludes = frame.original && frame.original.query && frame.original.query.include && frame.original.query.include.split(',') || [];
-    const requestedOptionsIncludes = frame.original && frame.original.options && frame.original.options.include || [];
+    const requestedOptionsIncludes = utils.options.trimAndLowerCase(frame.original && frame.original.options && frame.original.options.include || []);
     return {
         tiers: page.data.map((model) => {
             return cleanIncludes(
@@ -81,7 +82,8 @@ function serializeTier(tier, options, apiType) {
         stripe_prices: json.stripePrices ? json.stripePrices.map(price => serializeStripePrice(price, hideStripeData)) : null,
         monthly_price: serializeStripePrice(json.monthlyPrice, hideStripeData),
         yearly_price: serializeStripePrice(json.yearlyPrice, hideStripeData),
-        benefits: json.benefits || null
+        benefits: json.benefits || null,
+        visibility: json.visibility
     };
 
     return serialized;

package/core/server/api/canary/utils/serializers/output/utils/mapper.js

@@ -31,7 +31,8 @@ const mapTag = (model, frame) => {
     return jsonModel;
 };
 
-const mapPost = async (model, frame) => {
+const mapPost = async (model, frame, options = {}) => {
+    const {tiers: tiersData} = options || {};
     const extendedOptions = Object.assign(_.cloneDeep(frame.options), {
         extraProperties: ['canonical_url']
     });
@@ -45,12 +46,21 @@ const mapPost = async (model, frame) => {
     // Attach tiers to custom nql visibility filter
     if (labsService.isSet('multipleProducts')
         && jsonModel.visibility
-        && !['members', 'public', 'paid', 'tiers'].includes(jsonModel.visibility)
     ) {
-        const tiers = await postsService.getProductsFromVisibilityFilter(jsonModel.visibility);
+        if (['members', 'public'].includes(jsonModel.visibility) && jsonModel.tiers) {
+            jsonModel.tiers = tiersData || [];
+        }
+
+        if (jsonModel.visibility === 'paid' && jsonModel.tiers) {
+            jsonModel.tiers = tiersData ? tiersData.filter(t => t.type === 'paid') : [];
+        }
 
-        jsonModel.visibility = 'tiers';
-        jsonModel.tiers = tiers;
+        if (!['members', 'public', 'paid', 'tiers'].includes(jsonModel.visibility)) {
+            const tiers = await postsService.getProductsFromVisibilityFilter(jsonModel.visibility);
+
+            jsonModel.visibility = 'tiers';
+            jsonModel.tiers = tiers;
+        }
     }
 
     if (utils.isContentAPI(frame)) {
@@ -103,8 +113,8 @@ const mapPost = async (model, frame) => {
     return jsonModel;
 };
 
-const mapPage = async (model, frame) => {
-    const jsonModel = await mapPost(model, frame);
+const mapPage = async (model, frame, options) => {
+    const jsonModel = await mapPost(model, frame, options);
 
     delete jsonModel.email_subject;
     delete jsonModel.email_recipient_filter;

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

@@ -32,9 +32,10 @@ function configure(dbConfig) {
         process.env.BTHREADS_BACKEND = 'child_process';
     }
 
-    if (client === 'mysql') {
-        dbConfig.connection.timezone = 'UTC';
+    if (client === 'mysql2') {
+        dbConfig.connection.timezone = 'Z';
         dbConfig.connection.charset = 'utf8mb4';
+        dbConfig.connection.decimalNumbers = true;
 
         // NOTE: disabled so that worker processes can use the db without
         // requiring logging and causing file desriptor leaks.

package/core/server/data/migrations/versions/3.29/01-remove-duplicate-subscriptions.js

@@ -1,4 +1,5 @@
 const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = {
     config: {
@@ -6,7 +7,7 @@ module.exports = {
     },
 
     async up({transacting: knex}) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             logging.warn('Skipping cleanup of duplicate subscriptions - database is not MySQL');
             return;
         }

package/core/server/data/migrations/versions/3.29/02-remove-duplicate-customers.js

@@ -1,4 +1,5 @@
 const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = {
     config: {
@@ -6,7 +7,7 @@ module.exports = {
     },
 
     async up({transacting: knex}) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             logging.warn('Skipping cleanup of duplicate customers - database is not MySQL');
             return;
         }

package/core/server/data/migrations/versions/3.29/03-remove-orphaned-customers.js

@@ -1,4 +1,5 @@
 const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = {
     config: {
@@ -6,7 +7,7 @@ module.exports = {
     },
 
     async up({transacting: knex}) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             logging.warn('Skipping cleanup of orphaned customers - database is not MySQL');
             return;
         }

package/core/server/data/migrations/versions/3.29/04-remove-orphaned-subscriptions.js

@@ -1,4 +1,5 @@
 const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = {
     config: {
@@ -6,7 +7,7 @@ module.exports = {
     },
 
     async up({transacting: knex}) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             logging.warn('Skipping cleanup of orphaned subscriptions - database is not MySQL');
             return;
         }

package/core/server/data/migrations/versions/3.29/05-add-member-constraints.js

@@ -1,4 +1,5 @@
 const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = {
     config: {
@@ -6,7 +7,7 @@ module.exports = {
     },
 
     async up({transacting: knex}) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             return logging.warn('Skipping member tables index creation - database is not MySQL');
         }
 
@@ -91,7 +92,7 @@ module.exports = {
     },
 
     async down({transacting: knex}) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             return logging.warn('Skipping member tables index removal - database is not MySQL');
         }
 

package/core/server/data/migrations/versions/3.39/06-add-email-recipient-index.js

@@ -1,11 +1,12 @@
 const logging = require('@tryghost/logging');
 const {createNonTransactionalMigration} = require('../../utils');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createNonTransactionalMigration(
     async function up(knex) {
         let hasIndex = false;
 
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             const result = await knex.raw(`select * from sqlite_master where type = 'index' and tbl_name = 'email_recipients' and name = 'email_recipients_email_id_member_email_index'`);
             hasIndex = result.length !== 0;
         } else {
@@ -27,7 +28,7 @@ module.exports = createNonTransactionalMigration(
     async function down(knex) {
         let missingIndex = false;
 
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             const result = await knex.raw(`select * from sqlite_master where type = 'index' and tbl_name = 'email_recipients' and name = 'email_recipients_email_id_member_email_index'`);
             missingIndex = result.length === 0;
         } else {
@@ -42,7 +43,7 @@ module.exports = createNonTransactionalMigration(
 
         logging.info('Dropping composite index on email_recipients for [email_id, member_email]');
 
-        if (knex.client.config.client === 'mysql') {
+        if (DatabaseInfo.isMySQL(knex)) {
             await knex.schema.table('email_recipients', (table) => {
                 table.dropForeign('email_id');
                 table.dropIndex(['email_id', 'member_email']);

package/core/server/data/migrations/versions/4.0/14-remove-orphaned-stripe-records.js

@@ -1,8 +1,9 @@
 const {createIrreversibleMigration} = require('../../utils');
 const logging = require('@tryghost/logging');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createIrreversibleMigration(async function up(connection) {
-    if (connection.client.config.client === 'mysql') {
+    if (DatabaseInfo.isMySQL(connection)) {
         logging.info('Skipping removal of orphaned stripe records for MySQL');
         return;
     }

package/core/server/data/migrations/versions/4.0/26-add-cascade-on-delete.js

@@ -1,9 +1,10 @@
 const logging = require('@tryghost/logging');
 const {createIrreversibleMigration} = require('../../utils');
 const {addForeign, dropForeign} = require('../../../schema/commands');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createIrreversibleMigration(async (knex) => {
-    if (knex.client.config.client !== 'sqlite3') {
+    if (!DatabaseInfo.isSQLite(knex)) {
         return logging.warn('Skipping adding "on delete cascade" - database is not SQLite3');
     }
 

package/core/server/data/migrations/versions/4.0/29-fix-foreign-key-for-members-stripe-customers-subscriptions.js

@@ -1,9 +1,10 @@
 const logging = require('@tryghost/logging');
 const {createIrreversibleMigration} = require('../../utils');
 const {addForeign, dropForeign} = require('../../../schema/commands');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createIrreversibleMigration(async (knex) => {
-    if (knex.client.config.client !== 'sqlite3') {
+    if (!DatabaseInfo.isSQLite(knex)) {
         return logging.warn('Skipping fixing foreign key for members_stripe_customers_subscriptions - database is not SQLite3');
     }
 

package/core/server/data/migrations/versions/4.1/02-add-unique-constraint-for-member-stripe-tables.js

@@ -1,10 +1,11 @@
 const logging = require('@tryghost/logging');
 const {createTransactionalMigration} = require('../../utils');
 const {addUnique} = require('../../../schema/commands');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createTransactionalMigration(
     async function up(connection) {
-        if (connection.client.config.client !== 'sqlite3') {
+        if (!DatabaseInfo.isSQLite(connection)) {
             return logging.warn('Skipping adding unique constraint for members_stripe_customers_subscriptions and members_stripe_customers - database is not SQLite3');
         }
 

package/core/server/data/migrations/versions/4.20/05-remove-not-null-constraint-from-portal-title.js

@@ -1,6 +1,7 @@
 const logging = require('@tryghost/logging');
 const {createNonTransactionalMigration} = require('../../utils');
 const {addUnique} = require('../../../schema/commands');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createNonTransactionalMigration(
     async function up(knex) {
@@ -14,7 +15,7 @@ module.exports = createNonTransactionalMigration(
             table.string('portal_title', 191).nullable();
         });
 
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             // eslint-disable-next-line no-restricted-syntax
             for (const column of ['name', 'code', 'stripe_coupon_id']) {
                 await addUnique('offers', column, knex);
@@ -32,7 +33,7 @@ module.exports = createNonTransactionalMigration(
             table.string('portal_title', 191).notNullable();
         });
 
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             // eslint-disable-next-line no-restricted-syntax
             for (const column of ['name', 'code', 'stripe_coupon_id']) {
                 await addUnique('offers', column, knex);

package/core/server/data/migrations/versions/4.33/2022-01-18-09-07-remove-duplicate-offer-redemptions.js

@@ -1,10 +1,10 @@
 const logging = require('@tryghost/logging');
-
 const {createTransactionalMigration} = require('../../utils');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createTransactionalMigration(
     async function up(knex) {
-        if (knex.client.config.client !== 'mysql') {
+        if (!DatabaseInfo.isMySQL(knex)) {
             logging.warn('Skipping cleanup of duplicate offer redemptions - database is not MySQL');
             return;
         }

package/core/server/data/migrations/versions/4.35/2022-02-01-11-48-update-email-recipient-filter-column-type.js

@@ -1,9 +1,10 @@
 const logging = require('@tryghost/logging');
 const {createNonTransactionalMigration} = require('../../utils');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createNonTransactionalMigration(
     async function up(knex) {
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             logging.warn('Skipping migration for SQLite3');
             return;
         }

package/core/server/data/migrations/versions/4.35/2022-02-01-12-03-update-recipient-filter-column-type.js

@@ -1,9 +1,10 @@
 const logging = require('@tryghost/logging');
 const {createNonTransactionalMigration} = require('../../utils');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createNonTransactionalMigration(
     async function up(knex) {
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             logging.warn('Skipping migration for SQLite3');
             return;
         }

package/core/server/data/migrations/versions/4.37/2022-02-21-09-53-backfill-members-last-seen-at-column.js

@@ -1,9 +1,10 @@
 const logging = require('@tryghost/logging');
 const {createTransactionalMigration} = require('../../utils');
+const DatabaseInfo = require('@tryghost/database-info');
 
 module.exports = createTransactionalMigration(
     async function up(knex) {
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             logging.warn('Skipping migration for SQLite3');
             return;
         }
@@ -21,7 +22,7 @@ module.exports = createTransactionalMigration(
         `);
     },
     async function down(knex) {
-        if (knex.client.config.client === 'sqlite3') {
+        if (DatabaseInfo.isSQLite(knex)) {
             logging.warn('Skipping migration for SQLite3');
             return;
         }

package/core/server/data/migrations/versions/4.38/2022-03-01-08-46-add-visibility-to-tiers.js

@@ -0,0 +1,11 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('products', 'visible', {
+    type: 'boolean',
+    nullable: false,
+    defaultTo: false
+});
+
+module.exports.up = async () => {
+    // noop - column will be replaced with `visibility` instead
+};

package/core/server/data/migrations/versions/4.38/2022-03-03-16-12-add-visibility-to-tiers.js

@@ -0,0 +1,8 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('products', 'visibility', {
+    type: 'string',
+    maxlength: 50,
+    nullable: false,
+    defaultTo: 'none'
+});

package/core/server/data/migrations/versions/4.38/2022-03-03-16-17-drop-tiers-visible-column.js

@@ -0,0 +1,7 @@
+const {createDropColumnMigration} = require('../../utils');
+
+module.exports = createDropColumnMigration('products', 'visible', {});
+
+module.exports.down = async () => {
+    // noop - column was replaced by `visibility` instead
+};

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

@@ -3,5 +3,5 @@ const mysql = require('./mysql');
 
 module.exports = {
     sqlite3: sqlite3,
-    mysql: mysql
+    mysql2: mysql
 };

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

@@ -1,8 +1,8 @@
 const _ = require('lodash');
 const db = require('../../../data/db');
 
-const doRawAndFlatten = function doRaw(query, transaction, flattenFn) {
-    return (transaction || db.knex).raw(query).then(function (response) {
+const doRawAndFlatten = function doRaw(query, transaction = db.knex, flattenFn) {
+    return transaction.raw(query).then(function (response) {
         return _.flatten(flattenFn(response));
     });
 };
@@ -31,8 +31,8 @@ const getColumns = function getColumns(table, transaction) {
 // a wrong datatype in schema.js some installations using mysql could have been created using the
 // data type text instead of mediumtext.
 // For details see: https://github.com/TryGhost/Ghost/issues/1947
-const checkPostTable = function checkPostTable(transaction) {
-    return (transaction || db.knex).raw('SHOW FIELDS FROM posts where Field ="html" OR Field = "markdown"').then(function (response) {
+const checkPostTable = function checkPostTable(transaction = db.knex) {
+    return transaction.raw('SHOW FIELDS FROM posts where Field ="html" OR Field = "markdown"').then(function (response) {
         return _.flatten(_.map(response[0], function (entry) {
             if (entry.Type.toLowerCase() !== 'mediumtext') {
                 return (transaction || db.knex).raw('ALTER TABLE posts MODIFY ' + entry.Field + ' MEDIUMTEXT');