refactor: rename wrappers to clients

Author: Hweinstock

packages/core/src/awsService/ec2/model.ts

@@ -8,7 +8,7 @@ import { Ec2Selection } from './prompter'
 import { getOrInstallCli } from '../../shared/utilities/cliUtils'
 import { isCloud9 } from '../../shared/extensionUtilities'
 import { ToolkitError } from '../../shared/errors'
-import { SSMWrapper } from '../../shared/clients/ssm'
+import { SsmClient } from '../../shared/clients/ssm'
 import { Ec2Client } from '../../shared/clients/ec2Client'
 import {
     VscodeRemoteConnection,
@@ -51,7 +51,7 @@ interface RemoteUser {
 }
 
 export class Ec2Connecter implements vscode.Disposable {
-    protected ssm: SSMWrapper
+    protected ssm: SsmClient
     protected ec2Client: Ec2Client
     protected iamClient: DefaultIamClient
     protected sessionManager: Ec2SessionTracker
@@ -71,8 +71,8 @@ export class Ec2Connecter implements vscode.Disposable {
         this.sessionManager = new Ec2SessionTracker(regionCode, this.ssm)
     }
 
-    protected createSsmSdkClient(): SSMWrapper {
-        return new SSMWrapper(this.regionCode)
+    protected createSsmSdkClient(): SsmClient {
+        return new SsmClient(this.regionCode)
     }
 
     protected createEc2SdkClient(): Ec2Client {

packages/core/src/awsService/ec2/remoteSessionManager.ts

@@ -4,13 +4,13 @@
  */
 
 import { EC2 } from 'aws-sdk'
-import { SSMWrapper } from '../../shared/clients/ssm'
+import { SsmClient } from '../../shared/clients/ssm'
 import { Disposable } from 'vscode'
 
 export class Ec2SessionTracker extends Map<EC2.InstanceId, string> implements Disposable {
     public constructor(
         readonly regionCode: string,
-        protected ssm: SSMWrapper
+        protected ssm: SsmClient
     ) {
         super()
     }

packages/core/src/shared/clients/wrapper.ts renamed to packages/core/src/shared/clients/clientWrapper.ts

@@ -8,7 +8,7 @@ import { AwsClient, AwsClientConstructor, AwsCommand } from '../awsClientBuilder
 import { pageableToCollection } from '../utilities/collectionUtils'
 
 export abstract class ClientWrapper<C extends AwsClient> implements vscode.Disposable {
-    protected client: C | undefined
+    protected client?: C
 
     public constructor(
         public readonly regionCode: string,

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

@@ -21,9 +21,9 @@ import {
 } from '@aws-sdk/client-ssm'
 import { WaiterState } from '@smithy/util-waiter'
 import { ToolkitError } from '../errors'
-import { ClientWrapper } from './wrapper'
+import { ClientWrapper } from './clientWrapper'
 
-export class SSMWrapper extends ClientWrapper<SSMClient> {
+export class SsmClient extends ClientWrapper<SSMClient> {
     public constructor(public override readonly regionCode: string) {
         super(regionCode, SSMClient)
     }

packages/core/src/test/awsService/ec2/model.test.ts

@@ -6,7 +6,7 @@
 import assert from 'assert'
 import * as sinon from 'sinon'
 import { Ec2Connecter, getRemoveLinesCommand } from '../../../awsService/ec2/model'
-import { SSMWrapper } from '../../../shared/clients/ssm'
+import { SsmClient } from '../../../shared/clients/ssm'
 import { Ec2Client } from '../../../shared/clients/ec2Client'
 import { Ec2Selection } from '../../../awsService/ec2/prompter'
 import { ToolkitError } from '../../../shared/errors'
@@ -115,7 +115,7 @@ describe('Ec2ConnectClient', function () {
             sinon.stub(Ec2Connecter.prototype, 'isInstanceRunning').resolves(true)
             sinon.stub(Ec2Connecter.prototype, 'getAttachedIamRole').resolves({ Arn: 'testRole' } as IAM.Role)
             sinon.stub(Ec2Connecter.prototype, 'hasProperPermissions').resolves(true)
-            sinon.stub(SSMWrapper.prototype, 'getInstanceAgentPingStatus').resolves('offline')
+            sinon.stub(SsmClient.prototype, 'getInstanceAgentPingStatus').resolves('offline')
 
             try {
                 await client.checkForStartSessionError(instanceSelection)
@@ -129,15 +129,15 @@ describe('Ec2ConnectClient', function () {
             sinon.stub(Ec2Connecter.prototype, 'isInstanceRunning').resolves(true)
             sinon.stub(Ec2Connecter.prototype, 'getAttachedIamRole').resolves({ Arn: 'testRole' } as IAM.Role)
             sinon.stub(Ec2Connecter.prototype, 'hasProperPermissions').resolves(true)
-            sinon.stub(SSMWrapper.prototype, 'getInstanceAgentPingStatus').resolves('Online')
+            sinon.stub(SsmClient.prototype, 'getInstanceAgentPingStatus').resolves('Online')
 
             assert.doesNotThrow(async () => await client.checkForStartSessionError(instanceSelection))
         })
     })
 
     describe('sendSshKeysToInstance', async function () {
         it('calls the sdk with the proper parameters', async function () {
-            const sendCommandStub = sinon.stub(SSMWrapper.prototype, 'sendCommandAndWait')
+            const sendCommandStub = sinon.stub(SsmClient.prototype, 'sendCommandAndWait')
 
             const testSelection = {
                 instanceId: 'test-id',
@@ -151,7 +151,7 @@ describe('Ec2ConnectClient', function () {
         })
 
         it('avoids writing the keys to any telemetry metrics', async function () {
-            sinon.stub(SSMWrapper.prototype, 'sendCommandAndWait')
+            sinon.stub(SsmClient.prototype, 'sendCommandAndWait')
 
             const testSelection = {
                 instanceId: 'test-id',
@@ -173,7 +173,7 @@ describe('Ec2ConnectClient', function () {
         let getTargetPlatformNameStub: sinon.SinonStub<[target: string], Promise<string>>
 
         before(async function () {
-            getTargetPlatformNameStub = sinon.stub(SSMWrapper.prototype, 'getTargetPlatformName')
+            getTargetPlatformNameStub = sinon.stub(SsmClient.prototype, 'getTargetPlatformName')
         })
 
         after(async function () {
@@ -205,7 +205,7 @@ describe('Ec2ConnectClient', function () {
 
     describe('tryCleanKeys', async function () {
         it('calls the sdk with the proper parameters', async function () {
-            const sendCommandStub = sinon.stub(SSMWrapper.prototype, 'sendCommandAndWait')
+            const sendCommandStub = sinon.stub(SsmClient.prototype, 'sendCommandAndWait')
 
             const testSelection = {
                 instanceId: 'test-id',
@@ -222,7 +222,7 @@ describe('Ec2ConnectClient', function () {
 
         it('logs warning when sdk call fails', async function () {
             const sendCommandStub = sinon
-                .stub(SSMWrapper.prototype, 'sendCommandAndWait')
+                .stub(SsmClient.prototype, 'sendCommandAndWait')
                 .throws(new ToolkitError('error'))
 
             const testSelection = {

packages/core/src/test/awsService/ec2/remoteSessionManager.test.ts

@@ -6,11 +6,11 @@
 import assert from 'assert'
 import * as sinon from 'sinon'
 import { Ec2SessionTracker } from '../../../awsService/ec2/remoteSessionManager'
-import { SSMWrapper } from '../../../shared/clients/ssm'
+import { SsmClient } from '../../../shared/clients/ssm'
 
 describe('Ec2RemoteSessionManager', async function () {
     it('maintains connections to instances', async function () {
-        const envManager = new Ec2SessionTracker('test-region', new SSMWrapper('test-region'))
+        const envManager = new Ec2SessionTracker('test-region', new SsmClient('test-region'))
         await envManager.addSession('test-instance', 'test-env')
         await envManager.addSession('test-instance2', 'test-env2')
         await envManager.addSession('test-instance3', 'test-env3')
@@ -22,8 +22,8 @@ describe('Ec2RemoteSessionManager', async function () {
     })
 
     it('only allows for single connection with any given instance', async function () {
-        const envManager = new Ec2SessionTracker('test-region', new SSMWrapper('test-region'))
-        const terminateStub = sinon.stub(SSMWrapper.prototype, 'terminateSessionFromId')
+        const envManager = new Ec2SessionTracker('test-region', new SsmClient('test-region'))
+        const terminateStub = sinon.stub(SsmClient.prototype, 'terminateSessionFromId')
 
         await envManager.addSession('test-instance', 'test-env')
         sinon.assert.notCalled(terminateStub)
@@ -37,8 +37,8 @@ describe('Ec2RemoteSessionManager', async function () {
     })
 
     it('closes all active connections', async function () {
-        const envManager = new Ec2SessionTracker('test-region', new SSMWrapper('test-region'))
-        const terminateStub = sinon.stub(SSMWrapper.prototype, 'terminateSessionFromId')
+        const envManager = new Ec2SessionTracker('test-region', new SsmClient('test-region'))
+        const terminateStub = sinon.stub(SsmClient.prototype, 'terminateSessionFromId')
 
         await envManager.addSession('test-instance', 'test-env')
         await envManager.addSession('test-instance2', 'test-env2')