zapier-platform-core 15.16.0 → 15.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "15.16.0",
+  "version": "15.17.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -53,7 +53,7 @@
     "node-fetch": "2.6.7",
     "oauth-sign": "0.9.0",
     "semver": "7.5.2",
-    "zapier-platform-schema": "15.16.0"
+    "zapier-platform-schema": "15.17.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",
@@ -61,7 +61,7 @@
     "aws-sdk": "^2.1397.0",
     "dicer": "^0.3.1",
     "fs-extra": "^11.1.1",
-    "mock-fs": "^5.2.0",
+    "mock-fs": "^5.3.0",
     "nock": "^13.5.4",
     "tsd": "^0.31.1"
   },

package/src/constants.js

@@ -14,6 +14,8 @@ const RESPONSE_SIZE_LIMIT = 6291456;
 const UPLOAD_MAX_SIZE = 1000 * 1000 * 1000 * 1; // 1GB, in zapier backend too
 const NON_STREAM_UPLOAD_MAX_SIZE = 1000 * 1000 * 150;
 
+const ENCODED_FILENAME_MAX_LENGTH = 1000; // 1KB - S3 Metadata max is 2048
+
 const HYDRATE_DIRECTIVE_HOIST = '$HOIST$';
 
 const RENDER_ONLY_METHODS = [
@@ -58,6 +60,7 @@ const PACKAGE_VERSION = packageJson.version;
 module.exports = {
   DEFAULT_LOGGING_HTTP_API_KEY,
   DEFAULT_LOGGING_HTTP_ENDPOINT,
+  ENCODED_FILENAME_MAX_LENGTH,
   HYDRATE_DIRECTIVE_HOIST,
   IS_TESTING,
   KILL_MAX_LIMIT,

package/src/tools/create-file-stasher.js

@@ -12,7 +12,11 @@ const contentDisposition = require('content-disposition');
 
 const mime = require('mime-types');
 
-const { UPLOAD_MAX_SIZE, NON_STREAM_UPLOAD_MAX_SIZE } = require('../constants');
+const {
+  ENCODED_FILENAME_MAX_LENGTH,
+  UPLOAD_MAX_SIZE,
+  NON_STREAM_UPLOAD_MAX_SIZE,
+} = require('../constants');
 const uploader = require('./uploader');
 
 const DEFAULT_FILE_NAME = 'unnamedfile';
@@ -186,6 +190,24 @@ const ensureUploadMaxSizeNotExceeded = (streamOrData, length) => {
   }
 };
 
+// S3's max metadata size is 2KB
+// If the filename needs to be encoded, both the filename
+// and encoded filename are included in the Content-Disposition header
+const ensureMetadataMaxSizeNotExceeded = (filename) => {
+  const filenameMaxSize = ENCODED_FILENAME_MAX_LENGTH;
+  if (filename) {
+    const encodedFilename = encodeURIComponent(filename);
+    if (
+      encodedFilename !== filename &&
+      encodedFilename.length > filenameMaxSize
+    ) {
+      throw new Error(
+        `URI-Encoded Filename is too long at ${encodedFilename.length}, ${ENCODED_FILENAME_MAX_LENGTH} is the max.`
+      );
+    }
+  }
+};
+
 // Designed to be some user provided function/api.
 const createFileStasher = (input) => {
   const rpc = _.get(input, '_zapier.rpc');
@@ -247,6 +269,8 @@ const createFileStasher = (input) => {
     const finalLength = knownLength || length;
     ensureUploadMaxSizeNotExceeded(streamOrData, finalLength);
 
+    ensureMetadataMaxSizeNotExceeded(filename || _filename);
+
     return uploader(
       signedPostData,
       streamOrData,

package/src/tools/create-logger.js

@@ -330,6 +330,11 @@ const sendLog = async (logStreamFactory, options, event, message, data) => {
     toStdout(event, message, safeData);
   }
 
+  if (event.customLogger && typeof event.customLogger === 'function') {
+    // For `zapier invoke` command
+    event.customLogger(safeMessage, safeData);
+  }
+
   if (options.logBuffer && data.log_type === 'console') {
     // Cap size of messages in log buffer, in case devs log humongous things.
     options.logBuffer.push({ type: safeData.log_type, message: safeMessage });

package/src/tools/create-rpc-client.js

@@ -31,17 +31,42 @@ const rpcCacheMock = (zcacheTestObj, method, key, value = null, ttl = null) => {
   throw new Error(`Unexpected method '${method}'`);
 };
 
+const rpcCursorMock = (cursorTestObj, method, key, value = null) => {
+  if (method === 'get_cursor') {
+    return cursorTestObj[key] || null;
+  }
+
+  if (method === 'set_cursor') {
+    cursorTestObj[key] = value;
+    return null;
+  }
+
+  throw new Error(`Unexpected method '${method}'`);
+};
+
 const createRpcClient = (event) => {
-  return function (method) {
+  return async function (method) {
     const params = _.toArray(arguments);
     params.shift();
 
     const zcacheMethods = ['zcache_get', 'zcache_set', 'zcache_delete'];
-    if (zcacheMethods.includes(method) && _.isPlainObject(event.zcacheTestObj)) {
+    if (
+      zcacheMethods.includes(method) &&
+      _.isPlainObject(event.zcacheTestObj)
+    ) {
       const [key, value = null] = params;
       return rpcCacheMock(event.zcacheTestObj, method, key, value);
     }
 
+    const cursorMethods = ['get_cursor', 'set_cursor'];
+    if (
+      cursorMethods.includes(method) &&
+      _.isPlainObject(event.cursorTestObj)
+    ) {
+      const [key, value = null] = params;
+      return rpcCursorMock(event.cursorTestObj, method, key, value);
+    }
+
     const id = genId();
     const body = JSON.stringify({
       id,
@@ -72,25 +97,46 @@ const createRpcClient = (event) => {
       }
     }
 
-    return request(req)
-      .then((res) => {
+    // RPC can fail, so let's retry.
+    // Be careful what we throw here as this will be forwarded to the user.
+    const maxRetries = 3;
+    let attempt = 0;
+    let res;
+
+    while (attempt < maxRetries) {
+      // We will throw here, which will be caught by catch logic to either retry or bubble up.
+      try {
+        res = await request(req);
+
+        if (res.status > 500) {
+          throw new Error('Unable to reach the RPC server');
+        }
         if (res.content) {
+          // check if the ids match
           if (res.content.id !== id) {
             throw new Error(
               `Got id ${res.content.id} but expected ${id} when calling RPC`
             );
           }
-          return res.content;
+          if (res.content.error) {
+            throw new Error(res.content.error);
+          }
+          return res.content.result;
         } else {
           throw new Error(`Got a ${res.status} when calling RPC`);
         }
-      })
-      .then((content) => {
-        if (content.error) {
-          throw new Error(content.error);
+      } catch (err) {
+        attempt++;
+
+        if (attempt === maxRetries || (res && res.status < 500)) {
+          throw new Error(
+            `RPC request failed after ${attempt} attempts: ${err.message}`
+          );
         }
-        return content.result;
-      });
+        // sleep for 100ms before retrying
+        await new Promise((resolve) => setTimeout(resolve, 100));
+      }
+    }
   };
 };
 

package/types/zapier.custom.d.ts

@@ -73,6 +73,9 @@ declare class RefreshAuthError extends Error {}
 declare class ThrottledError extends Error {
   constructor(message: string, delay?: number);
 }
+declare class ResponseError extends Error {
+  constructor(response: HttpResponse);
+}
 
 // copied http stuff from external typings
 export interface HttpRequestOptions {
@@ -135,12 +138,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>;
@@ -199,6 +203,7 @@ export interface ZObject {
     ExpiredAuthError: typeof ExpiredAuthError;
     RefreshAuthError: typeof RefreshAuthError;
     ThrottledError: typeof ThrottledError;
+    ResponseError: typeof ResponseError;
   };
 
   cache: {

package/types/zapier.generated.d.ts

@@ -4,7 +4,7 @@
  * files, and/or the schema-to-ts tool and run its CLI to regenerate
  * these typings.
  *
- * zapier-platform-schema version: 15.16.0
+ * zapier-platform-schema version: 15.17.0
  *  schema-to-ts compiler version: 0.1.0
  */