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

package/lib/connection.d.ts

@@ -19,7 +19,8 @@ import QuickAction from './quick-action';
 import Process from './process';
 import Analytics from './api/analytics';
 import Apex from './api/apex';
-import { Bulk, BulkV2 } from './api/bulk';
+import { Bulk } from './api/bulk';
+import { BulkV2 } from './api/bulk2';
 import Chatter from './api/chatter';
 import Metadata from './api/metadata';
 import SoapApi from './api/soap';

package/lib/http-api.js

@@ -13,6 +13,7 @@ const logger_1 = require("./util/logger");
 const promise_1 = require("./util/promise");
 const csv_1 = require("./csv");
 const stream_1 = require("./util/stream");
+const get_body_size_1 = require("./util/get-body-size");
 /** @private */
 function parseJSON(str) {
     return JSON.parse(str);
@@ -103,6 +104,23 @@ class HttpApi extends events_1.EventEmitter {
                 // when session refresh delegate is available
                 if (this.isSessionExpired(response) && refreshDelegate) {
                     await refreshDelegate.refresh(requestTime);
+                    /* remove the `content-length` header after token refresh
+                     *
+                     * SOAP requests include the access token their the body,
+                     * if the first req had an invalid token and jsforce successfully
+                     * refreshed it we need to remove the `content-length` header
+                     * so that it get's re-calculated again with the new body.
+                     *
+                     * REST request aren't affected by this because the access token
+                     * is sent via HTTP headers
+                     *
+                     * `_message` is only present in SOAP requests
+                     */
+                    if ('_message' in request &&
+                        request.headers &&
+                        'content-length' in request.headers) {
+                        delete request.headers['content-length'];
+                    }
                     return this.request(request);
                 }
                 if (this.isErrorResponse(response)) {
@@ -137,6 +155,16 @@ class HttpApi extends events_1.EventEmitter {
             }
             headers['Sforce-Call-Options'] = callOptions.join(', ');
         }
+        const bodySize = (0, get_body_size_1.getBodySize)(request.body, headers);
+        const cannotHaveBody = ['GET', 'HEAD', 'OPTIONS'].includes(request.method);
+        if (!cannotHaveBody &&
+            !!request.body &&
+            !('transfer-encoding' in headers) &&
+            !('content-length' in headers) &&
+            !!bodySize) {
+            this._logger.debug(`missing 'content-length' header, setting it to: ${bodySize}`);
+            headers['content-length'] = String(bodySize);
+        }
         request.headers = headers;
     }
     /**
@@ -214,6 +242,10 @@ class HttpApi extends events_1.EventEmitter {
      */
     parseError(body) {
         const errors = body;
+        // XML response
+        if (errors.Errors) {
+            return errors.Errors.Error;
+        }
         return Array.isArray(errors) ? errors[0] : errors;
     }
     /**
@@ -237,6 +269,12 @@ class HttpApi extends events_1.EventEmitter {
                     errorCode: `ERROR_HTTP_${response.statusCode}`,
                     message: response.body,
                 };
+        if (response.headers['content-type'] === 'text/html') {
+            this._logger.debug(`html response.body: ${response.body}`);
+            return new HttpApiError(`HTTP response contains html content.
+Check that the org exists and can be reached.
+See error.content for the full html response.`, error.errorCode, error.message);
+        }
         return new HttpApiError(error.message, error.errorCode);
     }
 }

package/lib/index.d.ts

@@ -2,6 +2,7 @@ import jsforce from './jsforce';
 import './api/analytics';
 import './api/apex';
 import './api/bulk';
+import './api/bulk2';
 import './api/chatter';
 import './api/metadata';
 import './api/soap';

package/lib/index.js

@@ -21,6 +21,7 @@ const jsforce_1 = __importDefault(require("./jsforce"));
 require("./api/analytics");
 require("./api/apex");
 require("./api/bulk");
+require("./api/bulk2");
 require("./api/chatter");
 require("./api/metadata");
 require("./api/soap");

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/soap.js

@@ -10,6 +10,7 @@ exports.SOAP = exports.castTypeUsingSchema = void 0;
  */
 const http_api_1 = __importDefault(require("./http-api"));
 const function_1 = require("./util/function");
+const get_body_size_1 = require("./util/get-body-size");
 /**
  *
  */
@@ -196,6 +197,16 @@ class SOAP extends http_api_1.default {
     /** @override */
     beforeSend(request) {
         request.body = this._createEnvelope(request._message);
+        const headers = request.headers || {};
+        const bodySize = (0, get_body_size_1.getBodySize)(request.body, request.headers);
+        if (request.method === 'POST' &&
+            !('transfer-encoding' in headers) &&
+            !('content-length' in headers) &&
+            !!bodySize) {
+            this._logger.debug(`missing 'content-length' header, setting it to: ${bodySize}`);
+            headers['content-length'] = String(bodySize);
+        }
+        request.headers = headers;
     }
     /** @override **/
     isSessionExpired(response) {

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/lib/util/get-body-size.d.ts

@@ -0,0 +1,4 @@
+import { HttpBody } from '../types';
+export declare function getBodySize(body: HttpBody | undefined, headers?: {
+    [name: string]: string;
+}): number | undefined;

package/lib/util/get-body-size.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBodySize = void 0;
+const is_1 = __importDefault(require("@sindresorhus/is"));
+function getBodySize(body, headers = {}) {
+    function isFormData(body) {
+        return is_1.default.nodeStream(body) && is_1.default.function_(body.getBoundary);
+    }
+    if (headers && 'content-length' in headers) {
+        return Number(headers['content-length']);
+    }
+    if (!body) {
+        return 0;
+    }
+    if (is_1.default.string(body)) {
+        return Buffer.byteLength(body);
+    }
+    if (is_1.default.urlSearchParams(body)) {
+        return Buffer.byteLength(body.toString());
+    }
+    if (is_1.default.buffer(body)) {
+        return body.length;
+    }
+    try {
+        // `getLengthSync` will throw if body has a stream:
+        // https://github.com/form-data/form-data#integer-getlengthsync
+        if (isFormData(body)) {
+            return body.getLengthSync();
+        }
+    }
+    catch {
+        return undefined;
+    }
+    return undefined;
+}
+exports.getBodySize = getBodySize;

package/package.json

@@ -10,7 +10,7 @@
     "database.com"
   ],
   "homepage": "http://github.com/jsforce/jsforce",
-  "version": "3.0.0-next.1",
+  "version": "3.0.0-next.3",
   "repository": {
     "type": "git",
     "url": "git://github.com/jsforce/jsforce.git"
@@ -191,6 +191,7 @@
     "node": ">=18"
   },
   "dependencies": {
+    "@sindresorhus/is": "^4",
     "@types/node": "^18.15.3",
     "abort-controller": "^3.0.0",
     "base64url": "^3.0.1",
@@ -240,6 +241,7 @@
     "karma-jasmine-html-reporter": "^2.0.0",
     "karma-sourcemap-loader": "^0.4.0",
     "karma-webpack": "^5.0.0",
+    "nock": "^13.4.0",
     "path-browserify": "^1.0.1",
     "power-assert": "^1.6.1",
     "prettier": "^2.2.1",