Skip to content

Commit f94f46d

Browse files
committed
rename classes to avoid vague manager word
1 parent bcbb72d commit f94f46d

File tree

8 files changed

+35
-35
lines changed

8 files changed

+35
-35
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ import {
1616
stopInstance,
1717
linkToLaunchInstance,
1818
} from './commands'
19-
import { Ec2ConnectionManagerMap } from './connectionManagerMap'
19+
import { Ec2ConnecterMap } from './connectionManagerMap'
2020

21-
const connectionManagers = new Ec2ConnectionManagerMap()
21+
const connectionManagers = new Ec2ConnecterMap()
2222

2323
export async function activate(ctx: ExtContext): Promise<void> {
2424
ctx.extensionContext.subscriptions.push(

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ import { showRegionPrompter } from '../../auth/utils'
1111
import { openUrl } from '../../shared/utilities/vsCodeUtils'
1212
import { Ec2Prompter, Ec2Selection, instanceFilter } from './prompter'
1313
import { Ec2InstanceNode } from './explorer/ec2InstanceNode'
14-
import { Ec2ConnectionManagerMap } from './connectionManagerMap'
14+
import { Ec2ConnecterMap } from './connectionManagerMap'
1515

16-
export async function openTerminal(connectionManagers: Ec2ConnectionManagerMap, node?: Ec2Node) {
16+
export async function openTerminal(connectionManagers: Ec2ConnecterMap, node?: Ec2Node) {
1717
const selection = await getSelection(node)
1818
const connectionManager = connectionManagers.getOrInit(selection.region)
1919
await connectionManager.attemptToOpenEc2Terminal(selection)
2020
}
2121

22-
export async function openRemoteConnection(connectionManagers: Ec2ConnectionManagerMap, node?: Ec2Node) {
22+
export async function openRemoteConnection(connectionManagers: Ec2ConnecterMap, node?: Ec2Node) {
2323
const selection = await getSelection(node)
2424
const connectionManager = connectionManagers.getOrInit(selection.region)
2525
await connectionManager.tryOpenRemoteConnection(selection)

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44
*/
55

66
import { getLogger } from '../../shared'
7-
import { Ec2ConnectionManager } from './model'
7+
import { Ec2Connecter } from './model'
88

9-
export class Ec2ConnectionManagerMap extends Map<string, Ec2ConnectionManager> {
9+
export class Ec2ConnecterMap extends Map<string, Ec2Connecter> {
1010
private static warnSize: number = 25
1111

1212
public getOrInit(regionCode: string) {
1313
return this.has(regionCode) ? this.get(regionCode)! : this.initiateManager(regionCode)
1414
}
1515

16-
private initiateManager(regionCode: string): Ec2ConnectionManager {
17-
if (this.size >= Ec2ConnectionManagerMap.warnSize) {
16+
private initiateManager(regionCode: string): Ec2Connecter {
17+
if (this.size >= Ec2ConnecterMap.warnSize) {
1818
getLogger().warn(
19-
`Connection manager exceeded threshold of ${Ec2ConnectionManagerMap.warnSize} with ${this.size} active connections`
19+
`Connection manager exceeded threshold of ${Ec2ConnecterMap.warnSize} with ${this.size} active connections`
2020
)
2121
}
22-
const newConnectionManager = new Ec2ConnectionManager(regionCode)
22+
const newConnectionManager = new Ec2Connecter(regionCode)
2323
this.set(regionCode, newConnectionManager)
2424
return newConnectionManager
2525
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { showMessageWithCancel } from '../../shared/utilities/messages'
2929
import { SshConfig } from '../../shared/sshConfig'
3030
import { SshKeyPair } from './sshKeyPair'
3131
import globals from '../../shared/extensionGlobals'
32-
import { Ec2RemoteSessionManager } from './remoteSessionManager'
32+
import { Ec2SessionTracker } from './remoteSessionManager'
3333
import { getEc2SsmEnv } from './utils'
3434

3535
export type Ec2ConnectErrorCode = 'EC2SSMStatus' | 'EC2SSMPermission' | 'EC2SSMConnect' | 'EC2SSMAgentStatus'
@@ -40,11 +40,11 @@ export interface Ec2RemoteEnv extends VscodeRemoteConnection {
4040
ssmSession: SSM.StartSessionResponse
4141
}
4242

43-
export class Ec2ConnectionManager implements vscode.Disposable {
43+
export class Ec2Connecter implements vscode.Disposable {
4444
protected ssmClient: SsmClient
4545
protected ec2Client: Ec2Client
4646
protected iamClient: DefaultIamClient
47-
protected sessionManager: Ec2RemoteSessionManager
47+
protected sessionManager: Ec2SessionTracker
4848

4949
private policyDocumentationUri = vscode.Uri.parse(
5050
'https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started-instance-profile.html'
@@ -58,7 +58,7 @@ export class Ec2ConnectionManager implements vscode.Disposable {
5858
this.ssmClient = this.createSsmSdkClient()
5959
this.ec2Client = this.createEc2SdkClient()
6060
this.iamClient = this.createIamSdkClient()
61-
this.sessionManager = new Ec2RemoteSessionManager(regionCode, this.ssmClient)
61+
this.sessionManager = new Ec2SessionTracker(regionCode, this.ssmClient)
6262
}
6363

6464
protected createSsmSdkClient(): SsmClient {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { EC2, SSM } from 'aws-sdk'
77
import { SsmClient } from '../../shared/clients/ssmClient'
88
import { Disposable } from 'vscode'
99

10-
export class Ec2RemoteSessionManager extends Map<EC2.InstanceId, SSM.SessionId> implements Disposable {
10+
export class Ec2SessionTracker extends Map<EC2.InstanceId, SSM.SessionId> implements Disposable {
1111
public constructor(
1212
readonly regionCode: string,
1313
protected ssmClient: SsmClient

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55

66
import assert from 'assert'
77
import { Ec2Selection } from '../../../awsService/ec2/prompter'
8-
import { Ec2ConnectionManagerMap } from '../../../awsService/ec2/connectionManagerMap'
8+
import { Ec2ConnecterMap } from '../../../awsService/ec2/connectionManagerMap'
99

1010
describe('getConnectionManager', async function () {
11-
let connectionManagers: Ec2ConnectionManagerMap
11+
let connectionManagers: Ec2ConnecterMap
1212

1313
beforeEach(function () {
14-
connectionManagers = new Ec2ConnectionManagerMap()
14+
connectionManagers = new Ec2ConnecterMap()
1515
})
1616

1717
it('only creates new connection managers once for each region ', async function () {

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import assert from 'assert'
77
import * as sinon from 'sinon'
8-
import { Ec2ConnectionManager } from '../../../awsService/ec2/model'
8+
import { Ec2Connecter } from '../../../awsService/ec2/model'
99
import { SsmClient } from '../../../shared/clients/ssmClient'
1010
import { Ec2Client } from '../../../shared/clients/ec2Client'
1111
import { Ec2Selection } from '../../../awsService/ec2/prompter'
@@ -15,10 +15,10 @@ import { SshKeyPair } from '../../../awsService/ec2/sshKeyPair'
1515
import { DefaultIamClient } from '../../../shared/clients/iamClient'
1616

1717
describe('Ec2ConnectClient', function () {
18-
let client: Ec2ConnectionManager
18+
let client: Ec2Connecter
1919

2020
before(function () {
21-
client = new Ec2ConnectionManager('test-region')
21+
client = new Ec2Connecter('test-region')
2222
})
2323

2424
describe('getAttachedIamRole', async function () {
@@ -82,7 +82,7 @@ describe('Ec2ConnectClient', function () {
8282
})
8383

8484
it('throws EC2SSMStatus error if instance is not running', async function () {
85-
sinon.stub(Ec2ConnectionManager.prototype, 'isInstanceRunning').resolves(false)
85+
sinon.stub(Ec2Connecter.prototype, 'isInstanceRunning').resolves(false)
8686

8787
try {
8888
await client.checkForStartSessionError(instanceSelection)
@@ -93,8 +93,8 @@ describe('Ec2ConnectClient', function () {
9393
})
9494

9595
it('throws EC2SSMPermission error if instance is running but has no role', async function () {
96-
sinon.stub(Ec2ConnectionManager.prototype, 'isInstanceRunning').resolves(true)
97-
sinon.stub(Ec2ConnectionManager.prototype, 'getAttachedIamRole').resolves(undefined)
96+
sinon.stub(Ec2Connecter.prototype, 'isInstanceRunning').resolves(true)
97+
sinon.stub(Ec2Connecter.prototype, 'getAttachedIamRole').resolves(undefined)
9898

9999
try {
100100
await client.checkForStartSessionError(instanceSelection)
@@ -105,9 +105,9 @@ describe('Ec2ConnectClient', function () {
105105
})
106106

107107
it('throws EC2SSMAgent error if instance is running and has IAM Role, but agent is not running', async function () {
108-
sinon.stub(Ec2ConnectionManager.prototype, 'isInstanceRunning').resolves(true)
109-
sinon.stub(Ec2ConnectionManager.prototype, 'getAttachedIamRole').resolves({ Arn: 'testRole' } as IAM.Role)
110-
sinon.stub(Ec2ConnectionManager.prototype, 'hasProperPermissions').resolves(true)
108+
sinon.stub(Ec2Connecter.prototype, 'isInstanceRunning').resolves(true)
109+
sinon.stub(Ec2Connecter.prototype, 'getAttachedIamRole').resolves({ Arn: 'testRole' } as IAM.Role)
110+
sinon.stub(Ec2Connecter.prototype, 'hasProperPermissions').resolves(true)
111111
sinon.stub(SsmClient.prototype, 'getInstanceAgentPingStatus').resolves('offline')
112112

113113
try {
@@ -119,9 +119,9 @@ describe('Ec2ConnectClient', function () {
119119
})
120120

121121
it('does not throw an error if all checks pass', async function () {
122-
sinon.stub(Ec2ConnectionManager.prototype, 'isInstanceRunning').resolves(true)
123-
sinon.stub(Ec2ConnectionManager.prototype, 'getAttachedIamRole').resolves({ Arn: 'testRole' } as IAM.Role)
124-
sinon.stub(Ec2ConnectionManager.prototype, 'hasProperPermissions').resolves(true)
122+
sinon.stub(Ec2Connecter.prototype, 'isInstanceRunning').resolves(true)
123+
sinon.stub(Ec2Connecter.prototype, 'getAttachedIamRole').resolves({ Arn: 'testRole' } as IAM.Role)
124+
sinon.stub(Ec2Connecter.prototype, 'hasProperPermissions').resolves(true)
125125
sinon.stub(SsmClient.prototype, 'getInstanceAgentPingStatus').resolves('Online')
126126

127127
assert.doesNotThrow(async () => await client.checkForStartSessionError(instanceSelection))

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
import assert from 'assert'
77
import * as sinon from 'sinon'
8-
import { Ec2RemoteSessionManager } from '../../../awsService/ec2/remoteSessionManager'
8+
import { Ec2SessionTracker } from '../../../awsService/ec2/remoteSessionManager'
99
import { SsmClient } from '../../../shared/clients/ssmClient'
1010

1111
describe('Ec2RemoteSessionManager', async function () {
1212
it('maintains connections to instances', async function () {
13-
const envManager = new Ec2RemoteSessionManager('test-region', new SsmClient('test-region'))
13+
const envManager = new Ec2SessionTracker('test-region', new SsmClient('test-region'))
1414
await envManager.addSession('test-instance', 'test-env')
1515
await envManager.addSession('test-instance2', 'test-env2')
1616
await envManager.addSession('test-instance3', 'test-env3')
@@ -22,7 +22,7 @@ describe('Ec2RemoteSessionManager', async function () {
2222
})
2323

2424
it('only allows for single connection with any given instance', async function () {
25-
const envManager = new Ec2RemoteSessionManager('test-region', new SsmClient('test-region'))
25+
const envManager = new Ec2SessionTracker('test-region', new SsmClient('test-region'))
2626
const terminateStub = sinon.stub(SsmClient.prototype, 'terminateSessionFromId')
2727

2828
await envManager.addSession('test-instance', 'test-env')
@@ -37,7 +37,7 @@ describe('Ec2RemoteSessionManager', async function () {
3737
})
3838

3939
it('closes all active connections', async function () {
40-
const envManager = new Ec2RemoteSessionManager('test-region', new SsmClient('test-region'))
40+
const envManager = new Ec2SessionTracker('test-region', new SsmClient('test-region'))
4141
const terminateStub = sinon.stub(SsmClient.prototype, 'terminateSessionFromId')
4242

4343
await envManager.addSession('test-instance', 'test-env')

0 commit comments

Comments
 (0)