zapier-platform-cli 11.0.1 → 11.3.0

package/src/generators/templates/files/creates/uploadFile_v10.js

@@ -6,19 +6,25 @@ const FormData = require('form-data');
 // 9.x compatible code, see uploadFile_v9.js.
 const makeDownloadStream = (url) =>
   new Promise((resolve, reject) => {
-    http.request(url, resolve).on('error', reject).end();
+    http.request(url, (res) => {
+      // We can risk missing the first n bytes if we don't pause!
+      res.pause();
+      resolve(res);
+    }).on('error', reject).end();
   });
 
 const perform = async (z, bundle) => {
-  const form = new FormData();
-
-  form.append('filename', bundle.inputData.filename);
-
   // bundle.inputData.file will in fact be an URL where the file data can be
   // downloaded from which we do via a stream
   const stream = await makeDownloadStream(bundle.inputData.file, z);
+
+  const form = new FormData();
+  form.append('filename', bundle.inputData.filename);
   form.append('file', stream);
 
+  // All set! Resume the stream
+  stream.resume();
+
   const response = await z.request({
     url: 'https://auth-json-server.zapier-staging.com/upload',
     method: 'POST',

package/src/oclif/commands/describe.js

@@ -194,7 +194,7 @@ class DescribeCommand extends BaseCommand {
 }
 
 DescribeCommand.flags = buildFlags({ opts: { format: true } });
-DescribeCommand.description = `Describe the current integraiton.
+DescribeCommand.description = `Describe the current integration.
 
 This command prints a human readable enumeration of your integrations's
 triggers, searches, and creates as seen by Zapier. Useful to understand how your

package/src/oclif/commands/jobs.js

@@ -0,0 +1,98 @@
+const { chain } = require('lodash');
+
+const BaseCommand = require('../ZapierBaseCommand');
+const { listMigrations } = require('../../utils/api');
+const { buildFlags } = require('../buildFlags');
+
+const getVersion = (versionStr) => versionStr.split('@')[1];
+const getIsoDate = (unixTs) => (unixTs ? new Date(unixTs).toISOString() : '-');
+
+class JobsCommand extends BaseCommand {
+  async perform() {
+    /**
+     * Migrations and Jobs are used somewhat interchangeably here.
+     * Migrations represents the collection of promotion and migration
+     * background "jobs" that were recently executed on this app.
+     */
+
+    this.startSpinner('Loading jobs');
+    const { migrations } = await listMigrations();
+    this.stopSpinner();
+
+    const jobs = chain(migrations)
+      .filter(
+        (migration) =>
+          migration.job_kind === 'migrate' || migration.job_kind === 'promote'
+      )
+      .map((migration) => {
+        const job = {
+          app_title: migration.app_title,
+          job_id: migration.job_id,
+          job_kind: migration.job_kind,
+          job_stage: migration.job_stage,
+          version_from: getVersion(migration.from_selected_api),
+          version_to: getVersion(migration.to_selected_api),
+          started_at: getIsoDate(migration.started_at),
+          updated_at: getIsoDate(migration.updated_at),
+        };
+
+        if (migration.progress) {
+          job.overall_progress =
+            parseFloat(migration.progress.overall_progress * 100).toFixed(2) +
+            '%';
+
+          if (migration.progress.current_step) {
+            job.current_step = migration.progress.current_step.name;
+            job.current_progress = `${migration.progress.current_step.finished_points} finished, ${migration.progress.current_step.skipped_points} skipped, ${migration.progress.current_step.estimated_points} estimated`;
+            job.current_step_status = migration.progress.current_step.status;
+          }
+        }
+
+        if (migration.error) {
+          job.error_message = migration.error.message;
+        }
+
+        return job;
+      })
+      .sortBy((migration) => migration.started_at)
+      .value();
+
+    this.logTable({
+      rows: jobs,
+      headers: [
+        ['App Title', 'app_title'],
+        ['Job Id', 'job_id'],
+        ['Job Kind', 'job_kind'],
+        ['Job Stage', 'job_stage'],
+        ['From', 'version_from'],
+        ['To', 'version_to'],
+        ['Current Step', 'current_step'],
+        ['Current Progress', 'current_progress'],
+        ['Current Step Status', 'current_step_status'],
+        ['Progress', 'overall_progress'],
+        ['Started At', 'started_at'],
+        ['Updated At', 'updated_at'],
+        ['Errors', 'error_message'],
+      ],
+      emptyMessage:
+        'No recent migration or promotion jobs found. Try `zapier history` if you see older jobs.',
+    });
+  }
+}
+
+JobsCommand.examples = ['zapier jobs'];
+JobsCommand.description = `Lists ongoing migration or promotion jobs for the current integration.
+
+A job represents a background process that will be queued up when users execute a "migrate" or "promote" command for the current integration.
+
+Each job will be added to the end of a queue of "promote" and "migration" jobs where the "Job Stage" will then be initialized with "requested". 
+
+Job stages will then move to "estimating", "in_progress" and finally one of four "end" stages: "complete", "aborted", "errored" or "paused".
+
+Job times will vary as it depends on the size of the queue and how many users your integration has.
+
+Jobs are returned from oldest to newest.
+`;
+
+JobsCommand.flags = buildFlags({ opts: { format: true } });
+module.exports = JobsCommand;

package/src/oclif/commands/migrate.js

@@ -46,10 +46,14 @@ class MigrateCommand extends BaseCommand {
     }
 
     const body = {
-      percent,
+      job: {
+        name: 'migrate',
+        from_version: fromVersion,
+        to_version: toVersion,
+        email: user,
+      },
     };
     if (user) {
-      body.user = user;
       this.startSpinner(
         `Starting migration from ${fromVersion} to ${toVersion} for ${user}`
       );
@@ -58,8 +62,12 @@ class MigrateCommand extends BaseCommand {
         `Starting migration from ${fromVersion} to ${toVersion} for ${percent}%`
       );
     }
+    if (percent) {
+      body.job.percent_human = percent;
+    }
+
+    const url = `/apps/${app.id}/migrations`;
 
-    const url = `/apps/${app.id}/versions/${fromVersion}/migrate-to/${toVersion}`;
     try {
       await callAPI(url, { method: 'POST', body });
     } finally {
@@ -110,7 +118,7 @@ Start a migration to move users between different versions of your integration.
 
 Only use this command to migrate users between non-breaking versions, use \`zapier deprecate\` if you have breaking changes!
 
-Migration time varies based on the number of affected Zaps. Be patient and check \`zapier history\` to track the status.
+Migration time varies based on the number of affected Zaps. Be patient and check \`zapier jobs\` to track the status. Or use \`zapier history\` if you want to see older jobs.
 
 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.
 

package/src/oclif/commands/promote.js

@@ -60,19 +60,22 @@ class PromoteCommand extends BaseCommand {
       `Preparing to promote version ${version} of your integration "${app.title}".`
     );
 
-    const body = {};
-    if (changelog) {
-      body.changelog = changelog;
-    }
+    const body = {
+      job: {
+        name: 'promote',
+        to_version: version,
+        changelog,
+      },
+    };
 
     this.startSpinner(`Verifying and promoting ${version}`);
 
-    const url = `/apps/${app.id}/versions/${version}/promote/production`;
+    const url = `/apps/${app.id}/migrations`;
     try {
       await callAPI(
         url,
         {
-          method: 'PUT',
+          method: 'POST',
           body,
         },
         true
@@ -120,7 +123,7 @@ PromoteCommand.args = [
   {
     name: 'version',
     required: true,
-    description: 'The version you want promote.',
+    description: 'The version you want to promote.',
   },
 ];
 
@@ -136,6 +139,8 @@ Promote an integration version into production (non-private) rotation, which mea
 
 Promotes are an inherently safe operation for all existing users of your integration.
 
-If your integration is private and passes our integration checks, this will give you a URL to a form where you can fill in additional information for your integration to go public. After reviewing, the Zapier team will approve to make it public if there are no issues or decline with feedback.`;
+If your integration is private and passes our integration checks, this will give you a URL to a form where you can fill in additional information for your integration to go public. After reviewing, the Zapier team will approve to make it public if there are no issues or decline with feedback.
+
+Check \`zapier jobs\` to track the status of the promotion. Or use \`zapier history\` if you want to see older jobs.`;
 
 module.exports = PromoteCommand;

package/src/oclif/commands/test.js

@@ -1,5 +1,3 @@
-const path = require('path');
-const { pathExists } = require('fs-extra');
 const { flags } = require('@oclif/command');
 const chalk = require('chalk');
 
@@ -9,6 +7,7 @@ const constants = require('../../constants');
 const { buildFlags } = require('../buildFlags');
 const { readCredentials } = require('../../utils/api');
 const { runCommand } = require('../../utils/misc');
+const { getPackageManager } = require('../../utils/package-manager');
 
 class TestCommand extends BaseCommand {
   async perform() {
@@ -35,9 +34,7 @@ class TestCommand extends BaseCommand {
 
     const env = Object.assign({}, process.env, extraEnv);
 
-    const useYarn =
-      this.flags.yarn ||
-      (await pathExists(path.join(process.cwd(), 'yarn.lock')));
+    const packageManager = await getPackageManager(this.flags);
 
     const passthroughArgs = this.argv.includes('--')
       ? this.argv.slice(this.argv.indexOf('--') + 1)
@@ -47,21 +44,22 @@ class TestCommand extends BaseCommand {
       'run',
       '--silent',
       'test',
-      useYarn ? '' : '--', // yarn gives a warning if we include `--`
+      packageManager.useDoubleHyphenBeforeArgs ? '--' : '',
       ...passthroughArgs,
     ].filter(Boolean);
-    const packageManager = useYarn ? 'yarn' : 'npm';
 
     this.log('Running test suite with the following command:');
     // some extra formatting happen w/ quotes so it's clear when they're already like that in the array,
     // but the space-joined array made that unclear
     this.log(
-      `\n  ${chalk.cyanBright.bold(packageManager)} ${chalk.cyanBright(
+      `\n  ${chalk.cyanBright.bold(
+        packageManager.executable
+      )} ${chalk.cyanBright(
         argv.map((a) => (a.includes(' ') ? `"${a}"` : a)).join(' ')
       )}\n`
     );
 
-    const output = await runCommand(packageManager, argv, {
+    const output = await runCommand(packageManager.executable, argv, {
       stdio: 'inherit',
       env,
     });
@@ -81,6 +79,10 @@ TestCommand.flags = buildFlags({
       description:
         "Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.",
     }),
+    pnpm: flags.boolean({
+      description:
+        "Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.",
+    }),
   },
 });
 

package/src/oclif/hooks/renderMarkdownHelp.js

@@ -1,5 +1,5 @@
 const chalk = require('chalk');
-const marked = require('marked');
+const { marked } = require('marked');
 const TerminalRenderer = require('marked-terminal');
 const { stdtermwidth } = require('@oclif/plugin-help/lib/screen');
 

package/src/oclif/oCommands.js

@@ -15,6 +15,7 @@ module.exports = {
   'env:set': require('./commands/env/set'),
   'env:unset': require('./commands/env/unset'),
   history: require('./commands/history'),
+  jobs: require('./commands/jobs'),
   init: require('./commands/init'),
   integrations: require('./commands/integrations'),
   link: require('./commands/link'),

package/src/utils/api.js

@@ -327,6 +327,8 @@ const listLogs = (opts) => {
 const listEnv = (version) =>
   listEndpoint(`versions/${version}/environment`, 'env');
 
+const listMigrations = () => listEndpoint('migrations');
+
 // the goal of this is to call `/check` with as much info as possible
 // if the app is registered and auth is available, then we can send app id
 // otherwise, we should just send the definition and get back checks about that
@@ -411,6 +413,7 @@ module.exports = {
   listInvitees,
   listLogs,
   listVersions,
+  listMigrations,
   readCredentials,
   upload,
   validateApp,

package/src/utils/auth-files-codegen.js

@@ -404,13 +404,13 @@ const sessionAuthFile = () => {
           obj(
             objProperty('key', strLiteral('username')),
             objProperty('label', strLiteral('Username')),
-            objProperty('required', strLiteral('true'))
+            objProperty('required', 'true')
           ),
           obj(
             objProperty('key', strLiteral('password')),
             objProperty('label', strLiteral('Password')),
             objProperty('required', 'true'),
-            comment('this lets the user enter maksed data'),
+            comment('this lets the user enter masked data'),
             objProperty('type', strLiteral('password'))
           ),
         ],

package/src/utils/convert.js

@@ -167,7 +167,9 @@ const renderStep = (type, definition) => {
       if (func && func.source) {
         const args = func.args || ['z', 'bundle'];
         functionBlock.push(
-          `const ${funcName} = (${args.join(', ')}) => {\n${func.source}\n};`
+          `const ${funcName} = async (${args.join(', ')}) => {\n${
+            func.source
+          }\n};`
         );
 
         exportBlock.operation[funcName] = makePlaceholder(funcName);
@@ -188,7 +190,7 @@ const renderStep = (type, definition) => {
             funcNum ? funcNum++ : ++funcNum && ''
           }`;
           functionBlock.push(
-            `const ${funcName} = (${args.join(', ')}) => {\n${
+            `const ${funcName} = async (${args.join(', ')}) => {\n${
               maybeFunc.source
             }\n};`
           );
@@ -277,7 +279,7 @@ const renderAuth = async (appDefinition) => {
       if (func && func.source) {
         const args = func.args || ['z', 'bundle'];
         functionBlock.push(
-          `const ${funcName} = (${args.join(', ')}) => {${func.source}};`
+          `const ${funcName} = async (${args.join(', ')}) => {${func.source}};`
         );
 
         exportBlock[key] = makePlaceholder(funcName);
@@ -302,7 +304,7 @@ const renderHydrators = async (appDefinition) => {
     if (func && func.source) {
       const args = func.args || ['z', 'bundle'];
       functionBlock.push(
-        `const ${funcName} = (${args.join(', ')}) => {${func.source}};`
+        `const ${funcName} = async (${args.join(', ')}) => {${func.source}};`
       );
       exportBlock[funcName] = makePlaceholder(funcName);
     }
@@ -347,9 +349,8 @@ const renderIndex = async (appDefinition) => {
         importBlock.push(`const ${importName} = require('${filepath}');`);
 
         delete exportBlock[stepType][key];
-        exportBlock[stepType][
-          makePlaceholder(`[${importName}.key]`)
-        ] = makePlaceholder(importName);
+        exportBlock[stepType][makePlaceholder(`[${importName}.key]`)] =
+          makePlaceholder(importName);
       });
     }
   );
@@ -368,7 +369,7 @@ const renderIndex = async (appDefinition) => {
         const args = func.args || ['z', 'bundle'];
         const funcName = middlewareType;
         functionBlock.push(
-          `const ${funcName} = (${args.join(', ')}) => {${func.source}};`
+          `const ${funcName} = async (${args.join(', ')}) => {${func.source}};`
         );
 
         exportBlock[middlewareType][0] = makePlaceholder(funcName);

package/src/utils/npm.js

@@ -11,9 +11,7 @@ const getPackageLatestVersion = async (name) => {
 
 const getPackageSize = async (name, version) => {
   const baseUrl = `${BASE_URL}/${name}`;
-  const res = await fetch(`${baseUrl}/-/${name}-${version}.tgz`, {
-    method: 'HEAD',
-  });
+  const res = await fetch(`${baseUrl}/-/${name}-${version}.tgz`);
   return res.headers.get('content-length');
 };
 

package/src/utils/package-manager.js

@@ -0,0 +1,45 @@
+const { pathExists } = require('fs-extra');
+const path = require('path');
+
+const packageManagers = [
+  {
+    lockFile: 'package-lock.json',
+    forceFlag: undefined,
+    executable: 'npm',
+    useDoubleHyphenBeforeArgs: true,
+  },
+  {
+    lockFile: 'yarn.lock',
+    forceFlag: 'yarn',
+    executable: 'yarn',
+    useDoubleHyphenBeforeArgs: false, // yarn gives a warning if we include `--`
+  },
+  {
+    lockFile: 'pnpm-lock.yaml',
+    forceFlag: 'pnpm',
+    executable: 'pnpm',
+    useDoubleHyphenBeforeArgs: true,
+  },
+];
+
+const defaultPackageManager = packageManagers[0];
+
+const getPackageManager = async (flags) => {
+  for (const man of packageManagers) {
+    if (flags[man.forceFlag]) {
+      return man;
+    }
+  }
+
+  for (const man of packageManagers) {
+    if (await pathExists(path.join(process.cwd(), man.lockFile))) {
+      return man;
+    }
+  }
+
+  return defaultPackageManager;
+};
+
+module.exports = {
+  getPackageManager,
+};