prototyping idea for mass-migration

Author: rnegron

docs/cli.html

@@ -798,19 +798,21 @@ <h2 id="migrate">migrate</h2>
 </li>
 <li><p>The integration auth used is not shared.</p>
 </li>
-</ul><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 --account=account@example.com</code>). This will migrate all users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p><strong>Arguments</strong></p><ul>
+</ul><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 --account=account@example.com</code>). This will migrate all users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p>When you , you can also pass the <code>--include-all-compatible-versions</code> flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with <code>fromVersion</code> set to 1.2.0 and use the <code>--include-all-compatible-versions</code> flag.</p><p><strong>The <code>--include-all-compatible-versions</code> flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.</strong></p><p><strong>Arguments</strong></p><ul>
 <li>(required) <code>fromVersion</code> | The version FROM which to migrate users.</li>
 <li>(required) <code>toVersion</code> | The version TO which to migrate users.</li>
 <li><code>percent</code> | Percentage (between 1 and 100) of users to migrate.</li>
 </ul><p><strong>Flags</strong></p><ul>
 <li><code>--user</code> | Migrates all of a users&apos; Private Zaps within all accounts for which the specified user is a member</li>
 <li><code>--account</code> | Migrates all of a users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member</li>
+<li><code>--includeAllCompatibleVersions</code> | Schedules the migration of other compatible versions besides the &apos;fromVersion&apos;, if any are available. Compatible versions are those that are older than the &apos;fromVersion&apos; but still share the same major version number as the &apos;fromVersion&apos;.</li>
 <li><code>-d, --debug</code> | Show extra debugging output.</li>
 </ul><p><strong>Examples</strong></p><ul>
 <li><code>zapier migrate 1.0.0 1.0.1</code></li>
 <li><code>zapier migrate 1.0.1 2.0.0 10</code></li>
 <li><code>zapier migrate 2.0.0 2.0.1 --user=user@example.com</code></li>
 <li><code>zapier migrate 2.0.0 2.0.1 --account=account@example.com</code></li>
+<li><code>zapier migrate 2.4.0 2.5.0 --include-all-compatible-versions</code></li>
 </ul>
     </div>
     <div class="col-md-7 col-sm-12 col-height is-empty docs-code">

docs/cli.md

@@ -368,6 +368,10 @@ You cannot pass both `PERCENT` and `--user` or `--account`.
 
 You cannot pass both `--user` and `--account`.
 
+When you , you can also pass the `--include-all-compatible-versions` flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with `fromVersion` set to 1.2.0 and use the `--include-all-compatible-versions` flag.
+
+**The `--include-all-compatible-versions` flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.**
+
 **Arguments**
 * (required) `fromVersion` | The version FROM which to migrate users.
 * (required) `toVersion` | The version TO which to migrate users.
@@ -376,13 +380,15 @@ You cannot pass both `--user` and `--account`.
 **Flags**
 * `--user` | Migrates all of a users' Private Zaps within all accounts for which the specified user is a member
 * `--account` | Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member
+* `--includeAllCompatibleVersions` | Schedules the migration of other compatible versions besides the 'fromVersion', if any are available. Compatible versions are those that are older than the 'fromVersion' but still share the same major version number as the 'fromVersion'.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**
 * `zapier migrate 1.0.0 1.0.1`
 * `zapier migrate 1.0.1 2.0.0 10`
 * `zapier migrate 2.0.0 2.0.1 --user=user@example.com`
 * `zapier migrate 2.0.0 2.0.1 --account=account@example.com`
+* `zapier migrate 2.4.0 2.5.0 --include-all-compatible-versions`
 
 
 ## promote

packages/cli/docs/cli.html

@@ -798,19 +798,21 @@ <h2 id="migrate">migrate</h2>
 </li>
 <li><p>The integration auth used is not shared.</p>
 </li>
-</ul><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 --account=account@example.com</code>). This will migrate all users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p><strong>Arguments</strong></p><ul>
+</ul><p>Alternatively, you can pass the <code>--account</code> flag, (i.e. <code>zapier migrate 1.0.0 1.0.1 --account=account@example.com</code>). This will migrate all users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member.</p><p><strong>The <code>--account</code> flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.</strong></p><p>You cannot pass both <code>PERCENT</code> and <code>--user</code> or <code>--account</code>.</p><p>You cannot pass both <code>--user</code> and <code>--account</code>.</p><p>When you , you can also pass the <code>--include-all-compatible-versions</code> flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with <code>fromVersion</code> set to 1.2.0 and use the <code>--include-all-compatible-versions</code> flag.</p><p><strong>The <code>--include-all-compatible-versions</code> flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.</strong></p><p><strong>Arguments</strong></p><ul>
 <li>(required) <code>fromVersion</code> | The version FROM which to migrate users.</li>
 <li>(required) <code>toVersion</code> | The version TO which to migrate users.</li>
 <li><code>percent</code> | Percentage (between 1 and 100) of users to migrate.</li>
 </ul><p><strong>Flags</strong></p><ul>
 <li><code>--user</code> | Migrates all of a users&apos; Private Zaps within all accounts for which the specified user is a member</li>
 <li><code>--account</code> | Migrates all of a users&apos; Zaps, Private &amp; Shared, within all accounts for which the specified user is a member</li>
+<li><code>--includeAllCompatibleVersions</code> | Schedules the migration of other compatible versions besides the &apos;fromVersion&apos;, if any are available. Compatible versions are those that are older than the &apos;fromVersion&apos; but still share the same major version number as the &apos;fromVersion&apos;.</li>
 <li><code>-d, --debug</code> | Show extra debugging output.</li>
 </ul><p><strong>Examples</strong></p><ul>
 <li><code>zapier migrate 1.0.0 1.0.1</code></li>
 <li><code>zapier migrate 1.0.1 2.0.0 10</code></li>
 <li><code>zapier migrate 2.0.0 2.0.1 --user=user@example.com</code></li>
 <li><code>zapier migrate 2.0.0 2.0.1 --account=account@example.com</code></li>
+<li><code>zapier migrate 2.4.0 2.5.0 --include-all-compatible-versions</code></li>
 </ul>
     </div>
     <div class="col-md-7 col-sm-12 col-height is-empty docs-code">

packages/cli/docs/cli.md

@@ -368,6 +368,10 @@ You cannot pass both `PERCENT` and `--user` or `--account`.
 
 You cannot pass both `--user` and `--account`.
 
+When you , you can also pass the `--include-all-compatible-versions` flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with `fromVersion` set to 1.2.0 and use the `--include-all-compatible-versions` flag.
+
+**The `--include-all-compatible-versions` flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.**
+
 **Arguments**
 * (required) `fromVersion` | The version FROM which to migrate users.
 * (required) `toVersion` | The version TO which to migrate users.
@@ -376,13 +380,15 @@ You cannot pass both `--user` and `--account`.
 **Flags**
 * `--user` | Migrates all of a users' Private Zaps within all accounts for which the specified user is a member
 * `--account` | Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member
+* `--includeAllCompatibleVersions` | Schedules the migration of other compatible versions besides the 'fromVersion', if any are available. Compatible versions are those that are older than the 'fromVersion' but still share the same major version number as the 'fromVersion'.
 * `-d, --debug` | Show extra debugging output.
 
 **Examples**
 * `zapier migrate 1.0.0 1.0.1`
 * `zapier migrate 1.0.1 2.0.0 10`
 * `zapier migrate 2.0.0 2.0.1 --user=user@example.com`
 * `zapier migrate 2.0.0 2.0.1 --account=account@example.com`
+* `zapier migrate 2.4.0 2.5.0 --include-all-compatible-versions`
 
 
 ## promote

packages/cli/src/oclif/commands/migrate.js

@@ -2,7 +2,8 @@ const { flags } = require('@oclif/command');
 
 const BaseCommand = require('../ZapierBaseCommand');
 const PromoteCommand = require('./promote');
-const { callAPI } = require('../../utils/api');
+const { callAPI, listVersions } = require('../../utils/api');
+const { isVersionCompatible } = require('../../utils/semver-compatibility');
 const { buildFlags } = require('../buildFlags');
 
 class MigrateCommand extends BaseCommand {
@@ -16,6 +17,9 @@ class MigrateCommand extends BaseCommand {
     const user = this.flags.user;
     const fromVersion = this.args.fromVersion;
     const toVersion = this.args.toVersion;
+    const includeAllCompatibleVersions =
+      this.flags.includeAllCompatibleVersions;
+
     let flagType;
 
     if (user || account) {
@@ -36,6 +40,23 @@ class MigrateCommand extends BaseCommand {
 
     const app = await this.getWritableApp();
 
+    // `versionsToMigrate` should at least include the user-specified `fromVersion`
+    const versionsToMigrate = [fromVersion];
+
+    // If the `--include-all-compatible-versions` flag is active,we fetch all available
+    // versions, filter for which are compatible and then add them to `versionsToMigrate`
+    if (includeAllCompatibleVersions) {
+      const { versions } = await listVersions();
+      const versionStrings = versions.map((v) => v.version);
+      const compatibleVersions = versionStrings.filter((v) =>
+        isVersionCompatible({ versionCurrent: v, versionGoal: toVersion })
+      );
+
+      if (compatibleVersions.length > 0) {
+        versionsToMigrate.push(...compatibleVersions);
+      }
+    }
+
     let promoteFirst = false;
     if (
       percent === 100 &&
@@ -61,37 +82,44 @@ class MigrateCommand extends BaseCommand {
     const body = {
       job: {
         name: 'migrate',
-        from_version: fromVersion,
         to_version: toVersion,
         email: user || account,
         email_type: flagType,
       },
     };
-    if (user || account) {
-      this.startSpinner(
-        `Starting migration from ${fromVersion} to ${toVersion} for ${
-          user || account
-        }`
-      );
-    } else {
-      this.startSpinner(
-        `Starting migration from ${fromVersion} to ${toVersion} for ${percent}%`
-      );
-    }
+
     if (percent) {
       body.job.percent_human = percent;
     }
 
     const url = `/apps/${app.id}/migrations`;
 
-    try {
-      await callAPI(url, { method: 'POST', body });
-    } finally {
-      this.stopSpinner();
+    for (const version of versionsToMigrate) {
+      body.job.from_version = version;
+
+      if (user || account) {
+        this.startSpinner(
+          `Starting migration from ${fromVersion} to ${toVersion} for ${
+            user || account
+          }`
+        );
+      } else {
+        this.startSpinner(
+          `Starting migration from ${fromVersion} to ${toVersion} for ${percent}%`
+        );
+      }
+
+      try {
+        await callAPI(url, { method: 'POST', body });
+      } catch (err) {
+        this.error(err);
+      } finally {
+        this.stopSpinner();
+      }
     }
 
     this.log(
-      '\nMigration successfully queued, please check `zapier jobs` to track the status. Migrations usually take between 5-10 minutes.'
+      '\nMigration(s) successfully queued, please check `zapier jobs` to track their status. Migrations usually take between 5-10 minutes.'
     );
   }
 }
@@ -106,6 +134,10 @@ MigrateCommand.flags = buildFlags({
       description:
         "Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member",
     }),
+    includeAllCompatibleVersions: flags.string({
+      description:
+        "Schedules the migration of other compatible versions besides the 'fromVersion', if any are available. Compatible versions are those that are older than the 'fromVersion' but still share the same major version number as the 'fromVersion'.",
+    }),
   },
 });
 
@@ -134,6 +166,7 @@ MigrateCommand.examples = [
   'zapier migrate 1.0.1 2.0.0 10',
   'zapier migrate 2.0.0 2.0.1 --user=user@example.com',
   'zapier migrate 2.0.0 2.0.1 --account=account@example.com',
+  'zapier migrate 2.4.0 2.5.0 --include-all-compatible-versions',
 ];
 MigrateCommand.description = `Migrate a percentage of users or a single user from one version of your integration to another.
 
@@ -159,6 +192,11 @@ Alternatively, you can pass the \`--account\` flag, (i.e. \`zapier migrate 1.0.0
 
 You cannot pass both \`PERCENT\` and \`--user\` or \`--account\`.
 
-You cannot pass both \`--user\` and \`--account\`.`;
+You cannot pass both \`--user\` and \`--account\`.
+
+When you , you can also pass the \`--include-all-compatible-versions\` flag to migrate all older compatible versions of the integration. For example, if you have versions 1.0.0, 1.1.0 and 1.2.0 which you would like to migrate to version 2.0.0, you can run the migrate command with \`fromVersion\` set to 1.2.0 and use the \`--include-all-compatible-versions\` flag.
+
+**The \`--include-all-compatible-versions\` flag should be used cautiously as it is a bulk operation that will possibly affect more than just one version. It also only supports forward migrations; rolling back to a previous version would require individual migrations.**
+`;
 
 module.exports = MigrateCommand;

packages/cli/src/utils/semver-compatibility.js

@@ -0,0 +1,16 @@
+const semver = require('semver');
+
+function isVersionCompatible({ versionCurrent, versionGoal }) {
+  // First, check if both versions have the same major version
+  if (semver.major(versionGoal) !== semver.major(versionCurrent)) {
+    return false;
+  }
+
+  // Create a range that represents all versions less than or equal to 'versionGoal'
+  const versionRange = `<=${versionGoal}`;
+
+  // Check if 'versionCurrent' falls within this range
+  return semver.satisfies(versionCurrent, versionRange);
+}
+
+module.exports = { isVersionCompatible };