@salesforce/core 2.35.1 → 2.36.0

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.36.0](https://github.com/forcedotcom/sfdx-core/compare/v2.35.3...v2.36.0) (2022-03-23)
+
+### Features
+
+- rotating log file ([d185e00](https://github.com/forcedotcom/sfdx-core/commit/d185e00aa66fc558f3c0d710cb2fafa0655a9fbc))
+
+### Bug Fixes
+
+- bump jsforce types ([ddacb98](https://github.com/forcedotcom/sfdx-core/commit/ddacb987068d00aec2147130f3464232a6bdccdf))
+- check env before resetting ([abf6ea1](https://github.com/forcedotcom/sfdx-core/commit/abf6ea1bd721f773c09f346ff9ae8d01a915e5cd))
+
+### [2.35.3](https://github.com/forcedotcom/sfdx-core/compare/v2.35.2...v2.35.3) (2022-02-23)
+
+### Bug Fixes
+
+- always try to clean up aliases and configs ([cd0adc4](https://github.com/forcedotcom/sfdx-core/commit/cd0adc456978f27fc2d44cbcb61632925edcccd9))
+
+### [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/logger.d.ts

@@ -163,6 +163,17 @@ export declare class Logger {
     static readonly LEVEL_NAMES: string[];
     private static readonly lifecycle;
     private static rootLogger?;
+    /**
+     * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+     * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationPeriod: string;
+    /**
+     * The number of backup rotated log files to keep.
+     * Example: '3' will have the base sfdx.log file, and the past 3 (period) log files.
+     * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationCount: number;
     /**
      * Whether debug is enabled for this Logger.
      */

package/lib/logger.js

@@ -72,6 +72,17 @@ class Logger {
      * `Logger`.
      */
     constructor(optionsOrName) {
+        /**
+         * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+         * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+         */
+        this.logRotationPeriod = new kit_1.Env().getString('SFDX_LOG_ROTATION_PERIOD') || '1d';
+        /**
+         * The number of backup rotated log files to keep.
+         * Example: '3' will have the base sfdx.log file, and the past 3 (period) log files.
+         * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+         */
+        this.logRotationCount = new kit_1.Env().getNumber('SFDX_LOG_ROTATION_COUNT') || 2;
         /**
          * Whether debug is enabled for this Logger.
          */
@@ -250,12 +261,12 @@ class Logger {
         if (!this.bunyan.streams.find(
         // No bunyan typings
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (stream) => stream.type === 'file' && stream.path === logFile)) {
-            // TODO: rotating-file
-            // https://github.com/trentm/node-bunyan#stream-type-rotating-file
+        (stream) => stream.type === 'rotating-file' && stream.path === logFile)) {
             this.addStream({
-                type: 'file',
+                type: 'rotating-file',
                 path: logFile,
+                period: this.logRotationPeriod,
+                count: this.logRotationCount,
                 level: this.bunyan.level(),
             });
         }
@@ -290,12 +301,12 @@ class Logger {
         if (!this.bunyan.streams.find(
         // No bunyan typings
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (stream) => stream.type === 'file' && stream.path === logFile)) {
-            // TODO: rotating-file
-            // https://github.com/trentm/node-bunyan#stream-type-rotating-file
+        (stream) => stream.type === 'rotating-file' && stream.path === logFile)) {
             this.addStream({
-                type: 'file',
+                type: 'rotating-file',
                 path: logFile,
+                period: this.logRotationPeriod,
+                count: this.logRotationCount,
                 level: this.bunyan.level(),
             });
         }

package/lib/org.js

@@ -644,35 +644,33 @@ class Org extends kit_1.AsyncCreatable {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async removeUsers(throwWhenRemoveFails) {
         this.logger.debug(`Removing users associate with org: ${this.getOrgId()}`);
-        const config = await this.retrieveOrgUsersConfig();
+        const [config, authInfos, aliases] = await Promise.all([
+            this.retrieveOrgUsersConfig(),
+            this.readUserAuthFiles(),
+            aliases_1.Aliases.create(aliases_1.Aliases.getDefaultOptions()),
+        ]);
         this.logger.debug(`using path for org users: ${config.getPath()}`);
-        if (await config.exists()) {
-            const authInfos = await this.readUserAuthFiles();
-            const aliases = await aliases_1.Aliases.create(aliases_1.Aliases.getDefaultOptions());
-            this.logger.info(`Cleaning up usernames in org: ${this.getOrgId()}`);
-            for (const auth of authInfos) {
-                const username = auth.getFields().username;
-                const aliasKeys = (username && aliases.getKeysByValue(username)) || [];
-                aliases.unsetAll(aliasKeys);
-                let orgForUser;
-                if (username === this.getUsername()) {
-                    orgForUser = this;
-                }
-                else {
-                    const info = await authInfo_1.AuthInfo.create({ username });
-                    const connection = await connection_1.Connection.create({ authInfo: info });
-                    orgForUser = await Org.create({ connection });
-                }
-                const orgType = this.isDevHubOrg() ? config_1.Config.DEFAULT_DEV_HUB_USERNAME : config_1.Config.DEFAULT_USERNAME;
-                const configInfo = orgForUser.configAggregator.getInfo(orgType);
-                if ((configInfo.value === username || aliasKeys.includes(configInfo.value)) &&
-                    (configInfo.isGlobal() || configInfo.isLocal())) {
-                    await config_1.Config.update(configInfo.isGlobal(), orgType, undefined);
-                }
-                await orgForUser.removeAuth();
-            }
-            await aliases.write();
-        }
+        this.logger.info(`Cleaning up usernames in org: ${this.getOrgId()}`);
+        await Promise.all(authInfos
+            .map((auth) => auth.getFields().username)
+            .map(async (username) => {
+            const aliasKeys = (username && aliases.getKeysByValue(username)) || [];
+            aliases.unsetAll(aliasKeys);
+            const orgForUser = username === this.getUsername()
+                ? this
+                : await Org.create({
+                    connection: await connection_1.Connection.create({ authInfo: await authInfo_1.AuthInfo.create({ username }) }),
+                });
+            const orgType = this.isDevHubOrg() ? config_1.Config.DEFAULT_DEV_HUB_USERNAME : config_1.Config.DEFAULT_USERNAME;
+            const configInfo = orgForUser.configAggregator.getInfo(orgType);
+            const needsConfigUpdate = (configInfo.isGlobal() || configInfo.isLocal()) &&
+                (configInfo.value === username || aliasKeys.includes(configInfo.value));
+            return [
+                orgForUser.removeAuth(),
+                needsConfigUpdate ? config_1.Config.update(configInfo.isGlobal(), orgType, undefined) : undefined,
+            ].filter(Boolean);
+        }));
+        await aliases.write();
     }
     /**
      * Remove an associate sandbox config.

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.36.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -39,7 +39,7 @@
     "@salesforce/schemas": "^1.0.1",
     "@salesforce/ts-types": "^1.5.20",
     "@types/graceful-fs": "^4.1.5",
-    "@types/jsforce": "^1.9.38",
+    "@types/jsforce": "^1.9.41",
     "@types/mkdirp": "^1.0.1",
     "archiver": "^5.3.0",
     "debug": "^3.1.0",