@salesforce/core 2.35.3 → 2.36.2

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.2](https://github.com/forcedotcom/sfdx-core/compare/v2.36.1...v2.36.2) (2022-04-20)
+
+### [2.36.1](https://github.com/forcedotcom/sfdx-core/compare/v2.36.0...v2.36.1) (2022-04-14)
+
+### Bug Fixes
+
+- sandbox cname recognition ([#555](https://github.com/forcedotcom/sfdx-core/issues/555)) ([105bc9a](https://github.com/forcedotcom/sfdx-core/commit/105bc9a043b3c984846e060e5176b290fe49b5bc))
+
+## [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

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.d.ts

@@ -113,6 +113,17 @@ export declare class Org extends AsyncCreatable<Org.Options> {
      * @returns {ScratchOrgCreateResult}
      */
     scratchOrgCreate(options: ScratchOrgRequest): Promise<ScratchOrgCreateResult>;
+    /**
+     * Reports sandbox org creation status. If the org is ready, authenticates to the org.
+     *
+     * @param {sandboxname} string the sandbox name
+     * @param options Wait: The amount of time to wait before timing out, Interval: The time interval between polling
+     * @returns {SandboxProcessObject} the sandbox process object
+     */
+    sandboxStatus(sandboxname: string, options: {
+        wait?: Duration;
+        interval?: Duration;
+    }): Promise<SandboxProcessObject>;
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *
@@ -264,6 +275,29 @@ export declare class Org extends AsyncCreatable<Org.Options> {
      * **Throws** *{@link SfdxError} Throws and unsupported error.
      */
     protected getDefaultOptions(): Org.Options;
+    /**
+     * Query the sandbox for the SandboxProcessObject by sandbox name
+     *
+     * @param sandboxName The name of the sandbox to query
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    private queryLatestSandboxProcessBySandboxName;
+    /**
+     * Gets the sandboxProcessObject and then polls for it to complete.
+     *
+     * @param sandboxProcessName sanbox process name
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    private authWithRetriesByName;
+    /**
+     * Polls the sandbox org for the sandboxProcessObject.
+     *
+     * @param sandboxProcessObj: The in-progress sandbox signup request
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject}
+     */
+    private authWithRetries;
     private queryProduction;
     /**
      * this method will delete the sandbox org from the production org and clean up any local files

package/lib/org.js

@@ -110,6 +110,16 @@ class Org extends kit_1.AsyncCreatable {
     async scratchOrgCreate(options) {
         return scratchOrgCreate_1.scratchOrgCreate({ ...options, hubOrg: this });
     }
+    /**
+     * Reports sandbox org creation status. If the org is ready, authenticates to the org.
+     *
+     * @param {sandboxname} string the sandbox name
+     * @param options Wait: The amount of time to wait before timing out, Interval: The time interval between polling
+     * @returns {SandboxProcessObject} the sandbox process object
+     */
+    async sandboxStatus(sandboxname, options) {
+        return this.authWithRetriesByName(sandboxname, options);
+    }
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *
@@ -500,6 +510,58 @@ class Org extends kit_1.AsyncCreatable {
     getDefaultOptions() {
         throw new sfdxError_1.SfdxError('Not Supported');
     }
+    /**
+     * Query the sandbox for the SandboxProcessObject by sandbox name
+     *
+     * @param sandboxName The name of the sandbox to query
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    async queryLatestSandboxProcessBySandboxName(sandboxNameIn) {
+        var _a;
+        const { tooling } = this.getConnection();
+        this.logger.debug('QueryLatestSandboxProcessBySandboxName called with SandboxName: %s ', sandboxNameIn);
+        const queryStr = `SELECT Id, Status, SandboxName, SandboxInfoId, LicenseType, CreatedDate, CopyProgress, SandboxOrganization, SourceId, Description, EndDate FROM SandboxProcess WHERE SandboxName='${sandboxNameIn}' AND Status != 'D' ORDER BY CreatedDate DESC LIMIT 1`;
+        const queryResult = await tooling.query(queryStr);
+        this.logger.debug('Return from calling queryToolingApi: %s ', queryResult);
+        if (((_a = queryResult === null || queryResult === void 0 ? void 0 : queryResult.records) === null || _a === void 0 ? void 0 : _a.length) === 1) {
+            return queryResult.records[0];
+        }
+        else if (queryResult.records && queryResult.records.length > 1) {
+            throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'MultiSandboxProcessNotFoundBySandboxName', [sandboxNameIn]);
+        }
+        else {
+            throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'SandboxProcessNotFoundBySandboxName', [sandboxNameIn]);
+        }
+    }
+    /**
+     * Gets the sandboxProcessObject and then polls for it to complete.
+     *
+     * @param sandboxProcessName sanbox process name
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    async authWithRetriesByName(sandboxProcessName, options) {
+        return this.authWithRetries(await this.queryLatestSandboxProcessBySandboxName(sandboxProcessName), options);
+    }
+    /**
+     * Polls the sandbox org for the sandboxProcessObject.
+     *
+     * @param sandboxProcessObj: The in-progress sandbox signup request
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject}
+     */
+    async authWithRetries(sandboxProcessObj, options) {
+        var _a;
+        const retries = options.wait ? options.wait.seconds / kit_1.Duration.seconds(30).seconds : 0;
+        const pollInterval = (_a = options.interval) !== null && _a !== void 0 ? _a : kit_1.Duration.seconds(30);
+        this.logger.debug('AuthWithRetries sandboxProcessObj %s, retries %i', sandboxProcessObj, retries);
+        return this.pollStatusAndAuth({
+            sandboxProcessObj,
+            retries,
+            shouldPoll: retries > 0,
+            pollInterval,
+        });
+    }
     async queryProduction(org, field, value) {
         return org.connection.singleRecordQuery(`SELECT SandboxInfoId FROM SandboxProcess WHERE ${field} ='${value}' AND Status NOT IN ('D', 'E')`, { tooling: true });
     }

package/lib/util/sfdcUrl.d.ts

@@ -62,7 +62,7 @@ export declare class SfdcUrl extends URL {
     isSandboxUrl(createdOrgInstance?: string): boolean;
     /**
      * Tests whether this url is a sandbox url
-     * otherwise tryies to resolve dns cnames and then look if any is sandbox url
+     * otherwise tries to resolve dns cnames and then look if any is sandbox url
      *
      * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
      * @returns {Promise<boolean>} true if this domain resolves to sanbox url

package/lib/util/sfdcUrl.js

@@ -156,13 +156,15 @@ class SfdcUrl extends url_1.URL {
             this.origin.endsWith('sandbox.my.salesforce.mil') ||
             /sandbox\.my\.salesforce\.com/gi.test(this.origin) || // enhanced domains >= 230
             /(cs[0-9]+(\.my|)\.salesforce\.com)/gi.test(this.origin) || // my domains on CS instance OR CS instance without my domain
+            /(cs[0-9]+\.force\.com)/gi.test(this.origin) || // sandboxes have cnames like cs123.force.com
+            /(\w+--\w+\.my\.salesforce\.com)/gi.test(this.origin) || // sandboxes myDomain like foo--bar.my.salesforce.com
             /([a-z]{3}[0-9]+s\.sfdc-.+\.salesforce\.com)/gi.test(this.origin) || // falcon sandbox ex: usa2s.sfdc-whatever.salesforce.com
             /([a-z]{3}[0-9]+s\.sfdc-.+\.force\.com)/gi.test(this.origin) || // falcon sandbox ex: usa2s.sfdc-whatever.force.com
             this.hostname === 'test.salesforce.com');
     }
     /**
      * Tests whether this url is a sandbox url
-     * otherwise tryies to resolve dns cnames and then look if any is sandbox url
+     * otherwise tries to resolve dns cnames and then look if any is sandbox url
      *
      * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
      * @returns {Promise<boolean>} true if this domain resolves to sanbox url

package/messages/org.json

@@ -9,5 +9,7 @@
   "SandboxNotFound": "We can't find a SandboxProcess for the sandbox org %s.",
   "SandboxInfoCreateFailed": "The sandbox org creation failed with a result of %s.",
   "MissingAuthUsername": "The sandbox %s does not have an authorized username.",
-  "OrgPollingTimeout": "Sandbox status is %s; timed out waiting for completion."
+  "OrgPollingTimeout": "Sandbox status is %s; timed out waiting for completion.",
+  "SandboxProcessNotFoundBySandboxName": "We can't find a SandboxProcess with the SandboxName %s.",
+  "MultiSandboxProcessNotFoundBySandboxName": "We found more than one SandboxProcess with the SandboxName %s."
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "2.35.3",
+  "version": "2.36.2",
   "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",