trash-cleaner/lib/reporter/console-progress-reporter.js

Finds and deletes trash email in the mailbox

const ora = require('ora');
const { ProgressReporter } = require('./progress-reporter');

/**
 * A progress reporter that prints the progress on console.
 */
class ConsoleProgressReporter extends ProgressReporter {

    /**
     * Creates an instance of ConsoleProgressReporter.
     *
     * @param {boolean} cliMode Indicates if an interactive CLI mode is on.
     */
    constructor(cliMode) {
        super();

        if (cliMode) {
            this._spinner = ora();
            this._spinner.interval = 250;
        }
    }

    /**
     * An event that fires when cleaning has started.
     * 
     * @param {boolean} dryRun Do a dry-run cleanup without deleting emails.
     */
    onStart(dryRun) {
        if (this._spinner) {
            this._spinner.start('Starting cleaning...');
        }
        this._dryRun = dryRun;
        this._trashEmails = [];
        this._unreadEmailCount = 0;
    }

    /**
     * An event that fires when unread emails are being retrieved.
     */
    onRetrievingUnreadEmails() {
        this._update('Retrieving emails...');
    }

    /**
     * An event that fires when unread emails are retrieved.
     *
     * @param {Email[]} emails The list of unread emails.
     */
    onUnreadEmailsRetrieved(emails) {
        this._unreadEmailCount = emails.length;
        this._update(`Retrieved ${emails.length} emails.`);
    }

    /**
     * An event that fires when trash emails are identified.
     *
     * @param {Email[]} emails The list of trash emails.
     */
    onTrashEmailsIdentified(emails) {
        this._trashEmails = emails;
        this._update(`Found ${emails.length} trash emails.`);
    }

    /**
     * An event that fires when trash emails are being deleted.
     */
    onDeletingTrash() {
        this._update('Deleting trash emails...');
    }

    /**
     * An event that fires when trash emails are deleted.
     */
    onTrashDeleted() {
        this._update(`Trash emails${this._dryRun ? ' not' : ''} deleted.`);
    }

    /**
     * An event that fires when cleaning has stopped.
     */
    onStop() {
        if (this._spinner) {
            this._spinner.stop();
        }
        this._logTrashEmails();
        this._printSummary();
    }

    /**
     * Prints the summary of the cleanup operation.
     */
    _printSummary() {
        this._log(`Total no. of unread emails: ${this._unreadEmailCount}`);
        this._log(`Total no. of trash emails: ${this._trashEmails.length}`);
        if (this._dryRun) {
            this._log('');
            this._log(`Emails not deleted in dry-run mode.`)
        }
    }

    /**
     * Logs the trash emails to console.
     */
    _logTrashEmails() {
        if (this._trashEmails.length > 0) {
            this._trashEmails.forEach(this._logEmail.bind(this));
        }
    }

    /**
     * Shows an update message.
     *
     * @param {string} message The update message.
     */
    _update(message) {
        if (this._spinner) {
            this._spinner.text = message;
        }
    }

    /**
     * Logs the key properties of an email to the console.
     *
     * @param {Email} email The email to log.
     */
    _logEmail(email) {
        this._log(`From: ${email.from}`);
        this._log(`Labels: ${email.labels}`);
        this._log(`Subject: ${email.subject}`);
        this._log(`Snippet: ${email.snippet}`);
        this._log(`Body: ${email.body}`);
        this._log('-'.repeat(60));
    }

    /**
     * Logs the message to console.
     * 
     * @param {string} message The message to log.
     */
    _log(message) {
        console.log(message);
    }
}

module.exports = { ConsoleProgressReporter };