refactor(ssm): clean-up create/update wizard (#2742)

* Refactor SSM create/update wizard
* Add test coverage

Author: JadenSimon

src/shared/ui/common/region.ts

@@ -13,31 +13,32 @@ import { createQuickPick, QuickPickPrompter } from '../pickerPrompter'
 
 const localize = nls.loadMessageBundle()
 
-type RegionPrompterOptions = {
-    defaultRegion?: string
-    title?: string
-    buttons?: PrompterButtons<Region>
+interface RegionPrompterOptions {
+    readonly defaultRegion?: string
+    readonly title?: string
+    readonly buttons?: PrompterButtons<Region>
+    readonly serviceFilter?: string
 }
 
 export function createRegionPrompter(
-    regions?: Region[],
+    regions = getRegionsForActiveCredentials(globals.awsContext, globals.regionProvider),
     options: RegionPrompterOptions = {}
 ): QuickPickPrompter<Region> {
     const lastRegionKey = 'lastSelectedRegion'
-    if (!regions) {
-        regions = getRegionsForActiveCredentials(globals.awsContext, globals.regionProvider)
-    }
-    options.defaultRegion ??= globals.awsContext.getCredentialDefaultRegion()
+    const defaultRegion = options.defaultRegion ?? globals.awsContext.getCredentialDefaultRegion()
+    const filteredRegions = regions.filter(
+        r => !options.serviceFilter || globals.regionProvider.isServiceInRegion(options.serviceFilter, r.id)
+    )
 
-    const items = regions.map(region => ({
+    const items = filteredRegions.map(region => ({
         label: region.name,
         detail: region.id,
         data: region,
         skipEstimate: true,
         description: '',
     }))
 
-    const defaultRegionItem = items.find(item => item.detail === options.defaultRegion)
+    const defaultRegionItem = items.find(item => item.detail === defaultRegion)
 
     if (defaultRegionItem !== undefined) {
         defaultRegionItem.description = localize('AWS.generic.defaultRegion', '(default region)')
@@ -48,13 +49,13 @@ export function createRegionPrompter(
         buttons: options.buttons ?? createCommonButtons(),
         matchOnDetail: true,
         compare: (a, b) => {
-            return a.detail === options.defaultRegion ? -1 : b.detail === options.defaultRegion ? 1 : 0
+            return a.detail === defaultRegion ? -1 : b.detail === defaultRegion ? 1 : 0
         },
     })
 
     const lastRegion = globals.context.globalState.get<Region>(lastRegionKey)
     if (lastRegion !== undefined && (lastRegion as any).id) {
-        const found = regions.find(val => val.id === lastRegion.id)
+        const found = filteredRegions.find(val => val.id === lastRegion.id)
         if (found) {
             prompter.recentItem = lastRegion
         }

src/shared/wizards/wizard.ts

@@ -103,6 +103,10 @@ export class Wizard<TState extends Partial<Record<keyof TState, unknown>>> {
         return this._form
     }
 
+    public get initialState(): Readonly<Partial<TState>> | undefined {
+        return this.options.initState
+    }
+
     private _estimator: ((state: TState) => number) | undefined
     public set parentEstimator(estimator: (state: TState) => number) {
         this._estimator = estimator

src/ssmDocument/commands/publishDocument.ts

@@ -14,12 +14,7 @@ import { ssmJson, ssmYaml } from '../../shared/constants'
 import * as localizedText from '../../shared/localizedText'
 import { getLogger, Logger } from '../../shared/logger'
 import { RegionProvider } from '../../shared/regions/regionProvider'
-import {
-    DefaultPublishSSMDocumentWizardContext,
-    PublishSSMDocumentWizard,
-    PublishSSMDocumentWizardContext,
-    PublishSSMDocumentWizardResponse,
-} from '../wizards/publishDocumentWizard'
+import { PublishSSMDocumentWizard, PublishSSMDocumentWizardResponse } from '../wizards/publishDocumentWizard'
 import * as telemetry from '../../shared/telemetry/telemetry'
 import { Window } from '../../shared/vscode/window'
 import { showConfirmationMessage } from '../util/util'
@@ -56,17 +51,11 @@ export async function publishSSMDocument(awsContext: AwsContext, regionProvider:
     }
 
     try {
-        const wizardContext: PublishSSMDocumentWizardContext = new DefaultPublishSSMDocumentWizardContext(
-            awsContext,
-            regionProvider
-        )
-        const wizardResponse: PublishSSMDocumentWizardResponse | undefined = await new PublishSSMDocumentWizard(
-            wizardContext
-        ).run()
-        if (wizardResponse?.PublishSsmDocAction == 'Create') {
-            await createDocument(wizardResponse, textDocument)
-        } else if (wizardResponse?.PublishSsmDocAction == 'Update') {
-            await updateDocument(wizardResponse, textDocument)
+        const response = await new PublishSSMDocumentWizard().run()
+        if (response?.action == 'Create') {
+            await createDocument(response, textDocument)
+        } else if (response?.action == 'Update') {
+            await updateDocument(response, textDocument)
         }
     } catch (err) {
         logger.error(err as Error)
@@ -79,7 +68,7 @@ export async function createDocument(
     client: SsmDocumentClient = globals.toolkitClientBuilder.createSsmClient(wizardResponse.region)
 ) {
     let result: telemetry.Result = 'Succeeded'
-    const ssmOperation: telemetry.SsmOperation = wizardResponse.PublishSsmDocAction as telemetry.SsmOperation
+    const ssmOperation = wizardResponse.action as telemetry.SsmOperation
 
     const logger: Logger = getLogger()
     logger.info(`Creating Systems Manager Document '${wizardResponse.name}'`)
@@ -114,7 +103,7 @@ export async function updateDocument(
     window = Window.vscode()
 ) {
     let result: telemetry.Result = 'Succeeded'
-    const ssmOperation: telemetry.SsmOperation = wizardResponse.PublishSsmDocAction as telemetry.SsmOperation
+    const ssmOperation = wizardResponse.action as telemetry.SsmOperation
 
     const logger: Logger = getLogger()
     logger.info(`Updating Systems Manager Document '${wizardResponse.name}'`)