clean-up: remove ToolkitClientBuilder (#2748)

## Problem
`ToolkitClientBuilder` doesn't do much and makes testing harder than it needs to be. If we want factory functions, just add a static method to the client class instead. This is simpler and easier to find.

## Solution
Remove it and add a simple utility function for stubbing classes (`stubber.ts`).

Author: JadenSimon

package-lock.json

@@ -3209,7 +3209,7 @@
         "mocha-junit-reporter": "^2.0.0",
         "mocha-multi-reporters": "^1.5.1",
         "nyc": "^15.1.0",
-        "prettier": "^2.6.2",
+        "prettier": "^2.7.1",
         "prettier-plugin-sh": "^0.8.1",
         "pretty-quick": "^3.1.0",
         "readline-sync": "^1.4.9",

package.json

@@ -4,7 +4,6 @@
  */
 
 import { Window } from '../../shared/vscode/window'
-import { Env } from '../../shared/vscode/env'
 import { copyToClipboard } from '../../shared/utilities/messages'
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
@@ -14,12 +13,11 @@ import * as vscode from 'vscode'
 import { ProgressLocation } from 'vscode'
 
 import { Stage } from 'aws-sdk/clients/apigateway'
-import { ApiGatewayClient } from '../../shared/clients/apiGatewayClient'
+import { DefaultApiGatewayClient } from '../../shared/clients/apiGatewayClient'
 import { RegionProvider } from '../../shared/regions/regionProvider'
 import { DEFAULT_DNS_SUFFIX } from '../../shared/regions/regionUtilities'
 import { getLogger } from '../../shared/logger'
 import { recordApigatewayCopyUrl } from '../../shared/telemetry/telemetry'
-import globals from '../../shared/extensionGlobals'
 
 interface StageInvokeUrlQuickPick extends vscode.QuickPickItem {
     // override declaration so this can't be undefined
@@ -29,12 +27,11 @@ interface StageInvokeUrlQuickPick extends vscode.QuickPickItem {
 export async function copyUrlCommand(
     node: RestApiNode,
     regionProvider: RegionProvider,
-    window = Window.vscode(),
-    env = Env.vscode()
+    window = Window.vscode()
 ): Promise<void> {
     const region = node.regionCode
     const dnsSuffix = regionProvider.getDnsSuffixForRegion(region) || DEFAULT_DNS_SUFFIX
-    const client: ApiGatewayClient = globals.toolkitClientBuilder.createApiGatewayClient(region)
+    const client = new DefaultApiGatewayClient(region)
 
     let stages: Stage[]
     try {

src/apigateway/commands/copyUrl.ts

@@ -11,19 +11,22 @@ import * as vscode from 'vscode'
 import { AWSTreeNodeBase } from '../../shared/treeview/nodes/awsTreeNodeBase'
 import { PlaceholderNode } from '../../shared/treeview/nodes/placeholderNode'
 import { makeChildrenNodes } from '../../shared/treeview/utils'
-import { ApiGatewayClient } from '../../shared/clients/apiGatewayClient'
+import { DefaultApiGatewayClient } from '../../shared/clients/apiGatewayClient'
 import { RestApi } from 'aws-sdk/clients/apigateway'
 import { toArrayAsync, toMap, updateInPlace } from '../../shared/utilities/collectionUtils'
 import { RestApiNode } from './apiNodes'
-import globals from '../../shared/extensionGlobals'
 
 /**
  * An AWS Explorer node representing the API Gateway (v1) service.
  */
 export class ApiGatewayNode extends AWSTreeNodeBase {
     private readonly apiNodes: Map<string, RestApiNode>
 
-    public constructor(private readonly partitionId: string, public readonly regionCode: string) {
+    public constructor(
+        private readonly partitionId: string,
+        public readonly regionCode: string,
+        private readonly client = new DefaultApiGatewayClient(regionCode)
+    ) {
         super('API Gateway', vscode.TreeItemCollapsibleState.Collapsed)
         this.apiNodes = new Map<string, RestApiNode>()
     }
@@ -45,9 +48,8 @@ export class ApiGatewayNode extends AWSTreeNodeBase {
     }
 
     public async updateChildren(): Promise<void> {
-        const client: ApiGatewayClient = globals.toolkitClientBuilder.createApiGatewayClient(this.regionCode)
         const apis: Map<string, RestApi> = toMap(
-            await toArrayAsync(client.listApis()),
+            await toArrayAsync(this.client.listApis()),
             configuration => `${configuration.name} (${configuration.id})`
         )
 

src/apigateway/explorer/apiGatewayNodes.ts

@@ -11,9 +11,9 @@ import { toArrayAsync } from '../../shared/utilities/collectionUtils'
 import { Resource } from 'aws-sdk/clients/apigateway'
 import { localize } from '../../shared/utilities/vsCodeUtils'
 import { recordApigatewayInvokeRemote, Result } from '../../shared/telemetry/telemetry'
-import globals from '../../shared/extensionGlobals'
 import { VueWebview } from '../../webviews/main'
 import { ExtContext } from '../../shared/extensions'
+import { DefaultApiGatewayClient } from '../../shared/clients/apiGatewayClient'
 
 interface InvokeApiMessage {
     region: string
@@ -47,7 +47,8 @@ export class RemoteRestInvokeWebview extends VueWebview {
 
     public constructor(
         private readonly data: InvokeRemoteRestApiInitialData,
-        private readonly channel: vscode.OutputChannel
+        private readonly channel: vscode.OutputChannel,
+        private readonly client = new DefaultApiGatewayClient(data.Region)
     ) {
         super()
     }
@@ -62,7 +63,6 @@ export class RemoteRestInvokeWebview extends VueWebview {
 
     public async invokeApi(message: InvokeApiMessage): Promise<string> {
         let result: Result = 'Succeeded'
-        const client = globals.toolkitClientBuilder.createApiGatewayClient(message.region)
 
         this.logger.info('Invoking API Gateway resource:')
         this.logger.info(String(message.body))
@@ -73,7 +73,7 @@ export class RemoteRestInvokeWebview extends VueWebview {
         const path = message.selectedApiResource.path
         const pathWithQueryString = path && message.queryString ? `${path}?${message.queryString}` : undefined
         try {
-            const response = await client.testInvokeMethod(
+            const response = await this.client.testInvokeMethod(
                 message.api,
                 message.selectedApiResource.id!,
                 message.selectedMethod,
@@ -113,7 +113,7 @@ export async function invokeRemoteRestApi(
     const logger: Logger = getLogger()
 
     try {
-        const client = globals.toolkitClientBuilder.createApiGatewayClient(params.apiNode.regionCode)
+        const client = new DefaultApiGatewayClient(params.apiNode.regionCode)
         logger.info(`Loading API Resources for API ${params.apiNode.name} (id: ${params.apiNode.id})`)
         const resources = (await toArrayAsync(client.getResourcesForApi(params.apiNode.id)))
             .sort((a, b) => a.path!.localeCompare(b.path!))

src/apigateway/vue/invokeRemoteRestApi.ts

@@ -9,15 +9,17 @@ import { EcrRepositoryNode } from '../../ecr/explorer/ecrRepositoryNode'
 import { EcrTagNode } from '../../ecr/explorer/ecrTagNode'
 
 import { CreateAppRunnerServiceWizard } from '../wizards/apprunnerCreateServiceWizard'
-import globals from '../../shared/extensionGlobals'
+import { DefaultAppRunnerClient } from '../../shared/clients/apprunnerClient'
 
-export async function createFromEcr(node: EcrTagNode | EcrRepositoryNode): Promise<void> {
+export async function createFromEcr(
+    node: EcrTagNode | EcrRepositoryNode,
+    client = new DefaultAppRunnerClient(node.regionCode)
+): Promise<void> {
     let telemetryResult: telemetry.Result = 'Failed'
 
     try {
         const ecrNode = (node as any).tag === undefined ? (node as EcrRepositoryNode) : (node as EcrTagNode).parent
-        const client = globals.toolkitClientBuilder.createAppRunnerClient(ecrNode.regionCode)
-        const wizard = new CreateAppRunnerServiceWizard(ecrNode.regionCode, {
+        const wizard = new CreateAppRunnerServiceWizard(node.regionCode, {
             SourceConfiguration: {
                 ImageRepository: {
                     ImageIdentifier: `${ecrNode.repository.repositoryUri}:${(node as any).tag ?? 'latest'}`,

src/apprunner/commands/createServiceFromEcr.ts

@@ -7,7 +7,6 @@ import * as AsyncLock from 'async-lock'
 import { AppRunnerClient } from '../../shared/clients/apprunnerClient'
 import { AppRunner } from 'aws-sdk'
 import { AppRunnerNode } from './apprunnerNode'
-import { CloudWatchLogsClient } from '../../shared/clients/cloudWatchLogsClient'
 
 import { toArrayAsync, toMap } from '../../shared/utilities/collectionUtils'
 import { CloudWatchLogsBase } from '../../cloudWatchLogs/explorer/cloudWatchLogsNode'
@@ -17,6 +16,7 @@ import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
 import * as nls from 'vscode-nls'
 import { getLogger } from '../../shared/logger'
 import { getIcon } from '../../shared/icons'
+import { DefaultCloudWatchLogsClient } from '../../shared/clients/cloudWatchLogsClient'
 const localize = nls.loadMessageBundle()
 
 const CONTEXT_BASE = 'awsAppRunnerServiceNode'
@@ -36,18 +36,17 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
     public readonly name: string
     public readonly arn: string
     private readonly lock: AsyncLock = new AsyncLock()
+    protected readonly placeholderMessage = localize('AWS.explorerNode.apprunner.nologs', '[No App Runner logs found]')
 
     constructor(
         public readonly parent: AppRunnerNode,
         private readonly client: AppRunnerClient,
         private _info: AppRunner.Service,
-        private currentOperation: AppRunner.OperationSummary & { Type?: ServiceOperation } = {}
+        private currentOperation: AppRunner.OperationSummary & { Type?: ServiceOperation } = {},
+        cloudwatchClient = new DefaultCloudWatchLogsClient(client.regionCode)
     ) {
-        super(
-            'App Runner Service',
-            parent.regionCode,
-            localize('AWS.explorerNode.apprunner.nologs', '[No App Runner logs found]')
-        )
+        super('App Runner Service', parent.regionCode, cloudwatchClient)
+
         this.iconPath = getIcon('aws-apprunner-service')
         this.id = `AppRunnerService-${_info.ServiceArn}`
         this.name = _info.ServiceName
@@ -64,10 +63,10 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
         return `https://${this._info.ServiceUrl}`
     }
 
-    protected async getLogGroups(client: CloudWatchLogsClient): Promise<Map<string, CloudWatchLogs.LogGroup>> {
+    protected async getLogGroups(): Promise<Map<string, CloudWatchLogs.LogGroup>> {
         return toMap(
             await toArrayAsync(
-                client.describeLogGroups({
+                this.cloudwatchClient.describeLogGroups({
                     logGroupNamePrefix: `/aws/apprunner/${this._info.ServiceName}/${this._info.ServiceId}`,
                 })
             ),

src/apprunner/explorer/apprunnerServiceNode.ts

@@ -16,7 +16,9 @@ import { BasicExitPrompterProvider } from '../../shared/ui/common/exitPrompter'
 import { GitExtension } from '../../shared/extensions/git'
 import { makeDeploymentButton } from './deploymentButton'
 import { apprunnerCreateServiceDocsUrl } from '../../shared/constants'
-import globals from '../../shared/extensionGlobals'
+import { DefaultIamClient } from '../../shared/clients/iamClient'
+import { DefaultEcrClient } from '../../shared/clients/ecrClient'
+import { DefaultAppRunnerClient } from '../../shared/clients/apprunnerClient'
 
 const localize = nls.loadMessageBundle()
 
@@ -98,21 +100,27 @@ export class CreateAppRunnerServiceWizard extends Wizard<AppRunner.CreateService
     public constructor(
         region: string,
         initState: WizardState<AppRunner.CreateServiceRequest> = {},
-        implicitState: WizardState<AppRunner.CreateServiceRequest> = {}
+        implicitState: WizardState<AppRunner.CreateServiceRequest> = {},
+        clients = {
+            iam: new DefaultIamClient(region),
+            ecr: new DefaultEcrClient(region),
+            apprunner: new DefaultAppRunnerClient(region),
+        }
     ) {
         super({
             initState,
             implicitState,
             exitPrompterProvider: new BasicExitPrompterProvider(),
         })
 
-        const ecrClient = globals.toolkitClientBuilder.createEcrClient(region)
-        const iamClient = globals.toolkitClientBuilder.createIamClient(region)
-        const apprunnerClient = globals.toolkitClientBuilder.createAppRunnerClient(region)
         const autoDeployButton = makeDeploymentButton()
         const gitExtension = GitExtension.instance
-        const codeRepositoryWizard = new AppRunnerCodeRepositoryWizard(apprunnerClient, gitExtension, autoDeployButton)
-        const imageRepositoryWizard = new AppRunnerImageRepositoryWizard(ecrClient, iamClient, autoDeployButton)
+        const codeRepositoryWizard = new AppRunnerCodeRepositoryWizard(
+            clients.apprunner,
+            gitExtension,
+            autoDeployButton
+        )
+        const imageRepositoryWizard = new AppRunnerImageRepositoryWizard(clients.ecr, clients.iam, autoDeployButton)
 
         const form = this.form
 

src/apprunner/wizards/apprunnerCreateServiceWizard.ts

@@ -23,7 +23,12 @@ import { SsmDocumentNode } from '../ssmDocument/explorer/ssmDocumentNode'
 import { ResourcesNode } from '../dynamicResources/explorer/nodes/resourcesNode'
 import { AppRunnerNode } from '../apprunner/explorer/apprunnerNode'
 import { LoadMoreNode } from '../shared/treeview/nodes/loadMoreNode'
-import globals from '../shared/extensionGlobals'
+import { DefaultAppRunnerClient } from '../shared/clients/apprunnerClient'
+import { DefaultEcrClient } from '../shared/clients/ecrClient'
+import { DefaultEcsClient } from '../shared/clients/ecsClient'
+import { DefaultIotClient } from '../shared/clients/iotClient'
+import { DefaultS3Client } from '../shared/clients/s3Client'
+import { DefaultSchemaClient } from '../shared/clients/schemaClient'
 
 /**
  * An AWS Explorer node representing a region.
@@ -55,38 +60,33 @@ export class RegionNode extends AWSTreeNodeBase {
             { serviceId: 'apigateway', createFn: () => new ApiGatewayNode(partitionId, this.regionCode) },
             {
                 serviceId: 'apprunner',
-                createFn: () =>
-                    new AppRunnerNode(
-                        this.regionCode,
-                        globals.toolkitClientBuilder.createAppRunnerClient(this.regionCode)
-                    ),
+                createFn: () => new AppRunnerNode(this.regionCode, new DefaultAppRunnerClient(this.regionCode)),
             },
             { serviceId: 'cloudformation', createFn: () => new CloudFormationNode(this.regionCode) },
             { serviceId: 'logs', createFn: () => new CloudWatchLogsNode(this.regionCode) },
             {
                 serviceId: 'ecr',
-                createFn: () => new EcrNode(globals.toolkitClientBuilder.createEcrClient(this.regionCode)),
+                createFn: () => new EcrNode(new DefaultEcrClient(this.regionCode)),
             },
             {
                 serviceId: 'ecs',
-                createFn: () => new EcsNode(globals.toolkitClientBuilder.createEcsClient(this.regionCode)),
+                createFn: () => new EcsNode(new DefaultEcsClient(this.regionCode)),
             },
             {
                 serviceId: 'iot',
-                createFn: () => new IotNode(globals.toolkitClientBuilder.createIotClient(this.regionCode)),
+                createFn: () => new IotNode(new DefaultIotClient(this.regionCode)),
             },
             { serviceId: 'lambda', createFn: () => new LambdaNode(this.regionCode) },
             {
                 serviceId: 's3',
-                createFn: () => new S3Node(globals.toolkitClientBuilder.createS3Client(this.regionCode)),
+                createFn: () => new S3Node(new DefaultS3Client(this.regionCode)),
             },
             ...(isCloud9()
                 ? []
                 : [
                       {
                           serviceId: 'schemas',
-                          createFn: () =>
-                              new SchemasNode(globals.toolkitClientBuilder.createSchemaClient(this.regionCode)),
+                          createFn: () => new SchemasNode(new DefaultSchemaClient(this.regionCode)),
                       },
                   ]),
             { serviceId: 'states', createFn: () => new StepFunctionsNode(this.regionCode) },

src/awsexplorer/regionNode.ts

@@ -13,13 +13,12 @@ import { MultiStepWizard, WIZARD_RETRY, WIZARD_TERMINATE, WizardStep } from '../
 import { LogGroupNode } from '../explorer/logGroupNode'
 import { CloudWatchLogs } from 'aws-sdk'
 
-import { CloudWatchLogsClient } from '../../shared/clients/cloudWatchLogsClient'
+import { DefaultCloudWatchLogsClient } from '../../shared/clients/cloudWatchLogsClient'
 import * as telemetry from '../../shared/telemetry/telemetry'
 import { LOCALIZED_DATE_FORMAT } from '../../shared/constants'
 import { getPaginatedAwsCallIter, IteratorTransformer } from '../../shared/utilities/collectionUtils'
 import { LogStreamRegistry } from '../registry/logStreamRegistry'
 import { convertLogGroupInfoToUri } from '../cloudWatchLogsUtils'
-import globals from '../../shared/extensionGlobals'
 
 export interface SelectLogStreamResponse {
     region: string
@@ -58,7 +57,7 @@ export class DefaultSelectLogStreamWizardContext implements SelectLogStreamWizar
     public async pickLogStream(): Promise<string | undefined> {
         let telemetryResult: telemetry.Result = 'Succeeded'
 
-        const client: CloudWatchLogsClient = globals.toolkitClientBuilder.createCloudWatchLogsClient(this.regionCode)
+        const client = new DefaultCloudWatchLogsClient(this.regionCode)
         const request: CloudWatchLogs.DescribeLogStreamsRequest = {
             logGroupName: this.logGroupName,
             orderBy: 'LastEventTime',