Merge pull request #357 from salesforcecli/sm/fix-alias

fix: use newer core scratchOrgCreate

Author: maggiben

package.json

@@ -8,7 +8,7 @@
   "dependencies": {
     "@oclif/core": "^1.7.0",
     "@salesforce/command": "^5.2.0",
-    "@salesforce/core": "^3.23.8",
+    "@salesforce/core": "^3.24.0",
     "@salesforce/kit": "^1.5.17",
     "open": "8.4.0",
     "tslib": "^2"

src/commands/force/org/beta/create.ts

@@ -25,8 +25,8 @@ import {
   SandboxUserAuthResponse,
   SfError,
   StatusEvent,
-  ScratchOrgRequest,
   ScratchOrgInfo,
+  ScratchOrgRequest,
 } from '@salesforce/core';
 import { OrgCreateResult } from '../../../../shared/orgHooks';
 import { SandboxReporter } from '../../../../shared/sandboxReporter';
@@ -260,25 +260,6 @@ export class Create extends SfdxCommand {
     }
   }
 
-  private async setAliasAndDefaultUsername(username: string): Promise<void> {
-    const stateAggregator = await StateAggregator.getInstance();
-    if (this.flags.setalias) {
-      stateAggregator.aliases.set(this.flags.setalias, username);
-      this.logger.debug('Set Alias: %s result: %s', this.flags.setalias);
-    }
-    if (this.flags.setdefaultusername) {
-      let config: Config;
-      try {
-        config = await Config.create({ isGlobal: false });
-      } catch {
-        config = await Config.create({ isGlobal: true });
-      }
-      const value = stateAggregator.aliases.get(username) || username;
-      const result = config.set(OrgConfigProperties.TARGET_ORG, value);
-      await config.write();
-      this.logger.debug('Set defaultUsername: %s result: %s', this.flags.setdefaultusername, result);
-    }
-  }
   private async createScratchOrg(): Promise<ScratchOrgProcessObject> {
     this.logger.debug('OK, will do scratch org creation');
     if (!this.hubOrg) {
@@ -291,15 +272,14 @@ export class Create extends SfdxCommand {
 
     this.logger.debug('validation complete');
 
-    let secret: string;
-    if (this.flags.clientid) {
-      // If the user supplied a specific client ID, we have no way of knowing if it's
-      // a certificate-based Connected App or not. Therefore, we have to assume that
-      // we'll need the client secret, so prompt the user for it.
-      secret = await this.ux.prompt(messages.getMessage('secretPrompt'), {
-        type: 'mask',
-      });
-    }
+    // If the user supplied a specific client ID, we have no way of knowing if it's
+    // a certificate-based Connected App or not. Therefore, we have to assume that
+    // we'll need the client secret, so prompt the user for it.
+    const secret = this.flags.clientid
+      ? await this.ux.prompt(messages.getMessage('secretPrompt'), {
+          type: 'mask',
+        })
+      : undefined;
 
     const createCommandOptions: ScratchOrgRequest = {
       connectedAppConsumerKey: this.flags.clientid as string,
@@ -312,14 +292,15 @@ export class Create extends SfdxCommand {
       definitionfile: this.flags.definitionfile as string,
       orgConfig: this.varargs,
       clientSecret: secret,
+      setDefault: (this.flags.setdefaultusername as boolean) === true,
+      alias: this.flags.setalias as string | undefined,
+      tracksSource: true,
     };
 
     const { username, scratchOrgInfo, authFields, warnings } = await this.hubOrg.scratchOrgCreate(createCommandOptions);
 
     await Lifecycle.getInstance().emit('scratchOrgInfo', scratchOrgInfo);
 
-    await this.setAliasAndDefaultUsername(username);
-
     // emit postorgcreate event for hook
     const postOrgCreateHookInfo: OrgCreateResult = [authFields].map((element) => ({
       accessToken: element.accessToken,

test/commands/force/org/scratchOrgCreate.test.ts

@@ -4,7 +4,7 @@
  * 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 { Config, StateAggregator, SfError, Messages, Org, SfProject } from '@salesforce/core';
+import { SfError, Messages, Org, SfProject } from '@salesforce/core';
 import { fromStub, stubInterface, stubMethod } from '@salesforce/ts-sinon';
 import * as sinon from 'sinon';
 import { expect } from '@salesforce/command/lib/test';
@@ -44,8 +44,6 @@ describe('org:create', () => {
   let uxLogStub: sinon.SinonStub;
   let uxWarnStub: sinon.SinonStub;
   let promptStub: sinon.SinonStub;
-  let aliasGetStub: sinon.SinonStub;
-  let aliasSetStub: sinon.SinonSpy;
   let cmd: TestCreate;
 
   class TestCreate extends Create {
@@ -109,6 +107,7 @@ describe('org:create', () => {
       const prodOrg = stubMethod(sandbox, Org.prototype, 'scratchOrgCreate').resolves(CREATE_RESULT);
       await command.runIt();
       expect(prodOrg.firstCall.args[0]).to.deep.equal({
+        alias: undefined,
         apiversion: undefined,
         clientSecret: undefined,
         connectedAppConsumerKey: undefined,
@@ -120,6 +119,8 @@ describe('org:create', () => {
           unit: 0,
         },
         retry: 0,
+        setDefault: false,
+        tracksSource: true,
         definitionfile: 'myScratchDef.json',
         orgConfig: {
           licenseType: 'LicenseFromVarargs',
@@ -161,6 +162,7 @@ describe('org:create', () => {
       const prodOrg = stubMethod(sandbox, Org.prototype, 'scratchOrgCreate').resolves(CREATE_RESULT);
       await command.runIt();
       expect(prodOrg.firstCall.args[0]).to.deep.equal({
+        alias: undefined,
         apiversion: undefined,
         clientSecret,
         connectedAppConsumerKey,
@@ -173,6 +175,8 @@ describe('org:create', () => {
           unit: 0,
         },
         retry: 0,
+        setDefault: false,
+        tracksSource: true,
         orgConfig: {},
       });
       expect(promptStub.callCount).to.equal(1);
@@ -201,17 +205,9 @@ describe('org:create', () => {
         ...CREATE_RESULT,
         username: 'newScratchUsername',
       });
-      aliasGetStub = sinon.stub().returns('');
-      aliasSetStub = sinon.spy();
-      stubMethod(sandbox, StateAggregator, 'getInstance').returns({
-        aliases: {
-          get: aliasGetStub,
-          set: aliasSetStub,
-        },
-      });
-      const configStub = stubMethod(sandbox, Config.prototype, 'set');
       await command.runIt();
       expect(prodOrg.firstCall.args[0]).to.deep.equal({
+        alias: 'scratchOrgAlias',
         apiversion: undefined,
         clientSecret: undefined,
         connectedAppConsumerKey: undefined,
@@ -224,11 +220,10 @@ describe('org:create', () => {
           unit: 0,
         },
         retry: 0,
+        setDefault: true,
+        tracksSource: true,
         orgConfig: {},
       });
-      expect(aliasSetStub.firstCall.args).to.deep.equal(['scratchOrgAlias', 'newScratchUsername']);
-      expect(aliasGetStub.firstCall.args).to.deep.equal(['newScratchUsername']);
-      expect(configStub.firstCall.args).to.deep.equal(['target-org', 'newScratchUsername']);
     });
 
     it('will set alias as default', async () => {
@@ -252,18 +247,9 @@ describe('org:create', () => {
         username: 'newScratchUsername',
       });
 
-      aliasGetStub = sinon.stub().returns('scratchOrgAlias');
-      aliasSetStub = sinon.spy();
-      stubMethod(sandbox, StateAggregator, 'getInstance').returns({
-        aliases: {
-          get: aliasGetStub,
-          set: aliasSetStub,
-        },
-      });
-
-      const configStub = stubMethod(sandbox, Config.prototype, 'set');
       await command.runIt();
       expect(prodOrg.firstCall.args[0]).to.deep.equal({
+        alias: 'scratchOrgAlias',
         apiversion: undefined,
         clientSecret: undefined,
         connectedAppConsumerKey: undefined,
@@ -277,10 +263,9 @@ describe('org:create', () => {
         },
         retry: 0,
         orgConfig: {},
+        setDefault: true,
+        tracksSource: true,
       });
-      expect(aliasSetStub.firstCall.args).to.deep.equal(['scratchOrgAlias', 'newScratchUsername']);
-      expect(aliasGetStub.firstCall.args).to.deep.equal(['newScratchUsername']);
-      expect(configStub.firstCall.args).to.deep.equal(['target-org', 'scratchOrgAlias']);
     });
 
     it('will test json output', async () => {
@@ -295,6 +280,7 @@ describe('org:create', () => {
       });
       const result = await command.runIt();
       expect(prodOrg.firstCall.args[0]).to.deep.equal({
+        alias: undefined,
         apiversion: undefined,
         clientSecret: undefined,
         connectedAppConsumerKey: undefined,
@@ -307,6 +293,8 @@ describe('org:create', () => {
           unit: 0,
         },
         retry: 0,
+        tracksSource: true,
+        setDefault: false,
         orgConfig: {},
       });
       expect(result).to.have.keys(['username', 'authFields', 'scratchOrgInfo', 'warnings', 'orgId']);

yarn.lock

@@ -1104,10 +1104,10 @@
     semver "^7.3.5"
     ts-retry-promise "^0.6.0"
 
-"@salesforce/core@^3.20.1", "@salesforce/core@^3.23.8":
-  version "3.23.8"
-  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-3.23.8.tgz#de175ef8e9bce757adb1d515f43ce942b1427e2c"
-  integrity sha512-xE0yar5cDL0+PZbvJqRgzekY3ZKeFpZqhVQlsFMWMUH0jBo+sao8sS6U6aTnCJfISnDw08CMW90Kp8rgkYyvHA==
+"@salesforce/core@^3.20.1", "@salesforce/core@^3.24.0":
+  version "3.24.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-3.24.0.tgz#ecfa4ae3c23dab37b7431e5d8e7b623db2ba4f12"
+  integrity sha512-PiiJAfCIw0Gj9CUm0Y9C211JXgyJASoywHPmWKe6RY4Ul+WuHkFBDGmdRkuxHLA23P0PVZaclT0Av3CbWwmPSg==
   dependencies:
     "@salesforce/bunyan" "^2.0.0"
     "@salesforce/kit" "^1.5.41"
@@ -1124,7 +1124,7 @@
     form-data "^4.0.0"
     graceful-fs "^4.2.9"
     js2xmlparser "^4.0.1"
-    jsforce "2.0.0-beta.14"
+    jsforce beta
     jsonwebtoken "8.5.1"
     mkdirp "1.0.4"
     ts-retry-promise "^0.6.0"
@@ -4814,10 +4814,31 @@ jsesc@^2.5.1:
   resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4"
   integrity sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==
 
-[email protected]:
-  version "2.0.0-beta.14"
-  resolved "https://registry.yarnpkg.com/jsforce/-/jsforce-2.0.0-beta.14.tgz#237753bdabb7e80447b5b266eaefc4abf8b6c951"
-  integrity sha512-j66PaKroshB4VZbfKBAx9+lJy8etFfGG1hGFsI7ufwxvacXxLTAxZwOEZPkYPMigiHrPlEMtIwh5NqwBsIn9HA==
+jsforce@^1.11.0:
+  version "1.11.0"
+  resolved "https://registry.yarnpkg.com/jsforce/-/jsforce-1.11.0.tgz#7e853b82c534f1fe8e18f432a344bae81881a133"
+  integrity sha512-vYNXJXXdz9ZQNdfRqq/MCJ/zU7JGA7iEduwafQDzChR9FeqXgTNfHTppLVbw9mIniKkQZemmxSOtl7N04lj/5Q==
+  dependencies:
+    base64-url "^2.2.0"
+    co-prompt "^1.0.0"
+    coffeescript "^1.10.0"
+    commander "^2.9.0"
+    csv-parse "^4.10.1"
+    csv-stringify "^1.0.4"
+    faye "^1.4.0"
+    inherits "^2.0.1"
+    lodash "^4.17.19"
+    multistream "^2.0.5"
+    opn "^5.3.0"
+    promise "^7.1.1"
+    readable-stream "^2.1.0"
+    request "^2.72.0"
+    xml2js "^0.4.16"
+
+jsforce@beta:
+  version "2.0.0-beta.15"
+  resolved "https://registry.yarnpkg.com/jsforce/-/jsforce-2.0.0-beta.15.tgz#05255f3b54a001421c973b1a7b4dbb4468ded2a3"
+  integrity sha512-AfwIxG+y+WOsqSGKlezyL3G+4ItmR/zfcvg38x4CDa3eizDD0wWZBAOnJbOQ8U76zAQqrMsyWs+s3ozJzSLtZA==
   dependencies:
     "@babel/runtime" "^7.12.5"
     "@babel/runtime-corejs3" "^7.12.5"
@@ -4840,27 +4861,6 @@ [email protected]:
     strip-ansi "^6.0.0"
     xml2js "^0.4.22"
 
-jsforce@^1.11.0:
-  version "1.11.0"
-  resolved "https://registry.yarnpkg.com/jsforce/-/jsforce-1.11.0.tgz#7e853b82c534f1fe8e18f432a344bae81881a133"
-  integrity sha512-vYNXJXXdz9ZQNdfRqq/MCJ/zU7JGA7iEduwafQDzChR9FeqXgTNfHTppLVbw9mIniKkQZemmxSOtl7N04lj/5Q==
-  dependencies:
-    base64-url "^2.2.0"
-    co-prompt "^1.0.0"
-    coffeescript "^1.10.0"
-    commander "^2.9.0"
-    csv-parse "^4.10.1"
-    csv-stringify "^1.0.4"
-    faye "^1.4.0"
-    inherits "^2.0.1"
-    lodash "^4.17.19"
-    multistream "^2.0.5"
-    opn "^5.3.0"
-    promise "^7.1.1"
-    readable-stream "^2.1.0"
-    request "^2.72.0"
-    xml2js "^0.4.16"
-
 json-parse-better-errors@^1.0.1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9"