ghost 5.130.2 → 6.0.0-alpha.2

package/core/server/data/migrations/versions/4.9/01-add-reset-all-passwords-permission.js

@@ -1,11 +0,0 @@
-const {
-    addPermissionWithRoles
-} = require('../../utils');
-
-module.exports = addPermissionWithRoles({
-    name: 'Reset all passwords',
-    action: 'resetAllPasswords',
-    object: 'authentication'
-}, [
-    'Administrator'
-]);

package/core/server/data/migrations/versions/4.9/02-add-benefits-table.js

@@ -1,9 +0,0 @@
-const {addTable} = require('../../utils');
-
-module.exports = addTable('benefits', {
-    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-    name: {type: 'string', maxlength: 191, nullable: false},
-    slug: {type: 'string', maxlength: 191, nullable: false, unique: true},
-    created_at: {type: 'dateTime', nullable: false},
-    updated_at: {type: 'dateTime', nullable: true}
-});

package/core/server/data/migrations/versions/4.9/03-add-products-benefits-table.js

@@ -1,8 +0,0 @@
-const {addTable} = require('../../utils');
-
-module.exports = addTable('products_benefits', {
-    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-    product_id: {type: 'string', maxlength: 24, nullable: false, references: 'products.id', cascadeDelete: true},
-    benefit_id: {type: 'string', maxlength: 24, nullable: false, references: 'benefits.id', cascadeDelete: true},
-    sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0}
-});

package/core/server/data/migrations/versions/4.9/04-add-member-segment-to-email-batches.js

@@ -1,7 +0,0 @@
-const {createAddColumnMigration} = require('../../utils');
-
-module.exports = createAddColumnMigration('email_batches', 'member_segment', {
-    type: 'text',
-    maxlength: 2000,
-    nullable: true
-});

package/core/server/data/migrations/versions/4.9/05-fix-missed-mobiledoc-url-transforms.js

@@ -1,87 +0,0 @@
-const logging = require('@tryghost/logging');
-const urlUtils = require('../../../../../shared/url-utils');
-const htmlToPlaintext = require('@tryghost/html-to-plaintext');
-const mobiledocLib = require('../../../../lib/mobiledoc');
-const {createTransactionalMigration} = require('../../utils');
-
-// in Ghost versions 4.6.1-4.8.4 the 4.0 migration that transformed URLs had a bug
-// that meant urls inside cards in mobiledoc content was not being transformed
-//
-// if the migrations table indicates an upgrade was made from 3.x to 4.6-4.8 then
-// we'll re-run the transforms against post.mobiledoc and re-generate the html
-// and plaintext contents
-
-module.exports = createTransactionalMigration(
-    async function up(knex) {
-        const badVersionUsedFor40Migration = await knex('migrations')
-            .where({
-                name: '18-transform-urls-absolute-to-transform-ready.js'
-            })
-            .whereIn('currentVersion', ['4.6', '4.7', '4.8'])
-            .first();
-
-        if (!badVersionUsedFor40Migration) {
-            logging.info('Skipping transform of mobiledoc URLs - original transform was good');
-            return;
-        }
-
-        logging.info('Transforming all internal URLs in posts.{mobiledoc,html,plaintext} to transform-ready');
-
-        await knex.transaction(async (trx) => {
-            const postIdRows = await knex('posts')
-                .transacting(trx)
-                .forUpdate()
-                .select('id');
-
-            // eslint-disable-next-line no-restricted-syntax
-            for (const postIdRow of postIdRows) {
-                const {id} = postIdRow;
-                const [post] = await knex('posts')
-                    .transacting(trx)
-                    .where({id})
-                    .select([
-                        'mobiledoc'
-                    ]);
-
-                let mobiledoc;
-                let html;
-
-                try {
-                    mobiledoc = urlUtils.mobiledocToTransformReady(post.mobiledoc, {cardTransformers: mobiledocLib.cards});
-
-                    if (!mobiledoc) {
-                        logging.warn(`No mobiledoc for ${id}. Skipping.`);
-                        continue;
-                    }
-                } catch (err) {
-                    logging.warn(`Invalid mobiledoc JSON structure for ${id}. Skipping`);
-                    continue;
-                }
-
-                try {
-                    html = mobiledocLib.render(JSON.parse(mobiledoc));
-                } catch (err) {
-                    logging.warn(`Invalid mobiledoc content structure for ${id}, unable to render. Skipping`);
-                    continue;
-                }
-
-                const plaintext = htmlToPlaintext.excerpt(html);
-
-                await knex('posts')
-                    .transacting(trx)
-                    .where({id})
-                    .update({
-                        mobiledoc,
-                        html,
-                        plaintext
-                    });
-            }
-
-            return 'transaction complete';
-        });
-    },
-
-    async function down() {
-        // noop
-    }
-);

package/core/server/data/migrations/versions/4.9/06-add-comped-status.js

@@ -1,47 +0,0 @@
-const logging = require('@tryghost/logging');
-const {createTransactionalMigration} = require('../../utils');
-
-module.exports = createTransactionalMigration(
-    async function up(knex) {
-        // eslint-disable-next-line no-restricted-syntax
-        const compedMemberIds = (await knex('members')
-            .select('members.id')
-            .innerJoin(
-                'members_stripe_customers',
-                'members.id',
-                'members_stripe_customers.member_id'
-            ).innerJoin(
-                'members_stripe_customers_subscriptions',
-                function () {
-                    this.on(
-                        'members_stripe_customers.customer_id',
-                        'members_stripe_customers_subscriptions.customer_id'
-                    ).onIn(
-                        'members_stripe_customers_subscriptions.status',
-                        ['active', 'trialing', 'past_due', 'unpaid']
-                    );
-                }
-            ).where(
-                'members_stripe_customers_subscriptions.plan_nickname',
-                '=',
-                'Complimentary'
-            )).map(({id}) => id);
-
-        if (compedMemberIds.length === 0) {
-            logging.info('No Members found with Complimentary subscriptions');
-            return;
-        }
-
-        logging.info(`Updating ${compedMemberIds.length} Members status from 'paid' -> 'comped'`);
-
-        await knex('members')
-            .update('status', 'comped')
-            .whereIn('id', compedMemberIds);
-    },
-    async function down(knex) {
-        logging.info('Updating all member "comped" statuses to "paid"');
-        await knex('members')
-            .update('status', 'paid')
-            .where('status', 'comped');
-    }
-);

package/core/server/data/migrations/versions/4.9/07-update-comped-members-status-events.js

@@ -1,39 +0,0 @@
-const logging = require('@tryghost/logging');
-const {createTransactionalMigration} = require('../../utils');
-
-module.exports = createTransactionalMigration(
-    async function up(knex) {
-        logging.info('Updating members_status_events for comped members');
-        const compedMembers = await knex('members')
-            .select('id')
-            .where('status', 'comped');
-
-        if (compedMembers.length === 0) {
-            logging.info('No comped members found - skipping migration');
-            return;
-        } else {
-            logging.info(`Found ${compedMembers.length} comped members - checking members_status_events`);
-        }
-
-        // eslint-disable-next-line no-restricted-syntax
-        for (const member of compedMembers) {
-            const mostRecentStatusEvent = await knex('members_status_events')
-                .select('*')
-                .where('member_id', member.id)
-                .orderBy('created_at', 'desc')
-                .limit(1)
-                .first();
-
-            if (!mostRecentStatusEvent) {
-                logging.warn(`Could not find a status event for member ${member.id} - skipping this member`);
-            } else if (mostRecentStatusEvent.to_status !== 'comped') {
-                logging.info(`Updating members_status_event ${mostRecentStatusEvent.id}`);
-                await knex('members_status_events')
-                    .update('to_status', 'comped')
-                    .where('id', mostRecentStatusEvent.id);
-            }
-        }
-    },
-    async function down() {}
-);
-

package/core/server/models/mail-event.js

@@ -1,12 +0,0 @@
-const ghostBookshelf = require('./base');
-
-const MailEvent = ghostBookshelf.Model.extend({
-    tableName: 'temp_mail_events',
-    defaults() {
-        return {};
-    }
-}, {});
-
-module.exports = {
-    MailEvent: ghostBookshelf.model('MailEvent', MailEvent)
-};

package/core/server/services/mail-events/BookshelfMailEventRepository.js

@@ -1,40 +0,0 @@
-/**
- * @typedef {import('./MailEventRepository')} MailEventRepository
- * @typedef {import('./MailEvent').MailEvent} MailEvent
- */
-
-/**
- * @typedef {object} MailEventModel
- * @property {function} add
- */
-
-/**
- * @implements MailEventRepository
- */
-module.exports = class BookshelfMailEventRepository {
-    /**
-     * @type {MailEventModel}
-     */
-    #MailEventModel;
-
-    /**
-     * @param {object} MailEventModel
-     */
-    constructor(MailEventModel) {
-        this.#MailEventModel = MailEventModel;
-    }
-
-    /**
-     * @param {MailEvent} mailEvent
-     * @returns {Promise<void>}
-     */
-    async save(mailEvent) {
-        await this.#MailEventModel.add({
-            id: mailEvent.id,
-            type: mailEvent.type,
-            message_id: mailEvent.messageId,
-            recipient: mailEvent.recipient,
-            occurred_at: new Date(mailEvent.timestampMs)
-        });
-    }
-};

package/core/server/services/mail-events/InMemoryMailEventRepository.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InMemoryMailEventRepository = void 0;
-const InMemoryRepository_1 = require("../lib/InMemoryRepository");
-class InMemoryMailEventRepository extends InMemoryRepository_1.InMemoryRepository {
-    toPrimitive() {
-        return {};
-    }
-}
-exports.InMemoryMailEventRepository = InMemoryMailEventRepository;

package/core/server/services/mail-events/InMemoryMailEventRepository.ts

@@ -1,8 +0,0 @@
-import {InMemoryRepository} from '../lib/InMemoryRepository';
-import {MailEvent} from './MailEvent';
-
-export class InMemoryMailEventRepository extends InMemoryRepository<string, MailEvent> {
-    protected toPrimitive(): object {
-        return {};
-    }
-}

package/core/server/services/mail-events/MailEvent.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailEvent = void 0;
-class MailEvent {
-    id;
-    type;
-    messageId;
-    recipient;
-    timestampMs;
-    deleted;
-    constructor(id, type, messageId, recipient, timestampMs, deleted = false) {
-        this.id = id;
-        this.type = type;
-        this.messageId = messageId;
-        this.recipient = recipient;
-        this.timestampMs = timestampMs;
-        this.deleted = deleted;
-    }
-}
-exports.MailEvent = MailEvent;

package/core/server/services/mail-events/MailEvent.ts

@@ -1,10 +0,0 @@
-export class MailEvent {
-    constructor(
-        readonly id: string,
-        readonly type: string,
-        readonly messageId: string,
-        readonly recipient: string,
-        readonly timestampMs: number,
-        readonly deleted: boolean = false
-    ) {}
-}

package/core/server/services/mail-events/MailEventRepository.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/core/server/services/mail-events/MailEventRepository.ts

@@ -1,5 +0,0 @@
-import {MailEvent} from './MailEvent';
-
-export interface MailEventRepository {
-    save(event: MailEvent): Promise<void>;
-}

package/core/server/services/mail-events/MailEventService.js

@@ -1,124 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailEventService = void 0;
-const crypto_1 = __importDefault(require("crypto"));
-const errors_1 = __importDefault(require("@tryghost/errors"));
-const tpl_1 = __importDefault(require("@tryghost/tpl"));
-const MailEvent_1 = require("./MailEvent");
-/**
- * @see https://documentation.mailgun.com/en/latest/user_manual.html#events-1
- */
-var EventType;
-(function (EventType) {
-    EventType["CLICKED"] = "clicked";
-    EventType["COMPLAINED"] = "complained";
-    EventType["DELIVERED"] = "delivered";
-    EventType["FAILED"] = "failed";
-    EventType["OPENED"] = "opened";
-    EventType["UNSUBSCRIBED"] = "unsubscribed";
-})(EventType || (EventType = {}));
-const VALIDATION_MESSAGES = {
-    signingKeyNotConfigured: 'payload signing key is not configured',
-    payloadSignatureMissing: 'Payload is missing "signature"',
-    payloadSignatureInvalid: '"signature" is invalid',
-    payloadEventsMissing: 'Payload is missing "mail_events"',
-    payloadEventsInvalid: '"mail_events" is not an array',
-    payloadEventKeyMissing: 'Event [{idx}] is missing "{key}"'
-};
-class MailEventService {
-    mailEventRepository;
-    config;
-    labs;
-    static LABS_KEY = 'mailEvents';
-    static CONFIG_KEY_PAYLOAD_SIGNING_KEY = 'hostSettings:mailEventsPayloadSigningKey';
-    constructor(mailEventRepository, config, labs) {
-        this.mailEventRepository = mailEventRepository;
-        this.config = config;
-        this.labs = labs;
-    }
-    async processPayload(payload) {
-        if (this.labs.isSet(MailEventService.LABS_KEY) === false) {
-            throw new errors_1.default.NotFoundError();
-        }
-        const payloadSigningKey = this.config.get(MailEventService.CONFIG_KEY_PAYLOAD_SIGNING_KEY);
-        // Verify that the service is configured correctly - We expect a string
-        // for the payload signing key but as a safeguard we check the type here
-        // to prevent any unexpected behaviour
-        if (typeof payloadSigningKey !== 'string') {
-            throw new errors_1.default.InternalServerError({
-                message: (0, tpl_1.default)(VALIDATION_MESSAGES.signingKeyNotConfigured)
-            });
-        }
-        // Verify the payload
-        this.verifyPayload(payload, payloadSigningKey);
-        // Store known events
-        const eventTypes = new Set(Object.values(EventType));
-        for (const payloadEvent of payload.mail_events) {
-            if (eventTypes.has(payloadEvent.event) === false) {
-                continue;
-            }
-            try {
-                await this.mailEventRepository.save(new MailEvent_1.MailEvent(payloadEvent.id, payloadEvent.event, payloadEvent.message.headers['message-id'], payloadEvent.recipient, payloadEvent.timestamp * 1000));
-            }
-            catch (err) {
-                throw new errors_1.default.InternalServerError({
-                    message: 'Event could not be stored',
-                    err: err
-                });
-            }
-        }
-    }
-    validatePayload(payload) {
-        if (payload.signature === undefined) {
-            throw new errors_1.default.ValidationError({
-                message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadSignatureMissing)
-            });
-        }
-        if (typeof payload.signature !== 'string') {
-            throw new errors_1.default.ValidationError({
-                message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadSignatureInvalid)
-            });
-        }
-        if (payload.mail_events === undefined) {
-            throw new errors_1.default.ValidationError({
-                message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadEventsMissing)
-            });
-        }
-        if (Array.isArray(payload.mail_events) === false) {
-            throw new errors_1.default.ValidationError({
-                message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadEventsInvalid)
-            });
-        }
-        const expectedKeys = ['id', 'timestamp', 'event', 'message', 'recipient'];
-        payload.mail_events.forEach((payloadEvent, idx) => {
-            expectedKeys.forEach((key) => {
-                if (payloadEvent[key] === undefined) {
-                    throw new errors_1.default.ValidationError({
-                        message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadEventKeyMissing, { idx, key })
-                    });
-                }
-                if (key === 'message' && payloadEvent.message.headers?.['message-id'] === undefined) {
-                    throw new errors_1.default.ValidationError({
-                        message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadEventKeyMissing, { idx, key: 'message.headers.message-id' })
-                    });
-                }
-            });
-        });
-    }
-    verifyPayload(payload, payloadSigningKey) {
-        const data = JSON.stringify(payload.mail_events);
-        const signature = crypto_1.default
-            .createHmac('sha256', payloadSigningKey)
-            .update(data)
-            .digest('hex');
-        if (signature !== payload.signature) {
-            throw new errors_1.default.UnauthorizedError({
-                message: (0, tpl_1.default)(VALIDATION_MESSAGES.payloadSignatureInvalid)
-            });
-        }
-    }
-}
-exports.MailEventService = MailEventService;

package/core/server/services/mail-events/MailEventService.ts

@@ -1,169 +0,0 @@
-import crypto from 'crypto';
-import errors from '@tryghost/errors';
-import tpl from '@tryghost/tpl';
-
-import {MailEvent} from './MailEvent';
-import {MailEventRepository} from './MailEventRepository';
-
-/**
- * @see https://documentation.mailgun.com/en/latest/user_manual.html#events-1
- */
-enum EventType { // eslint-disable-line no-shadow
-    CLICKED = 'clicked',
-    COMPLAINED = 'complained',
-    DELIVERED = 'delivered',
-    FAILED = 'failed',
-    OPENED = 'opened',
-    UNSUBSCRIBED = 'unsubscribed'
-}
-
-interface PayloadEvent {
-    id: string;
-    timestamp: number; // Unix timestamp in seconds
-    event: string;
-    message: {
-        headers: {
-            'message-id': string;
-        }
-    },
-    recipient: string;
-}
-
-interface Payload {
-    signature: string;
-    mail_events: PayloadEvent[];
-}
-
-interface Labs {
-    isSet(key: string): boolean;
-}
-
-interface Config {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    get(key: string): any;
-}
-
-const VALIDATION_MESSAGES = {
-    signingKeyNotConfigured: 'payload signing key is not configured',
-    payloadSignatureMissing: 'Payload is missing "signature"',
-    payloadSignatureInvalid: '"signature" is invalid',
-    payloadEventsMissing: 'Payload is missing "mail_events"',
-    payloadEventsInvalid: '"mail_events" is not an array',
-    payloadEventKeyMissing: 'Event [{idx}] is missing "{key}"'
-};
-
-export class MailEventService {
-    static readonly LABS_KEY = 'mailEvents';
-    static readonly CONFIG_KEY_PAYLOAD_SIGNING_KEY = 'hostSettings:mailEventsPayloadSigningKey';
-
-    constructor(
-        private mailEventRepository: MailEventRepository,
-        private config: Config,
-        private labs: Labs
-    ) {}
-
-    async processPayload(payload: Payload) {
-        if (this.labs.isSet(MailEventService.LABS_KEY) === false) {
-            throw new errors.NotFoundError();
-        }
-
-        const payloadSigningKey = this.config.get(MailEventService.CONFIG_KEY_PAYLOAD_SIGNING_KEY);
-
-        // Verify that the service is configured correctly - We expect a string
-        // for the payload signing key but as a safeguard we check the type here
-        // to prevent any unexpected behaviour
-        if (typeof payloadSigningKey !== 'string') {
-            throw new errors.InternalServerError({
-                message: tpl(VALIDATION_MESSAGES.signingKeyNotConfigured)
-            });
-        }
-
-        // Verify the payload
-        this.verifyPayload(payload, payloadSigningKey);
-
-        // Store known events
-        const eventTypes = new Set<string>(Object.values(EventType) as string[]);
-
-        for (const payloadEvent of payload.mail_events) {
-            if (eventTypes.has(payloadEvent.event) === false) {
-                continue;
-            }
-
-            try {
-                await this.mailEventRepository.save(
-                    new MailEvent(
-                        payloadEvent.id,
-                        payloadEvent.event,
-                        payloadEvent.message.headers['message-id'],
-                        payloadEvent.recipient,
-                        payloadEvent.timestamp * 1000
-                    )
-                );
-            } catch (err) {
-                throw new errors.InternalServerError({
-                    message: 'Event could not be stored',
-                    err: err
-                });
-            }
-        }
-    }
-
-    validatePayload(payload: Payload) {
-        if (payload.signature === undefined) {
-            throw new errors.ValidationError({
-                message: tpl(VALIDATION_MESSAGES.payloadSignatureMissing)
-            });
-        }
-
-        if (typeof payload.signature !== 'string') {
-            throw new errors.ValidationError({
-                message: tpl(VALIDATION_MESSAGES.payloadSignatureInvalid)
-            });
-        }
-
-        if (payload.mail_events === undefined) {
-            throw new errors.ValidationError({
-                message: tpl(VALIDATION_MESSAGES.payloadEventsMissing)
-            });
-        }
-
-        if (Array.isArray(payload.mail_events) === false) {
-            throw new errors.ValidationError({
-                message: tpl(VALIDATION_MESSAGES.payloadEventsInvalid)
-            });
-        }
-
-        const expectedKeys: (keyof PayloadEvent)[] = ['id', 'timestamp', 'event', 'message', 'recipient'];
-
-        payload.mail_events.forEach((payloadEvent, idx) => {
-            expectedKeys.forEach((key) => {
-                if (payloadEvent[key] === undefined) {
-                    throw new errors.ValidationError({
-                        message: tpl(VALIDATION_MESSAGES.payloadEventKeyMissing, {idx, key})
-                    });
-                }
-
-                if (key === 'message' && payloadEvent.message.headers?.['message-id'] === undefined) {
-                    throw new errors.ValidationError({
-                        message: tpl(VALIDATION_MESSAGES.payloadEventKeyMissing, {idx, key: 'message.headers.message-id'})
-                    });
-                }
-            });
-        });
-    }
-
-    private verifyPayload(payload: Payload, payloadSigningKey: string) {
-        const data = JSON.stringify(payload.mail_events);
-
-        const signature = crypto
-            .createHmac('sha256', payloadSigningKey)
-            .update(data)
-            .digest('hex');
-
-        if (signature !== payload.signature) {
-            throw new errors.UnauthorizedError({
-                message: tpl(VALIDATION_MESSAGES.payloadSignatureInvalid)
-            });
-        }
-    }
-}

package/core/server/services/mail-events/index.js

@@ -1,21 +0,0 @@
-const {MailEventService} = require('./MailEventService');
-const MailEventRepository = require('./BookshelfMailEventRepository.js');
-
-class MailEventsServiceWrapper {
-    /**
-     * @type {MailEventService}
-     */
-    service;
-
-    async init() {
-        const config = require('../../../shared/config');
-        const labs = require('../../../shared/labs');
-        const models = require('../../models');
-
-        const repository = new MailEventRepository(models.MailEvent);
-
-        this.service = new MailEventService(repository, config, labs);
-    }
-}
-
-module.exports = new MailEventsServiceWrapper();

package/core/server/services/mail-events/libraries.d.ts

@@ -1,2 +0,0 @@
-declare module '@tryghost/errors';
-declare module '@tryghost/tpl';