zapier-platform-cli 14.1.2 → 15.0.1

package/src/utils/convert.js

@@ -3,6 +3,7 @@ const path = require('path');
 const _ = require('lodash');
 const prettier = require('prettier');
 const semver = require('semver');
+const traverse = require('traverse');
 
 const {
   PACKAGE_VERSION,
@@ -16,7 +17,8 @@ const { snakeCase } = require('./misc');
 const { getPackageLatestVersion } = require('./npm');
 let { startSpinner, endSpinner } = require('./display');
 
-const TEMPLATE_DIR = path.join(__dirname, '../../scaffold/convert');
+const SCAFFOLD_TEMPLATE_DIR = path.join(__dirname, '../../scaffold');
+const GENERATORS_TEMPLATE_DIR = path.join(__dirname, '../generators/templates');
 
 // A placeholder that can be used to identify this is something we need to replace
 // before generating the final code. See replacePlaceholders function. Make it really
@@ -29,10 +31,6 @@ const makePlaceholder = (replacement) => `${REPLACE_DIRECTIVE}${replacement}`;
 const replacePlaceholders = (str) =>
   str.replace(new RegExp(`"${REPLACE_DIRECTIVE}([^"]+)"`, 'g'), '$1');
 
-const quote = (s) => `'${s}'`;
-
-const escapeSpecialChars = (s) => s.replace(/\n/g, '\\n').replace(/'/g, "\\'");
-
 const createFile = async (content, filename, dir) => {
   const destFile = path.join(dir, filename);
   await ensureDir(path.dirname(destFile));
@@ -139,7 +137,7 @@ const renderPackageJson = async (appInfo, appDefinition) => {
     description,
     main: 'index.js',
     scripts: {
-      test: 'mocha --recursive -t 10000',
+      test: 'jest --testTimeout 10000',
     },
     engines: {
       node: `>=${LAMBDA_VERSION}`,
@@ -147,8 +145,7 @@ const renderPackageJson = async (appInfo, appDefinition) => {
     },
     dependencies,
     devDependencies: {
-      mocha: '^5.2.0',
-      should: '^13.2.0',
+      jest: '^29.6.0',
     },
     private: true,
     zapier: zapierMeta,
@@ -157,171 +154,65 @@ const renderPackageJson = async (appInfo, appDefinition) => {
   return prettifyJSON(pkg);
 };
 
-const renderStep = (type, definition) => {
-  let exportBlock = _.cloneDeep(definition);
-  let functionBlock = [];
-
-  ['perform', 'performList', 'performSubscribe', 'performUnsubscribe'].forEach(
-    (funcName) => {
-      const func = definition.operation[funcName];
-      if (func && func.source) {
-        const args = func.args || ['z', 'bundle'];
-        functionBlock.push(
-          `const ${funcName} = async (${args.join(', ')}) => {\n${
-            func.source
-          }\n};`
-        );
-
-        exportBlock.operation[funcName] = makePlaceholder(funcName);
+const renderSource = (definition, functions = {}) => {
+  traverse(definition).forEach(function (source) {
+    if (this.key === 'source') {
+      const args = this.parent.node.args || ['z', 'bundle'];
+      // Find first parent that is not an array (applies to inputFields)
+      const funcNameBase = this.path
+        .slice(0, -1)
+        .reverse()
+        .find((key) => !/^\d+$/.test(key));
+      let funcName = funcNameBase;
+      let funcNum = 0;
+      while (functions[funcName]) {
+        funcNum++;
+        funcName = `${funcNameBase}${funcNum}`;
       }
-    }
-  );
+      functions[funcName] = `const ${funcName} = async (${args.join(
+        ', '
+      )}) => {\n${source}\n};`;
 
-  ['inputFields', 'outputFields'].forEach((key) => {
-    const fields = definition.operation[key];
-    if (Array.isArray(fields) && fields.length > 0) {
-      // Godzilla currently doesn't allow mutliple dynamic fields (see PDE-948) but when it does, this will account for it
-      let funcNum = 0;
-      fields.forEach((maybeFunc, index) => {
-        if (maybeFunc.source) {
-          const args = maybeFunc.args || ['z', 'bundle'];
-          // always increment the number, but only return a value if it's > 0
-          const funcName = `get${_.upperFirst(key)}${
-            funcNum ? funcNum++ : ++funcNum && ''
-          }`;
-          functionBlock.push(
-            `const ${funcName} = async (${args.join(', ')}) => {\n${
-              maybeFunc.source
-            }\n};`
-          );
-
-          exportBlock.operation[key][index] = makePlaceholder(funcName);
-        }
-      });
+      this.parent.update(makePlaceholder(funcName));
     }
   });
+};
+
+const renderDefinitionSlice = (definitionSlice) => {
+  let exportBlock = _.cloneDeep(definitionSlice);
+  let functionBlock = {};
+
+  renderSource(exportBlock, functionBlock);
 
   exportBlock = `module.exports = ${replacePlaceholders(
     JSON.stringify(exportBlock)
   )};\n`;
 
-  functionBlock = functionBlock.join('\n\n');
+  functionBlock = Object.values(functionBlock).join('\n\n');
 
   return prettifyJs(functionBlock + '\n\n' + exportBlock);
 };
 
-// Render authData for test code
-const renderAuthData = (appDefinition) => {
-  const fieldKeys = getAuthFieldKeys(appDefinition);
-  const lines = _.map(fieldKeys, (key) => {
-    const upperKey = _.snakeCase(key).toUpperCase();
-    return `"${key}": process.env.${upperKey}`;
-  });
-  if (_.isEmpty(lines)) {
-    return `{
-      // TODO: Put your custom auth data here
-    }`;
-  }
-  return '{' + lines.join(',\n') + '}';
-};
-
-const renderDefaultInputData = (definition) => {
-  const lines = [];
-
-  if (definition.inputFields) {
-    definition.inputFields.forEach((field) => {
-      if (field.default || field.required) {
-        const defaultValue = field.default
-          ? quote(escapeSpecialChars(field.default))
-          : null;
-        lines.push(`'${field.key}': ${defaultValue}`);
-      }
-    });
-  }
-
-  if (lines.length === 0) {
-    return '{}';
-  }
-  return `{
-    // TODO: Pulled from input fields' default values. Edit if necessary.
-    ${lines.join(',\n')}
-  }`;
-};
-
-const renderStepTest = async (stepType, definition, appDefinition) => {
-  const templateName = {
-    triggers: 'trigger-test.template.js',
-    creates: 'create-test.template.js',
-    searches: 'search-test.template.js',
-  }[stepType];
-
+const renderStepTest = async (stepType, definition) => {
   const templateContext = {
-    key: definition.key,
-    authData: renderAuthData(appDefinition),
-    inputData: renderDefaultInputData(definition),
+    ACTION_PLURAL: stepType,
+    KEY: definition.key,
+    MAYBE_RESOURCE: '',
   };
 
-  const templateFile = path.join(TEMPLATE_DIR, templateName);
+  const templateFile = path.join(SCAFFOLD_TEMPLATE_DIR, 'test.template.js');
   return renderTemplate(templateFile, templateContext);
 };
 
-const renderAuth = async (appDefinition) => {
-  let exportBlock = _.cloneDeep(appDefinition.authentication);
-  let functionBlock = [];
+const renderAuth = async (appDefinition) =>
+  renderDefinitionSlice(appDefinition.authentication);
 
-  _.each(
-    {
-      connectionLabel: 'getConnectionLabel',
-      test: 'testAuth',
-    },
-    (funcName, key) => {
-      const func = appDefinition.authentication[key];
-      if (func && func.source) {
-        const args = func.args || ['z', 'bundle'];
-        functionBlock.push(
-          `const ${funcName} = async (${args.join(', ')}) => {${func.source}};`
-        );
-
-        exportBlock[key] = makePlaceholder(funcName);
-      }
-    }
-  );
-
-  exportBlock = `module.exports = ${replacePlaceholders(
-    JSON.stringify(exportBlock)
-  )};\n`;
-
-  functionBlock = functionBlock.join('\n\n');
-
-  return prettifyJs(functionBlock + '\n\n' + exportBlock);
-};
-
-const renderHydrators = async (appDefinition) => {
-  let exportBlock = _.cloneDeep(appDefinition.hydrators);
-  let functionBlock = [];
-
-  _.each(appDefinition.hydrators, (func, funcName) => {
-    if (func && func.source) {
-      const args = func.args || ['z', 'bundle'];
-      functionBlock.push(
-        `const ${funcName} = async (${args.join(', ')}) => {${func.source}};`
-      );
-      exportBlock[funcName] = makePlaceholder(funcName);
-    }
-  });
-
-  exportBlock = `module.exports = ${replacePlaceholders(
-    JSON.stringify(exportBlock)
-  )};\n`;
-
-  functionBlock = functionBlock.join('\n\n');
-
-  return prettifyJs(functionBlock + '\n\n' + exportBlock);
-};
+const renderHydrators = async (appDefinition) =>
+  renderDefinitionSlice(appDefinition.hydrators);
 
 const renderIndex = async (appDefinition) => {
   let exportBlock = _.cloneDeep(appDefinition);
-  let functionBlock = [];
+  let functionBlock = {};
   let importBlock = [];
 
   // replace version and platformVersion with dynamic reference
@@ -360,22 +251,7 @@ const renderIndex = async (appDefinition) => {
     exportBlock.hydrators = makePlaceholder('hydrators');
   }
 
-  ['beforeRequest', 'afterResponse'].forEach((middlewareType) => {
-    const middlewares = appDefinition[middlewareType];
-    if (middlewares && middlewares.length > 0) {
-      // Backend converter always generates only one middleware
-      const func = middlewares[0];
-      if (func.source) {
-        const args = func.args || ['z', 'bundle'];
-        const funcName = middlewareType;
-        functionBlock.push(
-          `const ${funcName} = async (${args.join(', ')}) => {${func.source}};`
-        );
-
-        exportBlock[middlewareType][0] = makePlaceholder(funcName);
-      }
-    }
-  });
+  renderSource(exportBlock, functionBlock);
 
   if (appDefinition.legacy && appDefinition.legacy.scriptingSource) {
     importBlock.push("\nconst fs = require('fs');");
@@ -390,7 +266,7 @@ const renderIndex = async (appDefinition) => {
   )};`;
 
   importBlock = importBlock.join('\n');
-  functionBlock = functionBlock.join('\n\n');
+  functionBlock = Object.values(functionBlock).join('\n\n');
 
   return prettifyJs(
     importBlock + '\n\n' + functionBlock + '\n\n' + exportBlock
@@ -408,19 +284,13 @@ const renderEnvironment = (appDefinition) => {
 
 const writeStep = async (stepType, definition, key, newAppDir) => {
   const filename = `${stepType}/${snakeCase(key)}.js`;
-  const content = await renderStep(stepType, definition);
+  const content = await renderDefinitionSlice(definition);
   await createFile(content, filename, newAppDir);
 };
 
-const writeStepTest = async (
-  stepType,
-  definition,
-  key,
-  appDefinition,
-  newAppDir
-) => {
-  const filename = `test/${stepType}/${snakeCase(key)}.js`;
-  const content = await renderStepTest(stepType, definition, appDefinition);
+const writeStepTest = async (stepType, definition, key, newAppDir) => {
+  const filename = `test/${stepType}/${snakeCase(key)}.test.js`;
+  const content = await renderStepTest(stepType, definition);
   await createFile(content, filename, newAppDir);
 };
 
@@ -458,7 +328,7 @@ const writeEnvironment = async (appDefinition, newAppDir) => {
 };
 
 const writeGitIgnore = async (newAppDir) => {
-  const srcPath = path.join(TEMPLATE_DIR, '/gitignore');
+  const srcPath = path.join(GENERATORS_TEMPLATE_DIR, '/gitignore');
   const destPath = path.join(newAppDir, '/.gitignore');
   await copyFile(srcPath, destPath);
 };
@@ -489,7 +359,7 @@ const convertApp = async (appInfo, appDefinition, newAppDir) => {
     _.each(appDefinition[stepType], (definition, key) => {
       promises.push(
         writeStep(stepType, definition, key, newAppDir),
-        writeStepTest(stepType, definition, key, appDefinition, newAppDir)
+        writeStepTest(stepType, definition, key, newAppDir)
       );
     });
   });

package/src/utils/metadata.js

@@ -0,0 +1,67 @@
+const ACTION_TYPE_MAPPING = {
+  trigger: 'read',
+  create: 'write',
+  search: 'search',
+};
+const isValidActionType = (type) => type in ACTION_TYPE_MAPPING;
+
+const bugfixMatches = new Set(['fix', 'fixed', 'fixes']);
+const featureUpdateMatches = new Set([
+  'add',
+  'adds',
+  'added',
+  'improve',
+  'improves',
+  'improved',
+  'improvement',
+  'improvements',
+  'update',
+  'updates',
+  'updated',
+  'new',
+]);
+
+const extractMetadata = (token, context) => {
+  if (!context) {
+    return;
+  }
+  const issueMetadata = token.match(/#(?<issueId>\d+)/);
+  if (Number.isInteger(Number(issueMetadata?.groups?.issueId))) {
+    return {
+      app_change_type: context,
+      issue_id: Number(issueMetadata?.groups?.issueId),
+    };
+  }
+  const appMetadata = token.match(
+    /(?<actionType>(trigger|create|search))\/(?<actionKey>\w+)/
+  );
+  if (
+    appMetadata?.groups?.actionKey &&
+    isValidActionType(appMetadata.groups.actionType)
+  ) {
+    return {
+      app_change_type: context,
+      action_key: appMetadata.groups.actionKey,
+      action_type: ACTION_TYPE_MAPPING[appMetadata.groups.actionType],
+    };
+  }
+};
+
+function* metadataWalker(line) {
+  let context;
+  for (const token of line.split(' ')) {
+    if (bugfixMatches.has(token.toLowerCase())) {
+      context = 'BUGFIX';
+    } else if (featureUpdateMatches.has(token.toLowerCase())) {
+      context = 'FEATURE_UPDATE';
+    }
+    const metadata = extractMetadata(token, context);
+    if (metadata) {
+      yield metadata;
+    }
+  }
+}
+
+const getMetadata = (content) => Array.from(metadataWalker(content));
+
+module.exports = { getMetadata };

package/src/version-store.js

@@ -16,4 +16,5 @@ module.exports = [
   { nodeVersion: '14', npmVersion: '>=5.6.0' }, // 11.x
   { nodeVersion: '14', npmVersion: '>=5.6.0' }, // 12.x
   { nodeVersion: '16', npmVersion: '>=5.6.0' }, // 13.x
+  { nodeVersion: '18', npmVersion: '>=5.6.0' }, // 15.x
 ];

package/scaffold/convert/create-test.template.js

@@ -1,22 +0,0 @@
-require('should');
-
-const zapier = require('zapier-platform-core');
-
-const App = require('../../index');
-const appTester = zapier.createAppTester(App);
-
-describe('Create - <%= key %>', () => {
-  zapier.tools.env.inject();
-
-  it('should create an object', async () => {
-    const bundle = {
-      authData: <%= authData %>,
-<% if (inputData) { %>
-      inputData: <%= inputData %>
-<% } %>
-    };
-
-    const result = await appTester(App.creates['<%= key %>'].operation.perform, bundle);
-    result.should.not.be.an.Array();
-  });
-});

package/scaffold/convert/gitignore

@@ -1,62 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Typescript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# environment variables file
-.env
-.environment
-
-# next.js build output
-.next

package/scaffold/convert/package.template.json

@@ -1,26 +0,0 @@
-{
-  "name": "<%= name %>",
-  "version": "1.0.0",
-  "description": "<%= description %>",
-  "main": "index.js",
-  "scripts": {
-    "test": "mocha --recursive -t 10000"
-  },
-  "engines": {
-    "node": ">=10",
-    "npm": ">=5.6.0"
-  },
-  "dependencies": {
-    "zapier-platform-core": "<%= coreVersion %>",
-    "zapier-platform-legacy-scripting-runner": "<%= runnerVersion %>"
-  },
-  "devDependencies": {
-    "mocha": "^5.2.0",
-    "should": "^13.2.0"
-  },
-  "private": true,
-  "zapier": {
-    "convertedFromAppID": <%= appId %>,
-    "convertedByCLIVersion": "<%= cliVersion %>"
-  }
-}

package/scaffold/convert/search-test.template.js

@@ -1,24 +0,0 @@
-require('should');
-
-const zapier = require('zapier-platform-core');
-
-const App = require('../../index');
-const appTester = zapier.createAppTester(App);
-
-describe('Search - <%= key %>', () => {
-  zapier.tools.env.inject();
-
-  it('should get an array', async () => {
-    const bundle = {
-      authData: <%= authData %>,
-<% if (inputData) { %>
-      inputData: <%= inputData %>
-<% } %>
-    };
-
-    const results = await appTester(App.searches['<%= key %>'].operation.perform, bundle);
-    results.should.be.an.Array();
-    results.length.should.be.aboveOrEqual(1);
-    results[0].should.have.property('id');
-  });
-});

package/scaffold/convert/trigger-test.template.js

@@ -1,22 +0,0 @@
-require('should');
-
-const zapier = require('zapier-platform-core');
-
-const App = require('../../index');
-const appTester = zapier.createAppTester(App);
-
-describe('Trigger - <%= key %>', () => {
-  zapier.tools.env.inject();
-
-  it('should get an array', async () => {
-    const bundle = {
-      authData: <%= authData %>,
-<% if (inputData) { %>
-      inputData: <%= inputData %>
-<% } %>
-    };
-
-    const results = await appTester(App.triggers['<%= key %>'].operation.perform, bundle);
-    results.should.be.an.Array();
-  });
-});