@salesforce/core 5.1.4 → 5.1.5

package/lib/org/authInfo.d.ts

@@ -182,7 +182,7 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     static parseSfdxAuthUrl(sfdxAuthUrl: string): Pick<AuthFields, 'clientId' | 'clientSecret' | 'refreshToken' | 'loginUrl'>;
     /**
      * Given a set of decrypted fields and an authInfo, determine if the org belongs to an available
-     * dev hub.
+     * dev hub, or if the org is a sandbox of another CLI authed production org.
      *
      * @param fields
      * @param orgAuthInfo
@@ -192,6 +192,7 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      * Find all dev hubs available in the local environment.
      */
     static getDevHubAuthInfos(): Promise<OrgAuthorization[]>;
+    private static identifyPossibleSandbox;
     /**
      * Checks active scratch orgs to match by the ScratchOrg field (the 15-char org id)
      * if you pass an 18-char scratchOrgId, it will be trimmed to 15-char for query purposes

package/lib/org/authInfo.js

@@ -220,7 +220,7 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Given a set of decrypted fields and an authInfo, determine if the org belongs to an available
-     * dev hub.
+     * dev hub, or if the org is a sandbox of another CLI authed production org.
      *
      * @param fields
      * @param orgAuthInfo
@@ -230,39 +230,53 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         // This is so we don't have to call authInfo.getFields(true) and decrypt again OR accidentally save an
         // authInfo before it is necessary.
         const logger = await logger_1.Logger.child('Common', { tag: 'identifyPossibleScratchOrgs' });
-        // return if we already know the hub org we know it is a devhub or prod-like or no orgId present
+        // return if we already know the hub org, we know it is a devhub or prod-like, or no orgId present
         if (fields.isDevHub || fields.devHubUsername || !fields.orgId)
             return;
-        logger.debug('getting devHubs');
+        logger.debug('getting devHubs and prod orgs to identify scratch orgs and sandboxes');
         // TODO: return if url is not sandbox-like to avoid constantly asking about production orgs
         // TODO: someday we make this easier by asking the org if it is a scratch org
         const hubAuthInfos = await AuthInfo.getDevHubAuthInfos();
+        // Get a list of org auths that are known not to be scratch orgs or sandboxes.
+        const possibleProdOrgs = await AuthInfo.listAllAuthorizations((orgAuth) => orgAuth && !orgAuth.isScratchOrg && !orgAuth.isSandbox);
         logger.debug(`found ${hubAuthInfos.length} DevHubs`);
-        if (hubAuthInfos.length === 0)
+        logger.debug(`found ${possibleProdOrgs.length} possible prod orgs`);
+        if (hubAuthInfos.length === 0 && possibleProdOrgs.length === 0) {
             return;
+        }
         // ask all those orgs if they know this orgId
-        await Promise.all(hubAuthInfos.map(async (hubAuthInfo) => {
-            try {
-                const soi = await AuthInfo.queryScratchOrg(hubAuthInfo.username, fields.orgId);
-                // if any return a result
-                logger.debug(`found orgId ${fields.orgId} in devhub ${hubAuthInfo.username}`);
+        await Promise.all([
+            ...hubAuthInfos.map(async (hubAuthInfo) => {
                 try {
-                    await orgAuthInfo.save({
-                        ...fields,
-                        devHubUsername: hubAuthInfo.username,
-                        expirationDate: soi.ExpirationDate,
-                        isScratch: true,
-                    });
-                    logger.debug(`set ${hubAuthInfo.username} as devhub and expirationDate ${soi.ExpirationDate} for scratch org ${orgAuthInfo.getUsername()}`);
+                    const soi = await AuthInfo.queryScratchOrg(hubAuthInfo.username, fields.orgId);
+                    // if any return a result
+                    logger.debug(`found orgId ${fields.orgId} in devhub ${hubAuthInfo.username}`);
+                    try {
+                        await orgAuthInfo.save({
+                            ...fields,
+                            devHubUsername: hubAuthInfo.username,
+                            expirationDate: soi.ExpirationDate,
+                            isScratch: true,
+                        });
+                        logger.debug(`set ${hubAuthInfo.username} as devhub and expirationDate ${soi.ExpirationDate} for scratch org ${orgAuthInfo.getUsername()}`);
+                    }
+                    catch (error) {
+                        logger.debug(`error updating auth file for ${orgAuthInfo.getUsername()}`, error);
+                    }
                 }
                 catch (error) {
-                    logger.debug(`error updating auth file for ${orgAuthInfo.getUsername()}`, error);
+                    if (error instanceof Error && error.name === 'NoActiveScratchOrgFound') {
+                        logger.error(`devhub ${hubAuthInfo.username} has no scratch orgs`, error);
+                    }
+                    else {
+                        logger.error(`Error connecting to devhub ${hubAuthInfo.username}`, error);
+                    }
                 }
-            }
-            catch (error) {
-                logger.error(`Error connecting to devhub ${hubAuthInfo.username}`, error);
-            }
-        }));
+            }),
+            ...possibleProdOrgs.map(async (pOrgAuthInfo) => {
+                await AuthInfo.identifyPossibleSandbox(pOrgAuthInfo, fields, orgAuthInfo, logger);
+            }),
+        ]);
     }
     /**
      * Find all dev hubs available in the local environment.
@@ -270,6 +284,52 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     static async getDevHubAuthInfos() {
         return AuthInfo.listAllAuthorizations((possibleHub) => possibleHub?.isDevHub ?? false);
     }
+    static async identifyPossibleSandbox(possibleProdOrg, fields, orgAuthInfo, logger) {
+        if (!fields.orgId) {
+            return;
+        }
+        try {
+            const prodOrg = await org_1.Org.create({ aliasOrUsername: possibleProdOrg.username });
+            const sbxProcess = await prodOrg.querySandboxProcessByOrgId(fields.orgId);
+            if (!sbxProcess?.SandboxInfoId) {
+                return;
+            }
+            logger.debug(`${fields.orgId} is a sandbox of ${possibleProdOrg.username}`);
+            try {
+                await orgAuthInfo.save({
+                    ...fields,
+                    isScratch: false,
+                    isSandbox: true,
+                });
+            }
+            catch (err) {
+                logger.debug(`error updating auth file for: ${orgAuthInfo.getUsername()}`, err);
+                throw err; // rethrow; don't want a sandbox config file with an invalid auth file
+            }
+            try {
+                // set the sandbox config value
+                const sfSandbox = {
+                    sandboxUsername: fields.username,
+                    sandboxOrgId: fields.orgId,
+                    prodOrgUsername: possibleProdOrg.username,
+                    sandboxName: sbxProcess.SandboxName,
+                    sandboxProcessId: sbxProcess.Id,
+                    sandboxInfoId: sbxProcess.SandboxInfoId,
+                    timestamp: new Date().toISOString(),
+                };
+                const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
+                stateAggregator.sandboxes.set(fields.orgId, sfSandbox);
+                logger.debug(`writing sandbox auth file for: ${orgAuthInfo.getUsername()} with ID: ${fields.orgId}`);
+                await stateAggregator.sandboxes.write(fields.orgId);
+            }
+            catch (e) {
+                logger.debug(`error writing sandbox auth file for: ${orgAuthInfo.getUsername()}`, e);
+            }
+        }
+        catch (err) {
+            logger.debug(`${fields.orgId} is not a sandbox of ${possibleProdOrg.username}`);
+        }
+    }
     /**
      * Checks active scratch orgs to match by the ScratchOrg field (the 15-char org id)
      * if you pass an 18-char scratchOrgId, it will be trimmed to 15-char for query purposes

package/lib/org/org.d.ts

@@ -78,6 +78,7 @@ export type SandboxFields = {
     sandboxUsername?: string;
     sandboxProcessId?: string;
     sandboxInfoId?: string;
+    timestamp?: string;
 };
 /**
  * Provides a way to manage a locally authenticated Org.
@@ -369,23 +370,26 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * query SandboxProcess via sandbox name
      *
      * @param name SandboxName to query for
-     * @private
      */
     querySandboxProcessBySandboxName(name: string): Promise<SandboxProcessObject>;
     /**
      * query SandboxProcess via SandboxInfoId
      *
      * @param id SandboxInfoId to query for
-     * @private
      */
     querySandboxProcessBySandboxInfoId(id: string): Promise<SandboxProcessObject>;
     /**
      * query SandboxProcess via Id
      *
      * @param id SandboxProcessId to query for
-     * @private
      */
     querySandboxProcessById(id: string): Promise<SandboxProcessObject>;
+    /**
+     * query SandboxProcess via SandboxOrganization (sandbox Org ID)
+     *
+     * @param sandboxOrgId SandboxOrganization ID to query for
+     */
+    querySandboxProcessByOrgId(sandboxOrgId: string): Promise<SandboxProcessObject>;
     /**
      * Initialize async components.
      */

package/lib/org/org.js

@@ -724,7 +724,6 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * query SandboxProcess via sandbox name
      *
      * @param name SandboxName to query for
-     * @private
      */
     async querySandboxProcessBySandboxName(name) {
         return this.querySandboxProcess(`SandboxName='${name}'`);
@@ -733,7 +732,6 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * query SandboxProcess via SandboxInfoId
      *
      * @param id SandboxInfoId to query for
-     * @private
      */
     async querySandboxProcessBySandboxInfoId(id) {
         return this.querySandboxProcess(`SandboxInfoId='${id}'`);
@@ -742,11 +740,19 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * query SandboxProcess via Id
      *
      * @param id SandboxProcessId to query for
-     * @private
      */
     async querySandboxProcessById(id) {
         return this.querySandboxProcess(`Id='${id}'`);
     }
+    /**
+     * query SandboxProcess via SandboxOrganization (sandbox Org ID)
+     *
+     * @param sandboxOrgId SandboxOrganization ID to query for
+     */
+    async querySandboxProcessByOrgId(sandboxOrgId) {
+        // Must query with a 15 character Org ID
+        return this.querySandboxProcess(`SandboxOrganization='${(0, sfdc_1.trimTo15)(sandboxOrgId)}'`);
+    }
     /**
      * Initialize async components.
      */

package/package.json

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