zapier-platform-cli 16.2.0 → 16.3.0

package/oclif.manifest.json

@@ -1061,6 +1061,13 @@
           "name": "invokedFromAnotherCommand",
           "allowNo": false,
           "type": "boolean"
+        },
+        "overwrite-partner-changes": {
+          "description": "(Internal Use Only) Allows Zapier Staff to push changes to integrations in certain situations.",
+          "hidden": true,
+          "name": "overwrite-partner-changes",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -1533,169 +1540,6 @@
         "clear.js"
       ]
     },
-    "canary:create": {
-      "aliases": [],
-      "args": {
-        "versionFrom": {
-          "description": "Version to route traffic from",
-          "name": "versionFrom",
-          "required": true
-        },
-        "versionTo": {
-          "description": "Version to canary traffic to",
-          "name": "versionTo",
-          "required": true
-        }
-      },
-      "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
-      "examples": [
-        "zapier canary:create 1.0.0 1.1.0 -p 25 -d 720",
-        "zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"
-      ],
-      "flags": {
-        "percent": {
-          "char": "p",
-          "description": "Percent of traffic to route to new version",
-          "name": "percent",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "duration": {
-          "char": "d",
-          "description": "Duration of the canary in seconds",
-          "name": "duration",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "canary:create",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "canary",
-        "create.js"
-      ]
-    },
-    "canary:delete": {
-      "aliases": [],
-      "args": {
-        "versionFrom": {
-          "description": "Version to route traffic from",
-          "name": "versionFrom",
-          "required": true
-        },
-        "versionTo": {
-          "description": "Version canary traffic is routed to",
-          "name": "versionTo",
-          "required": true
-        }
-      },
-      "description": "Delete an active canary deployment",
-      "examples": [
-        "zapier canary:delete 1.0.0 1.1.0"
-      ],
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "canary:delete",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "canary",
-        "delete.js"
-      ]
-    },
-    "canary:list": {
-      "aliases": [],
-      "args": {},
-      "description": "List all active canary deployments",
-      "examples": [
-        "zapier canary:list"
-      ],
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "format": {
-          "char": "f",
-          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "plain",
-            "json",
-            "raw",
-            "row",
-            "table"
-          ],
-          "type": "option"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "canary:list",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "canary",
-        "list.js"
-      ]
-    },
     "delete:integration": {
       "aliases": [
         "delete:app"
@@ -1954,6 +1798,169 @@
         "unset.js"
       ]
     },
+    "canary:create": {
+      "aliases": [],
+      "args": {
+        "versionFrom": {
+          "description": "Version to route traffic from",
+          "name": "versionFrom",
+          "required": true
+        },
+        "versionTo": {
+          "description": "Version to canary traffic to",
+          "name": "versionTo",
+          "required": true
+        }
+      },
+      "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
+      "examples": [
+        "zapier canary:create 1.0.0 1.1.0 -p 25 -d 720",
+        "zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"
+      ],
+      "flags": {
+        "percent": {
+          "char": "p",
+          "description": "Percent of traffic to route to new version",
+          "name": "percent",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "duration": {
+          "char": "d",
+          "description": "Duration of the canary in seconds",
+          "name": "duration",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "canary:create",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "canary",
+        "create.js"
+      ]
+    },
+    "canary:delete": {
+      "aliases": [],
+      "args": {
+        "versionFrom": {
+          "description": "Version to route traffic from",
+          "name": "versionFrom",
+          "required": true
+        },
+        "versionTo": {
+          "description": "Version canary traffic is routed to",
+          "name": "versionTo",
+          "required": true
+        }
+      },
+      "description": "Delete an active canary deployment",
+      "examples": [
+        "zapier canary:delete 1.0.0 1.1.0"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "canary:delete",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "canary",
+        "delete.js"
+      ]
+    },
+    "canary:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List all active canary deployments",
+      "examples": [
+        "zapier canary:list"
+      ],
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "format": {
+          "char": "f",
+          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "plain",
+            "json",
+            "raw",
+            "row",
+            "table"
+          ],
+          "type": "option"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "canary:list",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "canary",
+        "list.js"
+      ]
+    },
     "team:add": {
       "aliases": [
         "team:invite"
@@ -2333,5 +2340,5 @@
       ]
     }
   },
-  "version": "16.2.0"
+  "version": "16.3.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "16.2.0",
+  "version": "16.3.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

package/src/generators/pull.js

@@ -24,7 +24,10 @@ module.exports = class PullGenerator extends Generator {
         name: 'confirm',
         message: `Warning: You are about to overwrite existing files.
 
-Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch. During the process, you may abort anytime by pressing 'x'.
+Before proceeding, please make sure you have saved your work. Consider creating a backup or saving your current state in a git branch.
+
+If presented with a series of options ('ynarxdeiH'), you may
+press Enter to view more details about each option. For example, 'x' will abort the process.
 
 Do you want to continue?`,
         default: false,

package/src/oclif/commands/push.js

@@ -1,5 +1,6 @@
 const ZapierBaseCommand = require('../ZapierBaseCommand');
 const { BUILD_PATH, SOURCE_PATH } = require('../../constants');
+const { Flags } = require('@oclif/core');
 
 const BuildCommand = require('./build');
 
@@ -13,6 +14,7 @@ class PushCommand extends ZapierBaseCommand {
         skipNpmInstall: this.flags['skip-npm-install'],
         disableDependencyDetection: this.flags['disable-dependency-detection'],
         skipValidation: this.flags['skip-validation'],
+        overwritePartnerChanges: this.flags['overwrite-partner-changes'],
       },
     );
     this.log(
@@ -21,7 +23,14 @@ class PushCommand extends ZapierBaseCommand {
   }
 }
 
-PushCommand.flags = BuildCommand.flags;
+PushCommand.flags = {
+  ...BuildCommand.flags,
+  'overwrite-partner-changes': Flags.boolean({
+    description:
+      '(Internal Use Only) Allows Zapier Staff to push changes to integrations in certain situations.',
+    hidden: true,
+  }),
+};
 PushCommand.description = `Build and upload the current integration.
 
 This command is the same as running \`zapier build\` and \`zapier upload\` in sequence. See those for more info.`;

package/src/utils/api.js

@@ -422,7 +422,10 @@ const downloadSourceZip = async (dst) => {
   }
 };
 
-const upload = async (app, { skipValidation = false } = {}) => {
+const upload = async (
+  app,
+  { skipValidation = false, overwritePartnerChanges = false } = {},
+) => {
   const zipPath = constants.BUILD_PATH;
   const sourceZipPath = constants.SOURCE_PATH;
   const appDir = process.cwd();
@@ -449,17 +452,42 @@ const upload = async (app, { skipValidation = false } = {}) => {
   const binarySourceZip = fs.readFileSync(fullSourceZipPath);
   const sourceBuffer = Buffer.from(binarySourceZip).toString('base64');
 
+  const headers = {};
+  if (overwritePartnerChanges) {
+    headers['X-Overwrite-Partner-Changes'] = 'true';
+  }
+
   startSpinner(`Uploading version ${definition.version}`);
-  await callAPI(`/apps/${app.id}/versions/${definition.version}`, {
-    method: 'PUT',
-    body: {
-      zip_file: buffer,
-      source_zip_file: sourceBuffer,
-      skip_validation: skipValidation,
-    },
-  });
+  try {
+    await callAPI(
+      `/apps/${app.id}/versions/${definition.version}`,
+      {
+        method: 'PUT',
+        body: {
+          zip_file: buffer,
+          source_zip_file: sourceBuffer,
+          skip_validation: skipValidation,
+        },
+        extraHeaders: headers,
+      },
+      true,
+    );
+  } catch (err) {
+    endSpinner({ success: false });
+    // 409 from the backend specifically signals that the last changes were from a partner
+    // and this is a staff user which could unintentionally overwrite those changes
+    if (err.status === 409) {
+      throw new Error(
+        `The latest integration changes appear to be from a partner. OK to overwrite?` +
+          ` If so, run this command again using the '--overwrite-partner-changes' flag.`,
+      );
+    }
 
-  endSpinner();
+    // Don't ignore other errors, re-throw them with a user-friendly message
+    throw new Error(err.errText);
+  } finally {
+    endSpinner();
+  }
 };
 
 module.exports = {