@salesforce/core 2.35.1 → 2.35.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.35.2](https://github.com/forcedotcom/sfdx-core/compare/v2.35.1...v2.35.2) (2022-02-16)
+
+### Bug Fixes
+
+- network error tolerance ([#517](https://github.com/forcedotcom/sfdx-core/issues/517)) ([676ebfe](https://github.com/forcedotcom/sfdx-core/commit/676ebfe58b13826b53f461b2fef321c21f583004))
+- remove redundant warnings about no listerners on warnings ([7a5bd23](https://github.com/forcedotcom/sfdx-core/commit/7a5bd2390713da929e886f41d9dcbc811104f99a))
+
 ### [2.35.1](https://github.com/forcedotcom/sfdx-core/compare/v2.35.0...v2.35.1) (2022-02-10)
 
 ### Bug Fixes

package/lib/lifecycleEvents.js

@@ -170,7 +170,7 @@ class Lifecycle {
      */
     async emit(eventName, data) {
         const listeners = this.getListeners(eventName);
-        if (listeners.length === 0) {
+        if (listeners.length === 0 && eventName !== Lifecycle.warningEventName) {
             this.debug(`A lifecycle event with the name ${eventName} does not exist. An event must be registered before it can be emitted.`);
         }
         else {

package/lib/scratchOrgErrorCodes.d.ts

@@ -1,4 +1,4 @@
 import { Optional } from '@salesforce/ts-types';
 import { Logger } from './logger';
 import { ScratchOrgInfo } from './scratchOrgInfoApi';
-export declare const checkScratchOrgInfoForErrors: (orgInfo: ScratchOrgInfo, hubUsername: Optional<string>, logger: Logger) => ScratchOrgInfo;
+export declare const checkScratchOrgInfoForErrors: (orgInfo: Optional<ScratchOrgInfo>, hubUsername: Optional<string>, logger: Logger) => ScratchOrgInfo;

package/lib/scratchOrgErrorCodes.js

@@ -29,6 +29,9 @@ const optionalErrorCodeMessage = (errorCode, args) => {
     }
 };
 const checkScratchOrgInfoForErrors = (orgInfo, hubUsername, logger) => {
+    if (!orgInfo) {
+        throw new sfdxError_1.SfdxError('No scratch org info found.', 'ScratchOrgInfoNotFound');
+    }
     if (orgInfo.Status === 'Active') {
         return orgInfo;
     }

package/lib/scratchOrgInfoApi.d.ts

@@ -1,7 +1,6 @@
 import { Optional } from '@salesforce/ts-types';
 import { Duration } from '@salesforce/kit';
 import { RecordResult } from 'jsforce';
-import { retry } from 'ts-retry-promise';
 import { Org } from './org';
 import { AuthInfo } from './authInfo';
 import SettingsGenerator, { ObjectSetting } from './scratchOrgSettingsGenerator';

package/lib/scratchOrgInfoApi.js

@@ -18,6 +18,7 @@ const authInfo_1 = require("./authInfo");
 const messages_1 = require("./messages");
 const sfdxError_1 = require("./sfdxError");
 const sfdcUrl_1 = require("./util/sfdcUrl");
+const pollingClient_1 = require("./status/pollingClient");
 const myDomainResolver_1 = require("./status/myDomainResolver");
 const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
 messages_1.Messages.importMessagesDirectory(__dirname);
@@ -251,30 +252,53 @@ const pollForScratchOrgInfo = async (hubOrg, scratchOrgInfoId,
 timeout = kit_1.Duration.minutes(15)) => {
     const logger = await logger_1.Logger.child('scratchOrgInfoApi-pollForScratchOrgInfo');
     logger.debug(`PollingTimeout in minutes: ${timeout.minutes}`);
-    const response = await ts_retry_promise_1.retry(async () => {
-        const resultInProgress = await hubOrg
-            .getConnection()
-            .sobject('ScratchOrgInfo')
-            .retrieve(scratchOrgInfoId);
-        logger.debug(`polling client result: ${JSON.stringify(resultInProgress, null, 4)}`);
-        // Once it's "done" we can return it
-        if (resultInProgress.Status === 'Active' || resultInProgress.Status === 'Error') {
-            return resultInProgress;
+    const pollingOptions = {
+        async poll() {
+            try {
+                const resultInProgress = await hubOrg
+                    .getConnection()
+                    .sobject('ScratchOrgInfo')
+                    .retrieve(scratchOrgInfoId);
+                logger.debug(`polling client result: ${JSON.stringify(resultInProgress, null, 4)}`);
+                // Once it's "done" we can return it
+                if (resultInProgress.Status === 'Active' || resultInProgress.Status === 'Error') {
+                    return {
+                        completed: true,
+                        payload: resultInProgress,
+                    };
+                }
+                logger.debug(`Scratch org status is ${resultInProgress.Status}`);
+                return {
+                    completed: false,
+                };
+            }
+            catch (error) {
+                logger.debug(`An error occurred trying to retrieve scratchOrgInfo for ${scratchOrgInfoId}`);
+                logger.debug(`Error: ${error.message}`);
+                logger.debug('Re-trying deploy check again....');
+                return {
+                    completed: false,
+                };
+            }
+        },
+        timeout,
+        frequency: kit_1.Duration.seconds(1),
+        timeoutErrorName: 'ScratchOrgInfoTimeoutError',
+    };
+    const client = await pollingClient_1.PollingClient.create(pollingOptions);
+    try {
+        const resultInProgress = await client.subscribe();
+        return scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors(resultInProgress, hubOrg.getUsername(), logger);
+    }
+    catch (error) {
+        const err = error;
+        if (err.message) {
+            throw sfdxError_1.SfdxError.wrap(err);
         }
-        // all other statuses, OR lack of status (e.g. network errors) will cause a retry
-        throw new sfdxError_1.SfdxError(`Scratch org status is ${resultInProgress.Status}`);
-    }, {
-        retries: 'INFINITELY',
-        timeout: timeout.milliseconds,
-        delay: kit_1.Duration.seconds(2).milliseconds,
-        backoff: 'LINEAR',
-        maxBackOff: kit_1.Duration.seconds(30).milliseconds,
-    }).catch(() => {
         throw new sfdxError_1.SfdxError(`The scratch org did not complete within ${timeout.minutes} minutes`, 'orgCreationTimeout', [
             'Try your force:org:create command again with a longer --wait value',
         ]);
-    });
-    return scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors(response, hubOrg.getUsername(), logger);
+    }
 };
 exports.pollForScratchOrgInfo = pollForScratchOrgInfo;
 /**

package/lib/scratchOrgSettingsGenerator.js

@@ -101,7 +101,7 @@ class SettingsGenerator {
             timeoutErrorName: 'DeployingSettingsTimeoutError',
         };
         const client = await pollingClient_1.PollingClient.create(pollingOptions);
-        const status = (await client.subscribe());
+        const status = await client.subscribe();
         if (status !== RequestStatus.Succeeded) {
             const componentFailures = ts_types_1.ensureObject(result.details).componentFailures;
             const failures = (Array.isArray(componentFailures) ? componentFailures : [componentFailures])

package/lib/status/pollingClient.d.ts

@@ -38,7 +38,7 @@ export declare class PollingClient extends AsyncOptionalCreatable<PollingClient.
      * Returns a promise to call the specified polling function using the interval and timeout specified
      * in the polling options.
      */
-    subscribe(): Promise<AnyJson | undefined>;
+    subscribe<T = AnyJson>(): Promise<T | undefined>;
 }
 export declare namespace PollingClient {
     /**

package/lib/status/pollingClient.js

@@ -12,6 +12,7 @@ const ts_types_1 = require("@salesforce/ts-types");
 const ts_retry_promise_1 = require("ts-retry-promise");
 const logger_1 = require("../logger");
 const sfdxError_1 = require("../sfdxError");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 /**
  * This is a polling client that can be used to poll the status of long running tasks. It can be used as a replacement
  * for Streaming when streaming topics are not available or when streaming handshakes are failing. Why wouldn't you
@@ -51,6 +52,7 @@ class PollingClient extends kit_1.AsyncOptionalCreatable {
      * Returns a promise to call the specified polling function using the interval and timeout specified
      * in the polling options.
      */
+    // TODO v3.0 remove undefined as this method ensures that the payload is always returned
     async subscribe() {
         var _a;
         let errorInPollingFunction; // keep this around for returning in the catch block
@@ -60,11 +62,18 @@ class PollingClient extends kit_1.AsyncOptionalCreatable {
                 result = await this.options.poll();
             }
             catch (error) {
-                errorInPollingFunction = error;
+                const err = (errorInPollingFunction = error);
+                if (['ETIMEDOUT', 'ENOTFOUND', 'ECONNRESET', 'socket hang up'].some((retryableNetworkError) => err.message.includes(retryableNetworkError))) {
+                    this.logger.debug('Network error on the request', err);
+                    await lifecycleEvents_1.Lifecycle.getInstance().emitWarning('Network error occurred. Continuing to poll.');
+                    throw sfdxError_1.SfdxError.wrap(err);
+                }
                 // there was an actual error thrown, so we don't want to keep retrying
-                throw new ts_retry_promise_1.NotRetryableError(error.name);
+                throw new ts_retry_promise_1.NotRetryableError(err.name);
             }
             if (result.completed) {
+                // TODO v3.0: payload should be of type T always so that
+                // consumers get the same type in return.
                 return result.payload;
             }
             throw new Error('Operation did not complete.  Retrying...'); // triggers a retry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "2.35.1",
+  "version": "2.35.2",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",