zapier-platform-core 11.0.1 → 11.3.0

package/LICENSE

@@ -1,4 +1,3 @@
 Copyright (c) Zapier, Inc.
 
-This repository is part of Zapier Platform, of which license terms can be found at
-https://zapier.com/platform/tos.
+This repository is part of Zapier Platform.  By downloading, installing, accessing, or using any part of the Zapier Platform, including this repository, you agree to the Zapier Platform Agreement, which can be found at: https://zapier.com/platform/tos.  If you do not agree to the Zapier Platform Agreement, you may not download, install, access, or use any part of the Zapier Platform, including this repository.

package/index.d.ts

@@ -37,6 +37,7 @@ export interface Bundle<InputData = { [x: string]: any }> {
   inputData: InputData;
   inputDataRaw: { [x: string]: string };
   meta: {
+    isBulkRead: boolean;
     isFillingDynamicDropdown: boolean;
     isLoadingSample: boolean;
     isPopulatingDedupe: boolean;
@@ -70,6 +71,9 @@ declare class AppError extends Error {
 declare class HaltedError extends Error {}
 declare class ExpiredAuthError extends Error {}
 declare class RefreshAuthError extends Error {}
+declare class ThrottledError extends Error {
+  constructor(message: string, delay?: number);
+}
 
 // copied http stuff from external typings
 export interface HttpRequestOptions {
@@ -123,12 +127,13 @@ type DehydrateFunc = <T>(
 export interface ZObject {
   request: {
     // most specific overloads go first
-    (url: string, options: HttpRequestOptions & { raw: true }): Promise<
-      RawHttpResponse
-    >;
-    (options: HttpRequestOptions & { raw: true; url: string }): Promise<
-      RawHttpResponse
-    >;
+    (
+      url: string,
+      options: HttpRequestOptions & { raw: true }
+    ): Promise<RawHttpResponse>;
+    (
+      options: HttpRequestOptions & { raw: true; url: string }
+    ): Promise<RawHttpResponse>;
 
     (url: string, options?: HttpRequestOptions): Promise<HttpResponse>;
     (options: HttpRequestOptions & { url: string }): Promise<HttpResponse>;
@@ -186,5 +191,6 @@ export interface ZObject {
     HaltedError: typeof HaltedError;
     ExpiredAuthError: typeof ExpiredAuthError;
     RefreshAuthError: typeof RefreshAuthError;
+    ThrottledError: typeof ThrottledError;
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "11.0.1",
+  "version": "11.3.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -18,10 +18,11 @@
     "preversion": "git pull && yarn test",
     "version": "node bin/bump-dependencies.js && yarn && git add package.json yarn.lock",
     "postversion": "git push && git push --tags",
-    "test": "mocha -t 20000 --recursive test",
+    "main-tests": "mocha -t 20000 --recursive test",
+    "solo-test": "test $(OPT_OUT_PATCH_TEST_ONLY=yes mocha --recursive test -g 'should be able to opt out of patch' -R json | jq '.stats.passes') -eq 1 && echo 'Ran 1 test and it passed!'",
+    "test": "yarn main-tests && yarn solo-test",
     "debug": "mocha -t 10000 --inspect-brk --recursive test",
     "test:w": "mocha -t 10000 --recursive test --watch",
-    "plain-test": "mocha -t 5000 --recursive test",
     "integration-test": "mocha -t 20000 integration-test",
     "local-integration-test": "mocha -t 10000 integration-test --local",
     "lambda-integration-test": "mocha -t 10000 integration-test --lambda",
@@ -34,24 +35,27 @@
     "validate": "yarn test && yarn smoke-test && yarn lint"
   },
   "engines": {
-    "node": ">=10",
+    "node": ">=12",
     "npm": ">=5.6.0"
   },
   "engineStrict": true,
   "dependencies": {
+    "@zapier/secret-scrubber": "^1.0.3",
     "bluebird": "3.7.2",
     "content-disposition": "0.5.3",
     "dotenv": "9.0.2",
     "form-data": "4.0.0",
     "lodash": "4.17.21",
-    "node-fetch": "2.6.1",
+    "mime-types": "2.1.34",
+    "node-fetch": "2.6.6",
     "oauth-sign": "0.9.0",
     "semver": "7.3.5",
-    "zapier-platform-schema": "11.0.1"
+    "zapier-platform-schema": "11.3.0"
   },
   "devDependencies": {
     "adm-zip": "0.5.5",
     "aws-sdk": "^2.905.0",
+    "dicer": "^0.3.0",
     "fs-extra": "^10.0.0",
     "mock-fs": "^4.14.0"
   },

package/src/constants.js

@@ -23,17 +23,6 @@ const REQUEST_OBJECT_SHORTHAND_OPTIONS = { isShorthand: true, replace: true };
 const DEFAULT_LOGGING_HTTP_ENDPOINT = 'https://httplogger.zapier.com/input';
 const DEFAULT_LOGGING_HTTP_API_KEY = 'R24hzu86v3jntwtX2DtYECeWAB'; // It's ok, this isn't PROD
 
-const SENSITIVE_KEYS = [
-  'api_key',
-  'apikey',
-  'auth',
-  'passwd',
-  'password',
-  'secret',
-  'signature',
-  'token',
-];
-
 const SAFE_LOG_KEYS = [
   'account_id',
   'api_title',
@@ -76,6 +65,5 @@ module.exports = {
   REQUEST_OBJECT_SHORTHAND_OPTIONS,
   RESPONSE_SIZE_LIMIT,
   SAFE_LOG_KEYS,
-  SENSITIVE_KEYS,
   STATUSES,
 };

package/src/create-command-handler.js

@@ -18,7 +18,7 @@ const commandHandlers = {
   commands like 'execute', 'validate', 'definition', 'request'.
 */
 const createCommandHandler = (compiledApp) => {
-  return (input) => {
+  return async (input) => {
     const command = input._zapier.event.command || 'execute'; // validate || definition || request
     const handler = commandHandlers[command];
     if (!handler) {
@@ -26,7 +26,7 @@ const createCommandHandler = (compiledApp) => {
     }
 
     try {
-      return handler(compiledApp, input);
+      return await handler(compiledApp, input);
     } catch (err) {
       return handleError(err);
     }

package/src/errors.js

@@ -32,6 +32,7 @@ class ResponseError extends Error {
         status: response.status,
         headers: {
           'content-type': response.headers.get('content-type'),
+          'retry-after': response.headers.get('retry-after'),
         },
         content,
         request: {
@@ -44,6 +45,19 @@ class ResponseError extends Error {
   }
 }
 
+class ThrottledError extends Error {
+  constructor(message, delay) {
+    super(
+      JSON.stringify({
+        message,
+        delay,
+      })
+    );
+    this.name = 'ThrottledError';
+    this.doNotContextify = true;
+  }
+}
+
 // Make some of the errors we'll use!
 const createError = (name) => {
   const NewError = function (message = '') {
@@ -77,6 +91,7 @@ const exceptions = _.reduce(
   {
     Error: AppError,
     ResponseError,
+    ThrottledError,
   }
 );
 

package/src/tools/cleaner.js

@@ -45,6 +45,12 @@ const recurseCleanFuncs = (obj, path) => {
 
 // Recurse a nested object replace all instances of keys->vals in the bank.
 const recurseReplaceBank = (obj, bank = {}) => {
+  const matchesCurlies = /({{.*?}})/;
+  const matchesKeyRegexMap = Object.keys(bank).reduce((acc, key) => {
+    // Escape characters (ex. {{foo}} => \\{\\{foo\\}\\} )
+    acc[key] = new RegExp(key.replace(/[-[\]/{}()\\*+?.^$|]/g, '\\$&'), 'g');
+    return acc;
+  }, {});
   const replacer = (out) => {
     if (!['string', 'number'].includes(typeof out)) {
       return out;
@@ -57,15 +63,11 @@ const recurseReplaceBank = (obj, bank = {}) => {
     let maybeChangedString = originalValueStr;
 
     Object.keys(bank).forEach((key) => {
-      // Escape characters (ex. {{foo}} => \\{\\{foo\\}\\} )
-      const escapedKey = key.replace(/[-[\]/{}()\\*+?.^$|]/g, '\\$&');
-      const matchesKey = new RegExp(escapedKey, 'g');
-
+      const matchesKey = matchesKeyRegexMap[key];
       if (!matchesKey.test(maybeChangedString)) {
         return;
       }
 
-      const matchesCurlies = /({{.*?}})/;
       const valueParts = maybeChangedString
         .split(matchesCurlies)
         .filter(Boolean);
@@ -156,7 +158,7 @@ const isEmptyQueryParam = (value) =>
   value === '' ||
   value === null ||
   value === undefined ||
-  isCurlies.test(value);
+  (typeof value === 'string' && value.search(isCurlies) >= 0);
 
 const normalizeEmptyParamFields = normalizeEmptyRequestFields.bind(
   null,
@@ -165,7 +167,7 @@ const normalizeEmptyParamFields = normalizeEmptyRequestFields.bind(
 );
 const normalizeEmptyBodyFields = normalizeEmptyRequestFields.bind(
   null,
-  (v) => isCurlies.test(v),
+  (v) => typeof v === 'string' && v.search(isCurlies) >= 0,
   'body'
 );
 

package/src/tools/create-app-tester.js

@@ -3,32 +3,9 @@
 const createLambdaHandler = require('./create-lambda-handler');
 const resolveMethodPath = require('./resolve-method-path');
 const ZapierPromise = require('./promise');
-const { get } = require('lodash');
+const { isFunction } = require('lodash');
 const { genId } = require('./data');
-
-// this is (annoyingly) mirrored in cli/api_base, so that test functions only
-// have a storeKey when canPaginate is true. otherwise, a test would work but a
-// poll on site would fail. this is only used in test handlers
-
-// there are 2 places you can put a method that can interact with cursors:
-// triggers.contact.operation.perform, if it's a poll trigger
-// resources.contact.list.operation.perform if it's a resource
-// schema doesn't currently allow cursor use on hook trigger `performList`, so we don't need to account for it
-const shouldPaginate = (appRaw, method) => {
-  const methodParts = method.split('.');
-
-  if (
-    method.endsWith('perform') &&
-    ((methodParts[0] === 'resources' && methodParts[2] === 'list') ||
-      methodParts[0] === 'triggers' ||
-      methodParts[0] === 'bulkReads')
-  ) {
-    methodParts.pop();
-    return get(appRaw, [...methodParts, 'canPaginate']);
-  }
-
-  return false;
-};
+const { shouldPaginate } = require('./should-paginate');
 
 // Convert a app handler to promise for convenience.
 const promisifyHandler = (handler) => {
@@ -55,7 +32,21 @@ const createAppTester = (appRaw, { customStoreKey } = {}) => {
   return (methodOrFunc, bundle) => {
     bundle = bundle || {};
 
-    const method = resolveMethodPath(appRaw, methodOrFunc);
+    let method = resolveMethodPath(appRaw, methodOrFunc, false);
+    if (!method) {
+      if (isFunction(methodOrFunc)) {
+        // definitely have a function but didn't find it on the app; it's an adhoc
+        appRaw._testRequest = (z, bundle) => methodOrFunc(z, bundle);
+        method = resolveMethodPath(appRaw, appRaw._testRequest);
+      } else {
+        throw new Error(
+          `Unable to find the following on your App instance: ${JSON.stringify(
+            methodOrFunc
+          )}`
+        );
+      }
+    }
+
     const storeKey = shouldPaginate(appRaw, method)
       ? customStoreKey
         ? `testKey-${customStoreKey}`
@@ -77,7 +68,10 @@ const createAppTester = (appRaw, { customStoreKey } = {}) => {
       event.detailedLogToStdout = true;
     }
 
-    return createHandlerPromise(event).then((resp) => resp.results);
+    return createHandlerPromise(event).then((resp) => {
+      delete appRaw._testRequest; // clear adHocFunc so tests can't affect each other
+      return resp.results;
+    });
   };
 };