zapier-platform-cli 16.3.1 → 16.5.0

package/src/oclif/commands/invoke.js

@@ -15,6 +15,12 @@ const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 const { localAppCommand, getLocalAppHandler } = require('../../utils/local');
 const { startSpinner, endSpinner } = require('../../utils/display');
+const {
+  getLinkedAppConfig,
+  listAuthentications,
+  readCredentials,
+} = require('../../utils/api');
+const { AUTH_KEY } = require('../../constants');
 
 const ACTION_TYPE_PLURALS = {
   trigger: 'triggers',
@@ -235,9 +241,88 @@ const appendEnv = async (vars, prefix = '') => {
   );
 };
 
-const testAuth = async (authData, meta, zcacheTestObj) => {
+const replaceDoubleCurlies = async (request) => {
+  // Use lcurly-fieldName-rcurly instead of {{fieldName}} to bypass node-fetch's
+  // URL validation in case the variable is used in a URL.
+  if (request.url) {
+    request.url = request.url
+      .replaceAll('{{', 'lcurly-')
+      .replaceAll('}}', '-rcurly');
+  }
+
+  // The authorization header may confuse zapier.com and it's relay's job to add
+  // it, so we delete it here.
+  delete request.headers.authorization;
+  delete request.headers.Authorization;
+
+  return request;
+};
+
+const restoreDoubleCurlies = async (response) => {
+  if (response.url) {
+    response.url = response.url
+      .replaceAll('lcurly-', '{{')
+      .replaceAll('-rcurly', '}}');
+  }
+  if (response.request?.url) {
+    response.request.url = response.request.url
+      .replaceAll('lcurly-', '{{')
+      .replaceAll('-rcurly', '}}');
+  }
+  return response;
+};
+
+const localAppCommandWithRelayErrorHandler = async (args) => {
+  if (args.relayAuthenticationId) {
+    args = {
+      ...args,
+      beforeRequest: [replaceDoubleCurlies],
+      afterResponse: [restoreDoubleCurlies],
+    };
+  }
+
+  let output;
+  try {
+    output = await localAppCommand(args);
+  } catch (outerError) {
+    if (outerError.name === 'ResponseError') {
+      let response;
+      try {
+        response = JSON.parse(outerError.message);
+      } catch (innerError) {
+        throw outerError;
+      }
+      if (typeof response.content === 'string') {
+        const match = response.content.match(/domain filter `([^`]+)`/);
+        if (!match) {
+          throw outerError;
+        }
+        const domainFilter = match[1];
+        const requestUrl = response.request.url
+          .replaceAll('lcurly-', '{{')
+          .replaceAll('-rcurly', '}}');
+        throw new Error(
+          `Request to ${requestUrl} was blocked. ` +
+            `Only these domain names are allowed: ${domainFilter}. ` +
+            'Contact Zapier team to verify your domain filter setting.',
+        );
+      }
+    }
+    throw outerError;
+  }
+  return output;
+};
+
+const testAuth = async (
+  authId,
+  authData,
+  meta,
+  zcacheTestObj,
+  appId,
+  deployKey,
+) => {
   startSpinner('Invoking authentication.test');
-  const result = await localAppCommand({
+  const result = await localAppCommandWithRelayErrorHandler({
     command: 'execute',
     method: 'authentication.test',
     bundle: {
@@ -250,13 +335,31 @@ const testAuth = async (authData, meta, zcacheTestObj) => {
     zcacheTestObj,
     customLogger,
     calledFromCliInvoke: true,
+    appId,
+    deployKey,
+    relayAuthenticationId: authId,
   });
   endSpinner();
   return result;
 };
 
-const getAuthLabel = async (labelTemplate, authData, meta, zcacheTestObj) => {
-  const testResult = await testAuth(authData, meta, zcacheTestObj);
+const getAuthLabel = async (
+  labelTemplate,
+  authId,
+  authData,
+  meta,
+  zcacheTestObj,
+  appId,
+  deployKey,
+) => {
+  const testResult = await testAuth(
+    authId,
+    authData,
+    meta,
+    zcacheTestObj,
+    appId,
+    deployKey,
+  );
   labelTemplate = labelTemplate.replace('__', '.');
   const tpl = _.template(labelTemplate, { interpolate: /{{([\s\S]+?)}}/g });
   return tpl({ ...testResult, bundle: { authData, inputData: testResult } });
@@ -632,10 +735,13 @@ class InvokeCommand extends BaseCommand {
     field,
     appDefinition,
     inputData,
+    authId,
     authData,
     timezone,
     zcacheTestObj,
     cursorTestObj,
+    appId,
+    deployKey,
   ) {
     const message = formatFieldDisplay(field) + ':';
     if (field.dynamic) {
@@ -655,16 +761,19 @@ class InvokeCommand extends BaseCommand {
         'triggers',
         trigger,
         inputData,
+        authId,
         authData,
         meta,
         timezone,
         zcacheTestObj,
         cursorTestObj,
+        appId,
+        deployKey,
       );
       return this.promptWithList(
         message,
         choices.map((c) => {
-          const id = c[idField] || 'null';
+          const id = c[idField] ?? 'null';
           const label = getLabelForDynamicDropdown(c, labelField, idField);
           return {
             name: `${label} (${id})`,
@@ -685,11 +794,14 @@ class InvokeCommand extends BaseCommand {
     inputData,
     inputFields,
     appDefinition,
+    authId,
     authData,
     meta,
     timezone,
     zcacheTestObj,
     cursorTestObj,
+    appId,
+    deployKey,
   ) {
     const missingFields = getMissingRequiredInputFields(inputData, inputFields);
     if (missingFields.length) {
@@ -704,10 +816,13 @@ class InvokeCommand extends BaseCommand {
           f,
           appDefinition,
           inputData,
+          authId,
           authData,
           timezone,
           zcacheTestObj,
           cursorTestObj,
+          appId,
+          deployKey,
         );
       }
     }
@@ -717,10 +832,13 @@ class InvokeCommand extends BaseCommand {
     inputData,
     inputFields,
     appDefinition,
+    authId,
     authData,
     timezone,
     zcacheTestObj,
     cursorTestObj,
+    appId,
+    deployKey,
   ) {
     inputFields = inputFields.filter((f) => f.key);
     if (!inputFields.length) {
@@ -768,10 +886,13 @@ class InvokeCommand extends BaseCommand {
         field,
         appDefinition,
         inputData,
+        authId,
         authData,
         timezone,
         zcacheTestObj,
         cursorTestObj,
+        appId,
+        deployKey,
       );
     }
   }
@@ -780,31 +901,40 @@ class InvokeCommand extends BaseCommand {
     inputData,
     inputFields,
     appDefinition,
+    authId,
     authData,
     meta,
     timezone,
     zcacheTestObj,
     cursorTestObj,
+    appId,
+    deployKey,
   ) {
     await this.promptOrErrorForRequiredInputFields(
       inputData,
       inputFields,
       appDefinition,
+      authId,
       authData,
       meta,
       timezone,
       zcacheTestObj,
       cursorTestObj,
+      appId,
+      deployKey,
     );
     if (!this.nonInteractive && !meta.isFillingDynamicDropdown) {
       await this.promptForInputFieldEdit(
         inputData,
         inputFields,
         appDefinition,
+        authId,
         authData,
         timezone,
         zcacheTestObj,
         cursorTestObj,
+        appId,
+        deployKey,
       );
     }
   }
@@ -814,11 +944,14 @@ class InvokeCommand extends BaseCommand {
     actionTypePlural,
     action,
     inputData,
+    authId,
     authData,
     meta,
     timezone,
     zcacheTestObj,
     cursorTestObj,
+    appId,
+    deployKey,
   ) {
     // Do these in order:
     // 1. Prompt for static input fields that alter dynamic fields
@@ -835,17 +968,20 @@ class InvokeCommand extends BaseCommand {
       inputData,
       staticInputFields,
       appDefinition,
+      authId,
       authData,
       meta,
       timezone,
       zcacheTestObj,
       cursorTestObj,
+      appId,
+      deployKey,
     );
 
     let methodName = `${actionTypePlural}.${action.key}.operation.inputFields`;
     startSpinner(`Invoking ${methodName}`);
 
-    const inputFields = await localAppCommand({
+    const inputFields = await localAppCommandWithRelayErrorHandler({
       command: 'execute',
       method: methodName,
       bundle: {
@@ -857,6 +993,9 @@ class InvokeCommand extends BaseCommand {
       cursorTestObj,
       customLogger,
       calledFromCliInvoke: true,
+      appId,
+      deployKey,
+      relayAuthenticationId: authId,
     });
     endSpinner();
 
@@ -867,11 +1006,14 @@ class InvokeCommand extends BaseCommand {
         inputData,
         inputFields,
         appDefinition,
+        authId,
         authData,
         meta,
         timezone,
         zcacheTestObj,
         cursorTestObj,
+        appId,
+        deployKey,
       );
     }
 
@@ -879,7 +1021,7 @@ class InvokeCommand extends BaseCommand {
     methodName = `${actionTypePlural}.${action.key}.operation.perform`;
 
     startSpinner(`Invoking ${methodName}`);
-    const output = await localAppCommand({
+    const output = await localAppCommandWithRelayErrorHandler({
       command: 'execute',
       method: methodName,
       bundle: {
@@ -891,15 +1033,40 @@ class InvokeCommand extends BaseCommand {
       cursorTestObj,
       customLogger,
       calledFromCliInvoke: true,
+      appId,
+      deployKey,
+      relayAuthenticationId: authId,
     });
     endSpinner();
 
     return output;
   }
 
+  async promptForAuthentication() {
+    const auths = (await listAuthentications()).authentications;
+    if (!auths || auths.length === 0) {
+      throw new Error(
+        'No authentications/connections found for your integration. ' +
+          'Add a new connection at https://zapier.com/app/assets/connections ' +
+          'or use local auth data by removing the `--authentication-id` flag.',
+      );
+    }
+    const authChoices = auths.map((auth) => ({
+      name: `${auth.title} | ${auth.app_version} | ID: ${auth.id}`,
+      value: auth.id,
+    }));
+    return this.promptWithList(
+      'Which authentication/connection would you like to use?',
+      authChoices,
+      { useStderr: true },
+    );
+  }
+
   async perform() {
+    let authId = this.flags['authentication-id'];
+
     const dotenvResult = dotenv.config({ override: true });
-    if (_.isEmpty(dotenvResult.parsed)) {
+    if (!authId && _.isEmpty(dotenvResult.parsed)) {
       console.warn(
         'The .env file does not exist or is empty. ' +
           'You may need to set some environment variables in there if your code uses process.env.',
@@ -955,10 +1122,37 @@ class InvokeCommand extends BaseCommand {
       }
     }
 
-    const authData = loadAuthDataFromEnv();
+    const appId = (await getLinkedAppConfig(null, false))?.id;
+    const deployKey = (await readCredentials(false))[AUTH_KEY];
+
+    if (authId === '-' || authId === '') {
+      if (this.nonInteractive) {
+        throw new Error(
+          "You cannot specify '-' or an empty string for `--authentication-id` in non-interactive mode.",
+        );
+      }
+      authId = (await this.promptForAuthentication()).toString();
+    }
+
     const zcacheTestObj = {};
     const cursorTestObj = {};
 
+    let authData = {};
+    if (authId) {
+      // Fill authData with curlies if we're in relay mode
+      const authFields = appDefinition.authentication.fields || [];
+      for (const field of authFields) {
+        if (field.key) {
+          authData[field.key] = `{{${field.key}}}`;
+        }
+      }
+    }
+
+    // Load from .env as well even in relay mode, in case the integration code
+    // assumes there are values in bundle.authData. Loading from .env at least
+    // gives the developer an option to override the values in bundle.authData.
+    authData = { ...authData, ...loadAuthDataFromEnv() };
+
     if (actionType === 'auth') {
       const meta = {
         isLoadingSample: false,
@@ -970,6 +1164,13 @@ class InvokeCommand extends BaseCommand {
       };
       switch (actionKey) {
         case 'start': {
+          if (authId) {
+            throw new Error(
+              'The `--authentication-id` flag is not applicable. ' +
+                'The `auth start` subcommand is to initialize local auth data in the .env file, ' +
+                'whereas `--authentication-id` is for proxying requests using production auth data.',
+            );
+          }
           const newAuthData = await this.startAuth(
             appDefinition,
             zcacheTestObj,
@@ -984,6 +1185,13 @@ class InvokeCommand extends BaseCommand {
           return;
         }
         case 'refresh': {
+          if (authId) {
+            throw new Error(
+              'The `--authentication-id` flag is not applicable. ' +
+                'The `auth refresh` subcommand can only refresh your local auth data in the .env file. ' +
+                'You might want to run `auth test` instead, which tests and may refresh auth data with the specified authentication ID in production.',
+            );
+          }
           const newAuthData = await this.refreshAuth(
             appDefinition,
             authData,
@@ -999,7 +1207,14 @@ class InvokeCommand extends BaseCommand {
           return;
         }
         case 'test': {
-          const output = await testAuth(authData, meta, zcacheTestObj);
+          const output = await testAuth(
+            authId,
+            authData,
+            meta,
+            zcacheTestObj,
+            appId,
+            deployKey,
+          );
           console.log(JSON.stringify(output, null, 2));
           return;
         }
@@ -1009,14 +1224,24 @@ class InvokeCommand extends BaseCommand {
             console.warn(
               'Function-based connection label is not supported yet. Printing auth test result instead.',
             );
-            const output = await testAuth(authData, meta, zcacheTestObj);
+            const output = await testAuth(
+              authId,
+              authData,
+              meta,
+              zcacheTestObj,
+              appId,
+              deployKey,
+            );
             console.log(JSON.stringify(output, null, 2));
           } else {
             const output = await getAuthLabel(
               labelTemplate,
+              authId,
               authData,
               meta,
               zcacheTestObj,
+              appId,
+              deployKey,
             );
             if (output) {
               console.log(output);
@@ -1085,11 +1310,14 @@ class InvokeCommand extends BaseCommand {
         actionTypePlural,
         action,
         inputData,
+        authId,
         authData,
         meta,
         timezone,
         zcacheTestObj,
         cursorTestObj,
+        appId,
+        deployKey,
       );
       console.log(JSON.stringify(output, null, 2));
     }
@@ -1149,6 +1377,11 @@ InvokeCommand.flags = buildFlags({
         'Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAuth2 callback. This port can be different from the one in the redirect URI if you have port forwarding set up.',
       default: 9000,
     }),
+    'authentication-id': Flags.string({
+      char: 'a',
+      description:
+        'EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authentication ID (aka the "app connection" on Zapier). Find them at https://zapier.com/app/assets/connections (https://zpr.io/z8SjFTdnTFZ2 for instructions) or specify \'-\' to interactively select one from your available authentications. When specified, the code will still run locally, but all outgoing requests will be proxied through Zapier with the production auth data.',
+    }),
   },
 });
 
@@ -1171,13 +1404,27 @@ InvokeCommand.examples = [
   'zapier invoke auth label',
   'zapier invoke trigger new_recipe',
   `zapier invoke create add_recipe --inputData '{"title": "Pancakes"}'`,
-  'zapier invoke search find_recipe -i @file.json',
+  'zapier invoke search find_recipe -i @file.json --non-interactive',
   'cat file.json | zapier invoke trigger new_recipe -i @-',
+  'zapier invoke search find_ticket --authentication-id 12345',
+  'zapier invoke create add_ticket -a -',
 ];
 InvokeCommand.description = `Invoke an auth operation, a trigger, or a create/search action locally.
 
 This command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.
 
+Why use this command?
+
+* Fast feedback loop: Write code and run this command to verify if it works immediately
+* Step-by-step debugging: Running locally means you can use a debugger to step through your code
+* Untruncated logs: View complete logs and errors in your terminal
+
+### Authentication
+
+You can supply the authentcation data in two ways: Load from the local \`.env\` file or use the (experimental) \`--authentication-id\` flag.
+
+#### The local \`.env\` file
+
 This command loads environment variables and \`authData\` from the \`.env\` file in the current directory. If you don't have a \`.env\` file yet, you can use the \`zapier invoke auth start\` command to help you initialize it, or you can manually create it.
 
 The \`zapier invoke auth start\` subcommand will prompt you for the necessary auth fields and save them to the \`.env\` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.
@@ -1197,6 +1444,19 @@ authData_refresh_token='abcdefg'
 authData_account_name='zapier'
 \`\`\`
 
+
+#### The \`--authentication-id\` flag (EXPERIMENTAL)
+
+Setting up local auth data can be troublesome. You'd have to configure your app server to allow localhost redirect URIs or use a port forwarding tool. This is sometimes not easy to get right.
+
+The \`--authentication-id\` flag (\`-a\` for short) gives you an alternative (and perhaps easier) way to supply your auth data. You can use \`-a\` to specify an existing production authentication/connection. The available authentications can be found at https://zapier.com/app/assets/connections. Check https://zpr.io/z8SjFTdnTFZ2 for more instructions.
+
+When \`-a -\` is specified, such as \`zapier invoke auth test -a -\`, the command will interactively prompt you to select one of your available authentications.
+
+If you know your authentication ID, you can specify it directly, such as \`zapier invoke auth test -a 123456\`.
+
+#### Testing authentication
+
 To test if the auth data is correct, run either one of these:
 
 \`\`\`
@@ -1204,7 +1464,9 @@ zapier invoke auth test   # invokes authentication.test method
 zapier invoke auth label  # invokes authentication.test and renders connection label
 \`\`\`
 
-To refresh stale auth data for OAuth2 or session auth, run \`zapier invoke auth refresh\`.
+To refresh stale auth data for OAuth2 or session auth, run \`zapier invoke auth refresh\`. Note that refreshing is only applicable for local auth data in the \`.env\` file.
+
+### Invoking a trigger or an action
 
 Once you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key \`new_recipe\`:
 
@@ -1212,12 +1474,14 @@ Once you have the correct auth data, you can test an trigger, a search, or a cre
 zapier invoke trigger new_recipe
 \`\`\`
 
-To add input data, use the \`--inputData\` flag. The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.
+To add input data, use the \`--inputData\` flag (\`-i\` for short). The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.
 
 When you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the \`--non-interactive\` flag.
 
 The \`--debug\` flag will show you the HTTP request logs and any console logs you have in your code.
 
+### Limitations
+
 The following is a non-exhaustive list of current limitations and may be supported in the future:
 
 - Hook triggers, including REST hook subscribe/unsubscribe

package/src/oclif/commands/legacy.js

@@ -0,0 +1,61 @@
+const BaseCommand = require('../ZapierBaseCommand');
+const { Args, Flags } = require('@oclif/core');
+const { buildFlags } = require('../buildFlags');
+
+const { callAPI } = require('../../utils/api');
+
+class LegacyCommand extends BaseCommand {
+  async perform() {
+    const app = await this.getWritableApp();
+    const { version } = this.args;
+
+    if (
+      !this.flags.force &&
+      !(await this.confirm(
+        'Are you sure you want to mark this version as legacy? Existing Zaps and automations will continue to work, but users may not be able to create new Zaps or automations with this version.',
+      ))
+    ) {
+      this.log('\nCancelled, version is not marked as legacy.');
+      return;
+    }
+
+    this.log(
+      `\nPreparing to mark version ${version} your app "${app.title}" as legacy.\n`,
+    );
+    const url = `/apps/${app.id}/versions/${version}/legacy`;
+    this.startSpinner(`Making ${version} legacy`);
+    await callAPI(url, {
+      method: 'PUT',
+    });
+    this.stopSpinner();
+  }
+}
+
+LegacyCommand.flags = buildFlags({
+  commandFlags: {
+    force: Flags.boolean({
+      char: 'f',
+      description: 'Skip confirmation prompt. Use with caution.',
+    }),
+  },
+});
+LegacyCommand.args = {
+  version: Args.string({
+    description: 'The version to mark as legacy.',
+    required: true,
+  }),
+};
+LegacyCommand.examples = ['zapier legacy 1.2.3'];
+LegacyCommand.description = `Mark a non-production version of your integration as legacy.
+
+Use this when an integration version is no longer recommended for new users, but you don't want to block existing users from using it.
+
+Reasons why you might want to mark a version as legacy:
+- this version may be discontinued in the future
+- this version has bugs
+- a newer version has been released and you want to encourage users to upgrade
+
+`;
+LegacyCommand.skipValidInstallCheck = true;
+
+module.exports = LegacyCommand;

package/src/oclif/commands/promote.js

@@ -258,11 +258,6 @@ ${metadataPromptHelper}`);
 
     this.stopSpinner();
     this.log('  Promotion successful!');
-    if (!this.flags.invokedFromAnotherCommand) {
-      this.log(
-        'Optionally, run the `zapier migrate` command to move users to this version.',
-      );
-    }
   }
 }