@jsforce/jsforce-node 3.0.0-next.2 → 3.0.0-next.3

package/lib/request.js

@@ -4,10 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setDefaults = void 0;
+const stream_1 = require("stream");
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const abort_controller_1 = __importDefault(require("abort-controller"));
 const https_proxy_agent_1 = __importDefault(require("https-proxy-agent"));
 const request_helper_1 = require("./request-helper");
+const logger_1 = require("./util/logger");
+const is_1 = __importDefault(require("@sindresorhus/is"));
 /**
  *
  */
@@ -23,13 +26,35 @@ exports.setDefaults = setDefaults;
  *
  */
 async function startFetchRequest(request, options, input, output, emitter, counter = 0) {
+    const logger = (0, logger_1.getLogger)('fetch');
     const { httpProxy, followRedirect } = options;
     const agent = httpProxy ? (0, https_proxy_agent_1.default)(httpProxy) : undefined;
     const { url, body, ...rrequest } = request;
     const controller = new abort_controller_1.default();
-    let res;
-    try {
-        res = await (0, request_helper_1.executeWithTimeout)(() => (0, node_fetch_1.default)(url, {
+    let retryCount = 0;
+    const retryOpts = {
+        maxRetries: options.retry?.maxRetries ?? 5,
+        errorCodes: options.retry?.errorCodes ?? [
+            'ECONNRESET',
+            'ECONNREFUSED',
+            'ENOTFOUND',
+            'ENETDOWN',
+            'ENETUNREACH',
+            'EHOSTDOWN',
+            'UND_ERR_SOCKET',
+            'ETIMEDOUT',
+            'EPIPE',
+        ],
+        methods: options.retry?.methods ?? [
+            'GET',
+            'PUT',
+            'HEAD',
+            'OPTIONS',
+            'DELETE',
+        ],
+    };
+    const fetchWithRetries = async (maxRetry = retryOpts?.maxRetries) => {
+        const fetchOpts = {
             ...rrequest,
             ...(input && /^(post|put|patch)$/i.test(request.method)
                 ? { body: input }
@@ -37,7 +62,51 @@ async function startFetchRequest(request, options, input, output, emitter, count
             redirect: 'manual',
             signal: controller.signal,
             agent,
-        }), options.timeout, () => controller.abort());
+        };
+        try {
+            return await (0, node_fetch_1.default)(url, fetchOpts);
+        }
+        catch (err) {
+            logger.debug(`Request failed`);
+            const error = err;
+            // request was canceled by consumer (AbortController), skip retry and rethrow.
+            if (error.name === 'AbortError') {
+                throw error;
+            }
+            const shouldRetry = () => {
+                // only retry on operational errors
+                if (error.name != 'FetchError')
+                    return false;
+                if (retryCount === maxRetry)
+                    return false;
+                if (!retryOpts?.methods?.includes(request.method))
+                    return false;
+                if (is_1.default.nodeStream(body) && stream_1.Readable.isDisturbed(body)) {
+                    logger.debug('Body of type stream was read, unable to retry request.');
+                    return false;
+                }
+                if ('code' in error &&
+                    error.code &&
+                    retryOpts?.errorCodes?.includes(error.code))
+                    return true;
+                return false;
+            };
+            if (shouldRetry()) {
+                logger.debug(`retrying for the ${retryCount + 1} time`);
+                logger.debug(`Error: ${error}`);
+                // NOTE: this event is only used by tests and will be removed at any time.
+                // jsforce may switch to node's fetch which doesn't emit this event on retries.
+                emitter.emit('retry', retryCount);
+                retryCount++;
+                return await fetchWithRetries(maxRetry);
+            }
+            logger.debug('Skipping retry...');
+            throw err;
+        }
+    };
+    let res;
+    try {
+        res = await (0, request_helper_1.executeWithTimeout)(fetchWithRetries, options.timeout, () => controller.abort());
     }
     catch (err) {
         emitter.emit('error', err);

package/lib/types/common.d.ts

@@ -9,7 +9,7 @@ import * as FormData from 'form-data';
  */
 export type Callback<T, T2 = undefined> = (err: Error | null | undefined, ret?: T, ret2?: T2) => any;
 export type HttpBody = Buffer | URLSearchParams | NodeJS.ReadableStream | string | FormData | null;
-export type HttpMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+export type HttpMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
 export type HttpRequest = {
     url: string;
     method: HttpMethods;
@@ -19,6 +19,11 @@ export type HttpRequest = {
     body?: HttpBody;
 };
 export type HttpRequestOptions = {
+    retry?: {
+        maxRetries?: number;
+        errorCodes?: string[];
+        methods?: HttpMethods[];
+    };
     httpProxy?: string;
     timeout?: number;
     followRedirect?: boolean | ((redirectUrl: string) => HttpRequest | null);

package/package.json

@@ -10,7 +10,7 @@
     "database.com"
   ],
   "homepage": "http://github.com/jsforce/jsforce",
-  "version": "3.0.0-next.2",
+  "version": "3.0.0-next.3",
   "repository": {
     "type": "git",
     "url": "git://github.com/jsforce/jsforce.git"