ec2: add explorer node w/ dropdown for instances. (#3622)

Problem:
Feature currently only accessible from the command palette, and this therefore not discoverable.

Solution:
As a first step, add a node to the explorer that lists the ec2 instances associated with the account. On hover, we show the instance Id, but show the name in the explorer.

Author: Hweinstock

src/awsexplorer/regionNode.ts

@@ -26,6 +26,9 @@ import { DefaultS3Client } from '../shared/clients/s3Client'
 import { DefaultSchemaClient } from '../shared/clients/schemaClient'
 import { getEcsRootNode } from '../ecs/model'
 import { compareTreeItems, TreeShim } from '../shared/treeview/utils'
+import { Ec2ParentNode } from '../ec2/explorer/ec2ParentNode'
+import { DevSettings } from '../shared/settings'
+import { Ec2Client } from '../shared/clients/ec2Client'
 
 const serviceCandidates = [
     {
@@ -44,6 +47,12 @@ const serviceCandidates = [
         serviceId: 'logs',
         createFn: (regionCode: string) => new CloudWatchLogsNode(regionCode),
     },
+    {
+        serviceId: 'ec2',
+        when: () => DevSettings.instance.isDevMode(),
+        createFn: (regionCode: string, partitionId: string) =>
+            new Ec2ParentNode(regionCode, partitionId, new Ec2Client(regionCode)),
+    },
     {
         serviceId: 'ecr',
         createFn: (regionCode: string) => new EcrNode(new DefaultEcrClient(regionCode)),
@@ -106,9 +115,12 @@ export class RegionNode extends AWSTreeNodeBase {
         //  This interface exists so we can add additional nodes to the array (otherwise Typescript types the array to what's already in the array at creation)
         const partitionId = this.regionProvider.getPartitionId(this.regionCode) ?? defaultPartition
         const childNodes: AWSTreeNodeBase[] = []
-        for (const { serviceId, createFn } of serviceCandidates) {
-            if (this.regionProvider.isServiceInRegion(serviceId, this.regionCode)) {
-                const node = createFn(this.regionCode, partitionId)
+        for (const service of serviceCandidates) {
+            if (service.when !== undefined && !service.when()) {
+                continue
+            }
+            if (this.regionProvider.isServiceInRegion(service.serviceId, this.regionCode)) {
+                const node = service.createFn(this.regionCode, partitionId)
                 if (node !== undefined) {
                     childNodes.push(node)
                 }

src/ec2/explorer/ec2InstanceNode.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { getNameOfInstance } from '../../shared/clients/ec2Client'
+import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
+import { AWSTreeNodeBase } from '../../shared/treeview/nodes/awsTreeNodeBase'
+import { Ec2Instance } from '../../shared/clients/ec2Client'
+import { build } from '@aws-sdk/util-arn-parser'
+import globals from '../../shared/extensionGlobals'
+
+export class Ec2InstanceNode extends AWSTreeNodeBase implements AWSResourceNode {
+    public constructor(
+        public override readonly regionCode: string,
+        private readonly partitionId: string,
+        private instance: Ec2Instance,
+        public override readonly contextValue: string
+    ) {
+        super('')
+        this.update(instance)
+    }
+
+    public update(newInstance: Ec2Instance) {
+        this.setInstance(newInstance)
+        this.label = this.name
+        this.tooltip = this.InstanceId
+    }
+
+    public setInstance(newInstance: Ec2Instance) {
+        this.instance = newInstance
+    }
+
+    public get name(): string {
+        return getNameOfInstance(this.instance) ?? 'Unnamed instance'
+    }
+
+    public get InstanceId(): string {
+        return this.instance.InstanceId!
+    }
+
+    public get arn(): string {
+        return build({
+            partition: this.partitionId,
+            service: 'ec2',
+            region: this.regionCode,
+            accountId: globals.awsContext.getCredentialAccountId()!,
+            resource: 'instance',
+        })
+    }
+}

src/ec2/explorer/ec2ParentNode.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import * as vscode from 'vscode'
+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 { getNameOfInstance } from '../../shared/clients/ec2Client'
+import { updateInPlace } from '../../shared/utilities/collectionUtils'
+
+export const contextValueEc2 = 'awsEc2Node'
+
+export class Ec2ParentNode extends AWSTreeNodeBase {
+    protected readonly placeHolderMessage = '[No EC2 Instances Found]'
+    protected readonly ec2InstanceNodes: Map<string, Ec2InstanceNode>
+
+    public constructor(
+        public override readonly regionCode: string,
+        private readonly partitionId: string,
+        protected readonly ec2Client: Ec2Client
+    ) {
+        super('EC2', vscode.TreeItemCollapsibleState.Collapsed)
+        this.ec2InstanceNodes = new Map<string, Ec2InstanceNode>()
+    }
+
+    public override async getChildren(): Promise<AWSTreeNodeBase[]> {
+        return await makeChildrenNodes({
+            getChildNodes: async () => {
+                await this.updateChildren()
+
+                return [...this.ec2InstanceNodes.values()]
+            },
+            getNoChildrenPlaceholderNode: async () => new PlaceholderNode(this, this.placeHolderMessage),
+            sort: (nodeA, nodeB) => nodeA.name.localeCompare(nodeB.name),
+        })
+    }
+
+    public async updateChildren(): Promise<void> {
+        const ec2Instances = await (await this.ec2Client.getInstances()).toMap(instance => getNameOfInstance(instance))
+
+        updateInPlace(
+            this.ec2InstanceNodes,
+            ec2Instances.keys(),
+            key => this.ec2InstanceNodes.get(key)!.update(ec2Instances.get(key)!),
+            key => new Ec2InstanceNode(this.regionCode, this.partitionId, ec2Instances.get(key)!, contextValueEc2)
+        )
+    }
+}

src/ec2/model.ts

@@ -121,7 +121,7 @@ export class Ec2ConnectionManager {
         } catch (err: unknown) {
             // Default error if pre-check fails.
             this.throwConnectionError('Unable to connect to target instance. ', selection, {
-                code: 'EC2SSMAgentStatus',
+                code: 'EC2SSMConnect',
                 cause: err as Error,
             })
         }

src/test/ec2/explorer/ec2InstanceNode.test.ts

@@ -0,0 +1,54 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as assert from 'assert'
+import { Ec2InstanceNode } from '../../../ec2/explorer/ec2InstanceNode'
+import { Ec2Instance, getNameOfInstance } from '../../../shared/clients/ec2Client'
+import { contextValueEc2 } from '../../../ec2/explorer/ec2ParentNode'
+
+describe('ec2InstanceNode', function () {
+    let testNode: Ec2InstanceNode
+    let testInstance: Ec2Instance
+
+    before(function () {
+        testInstance = {
+            InstanceId: 'testId',
+            Tags: [
+                {
+                    Key: 'Name',
+                    Value: 'testName',
+                },
+            ],
+        }
+
+        testNode = new Ec2InstanceNode('testRegion', 'testPartition', testInstance, contextValueEc2)
+    })
+
+    it('instantiates without issue', async function () {
+        assert.ok(testNode)
+    })
+
+    it('initializes the region code', async function () {
+        assert.strictEqual(testNode.regionCode, 'testRegion')
+    })
+
+    it('initializes the label', async function () {
+        assert.strictEqual(testNode.label, getNameOfInstance(testInstance))
+    })
+
+    it('initializes the functionName', async function () {
+        assert.strictEqual(testNode.name, getNameOfInstance(testInstance))
+    })
+
+    it('initializes the tooltip', async function () {
+        assert.strictEqual(testNode.tooltip, testInstance.InstanceId)
+    })
+
+    it('has no children', async function () {
+        const childNodes = await testNode.getChildren()
+        assert.ok(childNodes)
+        assert.strictEqual(childNodes.length, 0, 'Expected node to have no children')
+    })
+})

src/test/ec2/explorer/ec2ParentNode.test.ts

@@ -0,0 +1,82 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as assert from 'assert'
+import { Ec2ParentNode, contextValueEc2 } from '../../../ec2/explorer/ec2ParentNode'
+import { stub } from '../../utilities/stubber'
+import { Ec2Client } from '../../../shared/clients/ec2Client'
+import { intoCollection } from '../../../shared/utilities/collectionUtils'
+import {
+    assertNodeListOnlyHasErrorNode,
+    assertNodeListOnlyHasPlaceholderNode,
+} from '../../utilities/explorerNodeAssertions'
+import { Ec2InstanceNode } from '../../../ec2/explorer/ec2InstanceNode'
+
+describe('ec2ParentNode', function () {
+    let testNode: Ec2ParentNode
+    let instanceNames: string[]
+    const testRegion = 'testRegion'
+    const testPartition = 'testPartition'
+
+    function createClient() {
+        const client = stub(Ec2Client, { regionCode: testRegion })
+        client.getInstances.callsFake(async () =>
+            intoCollection(
+                instanceNames.map(name => ({ InstanceId: name + name, Tags: [{ Key: 'Name', Value: name }] }))
+            )
+        )
+
+        return client
+    }
+
+    beforeEach(function () {
+        instanceNames = ['firstOne', 'secondOne']
+        testNode = new Ec2ParentNode(testRegion, testPartition, createClient())
+    })
+
+    it('returns placeholder node if no children are present', async function () {
+        instanceNames = []
+
+        const childNodes = await testNode.getChildren()
+
+        assertNodeListOnlyHasPlaceholderNode(childNodes)
+    })
+
+    it('has instance child nodes', async function () {
+        const childNodes = await testNode.getChildren()
+
+        assert.strictEqual(childNodes.length, instanceNames.length, 'Unexpected child count')
+
+        childNodes.forEach(node =>
+            assert.ok(node instanceof Ec2InstanceNode, 'Expected child node to be Ec2InstanceNode')
+        )
+    })
+
+    it('has child nodes with ec2 contextValuue', async function () {
+        const childNodes = await testNode.getChildren()
+
+        childNodes.forEach(node =>
+            assert.strictEqual(node.contextValue, contextValueEc2, 'expected the node to have a ec2 contextValue')
+        )
+    })
+
+    it('sorts child nodes', async function () {
+        const sortedText = ['aa', 'ab', 'bb', 'bc', 'cc', 'cd']
+        instanceNames = ['ab', 'bb', 'bc', 'aa', 'cc', 'cd']
+
+        const childNodes = await testNode.getChildren()
+
+        const actualChildOrder = childNodes.map(node => node.label)
+        assert.deepStrictEqual(actualChildOrder, sortedText, 'Unexpected child sort order')
+    })
+
+    it('has an error node for a child if an error happens during loading', async function () {
+        const client = createClient()
+        client.getInstances.throws(new Error())
+
+        const node = new Ec2ParentNode(testRegion, testPartition, client)
+        assertNodeListOnlyHasErrorNode(await node.getChildren())
+    })
+})