/** * Regression for https://github.com/slidevjs/slidev/issues/2784 * * On Vite 8, invalidating `/@slidev/title-renderer.md` when it is present in the * client module graph but not `isSelfAccepting` dead-ends HMR and forces a full * page reload. Title-renderer only embeds slide titles, so body-only edits must * not invalidate it. */ import type { HotPayload } from 'vite' import { mkdtemp, rm, writeFile } from 'node:fs/promises' import { tmpdir } from 'node:os' import { join } from 'node:path' import { afterEach, describe, expect, it } from 'vitest' import { createServer, parser, resolveOptions } from '../packages/slidev/node' const TITLE_RENDERER_MD = '/@slidev/title-renderer.md' const ENTRY_MD = `--- theme: none title: HMR Repro --- # Hello Body text --- # Second More ` interface HmrCapture { fullReloads: Array> slideUpdates: number moduleSnapshots: Array> } function titleRendererInvalidated(capture: HmrCapture) { return capture.moduleSnapshots.some(snapshot => snapshot.some(m => m.id === TITLE_RENDERER_MD), ) } async function createReproServer(entry: string) { const options = await resolveOptions({ entry, theme: 'none' }, 'dev') const capture: HmrCapture = { fullReloads: [], slideUpdates: 0, moduleSnapshots: [], } const server = await createServer( options, { plugins: [{ name: 'slidev-title-renderer-hmr-capture', hotUpdate: { order: 'post', handler(ctx) { if (!ctx.modules.length) return capture.moduleSnapshots.push( ctx.modules.map(m => ({ id: m.id, isSelfAccepting: m.isSelfAccepting, })), ) }, }, configureServer(s) { const hot = s.environments.client.hot const send = hot.send.bind(hot) hot.send = ((...args: Parameters) => { const payload = args[0] if (payload && typeof payload === 'object' && payload.type === 'full-reload') capture.fullReloads.push(payload) if (typeof payload === 'string' && payload === 'slidev:update-slide') capture.slideUpdates += 1 return send(...args) }) as typeof hot.send }, }], server: { middlewareMode: true }, clearScreen: false, logLevel: 'error', }, { async loadData(loadedSource) { const loaded = await parser.load(options, options.entry, loadedSource, 'dev') return { ...loaded, themeMeta: options.data.themeMeta, config: parser.resolveConfig(loaded.headmatter, options.data.themeMeta, options.entry), } }, }, ) return { server, options, capture } } describe('title-renderer HMR (#2784)', () => { const cleanups: Array<() => Promise> = [] afterEach(async () => { while (cleanups.length) await cleanups.pop()!() }) it('does not full-reload on a body-only slides.md edit when title-renderer is in the module graph', async () => { const dir = await mkdtemp(join(tmpdir(), 'slidev-title-renderer-hmr-')) const entry = join(dir, 'slides.md') await writeFile(entry, ENTRY_MD) const { server, capture } = await createReproServer(entry) cleanups.push(async () => { await server.close() await rm(dir, { recursive: true, force: true }) }) // Mirror the Vite 8 client graph state from #2784: the virtual module exists // (e.g. after overview/goto loaded it) but is not yet self-accepting. const titleMod = await server.environments.client.moduleGraph.ensureEntryFromUrl(TITLE_RENDERER_MD) expect(titleMod.isSelfAccepting).toBe(false) await writeFile(entry, ENTRY_MD.replace('Body text', 'Body text changed')) await waitFor(() => capture.slideUpdates > 0 || capture.fullReloads.length > 0) expect(capture.slideUpdates, 'Slidev should still emit slidev:update-slide').toBeGreaterThan(0) expect(titleRendererInvalidated(capture), 'body-only edits must not invalidate title-renderer.md').toBe(false) expect( capture.fullReloads, [ 'body-only edits must not trigger Vite full-reload via title-renderer.md.', `HMR modules seen: ${JSON.stringify(capture.moduleSnapshots)}`, ].join(' '), ).toEqual([]) }, 20_000) it('still invalidates title-renderer.md when a slide title changes', async () => { const dir = await mkdtemp(join(tmpdir(), 'slidev-title-renderer-hmr-title-')) const entry = join(dir, 'slides.md') await writeFile(entry, ENTRY_MD) const { server, capture } = await createReproServer(entry) cleanups.push(async () => { await server.close() await rm(dir, { recursive: true, force: true }) }) await server.environments.client.moduleGraph.ensureEntryFromUrl(TITLE_RENDERER_MD) // Second slide title comes from its heading (no per-slide frontmatter title). await writeFile(entry, ENTRY_MD.replace('# Second', '# Second Renamed')) await waitFor(() => capture.slideUpdates > 0 || titleRendererInvalidated(capture)) expect(capture.slideUpdates).toBeGreaterThan(0) expect(titleRendererInvalidated(capture)).toBe(true) }, 20_000) }) async function waitFor(predicate: () => boolean, timeout = 5_000, interval = 50) { const start = Date.now() while (Date.now() - start < timeout) { if (predicate()) return await new Promise(r => setTimeout(r, interval)) } throw new Error(`Timed out after ${timeout}ms waiting for HMR activity`) }