refactor: tighten typing constraints

Author: Hweinstock

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

@@ -7,6 +7,7 @@ import globals from '../extensionGlobals'
 import { AwsClient, AwsClientConstructor, AwsCommand, AwsCommandConstructor } from '../awsClientBuilderV3'
 import { PaginationConfiguration, Paginator } from '@aws-sdk/types'
 import { AsyncCollection, toCollection } from '../utilities/asyncCollection'
+import { isDefined } from '../utilities/tsUtils'
 
 type SDKPaginator<C, CommandInput extends object, CommandOutput extends object> = (
     config: Omit<PaginationConfiguration, 'client'> & { client: C },
@@ -49,10 +50,6 @@ export abstract class ClientWrapper<C extends AwsClient> implements vscode.Dispo
             .map((o) => o.filter(isDefined))
 
         return collection
-
-        function isDefined<T>(i: T | undefined): i is T {
-            return i !== undefined
-        }
     }
 
     protected async getFirst<CommandInput extends object, CommandOutput extends object, Output extends object>(

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

@@ -16,7 +16,14 @@ import { ServiceConfigurationOptions } from 'aws-sdk/lib/service'
 import { CancellationError, Timeout, waitTimeout, waitUntil } from '../utilities/timeoutUtils'
 import { isUserCancelledError } from '../../shared/errors'
 import { showMessageWithCancel } from '../utilities/messages'
-import { assertHasProps, ClassToInterfaceType, hasProps, isNonNullable, RequiredProps } from '../utilities/tsUtils'
+import {
+    assertHasProps,
+    ClassToInterfaceType,
+    hasProps,
+    isDefined,
+    isNonNullable,
+    RequiredProps,
+} from '../utilities/tsUtils'
 import { AsyncCollection, toCollection } from '../utilities/asyncCollection'
 import { joinAll, pageableToCollection } from '../utilities/collectionUtils'
 import { CodeCatalyst } from 'aws-sdk'
@@ -58,6 +65,7 @@ import {
     ListSpacesCommand,
     ListSpacesRequest,
     ListSpacesResponse,
+    ProjectSummary,
     SpaceSummary,
 } from '@aws-sdk/client-codecatalyst'
 import { truncateProps } from '../utilities/textUtilities'
@@ -525,9 +533,7 @@ class CodeCatalystClientInternal extends ClientWrapper<CodeCatalystSDKClient> {
     public listSpaces(request: ListSpacesRequest = {}): AsyncCollection<CodeCatalystOrg[]> {
         const requester: (request: ListSpacesRequest) => Promise<ListSpacesResponse> = async (request) =>
             this.callV3(ListSpacesCommand, request, true, { items: [] })
-        const collection = pageableToCollection(requester, request, 'nextToken', 'items').filter(
-            (summaries) => summaries !== undefined
-        )
+        const collection = pageableToCollection(requester, request, 'nextToken', 'items').filter(isDefined)
         return collection.map((summaries) =>
             summaries.filter((s) => hasProps(s, 'name')).map((s) => ({ type: 'org', ...s }))
         )
@@ -551,9 +557,7 @@ class CodeCatalystClientInternal extends ClientWrapper<CodeCatalystSDKClient> {
         const requester: (request: ListProjectsRequest) => Promise<ListProjectsResponse> = (request) =>
             this.callV3(ListProjectsCommand, request, true, { items: [] })
 
-        const collection = pageableToCollection(requester, request, 'nextToken', 'items').filter(
-            (summaries) => summaries !== undefined
-        )
+        const collection = pageableToCollection(requester, request, 'nextToken', 'items').filter(isDefined)
 
         return collection.map((summaries) =>
             summaries
@@ -569,16 +573,18 @@ class CodeCatalystClientInternal extends ClientWrapper<CodeCatalystSDKClient> {
     /**
      * Gets a flat list of all devenvs for the given CodeCatalyst project.
      */
-    public listDevEnvironments(proj: CodeCatalystProject): AsyncCollection<DevEnvironment[]> {
+    public listDevEnvironments(
+        proj: CodeCatalystProject
+    ): AsyncCollection<RequiredProps<DevEnvironment, 'id' | 'status' | 'lastUpdatedTime'>[]> {
         const initRequest = { spaceName: proj.org.name, projectName: proj.name }
         const requester: (request: ListDevEnvironmentsRequest) => Promise<ListDevEnvironmentsResponse> = (request) =>
             this.callV3(ListDevEnvironmentsCommand, request, true, { items: [] })
-        const collection = pageableToCollection(requester, initRequest, 'nextToken', 'items').filter(
-            (c) => c !== undefined
-        )
+        const collection = pageableToCollection(requester, initRequest, 'nextToken', 'items').filter(isDefined)
 
         return collection.map((envs) =>
-            envs.filter((s) => hasProps(s, 'id', 'status')).map((s) => toDevEnv(proj.org.name, proj.name, s))
+            envs
+                .filter((s) => hasProps(s, 'id', 'status', 'lastUpdatedTime'))
+                .map((s) => toDevEnv(proj.org.name, proj.name, s))
         )
     }
 

packages/core/src/shared/utilities/tsUtils.ts

@@ -161,3 +161,7 @@ export function omitIfPresent<T extends Record<string, unknown>>(obj: T, keys: s
     }
     return objCopy
 }
+
+export function isDefined<T>(i: T | undefined): i is T {
+    return i !== undefined
+}

packages/core/src/testE2E/codecatalyst/client.test.ts

@@ -191,7 +191,7 @@ describe.only('Test how this codebase uses the CodeCatalyst API', function () {
             assert.strictEqual(actualDevEnv.org.name, spaceName)
             assert.strictEqual(actualDevEnv.alias, differentDevEnvSettings.alias)
             assert.strictEqual(actualDevEnv.instanceType, 'dev.standard1.medium')
-            assert.strictEqual(actualDevEnv.persistentStorage.sizeInGiB, 32)
+            assert.strictEqual(actualDevEnv.persistentStorage && actualDevEnv.persistentStorage.sizeInGiB, 32)
         })
 
         it.skip('creates a Dev Environment using an existing branch', async function () {
@@ -533,7 +533,7 @@ describe.only('Test how this codebase uses the CodeCatalyst API', function () {
         )
     }
 
-    async function getAllDevEnvs(projectName: CodeCatalystProject['name']): Promise<DevEnvironment[]> {
+    async function getAllDevEnvs(projectName: CodeCatalystProject['name']) {
         const currentDevEnvs = await client
             .listDevEnvironments({ name: projectName, org: { name: spaceName }, type: 'project' })
             .flatten()