zapier-platform-cli 14.1.2 → 15.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "14.1.2",
+  "version": "15.0.1",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -19,7 +19,7 @@
     "/oclif.manifest.json"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "scripts": {
     "docs": "ZAPIER_BASE_ENDPOINT='' node scripts/docs.js && cp -r docs ../..",
@@ -38,8 +38,8 @@
     "validate": "yarn test && yarn smoke-test && yarn lint"
   },
   "dependencies": {
-    "@oclif/command": "1.8.21",
-    "@oclif/config": "1.18.6",
+    "@oclif/command": "1.8.27",
+    "@oclif/config": "1.18.10",
     "@oclif/plugin-autocomplete": "0.3.0",
     "@oclif/plugin-help": "3.2.2",
     "@oclif/plugin-not-found": "1.2.4",
@@ -49,28 +49,29 @@
     "cli-table3": "0.6.3",
     "colors": "1.4.0",
     "debug": "4.3.4",
-    "fs-extra": "10.0.0",
+    "fs-extra": "11.1.1",
     "gulp-filter": "7.0.0",
     "gulp-prettier": "4.0.0",
     "ignore": "5.2.4",
     "inquirer": "8.2.5",
-    "jscodeshift": "0.14.0",
+    "jscodeshift": "0.15.0",
     "klaw": "4.1.0",
     "lodash": "4.17.21",
     "marked": "4.2.12",
-    "marked-terminal": "5.1.1",
+    "marked-terminal": "5.2.0",
     "node-fetch": "2.6.7",
     "ora": "5.4.0",
     "parse-gitignore": "0.5.1",
-    "prettier": "2.8.3",
-    "read": "2.0.0",
-    "semver": "7.3.8",
+    "prettier": "2.8.8",
+    "read": "2.1.0",
+    "semver": "7.5.2",
     "string-length": "4.0.2",
     "through2": "4.0.2",
     "tmp": "0.2.1",
+    "traverse": "0.6.7",
     "update-notifier": "5.1.0",
     "yeoman-environment": "3.3.0",
-    "yeoman-generator": "5.7.0"
+    "yeoman-generator": "5.9.0"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.26.10",
@@ -80,7 +81,7 @@
     "litdoc": "1.5.6",
     "markdown-toc": "^1",
     "mock-fs": "^5.2.0",
-    "nock": "^13.3.0",
+    "nock": "^13.3.1",
     "stdout-stderr": "0.1.13",
     "yamljs": "0.3.0"
   },

package/scaffold/test.template.js

@@ -1,5 +1,3 @@
-/* globals describe, expect, test, it */
-
 const zapier = require('zapier-platform-core');
 
 // Use this to make test calls into your app:

package/src/constants.js

@@ -26,7 +26,7 @@ const BLACKLISTED_PATHS = [
 ];
 const NODE_VERSION = versionStore[versionStore.length - 1].nodeVersion;
 const LAMBDA_VERSION = `v${NODE_VERSION}`;
-const NODE_VERSION_CLI_REQUIRES = '>=14'; // should be the oldest non-ETL version
+const NODE_VERSION_CLI_REQUIRES = '>=16'; // should be the oldest non-ETL version
 const AUTH_KEY = 'deployKey';
 const ANALYTICS_KEY = 'analyticsMode';
 const ANALYTICS_MODES = {
@@ -59,6 +59,29 @@ const IS_TESTING =
 
 const MAX_DESCRIPTION_LENGTH = 140;
 
+const EXAMPLE_CHANGELOG = `
+## 3.0.0
+
+Made some changes that affect app actions
+
+1. Update the trigger/pr_review action, as well as changes for #456
+2. Fix trigger/new_card #208
+3. New action! create/add_contact
+
+However, we also addressed fixed open issues!
+
+- Fix #123 and an issue with create/send_message
+
+## 2.0.0
+
+* Fix some bugs.
+* Major docs fixes.
+
+## 1.0.0
+
+Initial release to public.
+`;
+
 module.exports = {
   ANALYTICS_KEY,
   ANALYTICS_MODES,
@@ -87,4 +110,5 @@ module.exports = {
   SOURCE_PATH,
   STARTER_REPO,
   UPDATE_NOTIFICATION_INTERVAL,
+  EXAMPLE_CHANGELOG,
 };

package/src/generators/index.js

@@ -46,7 +46,7 @@ const writeGenericPackageJson = (gen, packageJsonExtension) => {
           [PLATFORM_PACKAGE]: PACKAGE_VERSION,
         },
         devDependencies: {
-          jest: '^26.6.3',
+          jest: '^29.6.0',
         },
         private: true,
       },

package/src/oclif/commands/login.js

@@ -19,7 +19,13 @@ const { writeFile } = require('../../utils/files');
 const { prettyJSONstringify } = require('../../utils/display');
 const { isSamlEmail } = require('../../utils/credentials');
 
-const DEPLOY_KEY_DASH_URL = `${BASE_ENDPOINT}/developer/partner-settings/deploy-keys/`;
+const getDeployKeyUrl = () => {
+  const url = new URL(BASE_ENDPOINT);
+  url.hostname = `developer.${url.hostname}`;
+  url.pathname = 'partner-settings/deploy-keys/';
+  return url.href;
+};
+const DEPLOY_KEY_DASH_URL = getDeployKeyUrl();
 
 const isValidTotpCode = (i) => {
   const num = parseInt(i, 10);

package/src/oclif/commands/promote.js

@@ -8,6 +8,13 @@ const { callAPI } = require('../../utils/api');
 const { flattenCheckResult } = require('../../utils/display');
 const { getVersionChangelog } = require('../../utils/changelog');
 const checkMissingAppInfo = require('../../utils/check-missing-app-info');
+const { EXAMPLE_CHANGELOG } = require('../../constants');
+
+const ACTION_TYPE_MAPPING = {
+  read: 'trigger',
+  write: 'create',
+  search: 'search',
+};
 
 const serializeErrors = (errors) => {
   const opener = 'Promotion failed for the following reasons:\n\n';
@@ -25,6 +32,16 @@ const serializeErrors = (errors) => {
   );
 };
 
+const hasAppChangeType = (metadata, changeType) => {
+  return Boolean(
+    metadata?.some(
+      // Existing property name
+      // eslint-disable-next-line camelcase
+      ({ app_change_type }) => app_change_type === changeType
+    )
+  );
+};
+
 class PromoteCommand extends BaseCommand {
   async perform() {
     const app = await this.getWritableApp();
@@ -35,29 +52,88 @@ class PromoteCommand extends BaseCommand {
     const assumeYes = 'yes' in this.flags;
 
     let shouldContinue;
-    const changelog = await getVersionChangelog(version);
-    if (changelog) {
-      this.log(colors.green(`Changelog found for ${version}`));
-      this.log(`\n---\n${changelog}\n---\n`);
+    const { changelog, appMetadata, issueMetadata } = await getVersionChangelog(
+      version
+    );
 
-      shouldContinue =
-        assumeYes ||
-        (await this.confirm(
-          'Would you like to continue promoting with this changelog?'
-        ));
+    const metadataPromptHelper = `Issues are indicated by ${colors.bold.underline(
+      '#<issueId>'
+    )}, and actions by ${colors.bold.underline(
+      '<trigger|create|search>/<key>'
+    )}. Note issue IDs must be numeric and action identifiers are case sensitive.`;
+
+    if (!changelog) {
+      this.error(`${colors.yellow(
+        'Warning!'
+      )} Changelog not found. Please create a CHANGELOG.md file with user-facing descriptions. Example:
+${colors.cyan(EXAMPLE_CHANGELOG)}
+If bugfixes or updates to actions are present, then should be marked on a line that begins with "Update" or "Fix" (case insensitive) and information that contains the identifier.
+${metadataPromptHelper}`);
     } else {
-      this.log(
-        `${colors.yellow(
-          'Warning!'
-        )} Changelog not found. Please create a CHANGELOG.md file in a format similar to ${colors.cyan(
-          'https://gist.github.com/xavdid/b9ede3565f1188ce339292acc29612b2'
-        )} with user-facing descriptions.`
-      );
+      this.log(colors.green(`Changelog found for ${version}`));
+      this.log(`\n---\n${changelog}\n---`);
+      /* eslint-disable camelcase */
+      this.log(`\nParsed metadata:\n`);
+
+      const appFeatureUpdates =
+        appMetadata &&
+        appMetadata
+          .filter(({ app_change_type }) => app_change_type === 'FEATURE_UPDATE')
+          .map(
+            ({ action_type, action_key }) =>
+              `${action_key}/${ACTION_TYPE_MAPPING[action_type]}`
+          );
+
+      const issueFeatureUpdates =
+        issueMetadata &&
+        issueMetadata
+          .filter(({ app_change_type }) => app_change_type === 'FEATURE_UPDATE')
+          .map(({ issue_id }) => `#${issue_id}`);
+
+      if (appFeatureUpdates || issueFeatureUpdates) {
+        this.log(
+          `Feature updates: ${[
+            ...appFeatureUpdates,
+            ...issueFeatureUpdates,
+          ].join(', ')}`
+        );
+      }
+
+      const appBugfixes =
+        appMetadata &&
+        appMetadata
+          .filter(({ app_change_type }) => app_change_type === 'BUGFIX')
+          .map(
+            ({ action_type, action_key }) =>
+              `${action_key}/${ACTION_TYPE_MAPPING[action_type]}`
+          );
+      const issueBugfixes =
+        issueMetadata &&
+        issueMetadata
+          .filter(({ app_change_type }) => app_change_type === 'BUGFIX')
+          .map(({ issue_id }) => `#${issue_id}`);
+
+      if (appBugfixes || issueBugfixes) {
+        this.log(`Bug fixes: ${[...appBugfixes, issueBugfixes].join(', ')}`);
+      }
+
+      if (
+        !appFeatureUpdates &&
+        !issueFeatureUpdates &&
+        !appBugfixes &&
+        !issueBugfixes
+      ) {
+        this.log(
+          `No metadata was found in the changelog. Remember, you can associate the changelog with issues or triggers/actions.\n\n${metadataPromptHelper}`
+        );
+      }
+      this.log();
+      /* eslint-enable camelcase */
 
       shouldContinue =
         assumeYes ||
         (await this.confirm(
-          'Would you like to continue promoting without a changelog?'
+          'Would you like to continue promoting with this changelog?'
         ));
     }
 
@@ -69,11 +145,22 @@ class PromoteCommand extends BaseCommand {
       `Preparing to promote version ${version} of your integration "${app.title}".`
     );
 
+    const isFeatureUpdate =
+      hasAppChangeType(appMetadata, 'FEATURE_UPDATE') ||
+      hasAppChangeType(issueMetadata, 'FEATURE_UPDATE');
+    const isBugfix =
+      hasAppChangeType(appMetadata, 'BUGFIX') ||
+      hasAppChangeType(issueMetadata, 'BUGFIX');
     const body = {
       job: {
         name: 'promote',
         to_version: version,
         changelog,
+        app_metadata: appMetadata,
+        loki_metadata: issueMetadata,
+        is_feature_update: isFeatureUpdate,
+        is_bugfix: isBugfix,
+        is_other: !isFeatureUpdate && !isBugfix,
       },
     };
 

package/src/utils/changelog.js

@@ -1,7 +1,15 @@
-const _ = require('lodash');
 const path = require('path');
 
 const { readFile } = require('./files');
+const { getMetadata } = require('./metadata');
+
+const isAppMetadata = (obj) =>
+  obj?.app_change_type && obj?.action_key && obj?.action_type;
+
+const isIssueMetadata = (obj) => obj?.app_change_type && obj?.issue_id;
+
+// Turns an empty array into undefined so it will not be present in the body when sent
+const absentIfEmpty = (arr) => (arr.length === 0 ? undefined : arr);
 
 const getChangelogFromMarkdown = (version, markdown) => {
   const lines = markdown
@@ -9,41 +17,56 @@ const getChangelogFromMarkdown = (version, markdown) => {
     .replace(/\r/g, '\n')
     .split('\n');
 
-  let startingLine = _.findIndex(lines, (line) =>
-    RegExp(`## .*${version}`).test(line)
+  let startingLine = lines.findIndex((line) =>
+    RegExp(`^#{1,4} .*${version.split('.').join('\\.')}`).test(line)
   );
 
   if (startingLine === -1) {
-    return '';
+    throw new Error(`Version '${version}' not found in changelog`);
   }
 
-  // Skip the line with the version, and the next line (expected blank)
-  startingLine += 2;
+  startingLine++;
 
-  let endingLine = _.findIndex(
-    lines,
-    (line) => line.indexOf('## ') === 0,
-    startingLine
-  );
+  // Find the next line that starts with one or more '#' chars
+  let endingLine = lines
+    .slice(startingLine)
+    .findIndex((line) => /^#{1,4} /.test(line));
 
   if (endingLine === -1) {
     endingLine = lines.length;
   }
-
-  // Skip the line before the next version (expected blank)
-  endingLine -= 1;
+  endingLine += startingLine;
 
   const changelogLines = lines.slice(startingLine, endingLine);
+  const changelog = [];
+  const appMetadata = [];
+  const issueMetadata = [];
+
+  for (const line of changelogLines) {
+    for (const metadata of getMetadata(line)) {
+      if (isAppMetadata(metadata)) {
+        appMetadata.push(metadata);
+      } else if (isIssueMetadata(metadata)) {
+        issueMetadata.push(metadata);
+      }
+    }
+
+    changelog.push(line);
+  }
 
-  return changelogLines.join('\n');
+  return {
+    changelog: changelog.join('\n').trim(),
+    appMetadata: absentIfEmpty(appMetadata),
+    issueMetadata: absentIfEmpty(issueMetadata),
+  };
 };
 
-const getVersionChangelog = (version, appDir = '.') => {
+const getVersionChangelog = async (version, appDir = '.') => {
   const file = path.resolve(appDir, 'CHANGELOG.md');
 
   return readFile(file)
     .then((buffer) => getChangelogFromMarkdown(version, buffer.toString()))
-    .catch(() => ''); // We're ignoring files that don't exist or that aren't readable
+    .catch(() => ({ changelog: '' })); // We're ignoring files that don't exist or that aren't readable
 };
 
 module.exports = {