fix: check devhubs and non-scratch orgs and sandboxes

src/org/authInfo.ts

@@ -392,21 +392,29 @@ export class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     // authInfo before it is necessary.
     const logger = await 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 to identify scratch orgs and sandboxes');
+    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 devhubs, scratch orgs, or sandboxes.
+    const possibleProdOrgs = await AuthInfo.listAllAuthorizations(
+      (orgAuth) => orgAuth && !orgAuth.isDevHub && !orgAuth.isScratchOrg && !orgAuth.isSandbox
+    );
+
     logger.debug(`found ${hubAuthInfos.length} DevHubs`);
-    if (hubAuthInfos.length === 0) return;
+    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) => {
+    await Promise.all([
+      ...hubAuthInfos.map(async (hubAuthInfo) => {
         try {
           const soi = await AuthInfo.queryScratchOrg(hubAuthInfo.username, fields.orgId as string);
           // if any return a result
@@ -429,49 +437,16 @@ export class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
         } catch (error) {
           if (error instanceof Error && error.name === 'SingleRecordQuery_NoRecords' && fields.orgId) {
             // Not a scratch org owned by this hub. Check if it's a sandbox.
-            try {
-              const prodOrg = await Org.create({ aliasOrUsername: hubAuthInfo.username });
-              const sbxProcess = await prodOrg.querySandboxProcessByOrgId(fields.orgId);
-              logger.debug(`${fields.orgId} is a sandbox of ${hubAuthInfo.username}`);
-
-              try {
-                await orgAuthInfo.save({
-                  ...fields,
-                  isScratch: false,
-                  isSandbox: true,
-                });
-              } catch (err) {
-                logger.debug(`error updating auth file for: ${orgAuthInfo.getUsername()}`, err);
-              }
-
-              try {
-                // set the sandbox config value
-                const sfSandbox = {
-                  sandboxUsername: fields.username,
-                  sandboxOrgId: fields.orgId,
-                  prodOrgUsername: hubAuthInfo.username,
-                  sandboxName: sbxProcess.SandboxName,
-                  sandboxProcessId: sbxProcess.Id,
-                  sandboxInfoId: sbxProcess.SandboxInfoId,
-                  timestamp: new Date().toISOString(),
-                } as SandboxFields;
-
-                const stateAggregator = await 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 ${hubAuthInfo.username}`);
-            }
+            await AuthInfo.identifyPossibleSandbox(hubAuthInfo, fields, orgAuthInfo, logger);
           } else {
             logger.error(`Error connecting to devhub ${hubAuthInfo.username}`, error);
           }
         }
-      })
-    );
+      }),
+      ...possibleProdOrgs.map(async (pOrgAuthInfo) => {
+        await AuthInfo.identifyPossibleSandbox(pOrgAuthInfo, fields, orgAuthInfo, logger);
+      }),
+    ]);
   }
 
   /**
@@ -481,6 +456,59 @@ export class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     return AuthInfo.listAllAuthorizations((possibleHub) => possibleHub?.isDevHub ?? false);
   }
 
+  private static async identifyPossibleSandbox(
+    possibleProdOrg: OrgAuthorization,
+    fields: AuthFields,
+    orgAuthInfo: AuthInfo,
+    logger: Logger
+  ): Promise<void> {
+    if (!fields.orgId) {
+      return;
+    }
+
+    try {
+      const prodOrg = await 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(),
+        } as SandboxFields;
+
+        const stateAggregator = await 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

test/unit/org/authInfoTest.ts

@@ -1788,8 +1788,10 @@ describe('AuthInfo', () => {
       });
 
       const getDevHubAuthInfosStub = stubMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos').resolves([]);
+      stubMethod($$.SANDBOX, AuthInfo, 'listAllAuthorizations').resolves([]);
       const queryScratchOrgStub = stubMethod($$.SANDBOX, AuthInfo, 'queryScratchOrg');
       const authInfoSaveStub = stubMethod($$.SANDBOX, AuthInfo.prototype, 'save');
+      stubMethod($$.SANDBOX, Org.prototype, 'querySandboxProcessByOrgId').throws();
 
       await AuthInfo.identifyPossibleScratchOrgs({ orgId: user1.orgId }, authInfo);
       expect(getDevHubAuthInfosStub.callCount).to.be.equal(1);
@@ -1811,6 +1813,7 @@ describe('AuthInfo', () => {
       const getDevHubAuthInfosStub = stubMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos').resolves([]);
       const queryScratchOrgStub = stubMethod($$.SANDBOX, AuthInfo, 'queryScratchOrg');
       const authInfoSaveStub = stubMethod($$.SANDBOX, AuthInfo.prototype, 'save');
+      stubMethod($$.SANDBOX, Org.prototype, 'querySandboxProcessByOrgId').throws();
 
       await AuthInfo.identifyPossibleScratchOrgs(authInfo.getFields(), authInfo);
       expect(getDevHubAuthInfosStub.callCount).to.be.equal(0);
@@ -1833,6 +1836,7 @@ describe('AuthInfo', () => {
       const getDevHubAuthInfosSpy = spyMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos');
       const queryScratchOrgStub = stubMethod($$.SANDBOX, AuthInfo, 'queryScratchOrg');
       const authInfoSaveStub = stubMethod($$.SANDBOX, AuthInfo.prototype, 'save');
+      stubMethod($$.SANDBOX, Org.prototype, 'querySandboxProcessByOrgId').throws();
 
       await AuthInfo.identifyPossibleScratchOrgs(authInfo.getFields(), authInfo);
       expect(getDevHubAuthInfosSpy.callCount).to.be.equal(0);
@@ -1849,19 +1853,67 @@ describe('AuthInfo', () => {
         username: user1.username,
       });
 
-      const getDevHubAuthInfosSpy = spyMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos');
+      const devhubAuths = await AuthInfo.getDevHubAuthInfos();
+      const getDevHubAuthInfosStub = stubMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos').resolves(devhubAuths);
+      stubMethod($$.SANDBOX, AuthInfo, 'listAllAuthorizations').resolves([]);
       const queryScratchOrgStub = stubMethod($$.SANDBOX, AuthInfo, 'queryScratchOrg').resolves({
         Id: '123',
         ExpirationDate: '2020-01-01',
       });
       const authInfoSaveStub = stubMethod($$.SANDBOX, AuthInfo.prototype, 'save');
+      stubMethod($$.SANDBOX, Org.prototype, 'querySandboxProcessByOrgId').throws();
+
       await AuthInfo.identifyPossibleScratchOrgs(authInfo.getFields(), authInfo);
-      expect(getDevHubAuthInfosSpy.callCount).to.be.equal(1);
+      expect(getDevHubAuthInfosStub.callCount).to.be.equal(1);
       expect(queryScratchOrgStub.callCount).to.be.equal(1);
       expect(authInfoSaveStub.callCount).to.be.equal(1);
     });
 
-    it('should update auth file as a sandbox', async () => {
+    it('should update auth file as a sandbox from devhub', async () => {
+      adminTestData.makeDevHub();
+
+      await $$.stubAuths(adminTestData, user1);
+
+      const authInfo = await AuthInfo.create({
+        username: user1.username,
+      });
+
+      const stateAggregator = await StateAggregator.getInstance();
+      const stateAggregatorStub = stubMethod($$.SANDBOX, StateAggregator, 'getInstance');
+      const sandboxSetStub = stubMethod($$.SANDBOX, stateAggregator.sandboxes, 'set');
+      const sandboxWriteStub = stubMethod($$.SANDBOX, stateAggregator.sandboxes, 'write');
+      stateAggregatorStub.resolves(stateAggregator);
+      const devhubAuths = await AuthInfo.getDevHubAuthInfos();
+      stubMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos').resolves(devhubAuths);
+      stubMethod($$.SANDBOX, AuthInfo, 'listAllAuthorizations').resolves([]);
+      const authInfoSaveStub = stubMethod($$.SANDBOX, AuthInfo.prototype, 'save').resolves();
+      const queryScratchOrgStub = stubMethod($$.SANDBOX, AuthInfo, 'queryScratchOrg');
+      const queryScratchOrgError = new Error('not a scratch org');
+      queryScratchOrgError.name = 'SingleRecordQuery_NoRecords';
+      queryScratchOrgStub.throws(queryScratchOrgError);
+      const sbxQueryStub = stubMethod($$.SANDBOX, Org.prototype, 'querySandboxProcessByOrgId');
+      sbxQueryStub.resolves({
+        Id: '0GRB0000000L0ZVOA0',
+        Status: 'Completed',
+        SandboxName: 'TestSandbox',
+        SandboxInfoId: '0GQB0000000PCOdOAO',
+        LicenseType: 'DEVELOPER',
+        CreatedDate: '2021-01-22T22:49:52.000+0000',
+      });
+
+      await AuthInfo.identifyPossibleScratchOrgs(authInfo.getFields(), authInfo);
+
+      expect(authInfoSaveStub.callCount).to.be.equal(2);
+      expect(authInfoSaveStub.secondCall.args[0]).to.have.property('isSandbox', true);
+      expect(authInfoSaveStub.secondCall.args[0]).to.have.property('isScratch', false);
+      expect(sandboxSetStub.calledOnce).to.be.true;
+      expect(sandboxSetStub.firstCall.args[0]).to.equal(authInfo.getFields().orgId);
+      expect(sandboxSetStub.firstCall.args[1]).to.have.property('prodOrgUsername', adminTestData.username);
+      expect(sandboxWriteStub.calledOnce).to.be.true;
+      expect(sandboxWriteStub.firstCall.args[0]).to.equal(authInfo.getFields().orgId);
+    });
+
+    it('should update auth file as a sandbox from possible prod orgs', async () => {
       adminTestData.makeDevHub();
 
       await $$.stubAuths(adminTestData, user1);
@@ -1875,6 +1927,9 @@ describe('AuthInfo', () => {
       const sandboxSetStub = stubMethod($$.SANDBOX, stateAggregator.sandboxes, 'set');
       const sandboxWriteStub = stubMethod($$.SANDBOX, stateAggregator.sandboxes, 'write');
       stateAggregatorStub.resolves(stateAggregator);
+      const devhubAuths = await AuthInfo.getDevHubAuthInfos();
+      stubMethod($$.SANDBOX, AuthInfo, 'getDevHubAuthInfos').resolves([]);
+      stubMethod($$.SANDBOX, AuthInfo, 'listAllAuthorizations').resolves(devhubAuths);
       const authInfoSaveStub = stubMethod($$.SANDBOX, AuthInfo.prototype, 'save').resolves();
       const queryScratchOrgStub = stubMethod($$.SANDBOX, AuthInfo, 'queryScratchOrg');
       const queryScratchOrgError = new Error('not a scratch org');
@@ -1892,7 +1947,7 @@ describe('AuthInfo', () => {
 
       await AuthInfo.identifyPossibleScratchOrgs(authInfo.getFields(), authInfo);
 
-      expect(authInfoSaveStub.calledTwice).to.be.true;
+      expect(authInfoSaveStub.callCount).to.be.equal(2);
       expect(authInfoSaveStub.secondCall.args[0]).to.have.property('isSandbox', true);
       expect(authInfoSaveStub.secondCall.args[0]).to.have.property('isScratch', false);
       expect(sandboxSetStub.calledOnce).to.be.true;