refactor(regionProvider): use globalState abstraction

Author: justinmk3

packages/core/src/shared/constants.ts

@@ -7,7 +7,6 @@ import * as vscode from 'vscode'
 
 import { isCloud9 } from './extensionUtilities'
 
-export const regionSettingKey = 'region'
 export const profileSettingKey = 'profile'
 export const productName: string = 'aws-toolkit-vscode'
 

packages/core/src/shared/regions/regionProvider.ts

@@ -11,7 +11,6 @@ const localize = nls.loadMessageBundle()
 import * as vscode from 'vscode'
 import { getLogger } from '../logger'
 import { Endpoints, loadEndpoints, Region } from './endpoints'
-import { regionSettingKey } from '../constants'
 import { AwsContext } from '../awsContext'
 import { getIdeProperties, isAmazonQ, isCloud9 } from '../extensionUtilities'
 import { ResourceFetcher } from '../resourcefetcher/resourcefetcher'
@@ -38,7 +37,6 @@ export class RegionProvider {
 
     public constructor(
         endpoints: Endpoints = { partitions: [] },
-        private readonly globalState = globals.context.globalState,
         private readonly awsContext: Pick<AwsContext, 'getCredentialDefaultRegion'> = globals.awsContext
     ) {
         this.loadFromEndpoints(endpoints)
@@ -83,11 +81,11 @@ export class RegionProvider {
     }
 
     public getExplorerRegions(): string[] {
-        return this.globalState.get<string[]>(regionSettingKey, [])
+        return globals.globalState.tryGet<string[]>('region', Object, [])
     }
 
     public async updateExplorerRegions(regions: string[]): Promise<void> {
-        return this.globalState.update(regionSettingKey, Array.from(new Set(regions)))
+        return globals.globalState.update('region', Array.from(new Set(regions)))
     }
 
     /**
@@ -114,7 +112,7 @@ export class RegionProvider {
             return this.lastTouchedRegion
         }
 
-        const lastWizardResponse = this.globalState.get<Region>('lastSelectedRegion')
+        const lastWizardResponse = globals.globalState.tryGet<Region>('lastSelectedRegion', Object)
         if (lastWizardResponse && lastWizardResponse.id) {
             return lastWizardResponse.id
         }

packages/core/src/test/awsExplorer/awsExplorer.test.ts

@@ -8,7 +8,7 @@ import * as sinon from 'sinon'
 import { AwsExplorer } from '../../awsexplorer/awsExplorer'
 import { RegionNode } from '../../awsexplorer/regionNode'
 import { RegionProvider } from '../../shared/regions/regionProvider'
-import { FakeExtensionContext, FakeMemento } from '../fakeExtensionContext'
+import { FakeExtensionContext } from '../fakeExtensionContext'
 import {
     createTestRegionProvider,
     DEFAULT_TEST_REGION_CODE,
@@ -32,7 +32,7 @@ describe('AwsExplorer', function () {
         this.skip()
 
         const awsContext = makeFakeAwsContextWithPlaceholderIds({} as any as AWS.Credentials)
-        const regionProvider = createTestRegionProvider({ awsContext, globalState: new FakeMemento() })
+        const regionProvider = createTestRegionProvider({ awsContext })
         await regionProvider.updateExplorerRegions([DEFAULT_TEST_REGION_CODE])
 
         const fakeContext = await FakeExtensionContext.create()

packages/core/src/test/fakeExtensionContext.ts

@@ -126,7 +126,7 @@ export class FakeExtensionContext implements vscode.ExtensionContext {
                 validator: new FakeSamCliValidator(minSamCliVersionForGoSupport),
             } as SamCliContext
         }
-        const regionProvider = createTestRegionProvider({ globalState: ctx.globalState, awsContext })
+        const regionProvider = createTestRegionProvider({ awsContext })
         const outputChannel = new MockOutputChannel()
         const fakeTelemetryPublisher = new FakeTelemetryPublisher()
         const telemetryService = await DefaultTelemetryService.create(

packages/core/src/test/shared/regions/regionProvider.test.ts

@@ -6,7 +6,6 @@
 import assert from 'assert'
 import { RegionProvider } from '../../../shared/regions/regionProvider'
 import { createRegionPrompter } from '../../../shared/ui/common/region'
-import { FakeMemento } from '../../fakeExtensionContext'
 import { createQuickPickPrompterTester } from '../ui/testUtils'
 import { createSsoProfile, createTestAuth } from '../../credentials/testUtil'
 import { Auth } from '../../../auth/auth'
@@ -149,7 +148,7 @@ describe('RegionProvider', async function () {
         let regionProvider: RegionProvider
 
         beforeEach(function () {
-            regionProvider = new RegionProvider(endpoints, new FakeMemento())
+            regionProvider = new RegionProvider(endpoints)
         })
 
         it('remembers saved regions', async function () {
@@ -165,6 +164,11 @@ describe('RegionProvider', async function () {
     })
 
     describe('guessDefaultRegion', function () {
+        beforeEach(async function () {
+            // guessDefaultRegion is informed by the current SSO connection.
+            await Auth.instance.logout()
+        })
+
         afterEach(() => {
             sinon.restore()
         })
@@ -199,27 +203,27 @@ describe('RegionProvider', async function () {
         })
 
         it('prioritizes the AWS explorer region if there is only one', async function () {
-            const regionProvider = new RegionProvider(endpoints, new FakeMemento())
+            const regionProvider = new RegionProvider(endpoints)
             await regionProvider.updateExplorerRegions(['us-east-2'])
             regionProvider.setLastTouchedRegion('us-west-1')
             assert.strictEqual(regionProvider.guessDefaultRegion(), 'us-east-2')
         })
 
         it('returns undefined when unable to determine last used region', function () {
-            const regionProvider = new RegionProvider(endpoints, new FakeMemento())
+            const regionProvider = new RegionProvider(endpoints)
             assert.strictEqual(regionProvider.guessDefaultRegion(), undefined)
         })
 
         it('returns undefined when no active amazon Q connection', function () {
-            const regionProvider = new RegionProvider(endpoints, new FakeMemento())
+            const regionProvider = new RegionProvider(endpoints)
             sinon.stub(extUtils, 'isAmazonQ').returns(true)
 
             assert.strictEqual(regionProvider.guessDefaultRegion(), undefined)
         })
 
         it('returns connection region with active amazon Q connection', async function () {
             const region = 'us-west-2'
-            const regionProvider = new RegionProvider(endpoints, new FakeMemento())
+            const regionProvider = new RegionProvider(endpoints)
             const auth = createTestAuth()
             await auth.useConnection(await auth.createConnection(createSsoProfile({ ssoRegion: region })))
 

packages/core/src/test/shared/regions/testUtil.ts

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Memento } from 'vscode'
 import { AwsContext } from '../../../shared/awsContext'
 import { RegionProvider } from '../../../shared/regions/regionProvider'
 
@@ -41,9 +40,6 @@ const endpoints = {
     ],
 }
 
-export function createTestRegionProvider(opts?: {
-    globalState?: Memento & { setKeysForSync(keys: readonly string[]): void }
-    awsContext?: AwsContext
-}): RegionProvider {
-    return new RegionProvider(endpoints, opts?.globalState, opts?.awsContext)
+export function createTestRegionProvider(opts?: { awsContext?: AwsContext }): RegionProvider {
+    return new RegionProvider(endpoints, opts?.awsContext)
 }