rename to ec2Wrapper to avoid confusion

Hweinstock · Hweinstock · commit d806de90c74f · 2024-11-07T09:13:40.000-05:00
diff --git a/packages/core/src/awsService/ec2/commands.ts b/packages/core/src/awsService/ec2/commands.ts
@@ -4,7 +4,7 @@
  */
 import { Ec2InstanceNode } from './explorer/ec2InstanceNode'
 import { Ec2Node } from './explorer/ec2ParentNode'
-import { SafeEc2Instance, Ec2Client } from '../../shared/clients/ec2Client'
+import { SafeEc2Instance, Ec2Wrapper } from '../../shared/clients/ec2Wrapper'
 import { copyToClipboard } from '../../shared/utilities/messages'
 import { ec2LogSchema } from './ec2LogDocumentProvider'
 import { getAwsConsoleUrl } from '../../shared/awsConsole'
@@ -29,20 +29,20 @@ export async function openRemoteConnection(connectionManagers: Ec2ConnecterMap,
 export async function startInstance(node?: Ec2Node) {
     const prompterFilter = (instance: SafeEc2Instance) => instance.LastSeenStatus !== 'running'
     const selection = await getSelection(node, prompterFilter)
-    const client = new Ec2Client(selection.region)
+    const client = new Ec2Wrapper(selection.region)
     await client.startInstanceWithCancel(selection.instanceId)
 }
 
 export async function stopInstance(node?: Ec2Node) {
     const prompterFilter = (instance: SafeEc2Instance) => instance.LastSeenStatus !== 'stopped'
     const selection = await getSelection(node, prompterFilter)
-    const client = new Ec2Client(selection.region)
+    const client = new Ec2Wrapper(selection.region)
     await client.stopInstanceWithCancel(selection.instanceId)
 }
 
 export async function rebootInstance(node?: Ec2Node) {
     const selection = await getSelection(node)
-    const client = new Ec2Client(selection.region)
+    const client = new Ec2Wrapper(selection.region)
     await client.rebootInstanceWithCancel(selection.instanceId)
 }
 
diff --git a/packages/core/src/awsService/ec2/ec2LogDocumentProvider.ts b/packages/core/src/awsService/ec2/ec2LogDocumentProvider.ts
@@ -4,7 +4,7 @@
  */
 import * as vscode from 'vscode'
 import { Ec2Selection } from './prompter'
-import { Ec2Client } from '../../shared/clients/ec2Client'
+import { Ec2Wrapper } from '../../shared/clients/ec2Wrapper'
 import { ec2LogsScheme } from '../../shared/constants'
 import { UriSchema } from '../../shared/utilities/uriUtils'
 
@@ -16,7 +16,7 @@ export class Ec2LogDocumentProvider implements vscode.TextDocumentContentProvide
             throw new Error(`Invalid EC2 Logs URI: ${uri.toString()}`)
         }
         const ec2Selection = ec2LogSchema.parse(uri)
-        const ec2Client = new Ec2Client(ec2Selection.region)
+        const ec2Client = new Ec2Wrapper(ec2Selection.region)
         const consoleOutput = await ec2Client.getConsoleOutput(ec2Selection.instanceId, false)
         return consoleOutput.Output
     }
diff --git a/packages/core/src/awsService/ec2/explorer/ec2InstanceNode.ts b/packages/core/src/awsService/ec2/explorer/ec2InstanceNode.ts
@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import * as vscode from 'vscode'
-import { Ec2Client, getNameOfInstance } from '../../../shared/clients/ec2Client'
+import { Ec2Wrapper, getNameOfInstance } from '../../../shared/clients/ec2Wrapper'
 import { AWSResourceNode } from '../../../shared/treeview/nodes/awsResourceNode'
 import { AWSTreeNodeBase } from '../../../shared/treeview/nodes/awsTreeNodeBase'
-import { SafeEc2Instance } from '../../../shared/clients/ec2Client'
+import { SafeEc2Instance } from '../../../shared/clients/ec2Wrapper'
 import globals from '../../../shared/extensionGlobals'
 import { getIconCode } from '../utils'
 import { Ec2Selection } from '../prompter'
@@ -23,7 +23,7 @@ type Ec2InstanceNodeContext = 'awsEc2RunningNode' | 'awsEc2StoppedNode' | 'awsEc
 export class Ec2InstanceNode extends AWSTreeNodeBase implements AWSResourceNode {
     public constructor(
         public readonly parent: Ec2ParentNode,
-        public readonly client: Ec2Client,
+        public readonly client: Ec2Wrapper,
         public override readonly regionCode: string,
         private readonly partitionId: string,
         // XXX: this variable is marked as readonly, but the 'status' attribute is updated when polling the nodes.
diff --git a/packages/core/src/awsService/ec2/explorer/ec2ParentNode.ts b/packages/core/src/awsService/ec2/explorer/ec2ParentNode.ts
@@ -7,7 +7,7 @@ import { AWSTreeNodeBase } from '../../../shared/treeview/nodes/awsTreeNodeBase'
 import { makeChildrenNodes } from '../../../shared/treeview/utils'
 import { PlaceholderNode } from '../../../shared/treeview/nodes/placeholderNode'
 import { Ec2InstanceNode } from './ec2InstanceNode'
-import { Ec2Client } from '../../../shared/clients/ec2Client'
+import { Ec2Wrapper } from '../../../shared/clients/ec2Wrapper'
 import { updateInPlace } from '../../../shared/utilities/collectionUtils'
 import { PollingSet } from '../../../shared/utilities/pollingSet'
 
@@ -23,7 +23,7 @@ export class Ec2ParentNode extends AWSTreeNodeBase {
     public constructor(
         public override readonly regionCode: string,
         public readonly partitionId: string,
-        protected readonly ec2Client: Ec2Client
+        protected readonly ec2Client: Ec2Wrapper
     ) {
         super('EC2', vscode.TreeItemCollapsibleState.Collapsed)
         this.ec2InstanceNodes = new Map<string, Ec2InstanceNode>()
diff --git a/packages/core/src/awsService/ec2/model.ts b/packages/core/src/awsService/ec2/model.ts
@@ -10,7 +10,7 @@ import { getOrInstallCli } from '../../shared/utilities/cliUtils'
 import { isCloud9 } from '../../shared/extensionUtilities'
 import { ToolkitError } from '../../shared/errors'
 import { SsmClient } from '../../shared/clients/ssmClient'
-import { Ec2Client } from '../../shared/clients/ec2Client'
+import { Ec2Wrapper } from '../../shared/clients/ec2Wrapper'
 import {
     VscodeRemoteConnection,
     ensureDependencies,
@@ -40,7 +40,7 @@ export interface Ec2RemoteEnv extends VscodeRemoteConnection {
 
 export class Ec2Connecter implements vscode.Disposable {
     protected ssmClient: SsmClient
-    protected ec2Client: Ec2Client
+    protected ec2Client: Ec2Wrapper
     protected iamClient: DefaultIamClient
     protected sessionManager: Ec2SessionTracker
 
@@ -63,8 +63,8 @@ export class Ec2Connecter implements vscode.Disposable {
         return new SsmClient(this.regionCode)
     }
 
-    protected createEc2SdkClient(): Ec2Client {
-        return new Ec2Client(this.regionCode)
+    protected createEc2SdkClient(): Ec2Wrapper {
+        return new Ec2Wrapper(this.regionCode)
     }
 
     protected createIamSdkClient(): DefaultIamClient {
diff --git a/packages/core/src/awsService/ec2/prompter.ts b/packages/core/src/awsService/ec2/prompter.ts
@@ -5,7 +5,7 @@
 
 import { RegionSubmenu, RegionSubmenuResponse } from '../../shared/ui/common/regionSubmenu'
 import { DataQuickPickItem } from '../../shared/ui/pickerPrompter'
-import { Ec2Client, SafeEc2Instance } from '../../shared/clients/ec2Client'
+import { Ec2Wrapper, SafeEc2Instance } from '../../shared/clients/ec2Wrapper'
 import { isValidResponse } from '../../shared/wizards/wizard'
 import { CancellationError } from '../../shared/utilities/timeoutUtils'
 import { AsyncCollection } from '../../shared/utilities/asyncCollection'
@@ -54,7 +54,7 @@ export class Ec2Prompter {
     }
 
     protected async getInstancesFromRegion(regionCode: string): Promise<AsyncCollection<SafeEc2Instance>> {
-        const client = new Ec2Client(regionCode)
+        const client = new Ec2Wrapper(regionCode)
         return await client.getInstances()
     }
 
diff --git a/packages/core/src/awsService/ec2/utils.ts b/packages/core/src/awsService/ec2/utils.ts
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { SafeEc2Instance } from '../../shared/clients/ec2Client'
+import { SafeEc2Instance } from '../../shared/clients/ec2Wrapper'
 import { copyToClipboard } from '../../shared/utilities/messages'
 import { Ec2Selection } from './prompter'
 import { sshLogFileLocation } from '../../shared/sshConfig'
diff --git a/packages/core/src/awsexplorer/regionNode.ts b/packages/core/src/awsexplorer/regionNode.ts
@@ -30,7 +30,7 @@ import { getEcsRootNode } from '../awsService/ecs/model'
 import { compareTreeItems, TreeShim } from '../shared/treeview/utils'
 import { Ec2ParentNode } from '../awsService/ec2/explorer/ec2ParentNode'
 import { DevSettings } from '../shared/settings'
-import { Ec2Client } from '../shared/clients/ec2Client'
+import { Ec2Wrapper } from '../shared/clients/ec2Wrapper'
 import { isCloud9 } from '../shared/extensionUtilities'
 
 interface ServiceNode {
@@ -67,7 +67,7 @@ const serviceCandidates: ServiceNode[] = [
         serviceId: 'ec2',
         when: () => DevSettings.instance.isDevMode(),
         createFn: (regionCode: string, partitionId: string) =>
-            new Ec2ParentNode(regionCode, partitionId, new Ec2Client(regionCode)),
+            new Ec2ParentNode(regionCode, partitionId, new Ec2Wrapper(regionCode)),
     },
     {
         serviceId: 'ecr',
diff --git a/packages/core/src/shared/clients/ec2Wrapper.ts b/packages/core/src/shared/clients/ec2Wrapper.ts
@@ -49,7 +49,7 @@ interface SafeEc2GetConsoleOutputResult extends GetConsoleOutputRequest {
     InstanceId: string
 }
 
-export class Ec2Client {
+export class Ec2Wrapper {
     public constructor(public readonly regionCode: string) {}
 
     private async createSdkClient(): Promise<EC2Client> {
diff --git a/packages/core/src/test/awsService/ec2/ec2LogDocumentProvider.test.ts b/packages/core/src/test/awsService/ec2/ec2LogDocumentProvider.test.ts
@@ -8,7 +8,7 @@ import * as vscode from 'vscode'
 import * as sinon from 'sinon'
 import { Ec2LogDocumentProvider } from '../../../awsService/ec2/ec2LogDocumentProvider'
 import { ec2LogsScheme } from '../../../shared/constants'
-import { Ec2Client } from '../../../shared/clients/ec2Client'
+import { Ec2Wrapper } from '../../../shared/clients/ec2Wrapper'
 
 describe('LogDataDocumentProvider', async function () {
     let provider: Ec2LogDocumentProvider
@@ -28,7 +28,7 @@ describe('LogDataDocumentProvider', async function () {
     it('fetches content for valid ec2 log URI', async function () {
         const validUri = vscode.Uri.parse(`${ec2LogsScheme}:us-west1:instance1`)
         const expectedContent = 'log content'
-        sinon.stub(Ec2Client.prototype, 'getConsoleOutput').resolves({
+        sinon.stub(Ec2Wrapper.prototype, 'getConsoleOutput').resolves({
             InstanceId: 'instance1',
             Output: expectedContent,
         })
diff --git a/packages/core/src/test/awsService/ec2/explorer/ec2InstanceNode.test.ts b/packages/core/src/test/awsService/ec2/explorer/ec2InstanceNode.test.ts
@@ -10,7 +10,7 @@ import {
     Ec2InstanceRunningContext,
     Ec2InstanceStoppedContext,
 } from '../../../../awsService/ec2/explorer/ec2InstanceNode'
-import { Ec2Client, SafeEc2Instance, getNameOfInstance } from '../../../../shared/clients/ec2Client'
+import { Ec2Wrapper, SafeEc2Instance, getNameOfInstance } from '../../../../shared/clients/ec2Wrapper'
 import { Ec2ParentNode } from '../../../../awsService/ec2/explorer/ec2ParentNode'
 import * as sinon from 'sinon'
 import { PollingSet } from '../../../../shared/utilities/pollingSet'
@@ -36,7 +36,7 @@ describe('ec2InstanceNode', function () {
         // Don't want to be polling here, that is tested in ../ec2ParentNode.test.ts
         // disabled here for convenience (avoiding race conditions with timeout)
         sinon.stub(PollingSet.prototype, 'start')
-        const testClient = new Ec2Client('')
+        const testClient = new Ec2Wrapper('')
         const testParentNode = new Ec2ParentNode(testRegion, testPartition, testClient)
         testNode = new Ec2InstanceNode(testParentNode, testClient, 'testRegion', 'testPartition', testInstance)
     })
@@ -75,7 +75,7 @@ describe('ec2InstanceNode', function () {
     })
 
     it('intializes the client', async function () {
-        assert.ok(testNode.client instanceof Ec2Client)
+        assert.ok(testNode.client instanceof Ec2Wrapper)
     })
 
     it('sets context value based on status', async function () {
diff --git a/packages/core/src/test/awsService/ec2/explorer/ec2ParentNode.test.ts b/packages/core/src/test/awsService/ec2/explorer/ec2ParentNode.test.ts
@@ -6,7 +6,7 @@
 import assert from 'assert'
 import * as sinon from 'sinon'
 import { Ec2ParentNode } from '../../../../awsService/ec2/explorer/ec2ParentNode'
-import { Ec2Client, SafeEc2Instance } from '../../../../shared/clients/ec2Client'
+import { Ec2Wrapper, SafeEc2Instance } from '../../../../shared/clients/ec2Wrapper'
 import { intoCollection } from '../../../../shared/utilities/collectionUtils'
 import {
     assertNodeListOnlyHasErrorNode,
@@ -28,12 +28,12 @@ export const testInstance = {
     ],
     LastSeenStatus: 'running',
 } as SafeEc2Instance
-export const testClient = new Ec2Client('')
+export const testClient = new Ec2Wrapper('')
 export const testParentNode = new Ec2ParentNode('fake-region', 'testPartition', testClient)
 
 describe('ec2ParentNode', function () {
     let testNode: Ec2ParentNode
-    let client: Ec2Client
+    let client: Ec2Wrapper
     let getInstanceStub: sinon.SinonStub<[filters?: EC2.Filter[] | undefined], Promise<AsyncCollection<EC2.Instance>>>
     let clock: FakeTimers.InstalledClock
     let refreshStub: sinon.SinonStub<[], Promise<void>>
@@ -52,14 +52,14 @@ describe('ec2ParentNode', function () {
     }
 
     before(function () {
-        client = new Ec2Client(testRegion)
+        client = new Ec2Wrapper(testRegion)
         clock = installFakeClock()
         refreshStub = sinon.stub(Ec2InstanceNode.prototype, 'refreshNode')
-        statusUpdateStub = sinon.stub(Ec2Client.prototype, 'getInstanceStatus')
+        statusUpdateStub = sinon.stub(Ec2Wrapper.prototype, 'getInstanceStatus')
     })
 
     beforeEach(function () {
-        getInstanceStub = sinon.stub(Ec2Client.prototype, 'getInstances')
+        getInstanceStub = sinon.stub(Ec2Wrapper.prototype, 'getInstances')
         testNode = new Ec2ParentNode(testRegion, testPartition, client)
         refreshStub.resetHistory()
     })
diff --git a/packages/core/src/test/awsService/ec2/model.test.ts b/packages/core/src/test/awsService/ec2/model.test.ts
@@ -7,7 +7,7 @@ import assert from 'assert'
 import * as sinon from 'sinon'
 import { Ec2Connecter } from '../../../awsService/ec2/model'
 import { SsmClient } from '../../../shared/clients/ssmClient'
-import { Ec2Client } from '../../../shared/clients/ec2Client'
+import { Ec2Wrapper } from '../../../shared/clients/ec2Wrapper'
 import { Ec2Selection } from '../../../awsService/ec2/prompter'
 import { ToolkitError } from '../../../shared/errors'
 import { IAM } from 'aws-sdk'
@@ -27,7 +27,7 @@ describe('Ec2ConnectClient', function () {
     describe('getAttachedIamRole', async function () {
         it('only returns role if recieves ARN from instance profile', async function () {
             let role: IAM.Role | undefined
-            const getInstanceProfileStub = sinon.stub(Ec2Client.prototype, 'getAttachedIamInstanceProfile')
+            const getInstanceProfileStub = sinon.stub(Ec2Wrapper.prototype, 'getAttachedIamInstanceProfile')
 
             getInstanceProfileStub.resolves({ Arn: 'thisIsAnArn' })
             sinon
@@ -63,7 +63,7 @@ describe('Ec2ConnectClient', function () {
     describe('isInstanceRunning', async function () {
         it('only returns true with the instance is running', async function () {
             sinon
-                .stub(Ec2Client.prototype, 'getInstanceStatus')
+                .stub(Ec2Wrapper.prototype, 'getInstanceStatus')
                 .callsFake(async (input: string) => input.split(':')[0] as InstanceStateName)
 
             const actualFirstResult = await client.isInstanceRunning('running:instance')
diff --git a/packages/core/src/test/awsService/ec2/prompter.test.ts b/packages/core/src/test/awsService/ec2/prompter.test.ts
@@ -5,7 +5,7 @@
 import assert from 'assert'
 import * as sinon from 'sinon'
 import { Ec2Prompter, getSelection, instanceFilter } from '../../../awsService/ec2/prompter'
-import { SafeEc2Instance } from '../../../shared/clients/ec2Client'
+import { SafeEc2Instance } from '../../../shared/clients/ec2Wrapper'
 import { RegionSubmenuResponse } from '../../../shared/ui/common/regionSubmenu'
 import { Ec2Selection } from '../../../awsService/ec2/prompter'
 import { AsyncCollection } from '../../../shared/utilities/asyncCollection'
diff --git a/packages/core/src/test/awsService/ec2/utils.test.ts b/packages/core/src/test/awsService/ec2/utils.test.ts
@@ -5,7 +5,7 @@
 
 import assert from 'assert'
 import * as sinon from 'sinon'
-import { SafeEc2Instance } from '../../../shared/clients/ec2Client'
+import { SafeEc2Instance } from '../../../shared/clients/ec2Wrapper'
 import { getIconCode } from '../../../awsService/ec2/utils'
 import { DefaultAwsContext } from '../../../shared'
 
diff --git a/packages/core/src/test/shared/clients/ec2Wrapper.test.ts b/packages/core/src/test/shared/clients/ec2Wrapper.test.ts
@@ -7,9 +7,9 @@ import assert from 'assert'
 import { AsyncCollection } from '../../../shared/utilities/asyncCollection'
 import { toCollection } from '../../../shared/utilities/asyncCollection'
 import { intoCollection } from '../../../shared/utilities/collectionUtils'
-import { Ec2Client, instanceHasName } from '../../../shared/clients/ec2Client'
+import { Ec2Wrapper, instanceHasName } from '../../../shared/clients/ec2Wrapper'
 
-class MockEc2Client extends Ec2Client {
+class MockEc2Client extends Ec2Wrapper {
     public override async getInstanceStatus(instanceId: string): Promise<InstanceStateName> {
         return instanceId.split('-')[0] as InstanceStateName
     }
@@ -83,7 +83,7 @@ const incomepleteInstanceList: Instance[] = [
 ]
 
 describe('extractInstancesFromReservations', function () {
-    const client = new Ec2Client('')
+    const client = new Ec2Wrapper('')
 
     it('returns empty when given empty collection', async function () {
         const actualResult = await client
@@ -170,7 +170,7 @@ describe('updateInstancesDetail', async function () {
 })
 
 describe('getInstancesFilter', function () {
-    const client = new Ec2Client('')
+    const client = new Ec2Wrapper('')
 
     it('returns proper filter when given instanceId', function () {
         const testInstanceId1 = 'test'

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`import { RegionSubmenu, RegionSubmenuResponse } from '../../shared/ui/common/regionSubmenu'`
`7`	`7`	`import { DataQuickPickItem } from '../../shared/ui/pickerPrompter'`
`8`		`-import { Ec2Client, SafeEc2Instance } from '../../shared/clients/ec2Client'`
	`8`	`+import { Ec2Wrapper, SafeEc2Instance } from '../../shared/clients/ec2Wrapper'`
`9`	`9`	`import { isValidResponse } from '../../shared/wizards/wizard'`
`10`	`10`	`import { CancellationError } from '../../shared/utilities/timeoutUtils'`
`11`	`11`	`import { AsyncCollection } from '../../shared/utilities/asyncCollection'`
`@@ -54,7 +54,7 @@ export class Ec2Prompter {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`protected async getInstancesFromRegion(regionCode: string): Promise<AsyncCollection<SafeEc2Instance>> {`
`57`		`- const client = new Ec2Client(regionCode)`
	`57`	`+ const client = new Ec2Wrapper(regionCode)`
`58`	`58`	`return await client.getInstances()`
`59`	`59`	`}`
`60`	`60`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ interface SafeEc2GetConsoleOutputResult extends GetConsoleOutputRequest {`
`49`	`49`	`InstanceId: string`
`50`	`50`	`}`
`51`	`51`
`52`		`-export class Ec2Client {`
	`52`	`+export class Ec2Wrapper {`
`53`	`53`	`public constructor(public readonly regionCode: string) {}`
`54`	`54`
`55`	`55`	`private async createSdkClient(): Promise<EC2Client> {`