refactor: migrate some piece to sdkv3 with types

Author: Hweinstock

packages/core/src/awsService/apprunner/explorer/apprunnerNode.ts

@@ -8,10 +8,11 @@ import { AWSTreeNodeBase } from '../../../shared/treeview/nodes/awsTreeNodeBase'
 import { AppRunnerServiceNode } from './apprunnerServiceNode'
 import { PlaceholderNode } from '../../../shared/treeview/nodes/placeholderNode'
 import * as nls from 'vscode-nls'
-import { AppRunnerClient } from '../../../shared/clients/apprunner'
-import { getPaginatedAwsCallIter } from '../../../shared/utilities/collectionUtils'
+import { AppRunnerClient, AppRunnerServiceSummary } from '../../../shared/clients/apprunner'
 import { AppRunner } from 'aws-sdk'
 import { PollingSet } from '../../../shared/utilities/pollingSet'
+import { ListServicesRequest, ServiceSummary } from '@aws-sdk/client-apprunner'
+import { hasProps } from '../../../shared/utilities/tsUtils'
 
 const localize = nls.loadMessageBundle()
 
@@ -43,30 +44,13 @@ export class AppRunnerNode extends AWSTreeNodeBase {
         })
     }
 
-    private async getServiceSummaries(request: AppRunner.ListServicesRequest = {}): Promise<AppRunner.Service[]> {
-        const iterator = getPaginatedAwsCallIter({
-            awsCall: async (request) => await this.client.listServices(request),
-            nextTokenNames: {
-                request: 'NextToken',
-                response: 'NextToken',
-            },
-            request,
-        })
-
-        const services: AppRunner.Service[] = []
+    private async getServiceSummaries(request: ListServicesRequest = {}): Promise<AppRunnerServiceSummary[]> {
+        // TODO: avoid resolving all services at once.
+        return await this.client.paginateServices(request).flatten().filter(isService).promise()
 
-        while (true) {
-            const next = await iterator.next()
-
-            // eslint-disable-next-line unicorn/no-array-for-each
-            next.value.ServiceSummaryList.forEach((summary: AppRunner.Service) => services.push(summary))
-
-            if (next.done) {
-                break
-            }
+        function isService(s: ServiceSummary): s is AppRunnerServiceSummary {
+            return hasProps(s, 'ServiceName', 'ServiceArn', 'Status', 'ServiceId')
         }
-
-        return services
     }
 
     public async updateChildren(): Promise<void> {

packages/core/src/awsService/apprunner/explorer/apprunnerServiceNode.ts

@@ -4,7 +4,7 @@
  */
 
 import AsyncLock from 'async-lock'
-import { AppRunnerClient } from '../../../shared/clients/apprunner'
+import { AppRunnerClient, AppRunnerService, AppRunnerServiceSummary } from '../../../shared/clients/apprunner'
 import { AppRunner } from 'aws-sdk'
 import { AppRunnerNode } from './apprunnerNode'
 
@@ -17,6 +17,7 @@ import * as nls from 'vscode-nls'
 import { getLogger } from '../../../shared/logger/logger'
 import { getIcon } from '../../../shared/icons'
 import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
+import { UpdateServiceRequest } from '@aws-sdk/client-apprunner'
 const localize = nls.loadMessageBundle()
 
 const contextBase = 'awsAppRunnerServiceNode'
@@ -41,7 +42,7 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
     constructor(
         public readonly parent: AppRunnerNode,
         private readonly client: AppRunnerClient,
-        private _info: AppRunner.Service,
+        private _info: AppRunnerServiceSummary,
         private currentOperation: AppRunner.OperationSummary & { Type?: ServiceOperation } = {},
         cloudwatchClient = new DefaultCloudWatchLogsClient(client.regionCode)
     ) {
@@ -55,7 +56,7 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
         this.update(_info)
     }
 
-    public get info(): Readonly<AppRunner.Service> {
+    public get info(): Readonly<AppRunnerServiceSummary> {
         return this._info
     }
 
@@ -81,7 +82,8 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
         this.label = `${this._info.ServiceName} [${displayStatus}]`
     }
 
-    public update(info: AppRunner.ServiceSummary | AppRunner.Service): void {
+    // eslint-disable-next-line @typescript-eslint/no-duplicate-type-constituents
+    public update(info: AppRunnerServiceSummary | AppRunnerService): void {
         // update can be called multiple times during an event loop
         // this would rarely cause the node's status to appear as 'Operation in progress'
         this.lock
@@ -161,7 +163,7 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
         this.setOperation(resp.Service, resp.OperationId, 'DELETE_SERVICE')
     }
 
-    public async updateService(request: AppRunner.UpdateServiceRequest): Promise<void> {
+    public async updateService(request: UpdateServiceRequest): Promise<void> {
         const resp = await this.client.updateService({ ...request, ServiceArn: this._info.ServiceArn })
         this.setOperation(resp.Service, resp.OperationId, 'UPDATE_SERVICE')
     }
@@ -171,13 +173,14 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
         this.setOperation(this._info, resp.OperationId, 'START_DEPLOYMENT')
     }
 
-    public setOperation(info: AppRunner.Service, id?: string, type?: ServiceOperation): void {
+    // eslint-disable-next-line @typescript-eslint/no-duplicate-type-constituents
+    public setOperation(info: AppRunnerService | AppRunnerServiceSummary, id?: string, type?: ServiceOperation): void {
         this.currentOperation.Id = id
         this.currentOperation.Type = type
         this.update(info)
     }
 
-    public async describe(): Promise<AppRunner.Service> {
+    public async describe(): Promise<AppRunnerServiceSummary> {
         const resp = await this.client.describeService({ ServiceArn: this.arn })
         this.update(resp.Service)
         return this._info

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

@@ -7,11 +7,41 @@ import { AppRunner } from 'aws-sdk'
 import globals from '../extensionGlobals'
 import {
     AppRunnerClient as AppRunnerClientSDK,
+    DeleteServiceCommand,
+    DeleteServiceRequest,
+    DeleteServiceResponse,
+    DescribeServiceCommand,
+    DescribeServiceRequest,
+    DescribeServiceResponse,
     ListServicesCommand,
     ListServicesRequest,
     ListServicesResponse,
+    paginateListServices,
+    PauseServiceCommand,
+    PauseServiceRequest,
+    PauseServiceResponse,
+    ResumeServiceCommand,
+    ResumeServiceRequest,
+    ResumeServiceResponse,
+    Service,
+    ServiceSummary,
+    StartDeploymentCommand,
+    StartDeploymentRequest,
+    StartDeploymentResponse,
+    UpdateServiceCommand,
+    UpdateServiceRequest,
+    UpdateServiceResponse,
 } from '@aws-sdk/client-apprunner'
 import { ClientWrapper } from './clientWrapper'
+import { RequiredProps } from '../utilities/tsUtils'
+
+export type AppRunnerService = RequiredProps<Service, 'ServiceName' | 'ServiceArn' | 'Status' | 'ServiceId'>
+export type AppRunnerServiceSummary = RequiredProps<
+    ServiceSummary,
+    'ServiceName' | 'ServiceArn' | 'Status' | 'ServiceId'
+>
+
+type WithService<T> = T & { Service: AppRunnerService }
 
 export class AppRunnerClient extends ClientWrapper<AppRunnerClientSDK> {
     public constructor(regionCode: string) {
@@ -26,16 +56,20 @@ export class AppRunnerClient extends ClientWrapper<AppRunnerClientSDK> {
         return await this.makeRequest(ListServicesCommand, request)
     }
 
-    public async pauseService(request: AppRunner.PauseServiceRequest): Promise<AppRunner.PauseServiceResponse> {
-        return (await this.createSdkClient()).pauseService(request).promise()
+    public paginateServices(request: ListServicesRequest) {
+        return this.makePaginatedRequest(paginateListServices, request, (page) => page.ServiceSummaryList)
+    }
+
+    public async pauseService(request: PauseServiceRequest): Promise<WithService<PauseServiceResponse>> {
+        return await this.makeRequest(PauseServiceCommand, request)
     }
 
-    public async resumeService(request: AppRunner.ResumeServiceRequest): Promise<AppRunner.ResumeServiceResponse> {
-        return (await this.createSdkClient()).resumeService(request).promise()
+    public async resumeService(request: ResumeServiceRequest): Promise<WithService<ResumeServiceResponse>> {
+        return await this.makeRequest(ResumeServiceCommand, request)
     }
 
-    public async updateService(request: AppRunner.UpdateServiceRequest): Promise<AppRunner.UpdateServiceResponse> {
-        return (await this.createSdkClient()).updateService(request).promise()
+    public async updateService(request: UpdateServiceRequest): Promise<WithService<UpdateServiceResponse>> {
+        return await this.makeRequest(UpdateServiceCommand, request)
     }
 
     public async createConnection(
@@ -50,24 +84,20 @@ export class AppRunnerClient extends ClientWrapper<AppRunnerClientSDK> {
         return (await this.createSdkClient()).listConnections(request).promise()
     }
 
-    public async describeService(
-        request: AppRunner.DescribeServiceRequest
-    ): Promise<AppRunner.DescribeServiceResponse> {
-        return (await this.createSdkClient()).describeService(request).promise()
+    public async describeService(request: DescribeServiceRequest): Promise<WithService<DescribeServiceResponse>> {
+        return await this.makeRequest(DescribeServiceCommand, request)
     }
 
-    public async startDeployment(
-        request: AppRunner.StartDeploymentRequest
-    ): Promise<AppRunner.StartDeploymentResponse> {
-        return (await this.createSdkClient()).startDeployment(request).promise()
+    public async startDeployment(request: StartDeploymentRequest): Promise<StartDeploymentResponse> {
+        return await this.makeRequest(StartDeploymentCommand, request)
     }
 
     public async listOperations(request: AppRunner.ListOperationsRequest): Promise<AppRunner.ListOperationsResponse> {
         return (await this.createSdkClient()).listOperations(request).promise()
     }
 
-    public async deleteService(request: AppRunner.DeleteServiceRequest): Promise<AppRunner.DeleteServiceResponse> {
-        return (await this.createSdkClient()).deleteService(request).promise()
+    public async deleteService(request: DeleteServiceRequest): Promise<WithService<DeleteServiceResponse>> {
+        return this.makeRequest(DeleteServiceCommand, request)
     }
 
     protected async createSdkClient(): Promise<AppRunner> {

packages/core/src/test/awsService/apprunner/explorer/apprunnerServiceNode.test.ts

@@ -5,10 +5,9 @@
 
 import assert from 'assert'
 import * as sinon from 'sinon'
-import { AppRunner } from 'aws-sdk'
 import { AppRunnerNode } from '../../../../awsService/apprunner/explorer/apprunnerNode'
 import { AppRunnerServiceNode } from '../../../../awsService/apprunner/explorer/apprunnerServiceNode'
-import { AppRunnerClient } from '../../../../shared/clients/apprunner'
+import { AppRunnerClient, AppRunnerService } from '../../../../shared/clients/apprunner'
 import { DefaultCloudWatchLogsClient } from '../../../../shared/clients/cloudWatchLogsClient'
 import { asyncGenerator } from '../../../../shared/utilities/collectionUtils'
 import { AWSTreeNodeBase } from '../../../../shared/treeview/nodes/awsTreeNodeBase'
@@ -20,7 +19,7 @@ describe('AppRunnerServiceNode', function () {
     let mockParentNode: AppRunnerNode
     let node: AppRunnerServiceNode
 
-    const exampleInfo: AppRunner.Service = {
+    const exampleInfo: AppRunnerService = {
         ServiceName: 'test1',
         Status: 'RUNNING',
         ServiceArn: 'test-arn1',