Merge pull request #50 from gravity-ui/add-full-reset

feat: add resetToDefaultState method
gravity-ui · Feb 21, 2024 · 79290f4 · 79290f4
2 parents 31c2346 + 22db0b0
commit 79290f4
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 12 deletions.
diff --git a/src/controller.ts b/src/controller.ts
@@ -8,6 +8,18 @@ type Listener = () => void;
 
 let instanceCounter = 0;
 
+const getDefaultBaseState = (): BaseState => ({
+    availablePresets: [],
+    activePresets: [],
+    suggestedPresets: [],
+    wizardState: 'hidden' as const,
+});
+
+const getDefaultProgressState = () => ({
+    presetPassedSteps: {},
+    finishedPresets: [],
+});
+
 export class Controller<HintParams, Presets extends string, Steps extends string> {
     static findNextUnpassedStep(presetSteps: string[], passedSteps: string[]): string | undefined {
         if (!presetSteps) {
@@ -61,15 +73,9 @@ export class Controller<HintParams, Presets extends string, Steps extends string
     ) {
         this.options = options;
 
-        const defaultBaseState: BaseState = {
-            availablePresets: [],
-            activePresets: [],
-            suggestedPresets: [],
-            wizardState: 'hidden' as const,
-        };
         this.state = {
             base: {
-                ...defaultBaseState,
+                ...getDefaultBaseState(),
                 ...options.baseState,
             },
         };
@@ -459,14 +465,10 @@ export class Controller<HintParams, Presets extends string, Steps extends string
 
         this.logger.debug('Loading onboarding progress data');
         try {
-            const defaultProgress = {
-                presetPassedSteps: {},
-                finishedPresets: [],
-            };
             const newProgressState = await this.progressLoadingPromise;
 
             this.state.progress = {
-                ...defaultProgress,
+                ...getDefaultProgressState(),
                 ...newProgressState,
             };
             this.status = 'active';
@@ -478,6 +480,16 @@ export class Controller<HintParams, Presets extends string, Steps extends string
         }
     }
 
+    async resetToDefaultState() {
+        this.state = {
+            base: getDefaultBaseState(),
+            progress: getDefaultProgressState(),
+        };
+
+        await this.updateBaseState();
+        await this.updateProgress();
+    }
+
     private closeHint = (stepSlug?: Steps) => {
         const currentHintStep = this.hintStore.state.hint?.step.slug;
         this.logger.debug('Close hint(internal)', currentHintStep);

diff --git a/src/tests/controller.test.ts b/src/tests/controller.test.ts
@@ -292,3 +292,25 @@ describe('store api', function () {
         });
     });
 });
+
+it('resetToDefaultState -> hidden and empty ', async function () {
+    const options = getOptions();
+
+    const controller = new Controller(options);
+    await controller.ensureRunning();
+
+    await controller.resetToDefaultState();
+
+    expect(controller.state).toEqual({
+        base: {
+            activePresets: [],
+            availablePresets: [],
+            suggestedPresets: [],
+            wizardState: 'hidden',
+        },
+        progress: {
+            finishedPresets: [],
+            presetPassedSteps: {},
+        },
+    });
+});