Merge pull request #113 from gravity-ui/turn-on-onboarding

fix(onboarding): wizard-plugin fix turn on behavior

src/controller.ts

@@ -218,7 +218,7 @@ export class Controller<HintParams, Presets extends string, Steps extends string
         const allowRun = await this.events.emit('beforeShowHint', {stepData});
 
         if (!this.state.base.enabled) {
-            this.logger.debug('Wizard is not active', preset, stepSlug);
+            this.logger.debug('Onboarding is not enabled', preset, stepSlug);
             return;
         }
 

src/plugins/wizard-plugin.test.ts

@@ -41,6 +41,32 @@ describe('open wizard', function () {
         expect(options.getProgressState).toHaveBeenCalled();
     });
 
+    it('onboarding disabled, wizard hidden -> turn on onboarding', async function () {
+        const options = getOptions({enabled: false, wizardState: 'hidden'});
+        options.plugins = [new WizardPlugin()];
+
+        const controller = new Controller(options);
+
+        await controller.setWizardState('visible');
+
+        expect(controller.state.base.enabled).toBe(true);
+    });
+
+    it('onboarding disabled, wizard hidden -> can show hint', async function () {
+        const options = getOptions({enabled: false, wizardState: 'hidden'});
+        options.plugins = [new WizardPlugin()];
+
+        const controller = new Controller(options);
+
+        await controller.stepElementReached({
+            stepSlug: 'createSprint',
+            element: getAnchorElement(),
+        });
+        await controller.setWizardState('visible');
+
+        expect(controller.hintStore.state.open).toBe(true);
+    });
+
     it('onboarding enabled, wizard hidden -> load progress on open', async function () {
         const options = getOptions({wizardState: 'hidden'});
         options.plugins = [new WizardPlugin()];

src/plugins/wizard-plugin.ts

@@ -32,7 +32,11 @@ export class WizardPlugin implements OnboardingPlugin {
         }
 
         if (wizardState === 'visible' || wizardState === 'collapsed') {
+            this.onboardingInstance.state.base.enabled = true;
+            this.onboardingInstance.emitStateChange();
+
             await this.onboardingInstance.ensureRunning();
+            this.onboardingInstance.checkReachedHints();
         }
 
         if (wizardState === 'hidden') {