mirror of
https://github.com/hashicorp/vault.git
synced 2026-05-04 20:06:27 +02:00
16f98c11ce
* adds constants util for wizards and updates service to use WizardId type * updates wizards to use WIZARD_ID_MAP values * updates wizard tests to use the service for dismissal * updates playwright setup to add all wizard ids as dismissed in localStorage * removes wizard dismissal step from existing playwright tests * fixes issues accessing owner in beforeEach hooks of namespaces acceptance tests Co-authored-by: Jordan Reimer <zofskeez@gmail.com>
98 lines
3.2 KiB
TypeScript
98 lines
3.2 KiB
TypeScript
/**
|
|
* Copyright IBM Corp. 2016, 2025
|
|
* SPDX-License-Identifier: BUSL-1.1
|
|
*/
|
|
|
|
import Service from '@ember/service';
|
|
import { tracked } from '@glimmer/tracking';
|
|
import localStorage from 'vault/lib/local-storage';
|
|
import { DISMISSED_WIZARD_KEY } from 'vault/utils/constants/wizard';
|
|
|
|
import type { WizardId } from 'vault/app-types';
|
|
|
|
/**
|
|
* WizardService manages the state of wizards across the application,
|
|
* particularly tracking which wizards have been dismissed by the user.
|
|
* This service provides a centralized way to check and update wizard
|
|
* dismissal state instead of directly accessing localStorage.
|
|
*/
|
|
export default class WizardService extends Service {
|
|
@tracked dismissedWizards: string[] = this.loadDismissedWizards();
|
|
@tracked introVisibleState: Record<string, boolean> = {};
|
|
|
|
/**
|
|
* Load dismissed wizards from localStorage
|
|
*/
|
|
private loadDismissedWizards(): string[] {
|
|
return localStorage.getItem(DISMISSED_WIZARD_KEY) ?? [];
|
|
}
|
|
|
|
/**
|
|
* Check if a specific wizard has been dismissed by the user
|
|
* @param wizardId - The unique identifier for the wizard
|
|
* @returns true if the wizard has been dismissed, false otherwise
|
|
*/
|
|
isDismissed(wizardId: WizardId): boolean {
|
|
return this.dismissedWizards.includes(wizardId);
|
|
}
|
|
|
|
/**
|
|
* Mark a wizard as dismissed
|
|
* @param wizardId - The unique identifier for the wizard to dismiss
|
|
*/
|
|
dismiss(wizardId: WizardId): void {
|
|
// Only add if not already dismissed
|
|
if (!this.dismissedWizards.includes(wizardId)) {
|
|
this.dismissedWizards = [...this.dismissedWizards, wizardId];
|
|
localStorage.setItem(DISMISSED_WIZARD_KEY, this.dismissedWizards);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clear the dismissed state for a specific wizard
|
|
* @param wizardId - The unique identifier for the wizard to reset
|
|
*/
|
|
reset(wizardId: WizardId): void {
|
|
this.dismissedWizards = this.dismissedWizards.filter((id: string) => id !== wizardId);
|
|
localStorage.setItem(DISMISSED_WIZARD_KEY, this.dismissedWizards);
|
|
// Reset intro visibility when wizard is reset
|
|
this.setIntroVisible(wizardId, true);
|
|
}
|
|
|
|
/**
|
|
* Clear all dismissed wizard states
|
|
*/
|
|
resetAll(): void {
|
|
this.dismissedWizards = [];
|
|
localStorage.removeItem(DISMISSED_WIZARD_KEY);
|
|
this.introVisibleState = {};
|
|
}
|
|
|
|
/**
|
|
* Check if the intro is visible for a specific wizard
|
|
* @param wizardId - The unique identifier for the wizard
|
|
* @returns true if the intro is visible, false otherwise (defaults to true if wizard not dismissed, false if dismissed)
|
|
*/
|
|
isIntroVisible(wizardId: WizardId): boolean {
|
|
// If intro visibility has been explicitly set, use that value
|
|
if (this.introVisibleState[wizardId] !== undefined) {
|
|
return this.introVisibleState[wizardId];
|
|
}
|
|
// Otherwise, default to true if wizard is not dismissed (first time showing)
|
|
// and false if wizard is dismissed
|
|
return !this.isDismissed(wizardId);
|
|
}
|
|
|
|
/**
|
|
* Set the intro visibility state for a specific wizard
|
|
* @param wizardId - The unique identifier for the wizard
|
|
* @param visible - Whether the intro should be visible
|
|
*/
|
|
setIntroVisible(wizardId: WizardId, visible: boolean): void {
|
|
this.introVisibleState = {
|
|
...this.introVisibleState,
|
|
[wizardId]: visible,
|
|
};
|
|
}
|
|
}
|