test: stabilize coverage shard native checks

Author: sansenjian

electron/DesktopLyricManager.ts

@@ -5,11 +5,9 @@ import type { SongPlatform } from '@shared/types/schemas'
 import { DEFAULT_APP_CONFIG, type AppConfig } from '@shared/contracts/config'
 import { RECEIVE_CHANNELS, type ReceiveChannel } from '@shared/protocol/channels'
 
+import { getElectronModule } from './utils/electronModule'
 import { MAIN_DIST, RENDERER_DIST } from './utils/paths'
 
-const getElectron = (): typeof import('electron') =>
-  require('electron') as typeof import('electron')
-
 type ElectronStoreInstance = {
   get(key: string): unknown
   set(key: string, value: unknown): void
@@ -219,7 +217,7 @@ export class DesktopLyricManager {
     this.isWindowReady = false
     this.isRendererReady = false
 
-    const { BrowserWindow, screen } = getElectron()
+    const { BrowserWindow, screen } = getElectronModule()
     const primaryDisplay = screen.getPrimaryDisplay()
     const { width, height } = primaryDisplay.workAreaSize
     const x = this.lastPosition ? this.lastPosition.x : Math.floor((width - 800) / 2)

electron/WindowManager.ts

@@ -5,13 +5,13 @@ import type {
   Rectangle,
   WebContents as WebContentsType
 } from 'electron'
-import { BrowserWindow, nativeImage } from 'electron'
 import path from 'node:path'
 
 import { downloadManager } from './DownloadManager'
 import logger from './logger'
 import { getWindowsShellIdentity, type WindowsShellIdentity } from './main/app'
 import { RECEIVE_CHANNELS } from '@shared/protocol/channels'
+import { getElectronModule } from './utils/electronModule'
 import { MAIN_DIST, RENDERER_DIST, VITE_PUBLIC } from './utils/paths'
 const StoreModule = require('electron-store') as {
   default?: new (options?: { projectName: string }) => {
@@ -92,6 +92,7 @@ export class WindowManager {
   }
 
   createWindow(): void {
+    const { BrowserWindow } = getElectronModule()
     const startedAt = Date.now()
     const width = this.lastSize ? this.lastSize.width : 1200
     const height = this.lastSize ? this.lastSize.height : 800
@@ -507,6 +508,7 @@ export class WindowManager {
       return
     }
 
+    const { nativeImage } = getElectronModule()
     const iconsPath = process.env.VITE_PUBLIC || path.join(__dirname, '../public')
     const buttons = [
       {

electron/utils/electronModule.ts

@@ -0,0 +1,18 @@
+type ElectronModule = typeof import('electron')
+
+type ElectronTestGlobal = typeof globalThis & {
+  __LUO_ELECTRON_TEST_MOCK__?: Partial<ElectronModule>
+}
+
+export function getElectronModule(): ElectronModule {
+  const testMock =
+    process.env.VITEST === 'true'
+      ? (globalThis as ElectronTestGlobal).__LUO_ELECTRON_TEST_MOCK__
+      : undefined
+
+  if (testMock) {
+    return testMock as ElectronModule
+  }
+
+  return require('electron') as ElectronModule
+}

scripts/test-audio-output-remote-refresh.cjs

@@ -17,6 +17,8 @@ const freshUrlEnv = "LUO_AUDIO_OUTPUT_REMOTE_FRESH_URL";
 const freshHeadersEnv = "LUO_AUDIO_OUTPUT_REMOTE_FRESH_HEADERS";
 const nativePlaybackEnv = "LUO_AUDIO_OUTPUT_REMOTE_NATIVE_PLAYBACK";
 const nativePlaybackModeEnv = "LUO_AUDIO_OUTPUT_REMOTE_NATIVE_MODE";
+const nativePlaybackSkipHelperEnv =
+  "LUO_AUDIO_OUTPUT_REMOTE_NATIVE_SKIP_HELPER";
 const nativePlaybackStates = new Set(["starting", "playing", "ended"]);
 const projectRoot = path.resolve(__dirname, "..");
 const protocolVersion = 2;
@@ -493,8 +495,6 @@ async function verifyNativePlaybackFromFreshAudio(scenario, options = {}) {
     };
   }
 
-  const helperInfo = prepareAudioOutputHelper({ projectRoot });
-
   const cacheDir = fs.mkdtempSync(path.join(os.tmpdir(), "luo-remote-native-"));
   const extension = extensionForContentType(
     wholeFresh.contentType,
@@ -503,6 +503,26 @@ async function verifyNativePlaybackFromFreshAudio(scenario, options = {}) {
   const cachePath = path.join(cacheDir, `fresh-audio${extension}`);
   fs.writeFileSync(cachePath, wholeFresh.bytes);
 
+  const nativeMode = normalizeNativePlaybackMode(
+    process.env[nativePlaybackModeEnv],
+  );
+
+  if (parseBooleanEnv(nativePlaybackSkipHelperEnv, false)) {
+    return {
+      attempted: true,
+      started: false,
+      cachePath,
+      extension,
+      bytesReceived: wholeFresh.bytesReceived,
+      bodySha256: wholeFresh.bodySha256,
+      contentType: wholeFresh.contentType,
+      requestedMode: nativeMode,
+      reason: `Native helper startup skipped by ${nativePlaybackSkipHelperEnv}.`,
+    };
+  }
+
+  const helperInfo = prepareAudioOutputHelper({ projectRoot });
+
   const helper = spawn(helperInfo.helperPath, [], {
     cwd: projectRoot,
     env: process.env,
@@ -511,9 +531,6 @@ async function verifyNativePlaybackFromFreshAudio(scenario, options = {}) {
   });
   const events = attachHelperEventParser(helper);
   const deviceId = process.env.LUO_AUDIO_OUTPUT_TEST_DEVICE_ID || "";
-  const nativeMode = normalizeNativePlaybackMode(
-    process.env[nativePlaybackModeEnv],
-  );
   const timeoutMs = parseIntegerEnv(
     "LUO_AUDIO_OUTPUT_REMOTE_NATIVE_TIMEOUT_MS",
     15_000,

tests/electron/DesktopLyricManager.test.ts

@@ -1,4 +1,4 @@
-import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { RECEIVE_CHANNELS } from '@shared/protocol/channels'
 
@@ -78,6 +78,9 @@ function setInternals(manager: DesktopLyricManager, patch: Partial<ManagerIntern
 }
 
 type DesktopLyricManager = import('../../electron/DesktopLyricManager').DesktopLyricManager
+type ElectronTestGlobal = typeof globalThis & {
+  __LUO_ELECTRON_TEST_MOCK__?: ReturnType<typeof createElectronMock>
+}
 
 function createMockWindow(
   overrides: { isVisible?: boolean } = {}
@@ -94,7 +97,7 @@ function createMockWindow(
 describe('DesktopLyricManager', () => {
   beforeEach(() => {
     vi.resetModules()
-    vi.doMock('electron', createElectronMock)
+    ;(globalThis as ElectronTestGlobal).__LUO_ELECTRON_TEST_MOCK__ = createElectronMock()
     vi.clearAllMocks()
     browserWindowInstances.length = 0
     storeData.clear()
@@ -103,6 +106,10 @@ describe('DesktopLyricManager', () => {
     delete process.env.LUO_DESKTOP_LYRIC_DEBUG
   })
 
+  afterEach(() => {
+    delete (globalThis as ElectronTestGlobal).__LUO_ELECTRON_TEST_MOCK__
+  })
+
   it('replays the last cached lyric when an existing ready window is shown', async () => {
     const { DesktopLyricManager } = await import('../../electron/DesktopLyricManager')
     const manager = new DesktopLyricManager()

tests/electron/windowManager.test.ts

@@ -128,13 +128,17 @@ vi.mock('../../electron/utils/paths', () => ({
   VITE_PUBLIC: '/public'
 }))
 
+type ElectronTestGlobal = typeof globalThis & {
+  __LUO_ELECTRON_TEST_MOCK__?: ReturnType<typeof createElectronMock>
+}
+
 describe('electron/WindowManager', () => {
   const platformDescriptor = Object.getOwnPropertyDescriptor(process, 'platform')
 
   beforeEach(() => {
     vi.useFakeTimers()
     vi.resetModules()
-    vi.doMock('electron', createElectronMock)
+    ;(globalThis as ElectronTestGlobal).__LUO_ELECTRON_TEST_MOCK__ = createElectronMock()
     vi.clearAllMocks()
     browserWindowInstances.length = 0
     delete process.env.VITE_DEV_SERVER_URL
@@ -146,6 +150,7 @@ describe('electron/WindowManager', () => {
 
   afterEach(() => {
     vi.useRealTimers()
+    delete (globalThis as ElectronTestGlobal).__LUO_ELECTRON_TEST_MOCK__
     delete process.env.VITE_DEV_SERVER_URL
     if (platformDescriptor) {
       Object.defineProperty(process, 'platform', platformDescriptor)

tests/scripts/audioOutputRemoteRefreshScript.test.ts

@@ -78,6 +78,7 @@ describe('audio output remote refresh script', () => {
         LUO_AUDIO_OUTPUT_REMOTE_FRESH_HEADERS: '',
         LUO_AUDIO_OUTPUT_REMOTE_REFRESH_REPORT: reportPath,
         LUO_AUDIO_OUTPUT_REMOTE_NATIVE_PLAYBACK: '1',
+        LUO_AUDIO_OUTPUT_REMOTE_NATIVE_SKIP_HELPER: '1',
         LUO_AUDIO_OUTPUT_REMOTE_NATIVE_TIMEOUT_MS: '5000'
       },
       timeout: 60_000
@@ -182,6 +183,7 @@ describe('audio output remote refresh script', () => {
     expect(script).toContain('resolveReportPathFromEnv')
     expect(script).toContain('LUO_AUDIO_OUTPUT_REMOTE_NATIVE_PLAYBACK')
     expect(script).toContain('LUO_AUDIO_OUTPUT_REMOTE_NATIVE_MODE')
+    expect(script).toContain('LUO_AUDIO_OUTPUT_REMOTE_NATIVE_SKIP_HELPER')
     expect(script).toContain('requestedMode: nativeMode')
     expect(script).toContain('mode: nativeMode')
     expect(script).toContain('writeReportIfRequested')