clean-up(ui): remove CachedPrompter (#2752)

## Problem
Caching at intermediate layers in an architecture, especially UI, is generally not a good idea unless there's substantial benefit for doing so. `CachedPrompte`r is also clunky and hard to use.

## Solution
Remove `CachedPrompter`. Luckily I only used it in a few spots.

Author: JadenSimon

src/apprunner/wizards/apprunnerCreateServiceWizard.ts

@@ -12,10 +12,10 @@ import { Prompter } from '../../shared/ui/prompter'
 import { Wizard, WizardState } from '../../shared/wizards/wizard'
 import { AppRunnerImageRepositoryWizard } from './imageRepositoryWizard'
 import { AppRunnerCodeRepositoryWizard } from './codeRepositoryWizard'
-import { BasicExitPrompterProvider } from '../../shared/ui/common/exitPrompter'
 import { GitExtension } from '../../shared/extensions/git'
 import { makeDeploymentButton } from './deploymentButton'
 import { apprunnerCreateServiceDocsUrl } from '../../shared/constants'
+import { createExitPrompter } from '../../shared/ui/common/exitPrompter'
 import { DefaultIamClient } from '../../shared/clients/iamClient'
 import { DefaultEcrClient } from '../../shared/clients/ecrClient'
 import { DefaultAppRunnerClient } from '../../shared/clients/apprunnerClient'
@@ -110,7 +110,7 @@ export class CreateAppRunnerServiceWizard extends Wizard<AppRunner.CreateService
         super({
             initState,
             implicitState,
-            exitPrompterProvider: new BasicExitPrompterProvider(),
+            exitPrompterProvider: createExitPrompter,
         })
 
         const autoDeployButton = makeDeploymentButton()

src/apprunner/wizards/codeRepositoryWizard.ts

@@ -9,18 +9,11 @@ import { createCommonButtons, createRefreshButton, QuickInputToggleButton } from
 import { Remote } from '../../../types/git.d'
 import { GitExtension } from '../../shared/extensions/git'
 import * as vscode from 'vscode'
-import { CachedFunction, CachedPrompter } from '../../shared/ui/prompter'
 import { WizardForm } from '../../shared/wizards/wizardForm'
 import { createVariablesPrompter } from '../../shared/ui/common/variablesPrompter'
 import { AppRunnerClient } from '../../shared/clients/apprunnerClient'
 import { makeDeploymentButton } from './deploymentButton'
-import { ConnectionSummary } from 'aws-sdk/clients/apprunner'
-import {
-    createLabelQuickPick,
-    createQuickPick,
-    DataQuickPickItem,
-    QuickPickPrompter,
-} from '../../shared/ui/pickerPrompter'
+import { createLabelQuickPick, createQuickPick, QuickPickPrompter } from '../../shared/ui/pickerPrompter'
 import { createInputBox, InputBoxPrompter } from '../../shared/ui/inputPrompter'
 import {
     apprunnerConnectionHelpUrl,
@@ -29,7 +22,6 @@ import {
     apprunnerCreateServiceDocsUrl,
 } from '../../shared/constants'
 import { Wizard, WIZARD_BACK } from '../../shared/wizards/wizard'
-import { getLogger } from '../../shared/logger/logger'
 
 const localize = nls.loadMessageBundle()
 
@@ -151,71 +143,41 @@ function createPortPrompter(): InputBoxPrompter {
     })
 }
 
-export class ConnectionPrompter extends CachedPrompter<ConnectionSummary> {
-    public constructor(private readonly client: AppRunnerClient) {
-        super()
+export function createConnectionPrompter(client: AppRunnerClient) {
+    const noItemsFoundItem = {
+        label: 'No connections found',
+        detail: 'Click for documentation on creating a new GitHub connection for App Runner',
+        data: {} as any,
+        invalidSelection: true,
+        onClick: () => vscode.env.openExternal(vscode.Uri.parse(apprunnerConnectionHelpUrl)),
     }
 
-    protected load(): Promise<DataQuickPickItem<ConnectionSummary>[]> {
-        return this.client
-            .listConnections({})
-            .then(resp => {
-                const connections = resp.ConnectionSummaryList.filter(conn => conn.Status === 'AVAILABLE').map(
-                    conn => ({
-                        label: conn.ConnectionName!,
-                        data: conn,
-                    })
-                )
-
-                if (connections.length === 0) {
-                    return [
-                        {
-                            label: 'No connections found',
-                            detail: 'Click for documentation on creating a new GitHub connection for App Runner',
-                            data: {} as any,
-                            invalidSelection: true,
-                            onClick: vscode.env.openExternal.bind(
-                                vscode.env,
-                                vscode.Uri.parse(apprunnerConnectionHelpUrl)
-                            ),
-                        },
-                    ]
-                } else {
-                    return connections
-                }
-            })
-            .catch(err => {
-                getLogger().error(`Failed to list GitHub connections: %O`, err)
-                return [
-                    {
-                        label: localize(
-                            'AWS.apprunner.createService.selectConnection.failed',
-                            'Failed to list GitHub connections'
-                        ),
-                        description: localize('AWS.generic.goBack', 'Click to go back'),
-                        data: WIZARD_BACK,
-                    },
-                ]
-            })
+    const errorItem = {
+        label: localize('AWS.apprunner.createService.selectConnection.failed', 'Failed to list GitHub connections'),
+        description: localize('AWS.generic.goBack', 'Click to go back'),
+        data: WIZARD_BACK,
     }
 
-    protected createPrompter(loader: CachedFunction<ConnectionPrompter['load']>): QuickPickPrompter<ConnectionSummary> {
-        const connections = loader()
-        const refreshButton = createRefreshButton()
-        const prompter = createQuickPick(connections, {
-            title: localize('AWS.apprunner.createService.selectConnection.title', 'Select a connection'),
-            buttons: [refreshButton, ...createCommonButtons(apprunnerConnectionHelpUrl)],
-        })
+    const getItems = async () => {
+        const resp = await client.listConnections()
 
-        const refresh = () => {
-            loader.clearCache()
-            prompter.clearAndLoadItems(loader())
-        }
+        return resp.ConnectionSummaryList.filter(conn => conn.Status === 'AVAILABLE').map(conn => ({
+            label: conn.ConnectionName!,
+            data: conn,
+        }))
+    }
 
-        refreshButton.onClick = refresh
+    const refreshButton = createRefreshButton()
+    refreshButton.onClick = () => void prompter.clearAndLoadItems(getItems())
 
-        return prompter
-    }
+    const prompter = createQuickPick(getItems(), {
+        errorItem,
+        noItemsFoundItem,
+        buttons: [refreshButton, ...createCommonButtons(apprunnerConnectionHelpUrl)],
+        title: localize('AWS.apprunner.createService.selectConnection.title', 'Select a connection'),
+    })
+
+    return prompter
 }
 
 function createSourcePrompter(): QuickPickPrompter<AppRunner.ConfigurationSource> {
@@ -276,10 +238,9 @@ export class AppRunnerCodeRepositoryWizard extends Wizard<AppRunner.SourceConfig
     ) {
         super()
         const form = this.form
-        const connectionPrompter = new ConnectionPrompter(client)
 
-        form.AuthenticationConfiguration.ConnectionArn.bindPrompter(
-            connectionPrompter.transform(conn => conn.ConnectionArn!)
+        form.AuthenticationConfiguration.ConnectionArn.bindPrompter(() =>
+            createConnectionPrompter(client).transform(conn => conn.ConnectionArn!)
         )
         form.CodeRepository.applyBoundForm(createCodeRepositorySubForm(git))
         form.AutoDeploymentsEnabled.setDefault(() => autoDeployButton.state === 'on')

src/apprunner/wizards/imageRepositoryWizard.ts

@@ -21,9 +21,9 @@ import { makeDeploymentButton } from './deploymentButton'
 import { IamClient } from '../../shared/clients/iamClient'
 import { createRolePrompter } from '../../shared/ui/common/roles'
 import { getLogger } from '../../shared/logger/logger'
-import { BasicExitPrompterProvider } from '../../shared/ui/common/exitPrompter'
 import { isCloud9 } from '../../shared/extensionUtilities'
 import { apprunnerCreateServiceDocsUrl } from '../../shared/constants'
+import { createExitPrompter } from '../../shared/ui/common/exitPrompter'
 
 const localize = nls.loadMessageBundle()
 
@@ -228,7 +228,7 @@ function createImageRepositorySubForm(
     // note: this is intentionally initialized only once to preserve caches
     const imageIdentifierWizard = new Wizard({
         initForm: new ImageIdentifierForm(ecrClient),
-        exitPrompterProvider: new BasicExitPrompterProvider(),
+        exitPrompterProvider: createExitPrompter,
     })
 
     form.ImageIdentifier.bindPrompter(() =>

src/lambda/wizards/samInitWizard.ts

@@ -39,7 +39,7 @@ import { createLabelQuickPick, createQuickPick, QuickPickPrompter } from '../../
 import { createRegionPrompter } from '../../shared/ui/common/region'
 import { Region } from '../../shared/regions/endpoints'
 import { createCommonButtons } from '../../shared/ui/buttons'
-import { BasicExitPrompterProvider } from '../../shared/ui/common/exitPrompter'
+import { createExitPrompter } from '../../shared/ui/common/exitPrompter'
 
 const localize = nls.loadMessageBundle()
 
@@ -202,7 +202,7 @@ export class CreateNewSamAppWizard extends Wizard<CreateNewSamAppWizardForm> {
         credentials?: AWS.Credentials
     }) {
         super({
-            exitPrompterProvider: new BasicExitPrompterProvider(),
+            exitPrompterProvider: createExitPrompter,
         })
 
         this.form.runtimeAndPackage.bindPrompter(() => createRuntimePrompter(context.samCliVersion))

src/shared/clients/apprunnerClient.ts

@@ -40,7 +40,7 @@ export class DefaultAppRunnerClient {
     }
 
     public async listConnections(
-        request: AppRunner.ListConnectionsRequest
+        request: AppRunner.ListConnectionsRequest = {}
     ): Promise<AppRunner.ListConnectionsResponse> {
         return (await this.createSdkClient()).listConnections(request).promise()
     }

src/shared/ui/common/exitPrompter.ts

@@ -6,7 +6,7 @@
 import { localize } from '../../utilities/vsCodeUtils'
 import { StepEstimator } from '../../wizards/wizard'
 import { createQuickPick } from '../pickerPrompter'
-import { Prompter, CachedPrompter, PromptResult } from '../prompter'
+import { Prompter, PromptResult } from '../prompter'
 
 class BasicExitPrompter extends Prompter<boolean> {
     private _isStart = true
@@ -40,11 +40,6 @@ class BasicExitPrompter extends Prompter<boolean> {
     public setStepEstimator(estimator: StepEstimator<boolean>): void {}
 }
 
-export class BasicExitPrompterProvider extends CachedPrompter<boolean, any> {
-    protected load(...args: any) {
-        return undefined
-    }
-    protected createPrompter(loader: any, state: any): Prompter<boolean> {
-        return new BasicExitPrompter()
-    }
+export function createExitPrompter() {
+    return new BasicExitPrompter()
 }

src/shared/ui/inputPrompter.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode'
 import { assign } from '../utilities/collectionUtils'
-import { StepEstimator, WIZARD_BACK, WIZARD_EXIT } from '../wizards/wizard'
+import { isValidResponse, StepEstimator, WIZARD_BACK, WIZARD_EXIT } from '../wizards/wizard'
 import { QuickInputButton, PrompterButtons } from './buttons'
 import { Prompter, PromptResult } from './prompter'
 
@@ -46,6 +46,13 @@ export function createInputBox(options?: ExtendedInputBoxOptions): InputBoxPromp
     return prompter
 }
 
+export async function showInputBox(options?: ExtendedInputBoxOptions): Promise<string | undefined> {
+    const prompter = createInputBox(options)
+    const response = await prompter.prompt()
+
+    return isValidResponse(response) ? response : undefined
+}
+
 /**
  * UI element that accepts user-inputted text. Wraps around {@link vscode.InputBox InputBox}.
  *

src/shared/ui/pickerPrompter.ts

@@ -6,7 +6,7 @@
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 
-import { StepEstimator, WIZARD_BACK, WIZARD_EXIT } from '../wizards/wizard'
+import { isValidResponse, StepEstimator, WIZARD_BACK, WIZARD_EXIT } from '../wizards/wizard'
 import { QuickInputButton, PrompterButtons } from './buttons'
 import { Prompter, PromptResult, Transform } from './prompter'
 import { assign, isAsyncIterable } from '../utilities/collectionUtils'
@@ -151,6 +151,16 @@ export function createQuickPick<T>(
     return prompter
 }
 
+export async function showQuickPick<T>(
+    items: ItemLoadTypes<T>,
+    options?: ExtendedQuickPickOptions<T>
+): Promise<T | undefined> {
+    const prompter = createQuickPick(items, options)
+    const response = await prompter.prompt()
+
+    return isValidResponse(response) ? response : undefined
+}
+
 // Note: the generic type used in `createLabelQuickPick` is needed to infer the correct type when using string
 // literal types. Otherwise the narrowness of the type would be lost.
 /** Creates a QuickPick from normal QuickPickItems, using the `label` as the return value. */

src/shared/ui/prompter.ts

@@ -3,8 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import * as _ from 'lodash'
-import { isValidResponse, StateWithCache, StepEstimator, WizardControl } from '../wizards/wizard'
+import { isValidResponse, StepEstimator, WizardControl } from '../wizards/wizard'
 
 export type QuickPickDataType<T> = T | WizardControl | undefined
 
@@ -75,103 +74,3 @@ export abstract class Prompter<T> {
     protected abstract promptUser(): Promise<PromptResult<T>>
     public abstract setSteps(current: number, total: number): void
 }
-
-export interface CachedPrompter<T, TState extends Record<string, unknown>> {
-    (state: StateWithCache<TState, T>): Prompter<T>
-}
-
-type Cacheable = (...args: (string | number | boolean | undefined)[]) => NonNullable<any>
-
-/**
- * A wrapped function that can cache both synchronous and asynchronous return types.
- *
- * Pending promises are returned as-is, while resolved promises are 'unboxed' into their promised type.
- */
-export interface CachedFunction<F extends (...args: any) => any> {
-    (...args: Parameters<F>): Awaited<ReturnType<F>> | ReturnType<F>
-    clearCache(): void
-    supplantLast(result: Awaited<ReturnType<F>>): void
-}
-
-// TODO: this currently just caches primitive arguments which is not very flexible
-// there is a 'cache-object' library that could make sense here. we could just cache the entire
-// argument list itself and not worry about types
-function createCachedFunction<F extends Cacheable>(
-    loader: F,
-    cache: { [key: string]: ReturnType<F> } = {},
-    keys: Set<string> = new Set()
-): CachedFunction<F> {
-    const wrapped = (...args: Parameters<F>) => {
-        const key =
-            args
-                .map(arg => (arg ?? '').toString())
-                .map(arg => (arg === '' ? arg : `${arg}${arg.length}`))
-                .join() + '0' // Cannot index with an empty string
-
-        if (cache[key] !== undefined) {
-            return cache[key]
-        }
-
-        const resolved = loader(...args)
-        cache[key] = resolved as any
-        keys.add(key)
-
-        if (resolved instanceof Promise) {
-            return resolved.then(result => {
-                cache[key] = result
-                return result
-            })
-        }
-
-        return resolved
-    }
-
-    const clearCache = () => {
-        keys.forEach(key => delete cache[key])
-        keys.clear()
-    }
-
-    const supplantLast = (result: ReturnType<F>) => {
-        if (keys.size === 0) {
-            throw new Error('Cannot evict an empty cache')
-        }
-        cache[[...keys.values()].pop()!] = result
-    }
-
-    return Object.assign(wrapped, { clearCache, supplantLast })
-}
-
-// Rebinds the Function function body to instead call the extended class method
-const EXECUTE_CALLEE = 'return arguments.callee.call.apply(arguments.callee, arguments)'
-/**
- * Convenience class that lightly wraps the creation of a Prompter with the loading of whatever resources
- * are required. The 'load' call is wrapped with a cache for automatic caching of its results.
- */
-export abstract class CachedPrompter<
-    T,
-    TState extends Record<string, unknown> = Record<string, unknown>
-> extends Function {
-    private usedKeys = new Set<string>()
-    protected transforms: Transform<T, any>[] = []
-
-    public constructor() {
-        super(EXECUTE_CALLEE)
-    }
-
-    public transform<R>(callback: Transform<T, R>): CachedPrompter<R, TState> {
-        this.transforms.push(callback)
-        return this as unknown as CachedPrompter<R, TState>
-    }
-
-    public call(state: StateWithCache<TState, T>): Prompter<T> {
-        const cachedLoad = createCachedFunction(this.load.bind(this), state.stepCache, this.usedKeys)
-        const prompter = this.createPrompter(cachedLoad, state)
-
-        this.transforms.map(prompter.transform.bind(prompter))
-
-        return prompter
-    }
-
-    protected abstract load(...args: any): any
-    protected abstract createPrompter(loader: CachedFunction<any>, state: TState): Prompter<T>
-}