feat: use StateAggregator [sb-nuts]

cristiand391 · cristiand391 · commit 8abe9d7abe2c · 2022-06-08T15:06:58.000-03:00
diff --git a/package.json b/package.json
@@ -7,16 +7,16 @@
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^1.7.0",
-    "@salesforce/command": "^5.1.3",
-    "@salesforce/core": "^3.19.0",
+    "@salesforce/command": "^5.2.0",
+    "@salesforce/core": "^3.20.1",
     "@salesforce/kit": "^1.5.17",
     "open": "8.4.0",
     "tslib": "^2"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1",
     "@oclif/plugin-command-snapshot": "^3.1.3",
-    "@salesforce/cli-plugins-testkit": "^1.5.3",
+    "@salesforce/cli-plugins-testkit": "^2.2.0",
     "@salesforce/dev-config": "^3.0.1",
     "@salesforce/dev-scripts": "^2.0.2",
     "@salesforce/plugin-command-reference": "^1.3.0",
diff --git a/src/commands/force/org/beta/create.ts b/src/commands/force/org/beta/create.ts
@@ -11,7 +11,7 @@ import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
 import { Duration } from '@salesforce/kit';
 import {
   AuthFields,
-  GlobalInfo,
+  StateAggregator,
   Config,
   Lifecycle,
   Messages,
@@ -208,9 +208,9 @@ export class Create extends SfdxCommand {
       });
       if (results.sandboxRes?.authUserName) {
         if (this.flags.setalias) {
-          const globalInfo = await GlobalInfo.getInstance();
-          globalInfo.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
-          const result = await globalInfo.write();
+          const stateAggregator = await StateAggregator.getInstance();
+          stateAggregator.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
+          const result = await stateAggregator.aliases.write();
           this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, result);
         }
         if (this.flags.setdefaultusername) {
@@ -235,9 +235,9 @@ export class Create extends SfdxCommand {
       if (err?.message.includes('The org cannot be found')) {
         // there was most likely an issue with DNS when auth'ing to the new sandbox, but it was created.
         if (this.flags.setalias && this.sandboxAuth) {
-          const globalInfo = await GlobalInfo.getInstance();
-          globalInfo.aliases.set(this.flags.setalias, this.sandboxAuth.authUserName);
-          const result = await globalInfo.write();
+          const stateAggregator = await StateAggregator.getInstance();
+          stateAggregator.aliases.set(this.flags.setalias, this.sandboxAuth.authUserName);
+          const result = await stateAggregator.aliases.write();
           this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, result);
         }
         if (this.flags.setdefaultusername && this.sandboxAuth) {
@@ -262,9 +262,9 @@ export class Create extends SfdxCommand {
   }
 
   private async setAliasAndDefaultUsername(username: string): Promise<void> {
-    const globalInfo = await GlobalInfo.getInstance();
+    const stateAggregator = await StateAggregator.getInstance();
     if (this.flags.setalias) {
-      globalInfo.aliases.update(this.flags.setalias, username);
+      stateAggregator.aliases.set(this.flags.setalias, username);
       this.logger.debug('Set Alias: %s result: %s', this.flags.setalias);
     }
     if (this.flags.setdefaultusername) {
@@ -274,7 +274,7 @@ export class Create extends SfdxCommand {
       } catch {
         config = await Config.create({ isGlobal: true });
       }
-      const value = globalInfo.aliases.get(username) || username;
+      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);
diff --git a/src/commands/force/org/clone.ts b/src/commands/force/org/clone.ts
@@ -15,7 +15,7 @@ import {
   Messages,
   OrgTypes,
   SfdxPropertyKeys,
-  GlobalInfo,
+  StateAggregator,
   SandboxEvents,
   SandboxRequest,
   StatusEvent,
@@ -89,9 +89,9 @@ export class OrgCloneCommand extends SfdxCommand {
 
         if (results?.sandboxRes?.authUserName) {
           if (this.flags.setalias) {
-            const globalInfo = await GlobalInfo.getInstance();
-            globalInfo.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
-            const result = globalInfo.aliases.getAll();
+            const stateAggregator = await StateAggregator.getInstance();
+            stateAggregator.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
+            const result = stateAggregator.aliases.getAll();
             this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, result);
           }
           if (this.flags.setdefaultusername) {
diff --git a/src/commands/force/org/status.ts b/src/commands/force/org/status.ts
@@ -11,7 +11,7 @@ import {
   Config,
   Lifecycle,
   Messages,
-  GlobalInfo,
+  StateAggregator,
   SandboxEvents,
   SfdxPropertyKeys,
   StatusEvent,
@@ -72,8 +72,8 @@ export class OrgStatusCommand extends SfdxCommand {
       });
       if (results.sandboxRes?.authUserName) {
         if (this.flags.setalias) {
-          const info = await GlobalInfo.getInstance();
-          info.aliases.update(this.flags.setalias, results.sandboxRes.authUserName);
+          const stateAggregator = await StateAggregator.getInstance();
+          stateAggregator.aliases.set(this.flags.setalias, results.sandboxRes.authUserName);
           this.logger.debug('Set Alias: %s result: %s', this.flags.setalias, results.sandboxRes.authUserName);
         }
         if (this.flags.setdefaultusername) {
diff --git a/src/shared/utils.ts b/src/shared/utils.ts
@@ -5,12 +5,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ChildProcess } from 'child_process';
-import { GlobalInfo } from '@salesforce/core';
+import { StateAggregator } from '@salesforce/core';
 import * as open from 'open';
 
 export const getAliasByUsername = async (username: string): Promise<string> => {
-  const globalInfo = await GlobalInfo.getInstance();
-  const keys = globalInfo.aliases.getAll(username);
+  const stateAggregator = await StateAggregator.getInstance();
+  const keys = stateAggregator.aliases.getAll(username);
   // use the most recently added alias for that username
   return keys?.length ? keys[keys.length - 1] : undefined;
 };
diff --git a/test/commands/force/org/clone.test.ts b/test/commands/force/org/clone.test.ts
@@ -4,7 +4,14 @@
  * 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 { Org, Lifecycle, GlobalInfo, SandboxEvents, SfdxConfigAggregator, SfdxPropertyKeys } from '@salesforce/core';
+import {
+  Org,
+  Lifecycle,
+  StateAggregator,
+  SandboxEvents,
+  SfdxConfigAggregator,
+  SfdxPropertyKeys,
+} from '@salesforce/core';
 import { fromStub, stubInterface, stubMethod } from '@salesforce/ts-sinon';
 import * as sinon from 'sinon';
 import { expect } from '@salesforce/command/lib/test';
@@ -124,7 +131,7 @@ describe('org:clone', () => {
       on: onStub,
     });
     aliasSetStub = sinon.spy();
-    stubMethod(sandbox, GlobalInfo, 'getInstance').returns({
+    stubMethod(sandbox, StateAggregator, 'getInstance').returns({
       aliases: {
         set: aliasSetStub,
         getAll: () => ({
diff --git a/test/commands/force/org/sandboxCreate.test.ts b/test/commands/force/org/sandboxCreate.test.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import {
-  GlobalInfo,
+  StateAggregator,
   Config,
   Lifecycle,
   Messages,
@@ -271,11 +271,11 @@ describe('org:create', () => {
       stubMethod(sandbox, Org.prototype, 'createSandbox');
 
       aliasSetStub = sinon.spy();
-      stubMethod(sandbox, GlobalInfo, 'getInstance').returns({
+      stubMethod(sandbox, StateAggregator, 'getInstance').returns({
         aliases: {
           set: aliasSetStub,
+          write: sinon.stub(),
         },
-        write: sinon.stub(),
       });
       const configStub = stubMethod(sandbox, Config.prototype, 'set');
       await command.runIt();
diff --git a/test/commands/force/org/scratchOrgCreate.test.ts b/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, GlobalInfo, SfError, Messages, Org, SfProject } from '@salesforce/core';
+import { Config, StateAggregator, 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';
@@ -46,7 +46,6 @@ describe('org:create', () => {
   let promptStub: sinon.SinonStub;
   let aliasGetStub: sinon.SinonStub;
   let aliasSetStub: sinon.SinonSpy;
-  let aliasUpdateStub: sinon.SinonSpy;
   let cmd: TestCreate;
 
   class TestCreate extends Create {
@@ -204,12 +203,10 @@ describe('org:create', () => {
       });
       aliasGetStub = sinon.stub().returns('');
       aliasSetStub = sinon.spy();
-      aliasUpdateStub = sinon.spy();
-      stubMethod(sandbox, GlobalInfo, 'getInstance').returns({
+      stubMethod(sandbox, StateAggregator, 'getInstance').returns({
         aliases: {
           get: aliasGetStub,
           set: aliasSetStub,
-          update: aliasUpdateStub,
         },
       });
       const configStub = stubMethod(sandbox, Config.prototype, 'set');
@@ -229,7 +226,7 @@ describe('org:create', () => {
         retry: 0,
         orgConfig: {},
       });
-      expect(aliasUpdateStub.firstCall.args).to.deep.equal(['scratchOrgAlias', 'newScratchUsername']);
+      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']);
     });
@@ -256,11 +253,11 @@ describe('org:create', () => {
       });
 
       aliasGetStub = sinon.stub().returns('scratchOrgAlias');
-      aliasUpdateStub = sinon.spy();
-      stubMethod(sandbox, GlobalInfo, 'getInstance').returns({
+      aliasSetStub = sinon.spy();
+      stubMethod(sandbox, StateAggregator, 'getInstance').returns({
         aliases: {
           get: aliasGetStub,
-          update: aliasUpdateStub,
+          set: aliasSetStub,
         },
       });
 
@@ -281,7 +278,7 @@ describe('org:create', () => {
         retry: 0,
         orgConfig: {},
       });
-      expect(aliasUpdateStub.firstCall.args).to.deep.equal(['scratchOrgAlias', 'newScratchUsername']);
+      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']);
     });
diff --git a/test/commands/force/org/status.test.ts b/test/commands/force/org/status.test.ts
@@ -9,7 +9,7 @@ import {
   Org,
   SfdxPropertyKeys,
   SfdxConfigAggregator,
-  GlobalInfo,
+  StateAggregator,
   ConfigAggregator,
   Lifecycle,
   SandboxEvents,
@@ -60,7 +60,7 @@ describe('org:status', () => {
   let configSetStub: sinon.SinonStub;
   let configWriteStub: sinon.SinonStub;
   let onStub: sinon.SinonStub;
-  let updateValueStub: sinon.SinonStub;
+  let aliasSetStub: sinon.SinonStub;
   let configAggregatorStub;
 
   class TestOrgStatusCommand extends OrgStatusCommand {
@@ -104,10 +104,10 @@ describe('org:status', () => {
     uxTableStub = stubMethod(sandbox, UX.prototype, 'table');
     stubMethod(sandbox, UX.prototype, 'log');
     stubMethod(sandbox, UX.prototype, 'styledHeader');
-    updateValueStub = sinon.stub();
-    stubMethod(sandbox, GlobalInfo, 'getInstance').returns({
+    aliasSetStub = sinon.stub();
+    stubMethod(sandbox, StateAggregator, 'getInstance').returns({
       aliases: {
-        update: updateValueStub,
+        set: aliasSetStub,
       },
     });
     return cmd.runIt();
@@ -116,7 +116,7 @@ describe('org:status', () => {
   it('will return sandbox process object', async () => {
     const res = await runStatusCommand(['--sandboxname', sanboxname]);
     expect(uxTableStub.firstCall.args[0].length).to.equal(12);
-    expect(updateValueStub.callCount).to.be.equal(0);
+    expect(aliasSetStub.callCount).to.be.equal(0);
     expect(configSetStub.callCount).to.be.equal(0);
     expect(configWriteStub.callCount).to.be.equal(0);
     expect(onStub.callCount).to.be.equal(2);
@@ -131,7 +131,7 @@ describe('org:status', () => {
       sandboxalias,
       '--setdefaultusername',
     ]);
-    expect(updateValueStub.firstCall.args).to.deep.equal([sandboxalias, authUserName]);
+    expect(aliasSetStub.firstCall.args).to.deep.equal([sandboxalias, authUserName]);
     expect(onStub.secondCall.firstArg).to.be.equal(SandboxEvents.EVENT_RESULT);
     expect(onStub.callCount).to.be.equal(2);
     expect(res).to.deep.equal(sandboxProcessObj);
diff --git a/test/shared/utils.test.ts b/test/shared/utils.test.ts
@@ -6,7 +6,7 @@
  */
 import { expect } from '@salesforce/command/lib/test';
 import * as sinon from 'sinon';
-import { GlobalInfo } from '@salesforce/core';
+import { StateAggregator } from '@salesforce/core';
 import { stubMethod } from '@salesforce/ts-sinon';
 import { getAliasByUsername } from '../../src/shared/utils';
 
@@ -17,7 +17,7 @@ describe('getAliasByUsername', () => {
     getAllStub.withArgs('username1').returns(['alias1']);
     getAllStub.withArgs('username2').returns(['alias2', 'alias2b']);
 
-    stubMethod(sandbox, GlobalInfo, 'getInstance').resolves({
+    stubMethod(sandbox, StateAggregator, 'getInstance').resolves({
       aliases: {
         getAll: getAllStub,
       },
diff --git a/yarn.lock b/yarn.lock
@@ -1051,13 +1051,13 @@
     mv "~2"
     safe-json-stringify "~1"
 
-"@salesforce/cli-plugins-testkit@^1.5.3":
-  version "1.5.35"
-  resolved "https://registry.yarnpkg.com/@salesforce/cli-plugins-testkit/-/cli-plugins-testkit-1.5.35.tgz#dd4ab930f67b0334269fe3b2846c51af9c911fae"
-  integrity sha512-vjYvl+5v/HOBpnTaF8dxoqXgFlxdGXmt+ZD39QQ0lECj/4HJD8qS//4PQ5vEWs5RqxrW99SvDzF0K+GavMpAaQ==
+"@salesforce/cli-plugins-testkit@^2.2.0":
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/cli-plugins-testkit/-/cli-plugins-testkit-2.2.0.tgz#ead6cf3652a595b8b1915be939dc82e6b2a02be9"
+  integrity sha512-dKPAiElzOirELP2aGHQdkENxKDrEjypJfQUHvbPCKBX1rjDah0utrKSEAbNkTIGzaZrV+TxZhcy/AghtD69EGQ==
   dependencies:
-    "@salesforce/core" "^2.24.0"
-    "@salesforce/kit" "^1.5.13"
+    "@salesforce/core" "^3.20.1"
+    "@salesforce/kit" "^1.5.42"
     "@salesforce/ts-types" "^1.5.17"
     archiver "^5.2.0"
     debug "^4.3.1"
@@ -1081,19 +1081,19 @@
     chalk "^2.4.2"
     cli-ux "^4.9.3"
 
-"@salesforce/command@^5.1.3":
-  version "5.1.3"
-  resolved "https://registry.yarnpkg.com/@salesforce/command/-/command-5.1.3.tgz#a55e9b8e746a5a68322f59a637f920470da6b51f"
-  integrity sha512-spVCcHh/SYM9L5oI52z+VSEOsAXgDxj6GTlEvkm+KPctsIUhtxS1xKzjeeVCuUmRmvfq5LgwtjcgTSIqkeoL9w==
+"@salesforce/command@^5.2.0":
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/command/-/command-5.2.0.tgz#908b2fe38a6147b04d0a2316e459a3775889e4b1"
+  integrity sha512-HDr3oZTMkCeytL+MWL9+FxodDDhUzc+TyZKf4v+dF0VKevA8NFr2Hw6GyXJzLq/p8BKETHTe6cnq5KeiNIOsPg==
   dependencies:
     "@oclif/core" "^1.7.0"
     "@oclif/plugin-help" "^5.1.11"
-    "@salesforce/core" "^3.19.0"
+    "@salesforce/core" "^3.20.1"
     "@salesforce/kit" "^1.5.34"
     "@salesforce/ts-types" "^1.5.20"
     chalk "^2.4.2"
 
-"@salesforce/core@^2.24.0", "@salesforce/core@^2.35.0", "@salesforce/core@^2.36.4":
+"@salesforce/core@^2.35.0", "@salesforce/core@^2.36.4":
   version "2.37.1"
   resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-2.37.1.tgz#bfb6634e068278c7761d694a15e09a680b407137"
   integrity sha512-Jyppt6fc8uEBQgfD2uIvZlUVSTSkhgU4i+N0B4mQJ+0yeAu5foiGJnn7u6/GPkpLSgof8IZKC6f4crsi/9xyLA==
@@ -1117,10 +1117,10 @@
     semver "^7.3.5"
     ts-retry-promise "^0.6.0"
 
-"@salesforce/core@^3.19.0":
-  version "3.19.0"
-  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-3.19.0.tgz#e238b07190623dc4e1ca1888c1185f5bfa2d383e"
-  integrity sha512-64bz7cvfEkJz1JCMlf3W1CaWShoaINzfkrT6BQxtb5AdjZm5rs8Lmg3q6hie4hhWo3VVSvPOdnWEPpMJCdJ4/w==
+"@salesforce/core@^3.20.1":
+  version "3.20.1"
+  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-3.20.1.tgz#2f293a84eb793ce549ee42045877b82b9cf5e8d0"
+  integrity sha512-lOy+qJ9YxwUmvKG9eAvnWJn1yOHvd4G/3vuvUTXugj9G8JTqUyPwKFmWgIS2FSEBWkRIhDQnEIXbgrM6/ytC4A==
   dependencies:
     "@salesforce/bunyan" "^2.0.0"
     "@salesforce/kit" "^1.5.41"
@@ -1187,7 +1187,7 @@
     typedoc-plugin-missing-exports "0.22.6"
     typescript "^4.1.3"
 
-"@salesforce/kit@^1.5.13", "@salesforce/kit@^1.5.17":
+"@salesforce/kit@^1.5.17", "@salesforce/kit@^1.5.42":
   version "1.5.42"
   resolved "https://registry.yarnpkg.com/@salesforce/kit/-/kit-1.5.42.tgz#2c9f5fe9908723a70b65181526c5199e6bb943c5"
   integrity sha512-40QiPR+bg3iOC2lqCKwVO0iPw29lHCS5KzUZFiTOeu8HDu5SCgDhGc1d1Bj8KK/ZYDrAcNTZ8ObrlQFnme3fdQ==
