refactor(regions): consolidate region-related functionality (#2782)

## Problem
Anything related to regions is split between AwsContext and RegionProvider (plus some utility functions).
But to do anything useful you usually needed both objects.

## Solution
Move almost all region-related things to RegionProvider. This does make RegionProvider do a little bit more than I'd like though it's at least sticking to one idea.

Author: JadenSimon

src/apigateway/commands/copyUrl.ts

@@ -14,8 +14,7 @@ import { ProgressLocation } from 'vscode'
 
 import { Stage } from 'aws-sdk/clients/apigateway'
 import { DefaultApiGatewayClient } from '../../shared/clients/apiGatewayClient'
-import { RegionProvider } from '../../shared/regions/regionProvider'
-import { DEFAULT_DNS_SUFFIX } from '../../shared/regions/regionUtilities'
+import { DEFAULT_DNS_SUFFIX, RegionProvider } from '../../shared/regions/regionProvider'
 import { getLogger } from '../../shared/logger'
 import { recordApigatewayCopyUrl } from '../../shared/telemetry/telemetry'
 

src/awsexplorer/activation.ts

@@ -8,8 +8,6 @@ import { LoginManager } from '../credentials/loginManager'
 import { submitFeedback } from '../feedback/vue/submitFeedback'
 import { deleteCloudFormation } from '../lambda/commands/deleteCloudFormation'
 import { CloudFormationStackNode } from '../lambda/explorer/cloudFormationNodes'
-import { AwsContext } from '../shared/awsContext'
-import { AwsContextTreeCollection } from '../shared/awsContextTreeCollection'
 import globals from '../shared/extensionGlobals'
 import { ExtContext } from '../shared/extensions'
 import { getLogger } from '../shared/logger'
@@ -33,7 +31,6 @@ import { createLocalExplorerView } from './localExplorer'
  */
 export async function activate(args: {
     context: ExtContext
-    awsContextTrees: AwsContextTreeCollection
     regionProvider: RegionProvider
     toolkitOutputChannel: vscode.OutputChannel
     remoteInvokeOutputChannel: vscode.OutputChannel
@@ -56,9 +53,22 @@ export async function activate(args: {
         })
     )
 
-    args.awsContextTrees.addTree(awsExplorer)
+    recordVscodeActiveRegions({ value: args.regionProvider.getExplorerRegions().length })
 
-    updateAwsExplorerWhenAwsContextCredentialsChange(awsExplorer, args.context.awsContext, globals.context)
+    args.context.extensionContext.subscriptions.push(
+        args.context.awsContext.onDidChangeContext(async credentialsChangedEvent => {
+            getLogger().verbose(`Credentials changed (${credentialsChangedEvent.profileName}), updating AWS Explorer`)
+            awsExplorer.refresh()
+
+            if (credentialsChangedEvent.profileName) {
+                await checkExplorerForDefaultRegion(
+                    credentialsChangedEvent.profileName,
+                    args.regionProvider,
+                    awsExplorer
+                )
+            }
+        })
+    )
 }
 
 async function registerAwsExplorerCommands(
@@ -125,20 +135,3 @@ async function registerAwsExplorerCommands(
     const developerTools = createLocalExplorerView()
     context.extensionContext.subscriptions.push(developerTools)
 }
-
-function updateAwsExplorerWhenAwsContextCredentialsChange(
-    awsExplorer: AwsExplorer,
-    awsContext: AwsContext,
-    extensionContext: vscode.ExtensionContext
-) {
-    extensionContext.subscriptions.push(
-        awsContext.onDidChangeContext(async credentialsChangedEvent => {
-            getLogger().verbose(`Credentials changed (${credentialsChangedEvent.profileName}), updating AWS Explorer`)
-            awsExplorer.refresh()
-
-            if (credentialsChangedEvent.profileName) {
-                await checkExplorerForDefaultRegion(credentialsChangedEvent.profileName, awsContext, awsExplorer)
-            }
-        })
-    )
-}

src/awsexplorer/awsExplorer.ts

@@ -8,7 +8,6 @@ import { AwsContext } from '../shared/awsContext'
 import { getIdeProperties } from '../shared/extensionUtilities'
 import { getLogger, Logger } from '../shared/logger'
 import { RegionProvider } from '../shared/regions/regionProvider'
-import { getRegionsForActiveCredentials } from '../shared/regions/regionUtilities'
 import { RefreshableAwsTreeProvider } from '../shared/treeview/awsTreeProvider'
 import { AWSCommandTreeNode } from '../shared/treeview/nodes/awsCommandTreeNode'
 import { AWSTreeNodeBase } from '../shared/treeview/nodes/awsTreeNodeBase'
@@ -69,7 +68,7 @@ export class AwsExplorer implements vscode.TreeDataProvider<AWSTreeNodeBase>, Re
             })
         )
         this.extContext.subscriptions.push(
-            this.regionProvider.onRegionProviderUpdated(() => {
+            this.regionProvider.onDidChange(() => {
                 this.logger.verbose('Refreshing AWS Explorer due to Region Provider updates')
                 this.refresh()
             })
@@ -82,7 +81,7 @@ export class AwsExplorer implements vscode.TreeDataProvider<AWSTreeNodeBase>, Re
 
     public async getChildren(element?: AWSTreeNodeBase): Promise<AWSTreeNodeBase[]> {
         if (element) {
-            this.awsContext.setLastTouchedRegion(element.regionCode)
+            this.regionProvider.setLastTouchedRegion(element.regionCode)
         }
 
         let childNodes: AWSTreeNodeBase[] = []
@@ -126,9 +125,8 @@ export class AwsExplorer implements vscode.TreeDataProvider<AWSTreeNodeBase>, Re
             return [this.ROOT_NODE_SIGN_IN]
         }
 
-        const partitionRegions = getRegionsForActiveCredentials(this.awsContext, this.regionProvider)
-
-        const userVisibleRegionCodes = await this.awsContext.getExplorerRegions()
+        const partitionRegions = this.regionProvider.getRegions()
+        const userVisibleRegionCodes = this.regionProvider.getExplorerRegions()
         const regionMap = toMap(partitionRegions, r => r.id)
 
         return await makeChildrenNodes({

src/awsexplorer/defaultRegion.ts

@@ -7,12 +7,12 @@ import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
 import * as vscode from 'vscode'
-import { AwsContext } from '../shared/awsContext'
 import * as localizedText from '../shared/localizedText'
 import { createQuickPick, promptUser } from '../shared/ui/picker'
 import { AwsExplorer } from './awsExplorer'
 import { getIdeProperties, isCloud9 } from '../shared/extensionUtilities'
 import { PromptSettings } from '../shared/settings'
+import { RegionProvider } from '../shared/regions/regionProvider'
 
 class RegionMissingUI {
     public static readonly add: string = localizedText.yes
@@ -25,18 +25,18 @@ class RegionMissingUI {
 
 export async function checkExplorerForDefaultRegion(
     profileName: string,
-    awsContext: AwsContext,
+    regionProvider: RegionProvider,
     awsExplorer: AwsExplorer
 ): Promise<void> {
-    const profileRegion = awsContext.getCredentialDefaultRegion()
+    const profileRegion = regionProvider.defaultRegionId
 
-    const explorerRegions = new Set(await awsContext.getExplorerRegions())
+    const explorerRegions = new Set(regionProvider.getExplorerRegions())
     if (explorerRegions.has(profileRegion)) {
         return
     }
 
     if (isCloud9()) {
-        await awsContext.addExplorerRegion(profileRegion)
+        await regionProvider.updateExplorerRegions([...explorerRegions, profileRegion])
         awsExplorer.refresh()
         return
     }
@@ -80,7 +80,7 @@ export async function checkExplorerForDefaultRegion(
     const response = r[0].label
 
     if (response === RegionMissingUI.add) {
-        await awsContext.addExplorerRegion(profileRegion)
+        await regionProvider.updateExplorerRegions([...explorerRegions, profileRegion])
         awsExplorer.refresh()
     } else if (response === RegionMissingUI.alwaysIgnore) {
         PromptSettings.instance.disablePrompt('regionAddAutomatically')

src/awsexplorer/regionNode.ts

@@ -15,10 +15,9 @@ import { IotNode } from '../iot/explorer/iotNodes'
 import { EcsNode } from '../ecs/explorer/ecsNode'
 import { isCloud9 } from '../shared/extensionUtilities'
 import { Region } from '../shared/regions/endpoints'
-import { RegionProvider } from '../shared/regions/regionProvider'
+import { DEFAULT_PARTITION, RegionProvider } from '../shared/regions/regionProvider'
 import { AWSTreeNodeBase } from '../shared/treeview/nodes/awsTreeNodeBase'
 import { StepFunctionsNode } from '../stepFunctions/explorer/stepFunctionsNodes'
-import { DEFAULT_PARTITION } from '../shared/regions/regionUtilities'
 import { SsmDocumentNode } from '../ssmDocument/explorer/ssmDocumentNode'
 import { ResourcesNode } from '../dynamicResources/explorer/nodes/resourcesNode'
 import { AppRunnerNode } from '../apprunner/explorer/apprunnerNode'

src/credentials/loginManager.ts

@@ -17,7 +17,6 @@ import {
     CredentialType,
     recordAwsRefreshCredentials,
     recordAwsValidateCredentials,
-    recordVscodeActiveRegions,
     Result,
 } from '../shared/telemetry/telemetry'
 import { CredentialsStore } from './credentialsStore'
@@ -76,7 +75,6 @@ export class LoginManager {
             if (!accountId) {
                 throw new Error('Could not determine Account Id for credentials')
             }
-            recordVscodeActiveRegions({ value: (await this.awsContext.getExplorerRegions()).length })
 
             this.awsContext.credentialsShim = createCredentialsShim(this.store, args.providerId, credentials)
             await this.awsContext.setCredentials({

src/extension.ts

@@ -16,7 +16,6 @@ import { SharedCredentialsProviderFactory } from './credentials/providers/shared
 import { activate as activateSchemas } from './eventSchemas/activation'
 import { activate as activateLambda } from './lambda/activation'
 import { DefaultAWSClientBuilder } from './shared/awsClientBuilder'
-import { AwsContextTreeCollection } from './shared/awsContextTreeCollection'
 import { activate as activateCloudFormationTemplateRegistry } from './shared/cloudformation/activation'
 import { documentationUrl, endpointsFileUrl, githubCreateIssueUrl, githubUrl } from './shared/constants'
 import { DefaultAwsContext } from './shared/awsContext'
@@ -32,7 +31,7 @@ import {
 } from './shared/extensionUtilities'
 import { getLogger, Logger } from './shared/logger/logger'
 import { activate as activateLogger } from './shared/logger/activation'
-import { DefaultRegionProvider } from './shared/regions/defaultRegionProvider'
+import { RegionProvider } from './shared/regions/regionProvider'
 import { EndpointsProvider } from './shared/regions/endpointsProvider'
 import { FileResourceFetcher } from './shared/resourcefetcher/fileResourceFetcher'
 import { HttpResourceFetcher } from './shared/resourcefetcher/httpResourceFetcher'
@@ -96,10 +95,9 @@ export async function activate(context: vscode.ExtensionContext) {
 
         const endpointsProvider = makeEndpointsProvider()
 
-        const awsContext = new DefaultAwsContext(context)
+        const awsContext = new DefaultAwsContext()
         globals.awsContext = awsContext
-        const awsContextTrees = new AwsContextTreeCollection()
-        const regionProvider = new DefaultRegionProvider(endpointsProvider)
+        const regionProvider = RegionProvider.fromEndpointsProvider(endpointsProvider)
         const credentialsStore = new CredentialsStore()
         const loginManager = new LoginManager(awsContext, credentialsStore)
 
@@ -112,7 +110,7 @@ export async function activate(context: vscode.ExtensionContext) {
 
         await initializeAwsCredentialsStatusBarItem(awsContext, context)
         globals.regionProvider = regionProvider
-        globals.awsContextCommands = new AwsContextCommands(awsContext, awsContextTrees, regionProvider, loginManager)
+        globals.awsContextCommands = new AwsContextCommands(regionProvider, loginManager)
         globals.sdkClientBuilder = new DefaultAWSClientBuilder(awsContext)
         globals.schemaService = new SchemaService(context)
         globals.resourceManager = new AwsResourceManager(context)
@@ -190,7 +188,6 @@ export async function activate(context: vscode.ExtensionContext) {
 
         await activateAwsExplorer({
             context: extContext,
-            awsContextTrees,
             regionProvider,
             toolkitOutputChannel,
             remoteInvokeOutputChannel,
@@ -301,28 +298,6 @@ function makeEndpointsProvider(): EndpointsProvider {
     const remoteManifestFetcher = new HttpResourceFetcher(endpointsFileUrl, { showUrl: true })
 
     const provider = new EndpointsProvider(localManifestFetcher, remoteManifestFetcher)
-    // Start the load without waiting. It raises events as fetchers retrieve data.
-    provider.load().catch((err: Error) => {
-        getLogger().error('Failure while loading Endpoints Manifest: %O', err)
-
-        vscode.window.showErrorMessage(
-            `${localize(
-                'AWS.error.endpoint.load.failure',
-                'The {0} Toolkit was unable to load endpoints data.',
-                getIdeProperties().company
-            )} ${
-                isCloud9()
-                    ? localize(
-                          'AWS.error.impactedFunctionalityReset.cloud9',
-                          'Toolkit functionality may be impacted until the Cloud9 browser tab is refreshed.'
-                      )
-                    : localize(
-                          'AWS.error.impactedFunctionalityReset.vscode',
-                          'Toolkit functionality may be impacted until VS Code is restarted.'
-                      )
-            }`
-        )
-    })
 
     return provider
 }

src/lambda/commands/createNewSamApp.ts

@@ -46,7 +46,6 @@ import { getIdeProperties, isCloud9 } from '../../shared/extensionUtilities'
 import { execSync } from 'child_process'
 import { writeFile } from 'fs-extra'
 import { checklogs } from '../../shared/localizedText'
-import { getRegionsForActiveCredentials } from '../../shared/regions/regionUtilities'
 import globals from '../../shared/extensionGlobals'
 
 type CreateReason = 'unknown' | 'userCancelled' | 'fileNotFound' | 'complete' | 'error'
@@ -147,9 +146,7 @@ export async function createNewSamApplication(
 
         const credentials = await awsContext.getCredentials()
         samVersion = await getSamCliVersion(samCliContext)
-        const schemaRegions = getRegionsForActiveCredentials(awsContext, regionProvider).filter(r =>
-            regionProvider.isServiceInRegion('schemas', r.id)
-        )
+        const schemaRegions = regionProvider.getRegions().filter(r => regionProvider.isServiceInRegion('schemas', r.id))
         const defaultRegion = awsContext.getCredentialDefaultRegion()
 
         const config = await new CreateNewSamAppWizard({

src/lambda/commands/deploySamApplication.ts

@@ -8,7 +8,7 @@ import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 
 import { asEnvironmentVariables } from '../../credentials/credentialsUtilities'
-import { AwsContext, NoActiveCredentialError } from '../../shared/awsContext'
+import { AwsContext } from '../../shared/awsContext'
 import globals from '../../shared/extensionGlobals'
 
 import { makeTemporaryToolkitFolder, tryRemoveFolder } from '../../shared/filesystemUtilities'
@@ -73,7 +73,7 @@ export async function deploySamApplication(
     try {
         const credentials = await awsContext.getCredentials()
         if (!credentials) {
-            throw new NoActiveCredentialError()
+            throw new Error('No AWS profile selected')
         }
 
         throwAndNotifyIfInvalid(await samCliContext.validator.detectValidSamCli())

src/lambda/wizards/samDeployWizard.ts

@@ -13,7 +13,6 @@ import * as vscode from 'vscode'
 import { samDeployDocUrl } from '../../shared/constants'
 import * as localizedText from '../../shared/localizedText'
 import { getLogger } from '../../shared/logger'
-import { getRegionsForActiveCredentials } from '../../shared/regions/regionUtilities'
 import { createHelpButton } from '../../shared/ui/buttons'
 import * as input from '../../shared/ui/input'
 import * as picker from '../../shared/ui/picker'
@@ -351,10 +350,7 @@ export class DefaultSamDeployWizardContext implements SamDeployWizardContext {
     }
 
     public async promptUserForRegion(step: number, initialRegionCode?: string): Promise<string | undefined> {
-        const partitionRegions = getRegionsForActiveCredentials(
-            this.extContext.awsContext,
-            this.extContext.regionProvider
-        )
+        const partitionRegions = this.extContext.regionProvider.getRegions()
 
         const quickPick = picker.createQuickPick<vscode.QuickPickItem>({
             options: {