ghost/core/server/services/members/jobs/clean-expired-comped.js

The professional publishing platform

const {parentPort} = require('worker_threads');
const ObjectId = require('bson-objectid').default;
const {chunk: chunkArray} = require('lodash');
const debug = require('@tryghost/debug')('jobs:clean-expired-comped');
const moment = require('moment');

// recurring job to clean expired complimentary subscriptions

// Exit early when cancelled to prevent stalling shutdown. No cleanup needed when cancelling as everything is idempotent and will pick up
// where it left off on next run
function cancel() {
    if (parentPort) {
        parentPort.postMessage('Expired complimentary subscriptions cleanup cancelled before completion');
        parentPort.postMessage('cancelled');
    } else {
        setTimeout(() => {
            process.exit(0);
        }, 1000);
    }
}

if (parentPort) {
    parentPort.once('message', (message) => {
        if (message === 'cancel') {
            return cancel();
        }
    });
}

(async () => {
    const cleanupStartDate = new Date();
    const db = require('../../../data/db');
    debug(`Starting cleanup of expired comp subscriptions`);
    const expiredCompedRows = await db.knex('members_products')
        .where('expiry_at', '<', moment.utc().startOf('day').toISOString())
        .select('*');

    let deletedExpiredSubs = 0;
    let updatedMembers = 0;

    // Run cleanup for expired comp subscriptions
    // Removes expired comped entries from members_products table
    // Updates affected members status to free from comped
    // Adds member status event for going from comped to free
    if (expiredCompedRows?.length) {
        const rowIds = expiredCompedRows.map(d => d.id);
        const memberIds = expiredCompedRows.map(d => d.member_id);

        // Delete all expired comped rows
        deletedExpiredSubs = await db.knex('members_products')
            .whereIn('id', rowIds)
            .del();

        // fetch all comped members to update
        const membersToUpdate = await db.knex('members')
            .whereIn('id', memberIds)
            .andWhere('status', 'comped');

        const updateMemberIds = membersToUpdate.map(d => d.id);

        // Update all comped members to free
        updatedMembers = await db.knex('members')
            .whereIn('id', updateMemberIds)
            .update({
                status: 'free'
            });

        const statusEvents = membersToUpdate.map((member) => {
            const now = db.knex.raw('CURRENT_TIMESTAMP');

            return {
                id: ObjectId().toHexString(),
                member_id: member.id,
                from_status: member.status,
                to_status: 'free',
                created_at: now
            };
        });

        // SQLite >= 3.32.0 can support 32766 host parameters
        // each row uses 5 variables so ⌊32766/5⌋ = 6553
        const chunkSize = 6553;

        const chunks = chunkArray(statusEvents, chunkSize);

        // Adds status event for members going comped->free
        for (const chunk of chunks) {
            await db.knex('members_status_events').insert(chunk);
        }
    }

    let cleanupEndDate = new Date();

    debug(`Removed ${deletedExpiredSubs} expired subscriptions, updated ${updatedMembers} members in ${cleanupEndDate.valueOf() - cleanupStartDate.valueOf()}ms`);

    if (parentPort) {
        parentPort.postMessage(`Removed ${deletedExpiredSubs} expired subscriptions, updated ${updatedMembers} members in ${cleanupEndDate.valueOf() - cleanupStartDate.valueOf()}ms`);
        parentPort.postMessage('done');
    } else {
        // give the logging pipes time finish writing before exit
        setTimeout(() => {
            process.exit(0);
        }, 1000);
    }
})();