[revert] move NestedWizard logic to Wizard class

vicheey · vicheey · commit 77f402f6bfe1 · 2024-12-12T10:48:53.000-08:00
diff --git a/packages/core/src/shared/ui/nestedWizardPrompter.ts b/packages/core/src/shared/ui/nestedWizardPrompter.ts
@@ -0,0 +1,63 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Wizard, WizardOptions } from '../wizards/wizard'
+import { Prompter } from './prompter'
+import { WizardPrompter } from './wizardPrompter'
+import { createHash } from 'crypto'
+
+/**
+ * An abstract class that extends the base Wizard class plus the ability to
+ * use other wizard classes as prompters
+ */
+export abstract class NestedWizard<T> extends Wizard<T> {
+    /**
+     * Map to store memoized wizard instances using SHA-256 hashed keys
+     */
+    private wizardInstances: Map<string, any> = new Map()
+
+    public constructor(options?: WizardOptions<T>) {
+        super(options)
+    }
+
+    /**
+     * Creates a prompter for a wizard instance with memoization.
+     *
+     * @template TWizard - The type of wizard, must extend Wizard<TState>
+     * @template TState - The type of state managed by the wizard
+     *
+     * @param wizardClass - The wizard class constructor
+     * @param args - Constructor arguments for the wizard instance
+     *
+     * @returns A wizard prompter to be used as prompter
+     *
+     * @example
+     * // Create a prompter for SyncWizard
+     * const prompter = this.createWizardPrompter<SyncWizard, SyncParams>(
+     *     SyncWizard,
+     *     template.uri,
+     *     syncUrl
+     * )
+     *
+     * @remarks
+     * - Instances are memoized using a SHA-256 hash of the wizard class name and arguments
+     * - The same wizard instance is reused for identical constructor parameters for restoring wizard prompter
+     *   states during back button click event
+     */
+    protected createWizardPrompter<TWizard extends Wizard<TState>, TState>(
+        wizardClass: new (...args: any[]) => TWizard,
+        ...args: ConstructorParameters<new (...args: any[]) => TWizard>
+    ): Prompter<TState> {
+        const memoizeKey = createHash('sha256')
+            .update(wizardClass.name + JSON.stringify(args))
+            .digest('hex')
+
+        if (!this.wizardInstances.get(memoizeKey)) {
+            this.wizardInstances.set(memoizeKey, new wizardClass(...args))
+        }
+
+        return new WizardPrompter(this.wizardInstances.get(memoizeKey)) as Prompter<TState>
+    }
+}
diff --git a/packages/core/src/shared/ui/wizardPrompter.ts b/packages/core/src/shared/ui/wizardPrompter.ts
@@ -9,10 +9,14 @@ import { Prompter, PromptResult } from './prompter'
 
 /**
  * Wraps {@link Wizard} object into its own {@link Prompter}, allowing wizards to use other wizards in their flows.
- * This is meant to be used exclusively in createWizardPrompter() method of {@link Wizard} class.
+ * This is meant to be used exclusively in createWizardPrompter() method of {@link NestedWizard} class.
+ *
  * @remarks
- *  - Use createWizardPrompter() method of {@link Wizard} when creating a nested wizard prompter for proper state management.
  *  - The WizardPrompter class should never be instantiated with directly.
+ *  - Use createWizardPrompter() method of {@link NestedWizard} when creating a nested wizard prompter for proper state management.
+ *  - See examples:
+ *     - {@link SingleNestedWizard}
+ *     - {@link DoubleNestedWizard}
  */
 export class WizardPrompter<T> extends Prompter<T> {
     public get recentItem(): any {
@@ -57,7 +61,7 @@ export class WizardPrompter<T> extends Prompter<T> {
 
         if (this.response === undefined) {
             return WIZARD_BACK as PromptResult<T>
-        } else if (JSON.stringify(this.response) === '{}') {
+        } else if (_.isEmpty(this.response)) {
             return WIZARD_SKIP as PromptResult<T>
         }
 
diff --git a/packages/core/src/shared/wizards/wizard.ts b/packages/core/src/shared/wizards/wizard.ts
@@ -7,8 +7,6 @@ import { Branch, ControlSignal, StateMachineController, StepFunction } from './s
 import * as _ from 'lodash'
 import { Prompter, PromptResult } from '../../shared/ui/prompter'
 import { PrompterProvider, WizardForm } from './wizardForm'
-import { createHash } from 'crypto'
-import { WizardPrompter } from '../ui/wizardPrompter'
 
 /** Checks if the user response is valid (i.e. not undefined and not a control signal) */
 export function isValidResponse<T>(response: PromptResult<T>): response is T {
@@ -91,10 +89,6 @@ export class Wizard<TState extends Partial<Record<keyof TState, unknown>>> {
     private _exitStep?: StepFunction<TState>
     /** Guards against accidental use of the Wizard before `init()`. */
     private _ready: boolean
-    /**
-     * Map to store memoized wizard instances using SHA-256 hashed keys
-     */
-    private childWizards: Map<string, any> = new Map()
 
     /** Checks that `init()` was performed (if it was defined). */
     private assertReady() {
@@ -105,45 +99,6 @@ export class Wizard<TState extends Partial<Record<keyof TState, unknown>>> {
         }
     }
 
-    /**
-     * Creates a prompter for a wizard instance with memoization.
-     *
-     * @template TWizard - The type of wizard, must extend Wizard<TState>
-     * @template TState - The type of state managed by the wizard
-     *
-     * @param wizardClass - The wizard class constructor
-     * @param args - Constructor arguments for the wizard instance
-     *
-     * @returns A wizard prompter to be used as prompter
-     *
-     * @example
-     * // Create a prompter for SyncWizard
-     * const prompter = this.createWizardPrompter<SyncWizard, SyncParams>(
-     *     SyncWizard,
-     *     template.uri,
-     *     syncUrl
-     * )
-     *
-     * @remarks
-     * - Instances are memoized using a SHA-256 hash of the wizard class name and arguments
-     * - The same wizard instance is reused for identical constructor parameters for restoring wizard prompter
-     *   states during back button click event
-     */
-    protected createWizardPrompter<TWizard extends Wizard<TState>, TState>(
-        wizardClass: new (...args: any[]) => TWizard,
-        ...args: ConstructorParameters<new (...args: any[]) => TWizard>
-    ): Prompter<TState> {
-        const memoizeKey = createHash('sha256')
-            .update(wizardClass.name + JSON.stringify(args))
-            .digest('hex')
-
-        if (!this.childWizards.get(memoizeKey)) {
-            this.childWizards.set(memoizeKey, new wizardClass(...args))
-        }
-
-        return new WizardPrompter(this.childWizards.get(memoizeKey)) as Prompter<TState>
-    }
-
     /**
      * The offset is applied to both the current step and total number of steps. Useful if the wizard is
      * apart of some overarching flow.
diff --git a/packages/core/src/test/shared/wizards/nestedWizard.test.ts b/packages/core/src/test/shared/wizards/nestedWizard.test.ts
@@ -4,8 +4,8 @@
  */
 import * as vscode from 'vscode'
 import { createCommonButtons } from '../../../shared/ui/buttons'
+import { NestedWizard } from '../../../shared/ui/nestedWizardPrompter'
 import { createQuickPick, DataQuickPickItem } from '../../../shared/ui/pickerPrompter'
-import { Wizard } from '../../../shared/wizards/wizard'
 import * as assert from 'assert'
 import { PrompterTester } from './prompterTester'
 import { TestQuickPick } from '../vscode/quickInput'
@@ -40,7 +40,7 @@ export function createTestPrompter(title: string, itemsString: string[]) {
     return createQuickPick(items, { title: title, buttons: createCommonButtons() })
 }
 
-class ChildWizard extends Wizard<ChildWizardForm> {
+class ChildWizard extends NestedWizard<ChildWizardForm> {
     constructor() {
         super()
         this.form.childWizardProp1.bindPrompter(() =>
@@ -55,7 +55,7 @@ class ChildWizard extends Wizard<ChildWizardForm> {
     }
 }
 
-class SingleNestedWizard extends Wizard<SingleNestedWizardForm> {
+class SingleNestedWizard extends NestedWizard<SingleNestedWizardForm> {
     constructor() {
         super()
 
@@ -74,7 +74,7 @@ class SingleNestedWizard extends Wizard<SingleNestedWizardForm> {
     }
 }
 
-class DoubleNestedWizard extends Wizard<DoubleNestedWizardForm> {
+class DoubleNestedWizard extends NestedWizard<DoubleNestedWizardForm> {
     constructor() {
         super()
 
@@ -105,12 +105,12 @@ describe('NestedWizard', () => {
             +-- ChildWizard
             |   |
             |   +-- Prompter 1
-                    |   |
-                    |   +-- Prompter 2
-                    |   |
-                    |   +-- Prompter 3
-                    |
-                    +-- Prompter 3
+            |   |
+            |   +-- Prompter 2
+            |   |
+            |   +-- Prompter 3
+            |
+            +-- Prompter 3
          */
         const expectedCallOrders = [
             'SingleNestedWizard Prompter 1',
