refactor: rename client

Author: Hweinstock

packages/core/src/awsService/apprunner/explorer/apprunnerServiceNode.ts

@@ -16,7 +16,7 @@ import { AWSResourceNode } from '../../../shared/treeview/nodes/awsResourceNode'
 import * as nls from 'vscode-nls'
 import { getLogger } from '../../../shared/logger/logger'
 import { getIcon } from '../../../shared/icons'
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 const localize = nls.loadMessageBundle()
 
 const contextBase = 'awsAppRunnerServiceNode'
@@ -43,7 +43,7 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
         private readonly client: AppRunnerClient,
         private _info: AppRunner.Service,
         private currentOperation: AppRunner.OperationSummary & { Type?: ServiceOperation } = {},
-        cloudwatchClient = new DefaultCloudWatchLogsClient(client.regionCode)
+        cloudwatchClient = new CloudWatchLogsClient(client.regionCode)
     ) {
         super('App Runner Service', parent.regionCode, cloudwatchClient)
 

packages/core/src/awsService/cloudWatchLogs/commands/searchLogGroup.ts

@@ -17,7 +17,7 @@ import {
 import { DataQuickPickItem } from '../../../shared/ui/pickerPrompter'
 import { isValidResponse, isWizardControl, Wizard, WIZARD_RETRY } from '../../../shared/wizards/wizard'
 import { cwlUriSchema, msgKey, recordTelemetryFilter } from '../cloudWatchLogsUtils'
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { getLogger } from '../../../shared/logger/logger'
 import { TimeFilterResponse, TimeFilterSubmenu } from '../timeFilterSubmenu'
@@ -110,7 +110,7 @@ export async function searchLogGroup(
 }
 
 async function getLogGroupsFromRegion(regionCode: string): Promise<DataQuickPickItem<string>[]> {
-    const client = new DefaultCloudWatchLogsClient(regionCode)
+    const client = new CloudWatchLogsClient(regionCode)
     const logGroups = await logGroupsToArray(client.describeLogGroups())
     const options = logGroups.map<DataQuickPickItem<string>>((logGroupString) => ({
         label: logGroupString,

packages/core/src/awsService/cloudWatchLogs/commands/viewLogStream.ts

@@ -12,7 +12,7 @@ import { MultiStepWizard, WIZARD_RETRY, WIZARD_TERMINATE, WizardStep } from '../
 import { LogGroupNode } from '../explorer/logGroupNode'
 import { CloudWatchLogs } from 'aws-sdk'
 
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { getPaginatedAwsCallIter, IteratorTransformer } from '../../../shared/utilities/collectionUtils'
 import {
     CloudWatchLogsGroupInfo,
@@ -82,7 +82,7 @@ export class DefaultSelectLogStreamWizardContext implements SelectLogStreamWizar
     ) {}
 
     public async pickLogStream(): Promise<LogSearchChoice> {
-        const client = new DefaultCloudWatchLogsClient(this.regionCode)
+        const client = new CloudWatchLogsClient(this.regionCode)
         const request: CloudWatchLogs.DescribeLogStreamsRequest = {
             logGroupName: this.logGroupName,
             orderBy: 'LastEventTime',

packages/core/src/awsService/cloudWatchLogs/explorer/cloudWatchLogsNode.ts

@@ -9,7 +9,7 @@ const localize = nls.loadMessageBundle()
 import { CloudWatchLogs } from 'aws-sdk'
 import * as vscode from 'vscode'
 
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 
 import { AWSTreeNodeBase } from '../../../shared/treeview/nodes/awsTreeNodeBase'
 import { toMap, updateInPlace, toArrayAsync } from '../../../shared/utilities/collectionUtils'
@@ -24,13 +24,13 @@ export abstract class CloudWatchLogsBase extends AWSTreeNodeBase {
     public constructor(
         label: string,
         public override readonly regionCode: string,
-        protected readonly cloudwatchClient: DefaultCloudWatchLogsClient
+        protected readonly cloudwatchClient: CloudWatchLogsClient
     ) {
         super(label, vscode.TreeItemCollapsibleState.Collapsed)
         this.logGroupNodes = new Map<string, LogGroupNode>()
     }
 
-    protected abstract getLogGroups(client: DefaultCloudWatchLogsClient): Promise<Map<string, CloudWatchLogs.LogGroup>>
+    protected abstract getLogGroups(client: CloudWatchLogsClient): Promise<Map<string, CloudWatchLogs.LogGroup>>
 
     public override async getChildren(): Promise<AWSTreeNodeBase[]> {
         return await makeChildrenNodes({
@@ -58,12 +58,12 @@ export abstract class CloudWatchLogsBase extends AWSTreeNodeBase {
 export class CloudWatchLogsNode extends CloudWatchLogsBase {
     protected readonly placeholderMessage = localize('AWS.explorerNode.cloudWatchLogs.nologs', '[No log groups found]')
 
-    public constructor(regionCode: string, client = new DefaultCloudWatchLogsClient(regionCode)) {
+    public constructor(regionCode: string, client = new CloudWatchLogsClient(regionCode)) {
         super('CloudWatch Logs', regionCode, client)
         this.contextValue = 'awsCloudWatchLogParentNode'
     }
 
-    protected async getLogGroups(client: DefaultCloudWatchLogsClient): Promise<Map<string, CloudWatchLogs.LogGroup>> {
+    protected async getLogGroups(client: CloudWatchLogsClient): Promise<Map<string, CloudWatchLogs.LogGroup>> {
         return toMap(await toArrayAsync(client.describeLogGroups()), (configuration) => configuration.logGroupName)
     }
 }

packages/core/src/awsService/cloudWatchLogs/registry/logDataRegistry.ts

@@ -6,7 +6,7 @@
 import * as vscode from 'vscode'
 import { CloudWatchLogs } from 'aws-sdk'
 import { CloudWatchLogsSettings, uriToKey, msgKey, cwlUriSchema } from '../cloudWatchLogsUtils'
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { waitTimeout } from '../../../shared/utilities/timeoutUtils'
 import { Messages } from '../../../shared/utilities/messages'
 import { pageableToCollection } from '../../../shared/utilities/collectionUtils'
@@ -212,7 +212,7 @@ export async function filterLogEventsFromUri(
     nextToken?: string,
     completeTimeout = false
 ): Promise<CloudWatchLogsResponse> {
-    const client = new DefaultCloudWatchLogsClient(logGroupInfo.regionName)
+    const client = new CloudWatchLogsClient(logGroupInfo.regionName)
 
     const cwlParameters: CloudWatchLogs.FilterLogEventsRequest = {
         logGroupName: logGroupInfo.groupName,

packages/core/src/awsService/cloudWatchLogs/wizard/liveTailLogStreamSubmenu.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { Prompter, PromptResult } from '../../../shared/ui/prompter'
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { createCommonButtons } from '../../../shared/ui/buttons'
 import { createInputBox, InputBoxPrompter } from '../../../shared/ui/inputPrompter'
 import { createQuickPick, DataQuickPickItem, QuickPickPrompter } from '../../../shared/ui/pickerPrompter'
@@ -87,7 +87,7 @@ export class LogStreamFilterSubmenu extends Prompter<LogStreamFilterResponse> {
 
     public createLogStreamSelector(): QuickPickPrompter<string> {
         const helpUri = startLiveTailLogStreamNamesHelpUrl
-        const client = new DefaultCloudWatchLogsClient(this.region)
+        const client = new CloudWatchLogsClient(this.region)
         const request: CloudWatchLogs.DescribeLogStreamsRequest = {
             logGroupIdentifier: this.logGroupArn,
             orderBy: 'LastEventTime',

packages/core/src/awsService/cloudWatchLogs/wizard/tailLogGroupWizard.ts

@@ -6,7 +6,7 @@
 import * as nls from 'vscode-nls'
 import globals from '../../../shared/extensionGlobals'
 import { ToolkitError } from '../../../shared/errors'
-import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { cwlFilterPatternHelpUrl } from '../../../shared/constants'
 import { createBackButton, createExitButton, createHelpButton } from '../../../shared/ui/buttons'
 import { RegionSubmenu, RegionSubmenuResponse } from '../../../shared/ui/common/regionSubmenu'
@@ -64,7 +64,7 @@ export function createRegionLogGroupSubmenu(): RegionSubmenu<string> {
 }
 
 async function getLogGroupQuickPickOptions(regionCode: string): Promise<DataQuickPickItem<string>[]> {
-    const client = new DefaultCloudWatchLogsClient(regionCode)
+    const client = new CloudWatchLogsClient(regionCode)
     const logGroups = client.describeLogGroups()
 
     const logGroupsOptions: DataQuickPickItem<string>[] = []

packages/core/src/shared/clients/cloudWatchLogsClient.ts

@@ -4,12 +4,14 @@
  */
 
 import { CloudWatchLogs } from 'aws-sdk'
+import * as CloudWatchLogsV3 from '@aws-sdk/client-cloudwatch-logs'
 import globals from '../extensionGlobals'
-import { ClassToInterfaceType } from '../utilities/tsUtils'
+import { ClientWrapper } from './clientWrapper'
 
-export type CloudWatchLogsClient = ClassToInterfaceType<DefaultCloudWatchLogsClient>
-export class DefaultCloudWatchLogsClient {
-    public constructor(public readonly regionCode: string) {}
+export class CloudWatchLogsClient extends ClientWrapper<CloudWatchLogsV3.CloudWatchLogsClient> {
+    public constructor(regionCode: string) {
+        super(regionCode, CloudWatchLogsV3.CloudWatchLogsClient)
+    }
 
     public async *describeLogGroups(
         request: CloudWatchLogs.DescribeLogGroupsRequest = {}

packages/core/src/test/awsService/apprunner/explorer/apprunnerServiceNode.test.ts

@@ -9,7 +9,7 @@ import { AppRunner } from 'aws-sdk'
 import { AppRunnerNode } from '../../../../awsService/apprunner/explorer/apprunnerNode'
 import { AppRunnerServiceNode } from '../../../../awsService/apprunner/explorer/apprunnerServiceNode'
 import { DefaultAppRunnerClient } from '../../../../shared/clients/apprunnerClient'
-import { DefaultCloudWatchLogsClient } from '../../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../../shared/clients/cloudWatchLogsClient'
 import { asyncGenerator } from '../../../../shared/utilities/collectionUtils'
 import { AWSTreeNodeBase } from '../../../../shared/treeview/nodes/awsTreeNodeBase'
 import { stub } from '../../../utilities/stubber'
@@ -33,7 +33,7 @@ describe('AppRunnerServiceNode', function () {
     })
 
     beforeEach(function () {
-        const cloudwatchClient = stub(DefaultCloudWatchLogsClient, { regionCode: 'us-east-1' })
+        const cloudwatchClient = stub(CloudWatchLogsClient, { regionCode: 'us-east-1' })
         cloudwatchClient.describeLogGroups.returns(asyncGenerator([{ logGroupName: 'logs' }]))
 
         mockApprunnerClient = stub(DefaultAppRunnerClient, { regionCode: 'us-east-1' })

packages/core/src/test/awsService/cloudWatchLogs/explorer/cloudWatchLogsNode.test.ts

@@ -11,7 +11,7 @@ import {
     assertNodeListOnlyHasErrorNode,
     assertNodeListOnlyHasPlaceholderNode,
 } from '../../../utilities/explorerNodeAssertions'
-import { DefaultCloudWatchLogsClient } from '../../../../shared/clients/cloudWatchLogsClient'
+import { CloudWatchLogsClient } from '../../../../shared/clients/cloudWatchLogsClient'
 import { stub } from '../../../utilities/stubber'
 
 const fakeRegionCode = 'someregioncode'
@@ -25,7 +25,7 @@ describe('CloudWatchLogsNode', function () {
     let logGroupNames: string[]
 
     function createClient() {
-        const client = stub(DefaultCloudWatchLogsClient, { regionCode: fakeRegionCode })
+        const client = stub(CloudWatchLogsClient, { regionCode: fakeRegionCode })
         client.describeLogGroups.callsFake(() => asyncGenerator(logGroupNames.map((name) => ({ logGroupName: name }))))
 
         return client