@salesforce/core 2.36.1 → 2.36.2

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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

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/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.36.1",
+  "version": "2.36.2",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",