@jsforce/jsforce-node 3.10.13 → 3.10.14

package/lib/VERSION.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "3.10.13";
+declare const _default: "3.10.14";
 export default _default;

package/lib/VERSION.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '3.10.13';
+exports.default = '3.10.14';

package/lib/api/metadata.d.ts

@@ -163,8 +163,8 @@ export declare class AsyncResultLocator<S extends Schema, R extends {} = AsyncRe
  */
 export declare class RetrieveResultLocator<S extends Schema> extends AsyncResultLocator<S, RetrieveResult> {
     /**
-     * Check and wait until the async request becomes in completed status,
-     * and retrieve the result data.
+     * Poll checkRetrieveStatus() until the retrieve operation completes,
+     * then return the RetrieveResult.
      */
     complete(): Promise<RetrieveResult>;
     /**
@@ -183,8 +183,8 @@ export declare class RetrieveResultLocator<S extends Schema> extends AsyncResult
  */
 export declare class DeployResultLocator<S extends Schema> extends AsyncResultLocator<S, DeployResult> {
     /**
-     * Check and wait until the async request becomes in completed status,
-     * and retrieve the result data.
+     * Poll checkDeployStatus() until the deploy operation completes,
+     * then return the DeployResult.
      */
     complete(includeDetails?: boolean): Promise<DeployResult>;
 }

package/lib/api/metadata.js

@@ -356,12 +356,43 @@ exports.AsyncResultLocator = AsyncResultLocator;
  */
 class RetrieveResultLocator extends AsyncResultLocator {
     /**
-     * Check and wait until the async request becomes in completed status,
-     * and retrieve the result data.
+     * Poll checkRetrieveStatus() until the retrieve operation completes,
+     * then return the RetrieveResult.
      */
     async complete() {
-        const result = await super.complete();
-        return this._meta.checkRetrieveStatus(result.id);
+        if (!this._id) {
+            const asyncResult = await this._promise;
+            this._id = asyncResult.id;
+        }
+        const id = this._id;
+        return new Promise((resolve, reject) => {
+            const startTime = new Date().getTime();
+            const poll = async () => {
+                try {
+                    const now = new Date().getTime();
+                    if (startTime + this._meta.pollTimeout < now) {
+                        const err = new Error('Polling time out. Retrieve operation is not completed.');
+                        this.emit('error', err);
+                        reject(err);
+                        return;
+                    }
+                    const result = await this._meta.checkRetrieveStatus(id);
+                    if (result.done) {
+                        this.emit('complete', result);
+                        resolve(result);
+                    }
+                    else {
+                        this.emit('progress', result);
+                        setTimeout(poll, this._meta.pollInterval);
+                    }
+                }
+                catch (err) {
+                    this.emit('error', err);
+                    reject(err);
+                }
+            };
+            setTimeout(poll, this._meta.pollInterval);
+        });
     }
     /**
      * Change the retrieved result to Node.js readable stream
@@ -399,12 +430,43 @@ exports.RetrieveResultLocator = RetrieveResultLocator;
  */
 class DeployResultLocator extends AsyncResultLocator {
     /**
-     * Check and wait until the async request becomes in completed status,
-     * and retrieve the result data.
+     * Poll checkDeployStatus() until the deploy operation completes,
+     * then return the DeployResult.
      */
     async complete(includeDetails) {
-        const result = await super.complete();
-        return this._meta.checkDeployStatus(result.id, includeDetails);
+        if (!this._id) {
+            const asyncResult = await this._promise;
+            this._id = asyncResult.id;
+        }
+        const id = this._id;
+        return new Promise((resolve, reject) => {
+            const startTime = new Date().getTime();
+            const poll = async () => {
+                try {
+                    const now = new Date().getTime();
+                    if (startTime + this._meta.pollTimeout < now) {
+                        const err = new Error('Polling time out. Deploy operation is not completed.');
+                        this.emit('error', err);
+                        reject(err);
+                        return;
+                    }
+                    const result = await this._meta.checkDeployStatus(id, includeDetails);
+                    if (result.done) {
+                        this.emit('complete', result);
+                        resolve(result);
+                    }
+                    else {
+                        this.emit('progress', result);
+                        setTimeout(poll, this._meta.pollInterval);
+                    }
+                }
+                catch (err) {
+                    this.emit('error', err);
+                    reject(err);
+                }
+            };
+            setTimeout(poll, this._meta.pollInterval);
+        });
     }
 }
 exports.DeployResultLocator = DeployResultLocator;

package/lib/http-api.js

@@ -303,6 +303,11 @@ class HttpApi extends events_1.EventEmitter {
             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.
+
+HTTP status code: ${response.statusCode}.
+REST API Status Codes and Error Responses:
+https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/errorcodes.htm
+
 See \`error.data\` for the full html response.`, error.errorCode, error.message);
         }
         return error instanceof HttpApiError

package/lib/request.js

@@ -54,6 +54,7 @@ async function startFetchRequest(request, options, input, output, emitter, count
     const { url, body, ...rrequest } = request;
     const controller = new AbortController();
     let retryCount = 0;
+    let retry420Count = 0;
     const retryOpts = {
         statusCodes: options.retry?.statusCodes ?? [420, 429, 500, 502, 503, 504],
         maxRetries: options.retry?.maxRetries ?? 5,
@@ -82,7 +83,14 @@ async function startFetchRequest(request, options, input, output, emitter, count
         if (!retryOpts.methods.includes(request.method))
             return false;
         if (resOrErr instanceof node_fetch_1.Response) {
-            if (retryOpts.statusCodes.includes(resOrErr.status)) {
+            // REST API status codes: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/errorcodes.htm
+            //
+            // Deleted/expired scratch orgs return 420 and causes a long delay on all requests due to the retry with exponential backoff.
+            // We still want to retry on 420 (Metadata API requests sometimes return it) so here we'll limit to a maximum of 2 retries.
+            if (resOrErr.status === 420) {
+                return retry420Count < 2;
+            }
+            else if (retryOpts.statusCodes.includes(resOrErr.status)) {
                 if (maxRetry === retryCount) {
                     return false;
                 }
@@ -132,6 +140,9 @@ async function startFetchRequest(request, options, input, output, emitter, count
                 // jsforce may switch to node's fetch which doesn't emit this event on retries.
                 emitter.emit('retry', retryCount);
                 retryCount++;
+                if (res.status === 420) {
+                    retry420Count++;
+                }
                 return await fetchWithRetries(maxRetry);
             }
             // should we throw here if the maxRetry already happened and still got the same statusCode?
@@ -157,12 +168,7 @@ async function startFetchRequest(request, options, input, output, emitter, count
                 return fetchWithRetries(maxRetry);
             }
             logger.debug('Skipping retry...');
-            if (maxRetry === retryCount) {
-                throw err;
-            }
-            else {
-                throw err;
-            }
+            throw err;
         }
     };
     let res;

package/package.json

@@ -10,7 +10,7 @@
     "database.com"
   ],
   "homepage": "http://github.com/jsforce/jsforce",
-  "version": "3.10.13",
+  "version": "3.10.14",
   "repository": {
     "type": "git",
     "url": "git://github.com/jsforce/jsforce.git"