Files
api/web/__test__/components/Activation/ActivationModal.test.ts
Eli Bosley 3b00fec5fd chore: Remove legacy store modules and add new API key and reporting services (#1536)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added developer CLI tools for toggling GraphQL sandbox and modal
testing utilities.
* Introduced a "Show Activation Modal" developer component for UI
testing.
  * Added system initial setup detection and related GraphQL queries.
* Enhanced login and welcome pages with dynamic server info and initial
setup state.
  * Improved SSO button with internationalization and error handling.
* Added internal CLI admin API key management service and internal
GraphQL client service.
* Introduced comprehensive API report generation service for system and
service status.
* Added CLI commands and GraphQL mutations/queries for plugin and SSO
user management.
* Added new modal target components and improved teleport target
detection.

* **Enhancements**
* Refined modal dialog targeting and teleportation for flexible UI
placement.
* Updated modal components and stores for improved activation/welcome
modal control.
  * Improved plugin and SSO user management via CLI through GraphQL API.
* Refactored partner logo components to use props instead of store
dependencies.
  * Enhanced styling and accessibility for buttons and modals.
* Streamlined Tailwind CSS integration with shared styles and updated
theme variables.
* Improved GraphQL module configuration to avoid directive conflicts in
tests.
  * Adjusted Vite config for better dependency handling in test mode.
  * Improved error handling and logging in CLI commands and services.
* Reordered imports and refined component class bindings for UI
consistency.

* **Bug Fixes**
* Resolved issues with duplicate script tags and component registration
in the web UI.
* Fixed modal close button visibility and activation modal state
handling.
* Added error handling and logging improvements across CLI commands and
services.
  * Fixed newline issues in last-download-time fixture files.

* **Chores**
* Added and updated numerous tests for CLI commands, services, and UI
components.
* Updated translation files and localization resources for new UI
messages.
* Adjusted environment, configuration, and dependency files for improved
development and test workflows.
  * Cleaned up unused imports and mocks in tests.
  * Reorganized exports and barrel files in shared and UI modules.
  * Added integration and dependency resolution tests for core modules.

* **Removals & Refactoring**
* Removed legacy Redux state management, configuration, and UPnP logic
from the backend.
* Eliminated deprecated GraphQL subscriptions and client code related to
registration and mothership.
* Removed direct store manipulation and replaced with service-based
approaches in CLI commands.
  * Deleted unused or redundant test files and configuration listeners.
* Refactored SSO user service to consolidate add/remove operations into
a single update method.
* Simplified API key services with new methods for automatic key
management.
* Replaced direct plugin and SSO user service calls with GraphQL client
interactions in CLI commands.
* Removed complex theme fallback and dark mode CSS rules, replacing with
streamlined static theme variables.
* Cleaned up Tailwind CSS configuration and removed deprecated local
styles.
* Removed multiple internal utility files and replaced with simplified
or centralized implementations.
* Removed deprecated local configuration and synchronization files and
listeners.
  * Removed UPnP helper functions and job management classes.
* Refactored server resolver to dynamically construct local server data
internally.
* Removed CORS handler and replaced with simplified or externalized
logic.
* Removed store synchronization and registration event pubsub handling.
* Removed GraphQL client creation utilities for internal API
communication.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-07-25 15:07:37 -04:00

254 lines
6.8 KiB
TypeScript

/**
* Activation Modal Component Test Coverage
*/
import { ref } from 'vue';
import { mount } from '@vue/test-utils';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import type { ComposerTranslation } from 'vue-i18n';
import ActivationModal from '~/components/Activation/ActivationModal.vue';
vi.mock('@unraid/ui', async (importOriginal) => {
const actual = await importOriginal<typeof import('@unraid/ui')>();
return {
...actual,
Dialog: {
name: 'Dialog',
props: ['modelValue', 'title', 'description', 'showFooter', 'size', 'showCloseButton'],
emits: ['update:modelValue'],
template: `
<div v-if="modelValue" role="dialog" aria-modal="true">
<div v-if="$slots.header" class="dialog-header"><slot name="header" /></div>
<div class="dialog-body"><slot /></div>
<div v-if="$slots.footer" class="dialog-footer"><slot name="footer" /></div>
</div>
`,
},
BrandButton: {
template:
'<button data-testid="brand-button" :type="type" @click="$emit(\'click\')"><slot /></button>',
props: ['text', 'iconRight', 'variant', 'external', 'href', 'size', 'type'],
emits: ['click'],
},
};
});
const mockT = (key: string, args?: unknown[]) => (args ? `${key} ${JSON.stringify(args)}` : key);
const mockComponents = {
ActivationPartnerLogo: {
template: '<div data-testid="partner-logo"></div>',
props: ['partnerInfo'],
},
ActivationSteps: {
template: '<div data-testid="activation-steps" :active-step="activeStep"></div>',
props: ['activeStep'],
},
};
const mockActivationCodeDataStore = {
partnerInfo: ref({
hasPartnerLogo: false,
partnerName: null as string | null,
}),
};
let handleKeydown: ((e: KeyboardEvent) => void) | null = null;
const mockActivationCodeModalStore = {
isVisible: ref(true),
setIsHidden: vi.fn((value: boolean) => {
if (value === true) {
window.location.href = '/Tools/Registration';
}
}),
// This gets defined after we mock the store
_store: null as unknown,
};
const mockPurchaseStore = {
activate: vi.fn(),
};
// Mock all imports
vi.mock('vue-i18n', () => ({
useI18n: () => ({
t: mockT,
}),
}));
vi.mock('~/components/Activation/store/activationCodeModal', () => {
const store = {
useActivationCodeModalStore: () => {
mockActivationCodeModalStore._store = mockActivationCodeModalStore;
return mockActivationCodeModalStore;
},
};
return store;
});
vi.mock('~/components/Activation/store/activationCodeData', () => ({
useActivationCodeDataStore: () => mockActivationCodeDataStore,
}));
vi.mock('~/store/purchase', () => ({
usePurchaseStore: () => mockPurchaseStore,
}));
vi.mock('~/store/theme', () => ({
useThemeStore: vi.fn(),
}));
vi.mock('@heroicons/vue/24/solid', () => ({
ArrowTopRightOnSquareIcon: {},
}));
const originalAddEventListener = window.addEventListener;
window.addEventListener = vi.fn((event: string, handler: EventListenerOrEventListenerObject) => {
if (event === 'keydown') {
handleKeydown = handler as unknown as (e: KeyboardEvent) => void;
}
return originalAddEventListener(event, handler);
});
describe('Activation/ActivationModal.vue', () => {
beforeEach(() => {
vi.clearAllMocks();
mockActivationCodeDataStore.partnerInfo.value = {
hasPartnerLogo: false,
partnerName: null,
};
mockActivationCodeModalStore.isVisible.value = true;
// Reset window.location
Object.defineProperty(window, 'location', {
writable: true,
value: { href: '' },
});
handleKeydown = null;
});
const mountComponent = () => {
return mount(ActivationModal, {
props: { t: mockT as unknown as ComposerTranslation },
global: {
stubs: mockComponents,
},
});
};
it('uses the correct title text', () => {
mountComponent();
expect(mockT("Let's activate your Unraid OS License")).toBe("Let's activate your Unraid OS License");
});
it('uses the correct description text', () => {
mountComponent();
const descriptionText = mockT(
`On the following screen, your license will be activated. You'll then create an Unraid.net Account to manage your license going forward.`
);
expect(descriptionText).toBe(
"On the following screen, your license will be activated. You'll then create an Unraid.net Account to manage your license going forward."
);
});
it('provides documentation links with correct URLs', () => {
mountComponent();
const licensingText = mockT('More about Licensing');
const accountsText = mockT('More about Unraid.net Accounts');
expect(licensingText).toBe('More about Licensing');
expect(accountsText).toBe('More about Unraid.net Accounts');
});
it('displays the partner logo when available', () => {
mockActivationCodeDataStore.partnerInfo.value = {
hasPartnerLogo: true,
partnerName: 'partner-name',
};
const wrapper = mountComponent();
expect(wrapper.html()).toContain('data-testid="partner-logo"');
});
it('calls activate method when Activate Now button is clicked', async () => {
const wrapper = mountComponent();
const button = wrapper.find('[data-testid="brand-button"]');
expect(button.exists()).toBe(true);
await button.trigger('click');
expect(mockPurchaseStore.activate).toHaveBeenCalledTimes(1);
});
it('handles Konami code sequence to close modal and redirect', async () => {
mountComponent();
if (!handleKeydown) {
return;
}
const konamiCode = [
'ArrowUp',
'ArrowUp',
'ArrowDown',
'ArrowDown',
'ArrowLeft',
'ArrowRight',
'ArrowLeft',
'ArrowRight',
'b',
'a',
];
for (const key of konamiCode) {
handleKeydown(new KeyboardEvent('keydown', { key }));
}
expect(mockActivationCodeModalStore.setIsHidden).toHaveBeenCalledWith(true);
expect(window.location.href).toBe('/Tools/Registration');
});
it('does not trigger konami code action for incorrect sequence', async () => {
mountComponent();
if (!handleKeydown) {
return;
}
const incorrectSequence = ['ArrowUp', 'ArrowDown', 'b', 'a'];
for (const key of incorrectSequence) {
handleKeydown(new KeyboardEvent('keydown', { key }));
}
expect(mockActivationCodeModalStore.setIsHidden).not.toHaveBeenCalled();
expect(window.location.href).toBe('');
});
it('does not render when isVisible is false', () => {
mockActivationCodeModalStore.isVisible.value = false;
const wrapper = mountComponent();
expect(wrapper.find('[role="dialog"]').exists()).toBe(false);
});
it('renders activation steps with correct active step', () => {
const wrapper = mountComponent();
expect(wrapper.html()).toContain('data-testid="activation-steps"');
expect(wrapper.html()).toContain('active-step="2"');
});
});