zapier-platform-cli/lib/commands/migrate.js

The CLI for apps in the Zapier Developer Platform.

'use strict';

var utils = require('../utils');

var migrate = function migrate(context, fromVersion, toVersion) {
  var optionalPercent = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '100%';

  if (!toVersion) {
    context.line('Must provide both old and new version like `zapier migrate 1.0.0 1.0.1`.');
    return Promise.resolve();
  }
  optionalPercent = parseInt(optionalPercent, 10);
  return utils.getLinkedApp().then(function (app) {
    context.line('Getting ready to migrate your app "' + app.title + '" from ' + fromVersion + ' to ' + toVersion + '.\n');
    utils.printStarting('Starting migration from ' + fromVersion + ' to ' + toVersion + ' for ' + optionalPercent + '%');
    return utils.callAPI('/apps/' + app.id + '/versions/' + fromVersion + '/migrate-to/' + toVersion, {
      method: 'POST',
      body: {
        percent: optionalPercent
      }
    });
  }).then(function () {
    utils.printDone();
    context.line('\nMigration successfully queued, please check `zapier history` to track the status. Normal migrations take between 5-10 minutes.');
  });
};
migrate.argsSpec = [{ name: 'fromVersion', example: '1.0.0', required: true, help: 'the version **from** which to migrate users' }, { name: 'toVersion', example: '1.0.1', required: true, help: 'the version **to** which to migrate users' }, { name: 'percent', example: '100%', default: '100%', help: 'percent of users to migrate' }];
migrate.argOptsSpec = {};
migrate.help = 'Migrate users from one version of your app to another.';
migrate.example = 'zapier migrate 1.0.0 1.0.1 [10%]';
migrate.docs = '\nStarts a migration to move users between different versions of your app. You may also "revert" by simply swapping the from/to verion strings in the command line arguments (IE: `zapier migrate 1.0.1 1.0.0`).\n\nOnly migrate users between non-breaking versions, use `zapier deprecate` if you have breaking changes!\n\nMigrations can take between 5-10 minutes, so be patient and check `zapier history` to track the status\n\nNote: since a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.\n\n> Tip! We recommend migrating a small subset of users first, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.\n\n**Arguments**\n\n' + utils.argsFragment(migrate.argsSpec) + '\n' + utils.argOptsFragment(migrate.argOptsSpec) + '\n\n' + '```' + 'bash\n$ zapier migrate 1.0.0 1.0.1 15%\n# Getting ready to migrate your app "Example" from 1.0.0 to 1.0.1.\n#\n#   Starting migration from 1.0.0 to 1.0.1 for 15% - done!\n#\n# Migration successfully queued, please check `zapier history` to track the status. Normal migrations take between 5-10 minutes.\n' + '```' + '\n';

module.exports = migrate;