API Gateway nodes include their IDs (#1471)

Prevents duplicate nodes. Renders in a way familiar to console users with ID in parenthesis trailing the API name

Author: bryceitoc9

.changes/next-release/Feature-8729574b-6dd2-4ab4-88bb-a5f13b710e0b.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "List API Gateway names with their ID (so Toolkit can list APIs with identical names)"
+}

src/apigateway/explorer/apiGatewayNodes.ts

@@ -46,15 +46,15 @@ export class ApiGatewayNode extends AWSTreeNodeBase {
                     this,
                     localize('AWS.explorerNode.apigateway.noApis', '[No API Gateway REST APIs found]')
                 ),
-            sort: (nodeA: RestApiNode, nodeB: RestApiNode) => nodeA.name.localeCompare(nodeB.name),
+            sort: (nodeA: RestApiNode, nodeB: RestApiNode) => nodeA.label!.localeCompare(nodeB.label!),
         })
     }
 
     public async updateChildren(): Promise<void> {
         const client: ApiGatewayClient = ext.toolkitClientBuilder.createApiGatewayClient(this.regionCode)
         const apis: Map<string, RestApi> = toMap(
             await toArrayAsync(client.listApis()),
-            configuration => configuration.name
+            configuration => `${configuration.name} (${configuration.id})`
         )
 
         updateInPlace(

src/apigateway/explorer/apiNodes.ts

@@ -21,7 +21,7 @@ export class RestApiNode extends AWSTreeNodeBase implements AWSResourceNode {
 
     public update(api: RestApi): void {
         this.api = api
-        this.label = this.api.name || ''
+        this.label = `${this.api.name} (${this.api.id})` || ''
         this.tooltip = this.api.description
     }
 

src/test/apigateway/explorer/apiGatewayNodes.test.ts

@@ -18,19 +18,34 @@ import { RestApiNode } from '../../../apigateway/explorer/apiNodes'
 
 const FAKE_PARTITION_ID = 'aws'
 const FAKE_REGION_CODE = 'someregioncode'
-const UNSORTED_TEXT = ['zebra', 'Antelope', 'aardvark', 'elephant']
-const SORTED_TEXT = ['aardvark', 'Antelope', 'elephant', 'zebra']
+const UNSORTED_TEXT = [
+    { name: 'zebra', id: "it's zee not zed" },
+    { name: 'zebra', id: "it's actually zed" },
+    { name: 'Antelope', id: 'anti-antelope' },
+    { name: 'aardvark', id: 'a-a-r-d-vark' },
+    { name: 'elephant', id: 'trunk capacity' },
+]
+const SORTED_TEXT = [
+    'aardvark (a-a-r-d-vark)',
+    'Antelope (anti-antelope)',
+    'elephant (trunk capacity)',
+    "zebra (it's actually zed)",
+    "zebra (it's zee not zed)",
+]
 
 describe('ApiGatewayNode', () => {
     let sandbox: sinon.SinonSandbox
     let testNode: ApiGatewayNode
 
-    let apiNames: string[]
+    let apiNames: { name: string; id: string }[]
 
     beforeEach(() => {
         sandbox = sinon.createSandbox()
 
-        apiNames = ['api1', 'api2']
+        apiNames = [
+            { name: 'api1', id: '11111' },
+            { name: 'api2', id: '22222' },
+        ]
 
         initializeClientBuilders()
 
@@ -79,9 +94,10 @@ describe('ApiGatewayNode', () => {
         const apiGatewayClient = {
             listApis: sandbox.stub().callsFake(() => {
                 return asyncGenerator<RestApi>(
-                    apiNames.map<RestApi>(name => {
+                    apiNames.map<RestApi>(({ name, id }) => {
                         return {
-                            name: name,
+                            name,
+                            id,
                         }
                     })
                 )