zapier-platform-core 15.9.0 → 15.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "15.9.0",
+  "version": "15.10.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -52,7 +52,7 @@
     "node-fetch": "2.6.7",
     "oauth-sign": "0.9.0",
     "semver": "7.5.2",
-    "zapier-platform-schema": "15.9.0"
+    "zapier-platform-schema": "15.10.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",

package/src/app-middlewares/after/large-response-cacher.js

@@ -6,6 +6,9 @@ const responseStasher = require('../../tools/create-response-stasher');
 
 const largeResponseCachePointer = async (output) => {
   const response = cleaner.maskOutput(output);
+  if (!response.results) {
+    return output;
+  }
 
   const autostashLimit = output.input._zapier.event.autostashPayloadOutputLimit;
 

package/src/tools/create-http-patch.js

@@ -1,5 +1,8 @@
 const zlib = require('zlib');
 const _ = require('lodash');
+
+const { ALLOWED_HTTP_DATA_CONTENT_TYPES, getContentType } = require('./http');
+
 const constants = require('../constants');
 
 const createHttpPatch = (event) => {
@@ -54,19 +57,34 @@ const createHttpPatch = (event) => {
       const newCallback = function (response) {
         const chunks = [];
 
+        // Only include request or response data for specific content types
+        // which we are able to read in logs and which are not typically too large
+        const requestContentType = getContentType(options.headers || {});
+        const responseContentType = getContentType(response.headers || {});
+
+        const shouldIncludeRequestData =
+          ALLOWED_HTTP_DATA_CONTENT_TYPES.has(requestContentType);
+        const shouldIncludeResponseData =
+          ALLOWED_HTTP_DATA_CONTENT_TYPES.has(responseContentType);
+
         const sendToLogger = (responseBody) => {
           // Prepare data for GL
           const logData = {
             log_type: 'http',
-            request_type: 'devplatform-outbound',
+            // Using a custom request_type to differentiate from z.request() since `request_via_client` is not logged in GL
+            request_type: 'patched-devplatform-outbound',
             request_url: requestUrl,
             request_method: options.method || 'GET',
             request_headers: options.headers,
-            request_data: options.body || '',
+            request_data: shouldIncludeRequestData
+              ? options.body || ''
+              : '<unsupported format>',
             request_via_client: false,
             response_status_code: response.statusCode,
             response_headers: response.headers,
-            response_content: responseBody,
+            response_content: shouldIncludeResponseData
+              ? responseBody
+              : '<unsupported format>',
           };
 
           object.zapierLogger(

package/src/tools/create-lambda-handler.js

@@ -19,42 +19,43 @@ const environmentTools = require('./environment');
 const schemaTools = require('./schema');
 const ZapierPromise = require('./promise');
 
-const RequestSchema = require('zapier-platform-schema/lib/schemas/RequestSchema');
-const FunctionSchema = require('zapier-platform-schema/lib/schemas/FunctionSchema');
-
-const isRequestOrFunction = (obj) => {
+const isDefinedPrimitive = (value) => {
   return (
-    RequestSchema.validate(obj).valid || FunctionSchema.validate(obj).valid
+    value === null ||
+    typeof value === 'string' ||
+    typeof value === 'number' ||
+    typeof value === 'boolean'
   );
 };
 
-const extendAppRaw = (base, extension) => {
-  const keysToOverride = [
-    'test',
-    'perform',
-    'performList',
-    'performSubscribe',
-    'performUnsubscribe',
-  ];
-  const concatArrayAndOverrideKeys = (objValue, srcValue, key) => {
-    if (Array.isArray(objValue) && Array.isArray(srcValue)) {
-      return objValue.concat(srcValue);
-    }
+const shouldFullyReplace = (path) => {
+  // covers inputFields, outputFields, sample, throttle, etc
+  const isOperation = path[path.length - 2] === 'operation';
+  return isOperation;
+};
 
-    if (
-      // Do full replacement when it comes to keysToOverride
-      keysToOverride.indexOf(key) !== -1 &&
-      _.isPlainObject(srcValue) &&
-      _.isPlainObject(objValue) &&
-      isRequestOrFunction(srcValue) &&
-      isRequestOrFunction(objValue)
-    ) {
-      return srcValue;
+const extendAppRaw = (base, extension, path) => {
+  if (extension === undefined) {
+    return base;
+  } else if (isDefinedPrimitive(extension)) {
+    return extension;
+  } else if (Array.isArray(extension)) {
+    return [...extension];
+  } else if (_.isPlainObject(extension)) {
+    path = path || [];
+    if (shouldFullyReplace(path)) {
+      return extension;
+    } else {
+      const baseObject = _.isPlainObject(base) ? base : {};
+      const result = { ...baseObject };
+      for (const [key, value] of Object.entries(extension)) {
+        const newPath = [...path, key];
+        result[key] = extendAppRaw(baseObject[key], value, newPath);
+      }
+      return result;
     }
-
-    return undefined;
-  };
-  return _.mergeWith(base, extension, concatArrayAndOverrideKeys);
+  }
+  throw new TypeError('Unexpected type');
 };
 
 const getAppRawOverride = (rpc, appRawOverride) => {
@@ -116,17 +117,25 @@ const getAppRawOverride = (rpc, appRawOverride) => {
 // so allow for that, and an event.appRawOverride for "buildless" apps.
 const loadApp = (event, rpc, appRawOrPath) => {
   return new ZapierPromise((resolve, reject) => {
+    const appRaw = _.isString(appRawOrPath)
+      ? require(appRawOrPath)
+      : appRawOrPath;
+
     if (event && event.appRawOverride) {
+      if (
+        Array.isArray(event.appRawOverride) &&
+        event.appRawOverride.length > 1 &&
+        !event.appRawOverride[0]
+      ) {
+        event.appRawOverride[0] = appRaw;
+      }
+
       return getAppRawOverride(rpc, event.appRawOverride)
         .then((appRawOverride) => resolve(appRawOverride))
         .catch((err) => reject(err));
     }
 
-    if (_.isString(appRawOrPath)) {
-      return resolve(require(appRawOrPath));
-    }
-
-    return resolve(appRawOrPath);
+    return resolve(appRaw);
   });
 };
 

package/src/tools/http.js

@@ -4,6 +4,23 @@ const fetch = require('node-fetch');
 const FORM_TYPE = 'application/x-www-form-urlencoded';
 const JSON_TYPE = 'application/json';
 const JSON_TYPE_UTF8 = 'application/json; charset=utf-8';
+const BINARY_TYPE = 'application/octet-stream';
+const HTML_TYPE = 'text/html';
+const TEXT_TYPE = 'text/plain';
+const YAML_TYPE = 'application/yaml';
+const XML_TYPE = 'application/xml';
+const JSONAPI_TYPE = 'application/vnd.api+json';
+
+const ALLOWED_HTTP_DATA_CONTENT_TYPES = new Set([
+  FORM_TYPE,
+  JSON_TYPE,
+  JSON_TYPE_UTF8,
+  HTML_TYPE,
+  TEXT_TYPE,
+  YAML_TYPE,
+  XML_TYPE,
+  JSONAPI_TYPE,
+]);
 
 const getContentType = (headers) => {
   const headerKeys = Object.keys(headers);
@@ -101,6 +118,13 @@ module.exports = {
   FORM_TYPE,
   JSON_TYPE,
   JSON_TYPE_UTF8,
+  BINARY_TYPE,
+  HTML_TYPE,
+  TEXT_TYPE,
+  YAML_TYPE,
+  XML_TYPE,
+  JSONAPI_TYPE,
+  ALLOWED_HTTP_DATA_CONTENT_TYPES,
   getContentType,
   parseDictHeader,
   unheader,

package/src/tools/wrap-hydrate.js

@@ -4,9 +4,11 @@ const crypto = require('crypto');
 
 const { DehydrateError } = require('../errors');
 
-// Max URL length for Node is 8KB (https://stackoverflow.com/a/56954244/)
-// 8 * 1024 * (3 / 4) = 6144 max, minus some room for additional overhead
-const MAX_PAYLOAD_SIZE = 6000;
+// https://nodejs.org/docs/latest-v16.x/api/http.html#httpmaxheadersize
+// Base64 encoding adds approx 4/3 to the original size
+// To account for encoding, we use the inverse to calc the max original size (3/4)
+// 16kb limit * 1024 * (3 / 4) = 12.228 kb max, minus some room for additional overhead
+const MAX_PAYLOAD_SIZE = 12000;
 
 const wrapHydrate = (payload) => {
   payload = JSON.stringify(payload);