salesforcecli · peternhale · May 14, 2021 · May 7, 2021 · May 10, 2021 · May 10, 2021
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
diff --git a/.github/autointegrator.yml b/.github/autointegrator.yml
diff --git a/.github/no-response.yml b/.github/no-response.yml
diff --git a/src/commands/auth/device/login.ts b/src/commands/auth/device/login.ts
@@ -77,6 +77,7 @@ export default class Login extends SfdxCommand {
       const authInfo = await deviceOauthService.authorizeAndSave(approval);
       await Common.handleSideEffects(authInfo, this.flags);
       const fields = authInfo.getFields(true);
+      await Common.identifyPossibleScratchOrgs(fields, authInfo);
       const successMsg = messages.getMessage('success', [fields.username]);
       this.ux.log(successMsg);
       return fields;

diff --git a/src/commands/auth/jwt/grant.ts b/src/commands/auth/jwt/grant.ts
@@ -70,6 +70,7 @@ export default class Grant extends SfdxCommand {
       const authInfo = await this.initAuthInfo();
       await Common.handleSideEffects(authInfo, this.flags);
       result = authInfo.getFields(true);
+      await Common.identifyPossibleScratchOrgs(result, authInfo);
     } catch (err) {
       const msg = getString(err, 'message');
       throw SfdxError.create('@salesforce/plugin-auth', 'jwt.grant', 'JwtGrantError', [msg]);

diff --git a/src/commands/auth/sfdxurl/store.ts b/src/commands/auth/sfdxurl/store.ts
@@ -77,6 +77,8 @@ export default class Store extends SfdxCommand {
     await Common.handleSideEffects(authInfo, this.flags);
 
     const result = authInfo.getFields(true);
+    await Common.identifyPossibleScratchOrgs(result, authInfo);
+
     const successMsg = commonMessages.getMessage('authorizeCommandSuccess', [result.username, result.orgId]);
     this.ux.log(successMsg);
     return result;

diff --git a/src/commands/auth/web/login.ts b/src/commands/auth/web/login.ts
@@ -77,6 +77,8 @@ export default class Login extends SfdxCommand {
       const authInfo = await this.executeLoginFlow(oauthConfig);
       await Common.handleSideEffects(authInfo, this.flags);
       const fields = authInfo.getFields(true);
+      await Common.identifyPossibleScratchOrgs(fields, authInfo);
+
       const successMsg = commonMessages.getMessage('authorizeCommandSuccess', [fields.username, fields.orgId]);
       this.ux.log(successMsg);
       return fields;

diff --git a/src/common.ts b/src/common.ts
@@ -4,8 +4,9 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-
-import { AuthInfo, Logger, SfdcUrl, SfdxProject, Messages, SfdxError } from '@salesforce/core';
+import { basename } from 'path';
+import { QueryResult } from 'jsforce';
+import { AuthInfo, AuthFields, Logger, SfdcUrl, SfdxProject, Messages, Org, SfdxError, sfdc } from '@salesforce/core';
 import { getString, isObject, Optional } from '@salesforce/ts-types';
 
 Messages.importMessagesDirectory(__dirname);
@@ -54,4 +55,58 @@ export class Common {
     logger.debug(`loginUrl: ${loginUrl}`);
     return loginUrl;
   }
+
+  // fields property is passed in because the consumers of this method have performed the decrypt.
+  // This is so we don't have to call authInfo.getFields(true) and decrypt again OR accidentally save an
+  public static async identifyPossibleScratchOrgs(fields: AuthFields, orgAuthInfo: AuthInfo): Promise<void> {
+    const logger = await Logger.child('Common', { tag: 'identifyPossibleScratchOrgs' });
+
+    // return if we already know the hub or we know it is a devhub or prod-like
+    if (fields.isDevHub || fields.devHubUsername) return;
+    // there are no hubs to ask, so quit early
+    if (!(await AuthInfo.hasAuthentications())) return;
+    logger.debug('getting devHubs from authfiles');
+
+    // 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 this.getDevHubAuthInfos();
+    logger.debug(`found ${hubAuthInfos.length} DevHubs`);
+    if (hubAuthInfos.length === 0) return;
+
+    // ask all those orgs if they know this orgId
+    await Promise.all(
+      hubAuthInfos.map(async (hubAuthInfo) => {
+        try {
+          const devHubOrg = await Org.create({ aliasOrUsername: hubAuthInfo.getUsername() });
+          const conn = devHubOrg.getConnection();
+          const data = await conn.query<QueryResult<{ Id: string }>>(
+            `select Id from ScratchOrgInfo where ScratchOrg = '${sfdc.trimTo15(fields.orgId)}'`
+          );
+          if (data.totalSize > 0) {
+            // if any return a result
+            logger.debug(`found orgId ${fields.orgId} in devhub ${hubAuthInfo.getUsername()}`);
+            try {
+              await orgAuthInfo.save({ ...fields, devHubUsername: hubAuthInfo.getUsername() });
+              logger.debug(`set ${hubAuthInfo.getUsername()} as devhub for scratch org ${orgAuthInfo.getUsername()}`);
+            } catch (error) {
+              logger.debug(`error updating auth file for ${orgAuthInfo.getUsername()}`, error);
+            }
+          }
+        } catch (error) {
+          logger.error(`Error connecting to devhub ${hubAuthInfo.getUsername()}`, error);
+        }
+      })
+    );
+  }
+
+  public static async getDevHubAuthInfos(): Promise<AuthInfo[]> {
+    return (
+      await Promise.all(
+        (await AuthInfo.listAllAuthFiles())
+          .map((fileName) => basename(fileName, '.json'))
+          .map((username) => AuthInfo.create({ username }))
+      )
+    ).filter((possibleHub) => possibleHub?.getFields()?.isDevHub);
+  }
 }
diff --git a/test/commands/auth/device/login.test.ts b/test/commands/auth/device/login.test.ts
@@ -5,7 +5,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-/* eslint-disable @typescript-eslint/ban-ts-comment */
 /* eslint-disable camelcase */
 
 import { $$, expect, test } from '@salesforce/command/lib/test';
@@ -88,6 +87,9 @@ describe('auth:device:login', async () => {
     }
 
     stubMethod($$.SANDBOX, AuthInfo, 'create').callsFake(async () => authInfoStub);
+    $$.SANDBOX.stub(AuthInfo, 'listAllAuthFiles').callsFake(async () => {
+      return [`${authFields.username}.json`];
+    });
   }
 
   test

diff --git a/test/commands/auth/jwt/grant.test.ts b/test/commands/auth/jwt/grant.test.ts
@@ -28,6 +28,10 @@ describe('auth:jwt:grant', async () => {
       getFields: () => authFields,
     });
 
+    $$.SANDBOX.stub(AuthInfo, 'listAllAuthFiles').callsFake(async () => {
+      return [`${authFields.username}.json`];
+    });
+
     if (options.authInfoCreateFails) {
       $$.SANDBOX.stub(AuthInfo, 'create').throws(new Error('invalid client id'));
     } else if (options.existingAuth) {
@@ -36,10 +40,6 @@ describe('auth:jwt:grant', async () => {
         .throws(new SfdxError('auth exists', 'AuthInfoOverwriteError'))
         .onSecondCall()
         .callsFake(async () => authInfoStub);
-
-      $$.SANDBOX.stub(AuthInfo, 'listAllAuthFiles').callsFake(async () => {
-        return [`${authFields.username}.json`];
-      });
     } else {
       stubMethod($$.SANDBOX, AuthInfo, 'create').callsFake(async () => authInfoStub);
     }

diff --git a/test/commands/auth/scratch-identify.nut.ts b/test/commands/auth/scratch-identify.nut.ts
@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import * as path from 'path';
+import { expect } from 'chai';
+
+import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import { Env } from '@salesforce/kit';
+import { AnyJson, ensureString, getString, isArray } from '@salesforce/ts-types';
+import { AuthFields, Authorization, fs } from '@salesforce/core';
+
+describe('verify discovery/id of scratch org', () => {
+  let testSession: TestSession;
+  let hubUsername: string;
+  let orgUsername: string;
+  let jwtKey: string;
+  let orgInstanceUrl: string;
+
+  before('prepare session and ensure environment variables', async () => {
+    const env = new Env();
+    ensureString(env.getString('TESTKIT_JWT_KEY'));
+    ensureString(env.getString('TESTKIT_JWT_CLIENT_ID'));
+    ensureString(env.getString('TESTKIT_HUB_INSTANCE'));
+    hubUsername = ensureString(env.getString('TESTKIT_HUB_USERNAME'));
+    testSession = await TestSession.create({
+      project: { name: 'ScratchIDProject' },
+      setupCommands: [
+        `sfdx force:org:create -d 1 -s -f ${path.join('config', 'project-scratch-def.json')} --json`,
+        'sfdx force:org:display --json',
+      ],
+    });
+    if (isArray<AnyJson>(testSession.setup)) {
+      orgUsername = getString(testSession.setup[0], 'result.username');
+      orgInstanceUrl = getString(testSession.setup[1], 'result.instanceUrl', 'https://test.salesforce.com').replace(
+        '.com/',
+        '.com'
+      );
+    }
+    // we'll need this path for testing
+    jwtKey = path.join(testSession.homeDir, 'jwtKey');
+  });
+
+  after(async () => {
+    await testSession?.clean();
+  });
+
+  it('should have the scratch org in auth files', () => {
+    const list = execCmd<Authorization[]>('auth:list --json', { ensureExitCode: 0 }).jsonOutput;
+    const found = !!list.result.find((r) => r.username === orgUsername);
+    expect(found).to.be.true;
+  });
+
+  it('should logout from the org)', () => {
+    execCmd(`auth:logout -u ${orgUsername} --noprompt`, { ensureExitCode: 0 });
+  });
+
+  it('should NOT have the scratch org in auth files', () => {
+    const list = execCmd<Authorization[]>('auth:list --json', { ensureExitCode: 0 }).jsonOutput;
+    const found = !!list.result.find((r) => r.username === orgUsername);
+    expect(found).to.be.false;
+  });
+
+  it('should login to the org via jwt grant', async function () {
+    const env = new Env();
+    const command = `auth:jwt:grant -f ${jwtKey} --username ${orgUsername} --clientid ${env.getString(
+      'TESTKIT_JWT_CLIENT_ID'
+    )} -r ${orgInstanceUrl} --json`;
+    const output = execCmd<AuthFields>(command, {
+      ensureExitCode: 0,
+    }).jsonOutput.result;
+    expect(output.username).to.equal(orgUsername);
+  });
+
+  it('should have the devhubUsername in the auth file', async () => {
+    const fileContents = (await fs.readJson(path.join(testSession.homeDir, '.sfdx', `${orgUsername}.json`))) as {
+      devHubUsername: string;
+    };
+    expect(fileContents.devHubUsername).to.equal(hubUsername);
+  });
+});
diff --git a/test/commands/auth/sfdxurl/store.test.ts b/test/commands/auth/sfdxurl/store.test.ts
@@ -29,6 +29,10 @@ describe('auth:sfdxurl:store', async () => {
       getFields: () => authFields,
     });
 
+    $$.SANDBOX.stub(AuthInfo, 'listAllAuthFiles').callsFake(async () => {
+      return [`${authFields.username}.json`];
+    });
+
     if (!options.fileDoesNotExist) {
       $$.SANDBOX.stub(fs, 'readFile').callsFake(
         async () => 'force://PlatformCLI::CoffeeAndBacon@su0503.my.salesforce.com'
@@ -38,9 +42,6 @@ describe('auth:sfdxurl:store', async () => {
     if (options.authInfoCreateFails) {
       $$.SANDBOX.stub(AuthInfo, 'create').throws(new Error('invalid client id'));
     } else if (options.existingAuth) {
-      $$.SANDBOX.stub(AuthInfo, 'listAllAuthFiles').callsFake(async () => {
-        return [`${authFields.username}.json`];
-      });
       stubMethod($$.SANDBOX, AuthInfo, 'create').callsFake(async () => authInfoStub);
     } else {
       stubMethod($$.SANDBOX, AuthInfo, 'create').callsFake(async () => authInfoStub);

diff --git a/test/commands/auth/web/login.test.ts b/test/commands/auth/web/login.test.ts
@@ -35,14 +35,17 @@ describe('auth:web:login', () => {
     stubMethod($$.SANDBOX, Login.prototype, 'executeLoginFlow').callsFake(async () => {
       return authInfoStub;
     });
+    $$.SANDBOX.stub(AuthInfo, 'listAllAuthFiles').callsFake(async () => {
+      return [`${authFields.username}.json`];
+    });
     uxStub = stubInterface<UX>($$.SANDBOX, {
       prompt: () => promptAnswer,
     });
 
     const login = new Login([], config);
-    // @ts-ignore because protected memeber
+    // @ts-ignore because protected member
     login.ux = uxStub;
-    // @ts-ignore because protected memeber
+    // @ts-ignore because protected member
     login.flags = Object.assign({}, { noprompt: true }, flags);
     return login;
   }
@@ -58,9 +61,9 @@ describe('auth:web:login', () => {
     uxStub = stubInterface<UX>($$.SANDBOX, {});
 
     const login = new Login([], config);
-    // @ts-ignore because protected memeber
+    // @ts-ignore because protected member
     login.ux = uxStub;
-    // @ts-ignore because protected memeber
+    // @ts-ignore because protected member
     login.flags = { noprompt: true };
     return login;
   }