zapier-platform-core 12.0.3 → 12.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "12.0.3",
+  "version": "12.1.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -47,10 +47,11 @@
     "form-data": "4.0.0",
     "lodash": "4.17.21",
     "mime-types": "2.1.34",
+    "node-abort-controller": "3.0.1",
     "node-fetch": "2.6.7",
     "oauth-sign": "0.9.0",
     "semver": "7.3.5",
-    "zapier-platform-schema": "12.0.3"
+    "zapier-platform-schema": "12.1.0"
   },
   "devDependencies": {
     "adm-zip": "0.5.5",

package/src/tools/create-logger.js

@@ -1,9 +1,11 @@
 'use strict';
 
+const { promisify } = require('util');
 const { Transform } = require('stream');
 const { parse: querystringParse } = require('querystring');
 
 const _ = require('lodash');
+const { AbortController } = require('node-abort-controller');
 
 const request = require('./request-client-internal');
 const { simpleTruncate, recurseReplace, truncateData } = require('./data');
@@ -28,6 +30,10 @@ const {
 // than the limit (16 MB) on the server side.
 const LOG_STREAM_BYTES_LIMIT = 15 * 1024 * 1024;
 
+const DEFAULT_LOGGER_TIMEOUT = 200;
+
+const sleep = promisify(setTimeout);
+
 const isUrl = (url) => {
   try {
     // eslint-disable-next-line no-new
@@ -167,6 +173,7 @@ class LogStream extends Transform {
   constructor(options) {
     super(options);
     this.bytesWritten = 0;
+    this.controller = new AbortController();
     this.request = this._newRequest(options.url, options.token);
   }
 
@@ -179,15 +186,20 @@ class LogStream extends Transform {
         'X-Token': token,
       },
       body: this,
+      signal: this.controller.signal,
     };
     return request(httpOptions).catch((err) => {
+      if (err.name === 'AbortError') {
+        return {
+          status: 200,
+          content: 'aborted',
+        };
+      }
+
       // Swallow logging errors. This will show up in AWS logs at least.
-      console.error(
-        'Error making log request:',
-        err,
-        'http options:',
-        httpOptions
-      );
+      // Don't need to log for AbortError because that happens when we abort
+      // on purpose.
+      console.error('Error making log request:', err);
     });
   }
 
@@ -196,6 +208,10 @@ class LogStream extends Transform {
     this.bytesWritten += Buffer.byteLength(chunk, encoding);
     callback();
   }
+
+  abort() {
+    this.controller.abort();
+  }
 }
 
 // Implements singleton for LogStream. The goal is for every sendLog() call we
@@ -222,17 +238,35 @@ class LogStreamFactory {
     return this._logStream;
   }
 
-  async end() {
+  // Ends the logger and gets a response from the log server. Optionally takes
+  // timeoutToAbort to specify how many milliseconds we want to wait before
+  // force aborting the connection to the log server.
+  async end(timeoutToAbort = DEFAULT_LOGGER_TIMEOUT) {
     // Mark the factory as ended. This suggests that any logStream.write() that
     // follows should end() right away.
     this.ended = true;
+    let response;
 
     if (this._logStream) {
       this._logStream.end();
-      const response = await this._logStream.request;
+
+      const clock =
+        timeoutToAbort > 0 ? sleep(timeoutToAbort) : Promise.resolve(undefined);
+      const responsePromise = this._logStream.request;
+
+      const result = await Promise.race([clock, responsePromise]);
+      const isTimeout = !result;
+      if (isTimeout) {
+        this._logStream.abort();
+        // Expect to get a `{content: 'aborted'}` response
+        response = await responsePromise;
+      } else {
+        response = result;
+      }
+
       this._logStream = null;
-      return response;
     }
+    return response;
   }
 }
 
@@ -294,7 +328,7 @@ const sendLog = async (logStreamFactory, options, event, message, data) => {
       // (bad) callback that is still running after the Lambda handler returns?
       // We need to make sure the bad callback ends the logger as well.
       // Otherwise, it will hang!
-      logStreamFactory.end();
+      logStreamFactory.end(DEFAULT_LOGGER_TIMEOUT);
     }
   }
 };
@@ -331,8 +365,8 @@ const createLogger = (event, options) => {
   const logStreamFactory = new LogStreamFactory();
   const logger = sendLog.bind(undefined, logStreamFactory, options, event);
 
-  logger.end = async () => {
-    return logStreamFactory.end();
+  logger.end = async (timeoutToAbort = DEFAULT_LOGGER_TIMEOUT) => {
+    return logStreamFactory.end(timeoutToAbort);
   };
   return logger;
 };