@salesforce/core 2.29.0 → 2.30.0

package/CHANGELOG.md

@@ -2,20 +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.29.0](https://github.com/forcedotcom/sfdx-core/compare/v2.28.4...v2.29.0) (2021-11-17)
+## [2.30.0](https://github.com/forcedotcom/sfdx-core/compare/v2.29.0...v2.30.0) (2021-11-25)
 
 
 ### Features
 
-* cleans up old listeners from upgraded instance ([e3f2d69](https://github.com/forcedotcom/sfdx-core/commit/e3f2d69ccd5c096d37addb1b982e19354175f11a))
-* use warnings instead of process in sfdx-core ([c1f7e98](https://github.com/forcedotcom/sfdx-core/commit/c1f7e98f6b19d57da1a2ee0cdf58e449079f0ee7))
-* warning and telemetry events ([80a8039](https://github.com/forcedotcom/sfdx-core/commit/80a8039e2f686d973ddbc24c9a2980fb93928d13))
-* warning and telemetry events ([a04b293](https://github.com/forcedotcom/sfdx-core/commit/a04b29355c8ca6c7e37e071ccc159aff5e5e9ca0))
+* delete scratch orgs and sandboxes ([#491](https://github.com/forcedotcom/sfdx-core/issues/491)) ([468c348](https://github.com/forcedotcom/sfdx-core/commit/468c348f0ecc69ddeea02927bf7a26ca660a86ca))
+
+## [2.29.0](https://github.com/forcedotcom/sfdx-core/compare/v2.28.4...v2.29.0) (2021-11-17)
+
+### Features
 
+- cleans up old listeners from upgraded instance ([e3f2d69](https://github.com/forcedotcom/sfdx-core/commit/e3f2d69ccd5c096d37addb1b982e19354175f11a))
+- use warnings instead of process in sfdx-core ([c1f7e98](https://github.com/forcedotcom/sfdx-core/commit/c1f7e98f6b19d57da1a2ee0cdf58e449079f0ee7))
+- warning and telemetry events ([80a8039](https://github.com/forcedotcom/sfdx-core/commit/80a8039e2f686d973ddbc24c9a2980fb93928d13))
+- warning and telemetry events ([a04b293](https://github.com/forcedotcom/sfdx-core/commit/a04b29355c8ca6c7e37e071ccc159aff5e5e9ca0))
 
 ### Bug Fixes
 
-* transfer listeners when upgrading the global instance to newer version ([0a40831](https://github.com/forcedotcom/sfdx-core/commit/0a408317c132548771ced0fe196178d2e9c76232))
+- transfer listeners when upgrading the global instance to newer version ([0a40831](https://github.com/forcedotcom/sfdx-core/commit/0a408317c132548771ced0fe196178d2e9c76232))
 
 ### [2.28.4](https://github.com/forcedotcom/sfdx-core/compare/v2.28.3...v2.28.4) (2021-11-10)
 

package/lib/org.d.ts

@@ -60,6 +60,11 @@ export declare class Org extends AsyncCreatable<Org.Options> {
      * @param throwWhenRemoveFails Determines if the call should throw an error or fail silently.
      */
     remove(throwWhenRemoveFails?: boolean): Promise<void>;
+    /**
+     * Check if org is a sandbox org by checking its SandboxOrgConfig.
+     *
+     */
+    isSandbox(): Promise<boolean>;
     /**
      * Check that this org is a scratch org by asking the dev hub if it knows about it.
      *
@@ -82,6 +87,16 @@ export declare class Org extends AsyncCreatable<Org.Options> {
      * dev hub**. If you need accuracy, use the {@link Org.determineIfDevHubOrg} method.
      */
     isDevHubOrg(): boolean;
+    /**
+     * Will delete 'this' instance remotely and any files locally
+     *
+     * @param controllingOrg username or Org that 'this.devhub' or 'this.production' refers to. AKA a DevHub for a scratch org, or a Production Org for a sandbox
+     */
+    deleteFrom(controllingOrg: string | Org): Promise<void>;
+    /**
+     * Will delete 'this' instance remotely and any files locally
+     */
+    delete(): Promise<void>;
     /**
      * Returns `true` if the org is a Dev Hub.
      *
@@ -177,6 +192,21 @@ export declare class Org extends AsyncCreatable<Org.Options> {
      * **Throws** *{@link SfdxError} Throws and unsupported error.
      */
     protected getDefaultOptions(): Org.Options;
+    private queryProduction;
+    /**
+     * this method will delete the sandbox org from the production org and clean up any local files
+     *
+     * @param prodOrg - Production org associated with this sandbox
+     * @private
+     */
+    private deleteSandbox;
+    /**
+     * If this Org is a scratch org, calling this method will delete the scratch org from the DevHub and clean up any local files
+     *
+     * @param devHub - optional DevHub Org of the to-be-deleted scratch org
+     * @private
+     */
+    private deleteScratchOrg;
     /**
      * Returns a promise to delete an auth info file from the local file system and any related cache information for
      * this Org.. You don't want to call this method directly. Instead consider calling Org.remove()

package/lib/org.js

@@ -72,7 +72,7 @@ class Org extends kit_1.AsyncCreatable {
             this.logger.debug(`cleaning data for path: ${dataPath}`);
         }
         catch (err) {
-            if (err.name === 'InvalidProjectWorkspace') {
+            if (err instanceof Error && err.name === 'InvalidProjectWorkspace') {
                 // If we aren't in a project dir, we can't clean up data files.
                 // If the user unlink this org outside of the workspace they used it in,
                 // data files will be left over.
@@ -110,6 +110,13 @@ class Org extends kit_1.AsyncCreatable {
         // So, just in case no users are added to this org we will try the remove again.
         await this.removeAuth();
     }
+    /**
+     * Check if org is a sandbox org by checking its SandboxOrgConfig.
+     *
+     */
+    async isSandbox() {
+        return !!(await this.getSandboxOrgConfigField(sandboxOrgConfig_1.SandboxOrgConfig.Fields.PROD_ORG_USERNAME));
+    }
     /**
      * Check that this org is a scratch org by asking the dev hub if it knows about it.
      *
@@ -133,7 +140,7 @@ class Org extends kit_1.AsyncCreatable {
             results = await devHubConnection.query(DEV_HUB_SOQL);
         }
         catch (err) {
-            if (err.name === 'INVALID_TYPE') {
+            if (err instanceof Error && err.name === 'INVALID_TYPE') {
                 throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'NotADevHub', [devHubConnection.getUsername()]);
             }
             throw err;
@@ -175,6 +182,36 @@ class Org extends kit_1.AsyncCreatable {
             return false;
         }
     }
+    /**
+     * Will delete 'this' instance remotely and any files locally
+     *
+     * @param controllingOrg username or Org that 'this.devhub' or 'this.production' refers to. AKA a DevHub for a scratch org, or a Production Org for a sandbox
+     */
+    async deleteFrom(controllingOrg) {
+        if (typeof controllingOrg === 'string') {
+            controllingOrg = await Org.create({
+                aggregator: this.configAggregator,
+                aliasOrUsername: controllingOrg,
+            });
+        }
+        if (await this.isSandbox()) {
+            await this.deleteSandbox(controllingOrg);
+        }
+        else {
+            await this.deleteScratchOrg(controllingOrg);
+        }
+    }
+    /**
+     * Will delete 'this' instance remotely and any files locally
+     */
+    async delete() {
+        if (await this.isSandbox()) {
+            await this.deleteSandbox();
+        }
+        else {
+            await this.deleteScratchOrg();
+        }
+    }
     /**
      * Returns `true` if the org is a Dev Hub.
      *
@@ -416,6 +453,98 @@ class Org extends kit_1.AsyncCreatable {
     getDefaultOptions() {
         throw new sfdxError_1.SfdxError('Not Supported');
     }
+    async queryProduction(org, field, value) {
+        return org.connection.singleRecordQuery(`SELECT SandboxInfoId FROM SandboxProcess WHERE ${field} ='${value}' AND Status NOT IN ('D', 'E')`, { tooling: true });
+    }
+    /**
+     * this method will delete the sandbox org from the production org and clean up any local files
+     *
+     * @param prodOrg - Production org associated with this sandbox
+     * @private
+     */
+    async deleteSandbox(prodOrg) {
+        prodOrg !== null && prodOrg !== void 0 ? prodOrg : (prodOrg = await Org.create({
+            aggregator: this.configAggregator,
+            aliasOrUsername: await this.getSandboxOrgConfigField(sandboxOrgConfig_1.SandboxOrgConfig.Fields.PROD_ORG_USERNAME),
+        }));
+        let result;
+        // attempt to locate sandbox id by username
+        try {
+            // try to calculate sandbox name from the production org
+            // production org: admin@integrationtesthub.org
+            // this.getUsername: admin@integrationtesthub.org.dev1
+            // sandboxName in Production: dev1
+            const sandboxName = (this.getUsername() || '').split(`${prodOrg.getUsername()}.`)[1];
+            if (!sandboxName) {
+                this.logger.debug('Could not construct a sandbox name');
+                throw new Error();
+            }
+            this.logger.debug(`attempting to locate sandbox with username ${sandboxName}`);
+            result = await this.queryProduction(prodOrg, 'SandboxName', sandboxName);
+            if (!result) {
+                this.logger.debug(`Failed to find sandbox with username: ${sandboxName}`);
+                throw new Error();
+            }
+        }
+        catch {
+            // if an error is thrown, don't panic yet. we'll try querying by orgId
+            const trimmedId = sfdc_1.sfdc.trimTo15(this.getOrgId());
+            this.logger.debug(`defaulting to trimming id from ${this.getOrgId()} to ${trimmedId}`);
+            try {
+                result = await this.queryProduction(prodOrg, 'SandboxOrganization', trimmedId);
+            }
+            catch {
+                throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'SandboxNotFound', [trimmedId]);
+            }
+        }
+        const deleteResult = await prodOrg.connection.tooling.delete('SandboxInfo', result.SandboxInfoId);
+        this.logger.debug('Return from calling tooling.delete: %o ', deleteResult);
+        await this.remove();
+        if (Array.isArray(deleteResult) || !deleteResult.success) {
+            throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'SandboxDeleteFailed', [JSON.stringify(deleteResult)]);
+        }
+    }
+    /**
+     * If this Org is a scratch org, calling this method will delete the scratch org from the DevHub and clean up any local files
+     *
+     * @param devHub - optional DevHub Org of the to-be-deleted scratch org
+     * @private
+     */
+    async deleteScratchOrg(devHub) {
+        // if we didn't get a devHub, we'll get it from the this org
+        devHub !== null && devHub !== void 0 ? devHub : (devHub = await this.getDevHubOrg());
+        if (!devHub) {
+            throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'NoDevHubFound');
+        }
+        if (devHub.getOrgId() === this.getOrgId()) {
+            // we're attempting to delete a DevHub
+            throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'DeleteOrgHubError');
+        }
+        try {
+            const devHubConn = devHub.getConnection();
+            const username = this.getUsername();
+            const activeScratchOrgRecordId = (await devHubConn.singleRecordQuery(`SELECT Id FROM ActiveScratchOrg WHERE SignupUsername='${username}'`)).Id;
+            this.logger.trace(`found matching ActiveScratchOrg with SignupUsername: ${username}.  Deleting...`);
+            await devHubConn.delete('ActiveScratchOrg', activeScratchOrgRecordId);
+            await this.remove();
+        }
+        catch (err) {
+            this.logger.info(err instanceof Error ? err.message : err);
+            if (err instanceof Error && (err.name === 'INVALID_TYPE' || err.name === 'INSUFFICIENT_ACCESS_OR_READONLY')) {
+                // most likely from devHubConn.delete
+                this.logger.info('Insufficient privilege to access ActiveScratchOrgs.');
+                throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'InsufficientAccessToDelete');
+            }
+            if (err instanceof Error && err.name === connection_1.SingleRecordQueryErrors.NoRecords) {
+                // most likely from singleRecordQuery
+                this.logger.info('The above error can be the result of deleting an expired or already deleted org.');
+                this.logger.info('attempting to cleanup the auth file');
+                await this.removeAuth();
+                throw sfdxError_1.SfdxError.create('@salesforce/core', 'org', 'ScratchOrgNotFound');
+            }
+            throw err;
+        }
+    }
     /**
      * Returns a promise to delete an auth info file from the local file system and any related cache information for
      * this Org.. You don't want to call this method directly. Instead consider calling Org.remove()
@@ -465,7 +594,6 @@ class Org extends kit_1.AsyncCreatable {
      *
      * @param throwWhenRemoveFails true if manageDelete should throw or not if the deleted fails.
      */
-    // 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();

package/lib/testSetup.d.ts

@@ -388,7 +388,9 @@ export declare class MockTestOrgData {
     refreshToken: string;
     userId: string;
     redirectUri: string;
-    constructor(id?: string);
+    constructor(id?: string, options?: {
+        username: string;
+    });
     createDevHubUsername(username: string): void;
     makeDevHub(): void;
     createUser(user: string): MockTestOrgData;

package/lib/testSetup.js

@@ -464,11 +464,11 @@ exports.StreamingMockCometClient = StreamingMockCometClient;
  * Mock class for OrgData.
  */
 class MockTestOrgData {
-    constructor(id = uniqid()) {
+    constructor(id = uniqid(), options) {
         this.testId = id;
         this.userId = `user_id_${this.testId}`;
         this.orgId = `${this.testId}`;
-        this.username = `admin_${this.testId}@gb.org`;
+        this.username = (options === null || options === void 0 ? void 0 : options.username) || `admin_${this.testId}@gb.org`;
         this.loginUrl = `http://login.${this.testId}.salesforce.com`;
         this.instanceUrl = `http://instance.${this.testId}.salesforce.com`;
         this.clientId = `${this.testId}/client_id`;

package/messages/org.json

@@ -1,4 +1,10 @@
 {
-    "NotFoundOnDevHub": "The scratch org does not belong to the dev hub username %s.",
-    "NotADevHub": "The provided dev hub username %s is not a valid dev hub."
-}
+  "NotFoundOnDevHub": "The scratch org does not belong to the dev hub username %s.",
+  "NotADevHub": "The provided dev hub username %s is not a valid dev hub.",
+  "NoDevHubFound": "Unable to associate this scratch org with a DevHub",
+  "DeleteOrgHubError": "The Dev Hub org cannot be deleted.",
+  "InsufficientAccessToDelete": "You do not have the appropriate permissions to delete a scratch org. Please contact your Salesforce admin.",
+  "ScratchOrgNotFound": "Attempting to delete an expired or deleted org",
+  "SandboxDeleteFailed": "The sandbox org deletion failed with a result of %s.",
+  "SandboxNotFound": "We can't find a SandboxProcess for the sandbox org %s."
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "2.29.0",
+  "version": "2.30.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -67,7 +67,7 @@
     "@types/jsonwebtoken": "8.3.2",
     "@types/semver": "^7.3.9",
     "@types/shelljs": "0.7.8",
-    "@types/sinon": "^9.0.8",
+    "@types/sinon": "^10.0.6",
     "@typescript-eslint/eslint-plugin": "^4.2.0",
     "@typescript-eslint/parser": "4.26.0",
     "chai": "^4.2.0",
@@ -87,7 +87,7 @@
     "prettier": "^2.0.5",
     "pretty-quick": "^2.0.1",
     "shelljs": "0.8.1",
-    "sinon": "^9.0.2",
+    "sinon": "10.0.0",
     "ts-node": "^8.10.2",
     "typescript": "^4.1.3"
   },