purge_expired_tokens.js

#!/usr/bin/env node

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This is a command line tool that can be used to purge expired tokens
 * from the OAuth database. It requires you specify a pocket client id
 * before running. Currently, access tokens created from pocket should
 * not be deleted even if expired.
 *
 * Example usage:
 *
 * node purge_expired_tokens.js --config dev --pocket-id dcdb5ae7add825d2 --token-count 10000 --delay-seconds 1
 *
 * or, for multiple pocket ids:
 *
 * node purge_expired_tokens.js --config dev --pocket-id dcdb5ae7add825d2,678f75ae1c0f8002 --token-count 10000 --delay-seconds 1
 *
 * */

const config = require('../lib/config');
const package = require('../package.json');
const program = require('commander');

// Don't bother updating the clients table.
config.set('db.autoUpdateClients', false);

program
  .version(package.version)
  .option('-c, --config [config]', 'Configuration to use. Ex. dev')
  .option('-p, --pocket-id <pocketId>', 'Pocket Client Ids. These tokens will not be purged. (CSV)')
  .option('-t, --token-count <tokenCount>', 'Number of tokens to delete.')
  .option('-d, --delay-seconds <delaySeconds>', 'Delay (seconds) between each deletion round. (Default: 1 second)')
  .parse(process.argv);

program.parse(process.argv);

if (! program.config) {
  program.config = 'dev';
}

process.env.NODE_ENV = program.config;

const db = require('../lib/db');
const logger = require('../lib/logging')('bin.purge_expired_tokens');

if (! program.pocketId) {
  logger.error('invalid', { message: 'Required pocket client id!' });
  process.exit(1);
}

const numberOfTokens = parseInt(program.tokenCount) || 200;
const delaySeconds = Number(program.delaySeconds) || 1; // Default 1 seconds
// There may be more than one pocketId, so treat this as a comma-separated list.
const ignorePocketClientId = program.pocketId.split(/\s*,\s*/g);

db.ping().done(function() {
  // Only mysql impl supports token deletion at the moment
  if (db.purgeExpiredTokens) {
    logger.info('deleting', {
      numberOfTokens: numberOfTokens,
      delaySeconds: delaySeconds,
      ignorePocketClientId: ignorePocketClientId
    });

    // To reduce the risk of deleting pocket tokens, ensure that the pocket-id
    // passed in belongs to a client.
    return db.purgeExpiredTokens(numberOfTokens, delaySeconds, ignorePocketClientId)
      .then(function () {
        logger.info('completed');
        process.exit(0);
      })
      .catch(function (err) {
        logger.error('error', err);
        process.exit(1);
      });
  } else {
    var message = 'Unable to purge expired tokens, only available ' +
      'when using config with mysql database.';
    logger.info('skipping', { message: message });
  }
}, function(err) {
  logger.critical('db.ping', err);
  process.exit(1);
});

process.on('uncaughtException', function (err) {
  logger.error('error', err);
  process.exit(2);
});