Testing: Speed up store tests by ~20s

vdavid · vdavid · commit dab071f5fd84 · 2026-03-22T12:34:31.000+01:00
- Replace `vi.resetModules()` + `loadModule()` pattern with static imports + `resetForTesting()` in `beforeEach` across `mtp-store`, `ai-state`, and `licensing-store` tests
- Add `resetForTesting()` to each store module, resetting state without re-parsing the full dependency tree
- Module import cost paid once instead of once per test (~8s saved per file)
- Document `resetForTesting()` maintenance requirement in colocated `CLAUDE.md` files
diff --git a/apps/desktop/src/lib/ai/CLAUDE.md b/apps/desktop/src/lib/ai/CLAUDE.md
@@ -58,6 +58,9 @@ provide checksums) — file size check only.
 - **Model switch requires app restart**: Changing selected model in Settings requires download + restart. No hot-swap.
 - **`opted_out` flag is legacy**: The `opted_out` field in `AiState` is superseded by `ai.provider` setting. It remains
   in the struct but is no longer checked. `ai.provider` in the frontend settings store is the source of truth.
+- **`resetForTesting()` must stay in sync with module state**: When adding new `$state` fields to `ai-state.svelte.ts`,
+  update `resetForTesting()` to clear them. Tests use this instead of `vi.resetModules()` to avoid ~8s module re-parse
+  penalty per test.
 
 ## Development
 
diff --git a/apps/desktop/src/lib/ai/ai-state.svelte.ts b/apps/desktop/src/lib/ai/ai-state.svelte.ts
@@ -34,6 +34,14 @@ export function getAiState(): AiStateData {
     return aiState
 }
 
+/** Resets all state to initial values. For use in tests only. */
+export function resetForTesting(): void {
+    aiState.notificationState = 'hidden'
+    aiState.downloadProgress = null
+    aiState.progressText = ''
+    aiState.modelInfo = null
+}
+
 export async function initAiState(): Promise<() => void> {
     // Don't show toast when provider is off or openai-compatible
     const aiProvider = getSetting('ai.provider')
diff --git a/apps/desktop/src/lib/ai/ai-state.test.ts b/apps/desktop/src/lib/ai/ai-state.test.ts
@@ -16,6 +16,15 @@ vi.mock('$lib/tauri-commands', async () => {
 })
 
 import { getAiStatus, getAiModelInfo, startAiDownload, cancelAiDownload, dismissAiOffer } from '$lib/tauri-commands'
+import {
+    getAiState,
+    initAiState,
+    handleDownload,
+    handleCancel,
+    handleDismiss,
+    handleGotIt,
+    resetForTesting,
+} from './ai-state.svelte'
 
 const mockModelInfo = {
     id: 'ministral-3b-instruct-q4km',
@@ -29,28 +38,22 @@ const mockModelInfo = {
 describe('ai-state', () => {
     beforeEach(() => {
         vi.clearAllMocks()
-        vi.resetModules()
+        resetForTesting()
     })
 
-    async function loadModule() {
-        return await import('./ai-state.svelte')
-    }
-
     describe('getAiState', () => {
-        it('returns initial hidden state', async () => {
-            const { getAiState } = await loadModule()
+        it('returns initial hidden state', () => {
             const state = getAiState()
             expect(state.notificationState).toBe('hidden')
             expect(state.downloadProgress).toBeNull()
             expect(state.progressText).toBe('')
-        }, 15_000)
+        })
     })
 
     describe('initAiState', () => {
         it('sets offer state when status is offer', async () => {
             vi.mocked(getAiStatus).mockResolvedValue('offer')
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
-            const { initAiState, getAiState } = await loadModule()
 
             await initAiState()
 
@@ -61,7 +64,6 @@ describe('ai-state', () => {
         it('stays hidden when status is available', async () => {
             vi.mocked(getAiStatus).mockResolvedValue('available')
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
-            const { initAiState, getAiState } = await loadModule()
 
             await initAiState()
 
@@ -72,7 +74,6 @@ describe('ai-state', () => {
         it('stays hidden when status is unavailable', async () => {
             vi.mocked(getAiStatus).mockResolvedValue('unavailable')
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
-            const { initAiState, getAiState } = await loadModule()
 
             await initAiState()
 
@@ -91,7 +92,6 @@ describe('ai-state', () => {
                 .mockResolvedValueOnce(unlistenFns[3])
                 .mockResolvedValueOnce(unlistenFns[4])
 
-            const { initAiState } = await loadModule()
             const cleanup = await initAiState()
 
             expect(listen).toHaveBeenCalledTimes(5)
@@ -114,7 +114,6 @@ describe('ai-state', () => {
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
             vi.mocked(startAiDownload).mockResolvedValue(undefined)
 
-            const { initAiState, handleDownload, getAiState } = await loadModule()
             await initAiState()
 
             await handleDownload()
@@ -129,7 +128,6 @@ describe('ai-state', () => {
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
             vi.mocked(startAiDownload).mockRejectedValue(new Error('Network error'))
 
-            const { initAiState, handleDownload, getAiState } = await loadModule()
             await initAiState()
 
             await handleDownload()
@@ -146,7 +144,6 @@ describe('ai-state', () => {
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
             vi.mocked(cancelAiDownload).mockResolvedValue(undefined)
 
-            const { initAiState, handleCancel, getAiState } = await loadModule()
             await initAiState()
 
             await handleCancel()
@@ -164,7 +161,6 @@ describe('ai-state', () => {
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
             vi.mocked(dismissAiOffer).mockResolvedValue(undefined)
 
-            const { initAiState, handleDismiss, getAiState } = await loadModule()
             await initAiState()
             expect(getAiState().notificationState).toBe('offer')
 
@@ -179,7 +175,6 @@ describe('ai-state', () => {
         it('hides the notification', async () => {
             vi.mocked(getAiStatus).mockResolvedValue('offer')
             vi.mocked(getAiModelInfo).mockResolvedValue(mockModelInfo)
-            const { initAiState, handleGotIt, getAiState } = await loadModule()
             await initAiState()
 
             handleGotIt()
@@ -200,7 +195,6 @@ describe('ai-state', () => {
                 return Promise.resolve(() => {})
             })
 
-            const { initAiState, getAiState } = await loadModule()
             await initAiState()
 
             progressCallback?.({
@@ -224,7 +218,6 @@ describe('ai-state', () => {
                 return Promise.resolve(() => {})
             })
 
-            const { initAiState, getAiState } = await loadModule()
             await initAiState()
 
             progressCallback?.({ payload: { bytesDownloaded: 0, totalBytes: 0, speed: 0, etaSeconds: 0 } })
@@ -244,7 +237,6 @@ describe('ai-state', () => {
                 return Promise.resolve(() => {})
             })
 
-            const { initAiState, getAiState } = await loadModule()
             await initAiState()
 
             installingCallback?.()
@@ -265,7 +257,6 @@ describe('ai-state', () => {
                 return Promise.resolve(() => {})
             })
 
-            const { initAiState, getAiState } = await loadModule()
             await initAiState()
 
             completeCallback?.()
diff --git a/apps/desktop/src/lib/licensing/CLAUDE.md b/apps/desktop/src/lib/licensing/CLAUDE.md
@@ -52,6 +52,9 @@ dismiss). The About window and modals read the cached value on mount.
 
 ## Gotchas
 
+- **`resetForTesting()` must stay in sync with module state** — when adding new fields to `licenseState` in
+  `licensing-store.svelte.ts`, update `resetForTesting()` to clear them. Tests use this instead of `vi.resetModules()`
+  to avoid module re-parse penalty per test.
 - **Mock mode only in debug builds** — `CMDR_MOCK_LICENSE` env var bypasses validation. Silently ignored in release.
 - **Ed25519 public key embedded** — hardcoded in `verification.rs`. Must match license server's private key.
 - **Commercial reminder timing** — tracked in `license.json` via `firstRunTimestamp`. Shows 30 days after first launch,
diff --git a/apps/desktop/src/lib/licensing/licensing-store.svelte.ts b/apps/desktop/src/lib/licensing/licensing-store.svelte.ts
@@ -20,6 +20,13 @@ const licenseState = {
     pendingVerification: false,
 }
 
+/** Resets all state to initial values. For use in tests only. */
+export function resetForTesting(): void {
+    licenseState.cachedStatus = null
+    licenseState.shouldShowModal = false
+    licenseState.pendingVerification = false
+}
+
 /**
  * Loads the license status from the backend.
  * Should be called once at app startup.
diff --git a/apps/desktop/src/lib/licensing/licensing.test.ts b/apps/desktop/src/lib/licensing/licensing.test.ts
@@ -9,6 +9,12 @@ vi.mock('$lib/tauri-commands', () => ({
 
 import type { LicenseStatus } from '$lib/tauri-commands'
 import { getLicenseStatus, needsLicenseValidation, validateLicenseWithServer } from '$lib/tauri-commands'
+import {
+    getCachedStatus,
+    loadLicenseStatus,
+    triggerValidationIfNeeded,
+    resetForTesting,
+} from './licensing-store.svelte'
 
 const personalStatus: LicenseStatus = { type: 'personal', showCommercialReminder: false }
 const commercialStatus: LicenseStatus = {
@@ -27,24 +33,18 @@ const expiredStatus: LicenseStatus = {
 describe('licensing-store', () => {
     beforeEach(() => {
         vi.clearAllMocks()
-        vi.resetModules()
+        resetForTesting()
     })
 
-    async function loadStore() {
-        return await import('./licensing-store.svelte')
-    }
-
     describe('getCachedStatus', () => {
-        it('returns null before status is loaded', async () => {
-            const { getCachedStatus } = await loadStore()
+        it('returns null before status is loaded', () => {
             expect(getCachedStatus()).toBeNull()
-        }, 15_000)
+        })
     })
 
     describe('loadLicenseStatus', () => {
         it('fetches status from backend and caches it', async () => {
             vi.mocked(getLicenseStatus).mockResolvedValue(personalStatus)
-            const { loadLicenseStatus, getCachedStatus } = await loadStore()
 
             const result = await loadLicenseStatus()
 
@@ -56,7 +56,6 @@ describe('licensing-store', () => {
     describe('triggerValidationIfNeeded', () => {
         it('skips validation when not needed', async () => {
             vi.mocked(needsLicenseValidation).mockResolvedValue(false)
-            const { triggerValidationIfNeeded } = await loadStore()
 
             const result = await triggerValidationIfNeeded()
 
@@ -67,7 +66,6 @@ describe('licensing-store', () => {
         it('validates with server and updates cache when needed', async () => {
             vi.mocked(needsLicenseValidation).mockResolvedValue(true)
             vi.mocked(validateLicenseWithServer).mockResolvedValue(commercialStatus)
-            const { triggerValidationIfNeeded, getCachedStatus } = await loadStore()
 
             const result = await triggerValidationIfNeeded()
 
@@ -79,7 +77,6 @@ describe('licensing-store', () => {
             vi.mocked(getLicenseStatus).mockResolvedValue(personalStatus)
             vi.mocked(needsLicenseValidation).mockResolvedValue(true)
             vi.mocked(validateLicenseWithServer).mockRejectedValue(new Error('Network error'))
-            const { loadLicenseStatus, triggerValidationIfNeeded, getCachedStatus } = await loadStore()
 
             await loadLicenseStatus()
             const result = await triggerValidationIfNeeded()
@@ -91,7 +88,6 @@ describe('licensing-store', () => {
         it('caches expired status from server validation', async () => {
             vi.mocked(needsLicenseValidation).mockResolvedValue(true)
             vi.mocked(validateLicenseWithServer).mockResolvedValue(expiredStatus)
-            const { triggerValidationIfNeeded, getCachedStatus } = await loadStore()
 
             const result = await triggerValidationIfNeeded()
 
diff --git a/apps/desktop/src/lib/mtp/CLAUDE.md b/apps/desktop/src/lib/mtp/CLAUDE.md
@@ -64,3 +64,6 @@ clipboard requires local file paths, which MTP virtual paths can't provide — t
   device. Not granular (don't know which directory changed without extra MTP calls).
 - **30-second timeout is intentional**: Some Android devices are slow (USB 2.0, old hardware). MTP operations have 30s
   timeout, not the usual 10s.
+- **`resetForTesting()` must stay in sync with module state**: When adding new module-level state to
+  `mtp-store.svelte.ts`, update `resetForTesting()` to clear it. Tests use this instead of `vi.resetModules()` to avoid
+  ~8s module re-parse penalty per test.
diff --git a/apps/desktop/src/lib/mtp/mtp-store.svelte.ts b/apps/desktop/src/lib/mtp/mtp-store.svelte.ts
@@ -364,6 +364,21 @@ export async function initialize(): Promise<void> {
     logger.debug('MTP store initialized')
 }
 
+/** Resets all state to initial values. For use in tests only. */
+export function resetForTesting(): void {
+    state = {
+        devices: new SvelteMap(),
+        initialized: false,
+        scanning: false,
+    }
+    unlistenConnected = undefined
+    unlistenDisconnected = undefined
+    unlistenExclusiveAccess = undefined
+    unlistenPermissionError = undefined
+    unlistenDeviceDetected = undefined
+    unlistenDeviceRemoved = undefined
+}
+
 /**
  * Cleans up the MTP store.
  * Should be called when the app is shutting down.
diff --git a/apps/desktop/src/lib/mtp/mtp-store.test.ts b/apps/desktop/src/lib/mtp/mtp-store.test.ts
