Yichen Jiang
85a3a158dd
Review round three found the provider's write path could destroy state it never observed: - Watcher reloads and document writes ran on two independent promise chains, and a write rendered the whole next document from the cached text. An external edit still inside the debounce window (or missed outright) was overwritten, and the follow-up reload no-oped because the post-rename content matched the cache — the edit vanished without a trace. Reloads and writes now share one operation chain, and every write starts by reconciling the on-disk text into the seam before rendering, so unobserved sibling sections survive and publish first. An unparsable on-disk document fails the write loud instead of being overwritten. - The initial load raced the watcher's own setup: a change written between that read and the watcher becoming active never fired an event. The watcher's ready signal now queues one reconcile, closing the gap. - Two processes sharing a harness home rendered from independent caches, last writer winning. Writes now hold a wx-created <file>.lock sibling around the read-render-rename cycle with bounded backoff, a crashed- holder stale takeover, and a deadline failure; readers stay lock-free because the rename commit is atomic. - renderYaml replaced the whole namespace node, dropping every comment inside the section. The next section now lands as a leaf-level diff (set changed values, delete removed keys), so comments, anchors, and formatting survive on every untouched node and on the key of every changed pair; arrays still replace wholesale when unequal.
226 lines
8.9 KiB
TypeScript
226 lines
8.9 KiB
TypeScript
import { afterEach, describe, expect, it, vi } from 'vitest'
|
|
import { Context } from 'cordis'
|
|
import z from 'schemastery'
|
|
import { chmod, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
|
|
import { tmpdir } from 'node:os'
|
|
import { join } from 'node:path'
|
|
import { settingsNamespace } from '@deepseek-ai/dsh-settings'
|
|
import { SettingsLocal } from '../src/index.ts'
|
|
|
|
// chokidar is the nondeterministic OS boundary: faking it lets these tests
|
|
// drive the event pipeline (error events, races with unreadable files)
|
|
// deterministically. Real end-to-end watching stays covered by local.spec.ts.
|
|
vi.mock('chokidar', async () => {
|
|
const { EventEmitter } = await import('node:events')
|
|
class FakeWatcher extends EventEmitter {
|
|
close = vi.fn(() => Promise.resolve())
|
|
}
|
|
const instances: Array<{ path: string; options: unknown; watcher: InstanceType<typeof FakeWatcher> }> = []
|
|
return {
|
|
watch: vi.fn((path: string, options: unknown) => {
|
|
const watcher = new FakeWatcher()
|
|
instances.push({ path, options, watcher })
|
|
return watcher
|
|
}),
|
|
__instances: instances,
|
|
}
|
|
})
|
|
|
|
interface FakeChokidar {
|
|
__instances: Array<{
|
|
path: string
|
|
options: { awaitWriteFinish: { stabilityThreshold: number; pollInterval: number } }
|
|
watcher: import('node:events').EventEmitter
|
|
}>
|
|
}
|
|
|
|
async function fakeInstances(): Promise<FakeChokidar['__instances']> {
|
|
const chokidar = await import('chokidar') as unknown as FakeChokidar
|
|
return chokidar.__instances
|
|
}
|
|
|
|
const ThemeSchema: z<{ theme: string }> = z.object({
|
|
theme: z.string().default('dark'),
|
|
})
|
|
|
|
const cleanups: Array<() => Promise<void>> = []
|
|
|
|
afterEach(async () => {
|
|
while (cleanups.length > 0) await cleanups.pop()!()
|
|
;(await fakeInstances()).length = 0
|
|
})
|
|
|
|
async function tempDir(): Promise<string> {
|
|
const dir = await mkdtemp(join(tmpdir(), 'dsh-settings-watch-'))
|
|
cleanups.push(() => rm(dir, { recursive: true, force: true }))
|
|
return dir
|
|
}
|
|
|
|
async function boot(config: ConstructorParameters<typeof SettingsLocal>[1]): Promise<Context> {
|
|
const ctx = new Context()
|
|
const fiber = ctx.plugin(SettingsLocal, config)
|
|
cleanups.push(async () => { await fiber.dispose() })
|
|
await fiber
|
|
return ctx
|
|
}
|
|
|
|
describe('watcher pipeline', () => {
|
|
it('clamps the write-settle poll interval for a zero debounce', async () => {
|
|
const dir = await tempDir()
|
|
await boot({ path: join(dir, 'settings.yaml'), debounceMs: 0 })
|
|
const [instance] = await fakeInstances()
|
|
expect(instance!.options.awaitWriteFinish).toEqual({ stabilityThreshold: 0, pollInterval: 1 })
|
|
})
|
|
|
|
it('survives a watcher error and keeps publishing later edits', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const scope = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
const [instance] = await fakeInstances()
|
|
|
|
instance!.watcher.emit('error', new Error('watch backend failure'))
|
|
expect(scope.get()).toEqual({ theme: 'dark' })
|
|
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
instance!.watcher.emit('all', 'change', path)
|
|
await vi.waitFor(() => {
|
|
expect(scope.get()).toEqual({ theme: 'light' })
|
|
})
|
|
})
|
|
|
|
it('keeps the last good document when the file turns unreadable at runtime', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const scope = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
|
|
await chmod(path, 0o000)
|
|
cleanups.push(() => chmod(path, 0o600))
|
|
const [instance] = await fakeInstances()
|
|
instance!.watcher.emit('all', 'change', path)
|
|
// The warn-and-keep path is asynchronous; give the serialized refresh a turn.
|
|
await new Promise(resolve => setTimeout(resolve, 50))
|
|
expect(scope.get()).toEqual({ theme: 'light' })
|
|
})
|
|
|
|
it('keeps the reload queue alive after an invariant violation escapes a commit', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const scope = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
let arm = true
|
|
ctx.on('settings/updated', () => {
|
|
if (!arm) return
|
|
throw Object.assign(new Error('forged relation'), { code: 'INVARIANT' })
|
|
})
|
|
const [instance] = await fakeInstances()
|
|
|
|
await writeFile(path, 'ui-theme:\n theme: broken-commit\n')
|
|
instance!.watcher.emit('all', 'change', path)
|
|
await vi.waitFor(() => {
|
|
expect(scope.get().theme).toBe('broken-commit')
|
|
})
|
|
|
|
arm = false
|
|
await writeFile(path, 'ui-theme:\n theme: recovered\n')
|
|
instance!.watcher.emit('all', 'change', path)
|
|
await vi.waitFor(() => {
|
|
expect(scope.get().theme).toBe('recovered')
|
|
})
|
|
})
|
|
|
|
it('quiesces the refresh pipeline before dispose completes', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
const ctx = new Context()
|
|
const fiber = ctx.plugin(SettingsLocal, { path, debounceMs: 5 })
|
|
await fiber
|
|
ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
let disposed = false
|
|
let postDisposeCommits = 0
|
|
ctx.on('settings/updated', () => {
|
|
if (disposed) postDisposeCommits += 1
|
|
})
|
|
|
|
await writeFile(path, 'ui-theme:\n theme: darker\n')
|
|
const [instance] = await fakeInstances()
|
|
// Two queued refreshes: dispose interrupts one mid-flight and the other
|
|
// before it starts, so both closed guards must hold.
|
|
instance!.watcher.emit('all', 'change', path)
|
|
instance!.watcher.emit('all', 'change', path)
|
|
await fiber.dispose()
|
|
disposed = true
|
|
instance!.watcher.emit('all', 'change', path)
|
|
instance!.watcher.emit('ready')
|
|
await new Promise(resolve => setTimeout(resolve, 100))
|
|
expect(postDisposeCommits).toBe(0)
|
|
})
|
|
|
|
it('treats an event for a still-absent file as a no-op', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const scope = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
const [instance] = await fakeInstances()
|
|
instance!.watcher.emit('all', 'add', path)
|
|
await new Promise(resolve => setTimeout(resolve, 50))
|
|
expect(scope.get()).toEqual({ theme: 'dark' })
|
|
})
|
|
|
|
it('folds an unobserved external edit into a write instead of overwriting it', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const theme = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
const editor = ctx.settings.register(settingsNamespace('editor'), z.object({
|
|
tabWidth: z.number().default(2),
|
|
}))
|
|
// The external edit has landed on disk but its watcher event has not
|
|
// fired yet (a debounce window, or a missed event): the write must fold
|
|
// it in, not resurrect the stale document.
|
|
await writeFile(path, 'ui-theme:\n theme: light\neditor:\n tabWidth: 8\n')
|
|
await theme.update({ theme: 'darker' })
|
|
const text = await readFile(path, 'utf8')
|
|
expect(text).toContain('tabWidth: 8')
|
|
expect(text).toContain('theme: darker')
|
|
// The fold published the unobserved section before the write committed.
|
|
expect(editor.get()).toEqual({ tabWidth: 8 })
|
|
})
|
|
|
|
it('reconciles at watcher ready so a change during setup is not missed', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const scope = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
// Written after the initial load but before the watcher became active:
|
|
// no 'all' event will ever fire for it.
|
|
await writeFile(path, 'ui-theme:\n theme: written-before-ready\n')
|
|
const [instance] = await fakeInstances()
|
|
instance!.watcher.emit('ready')
|
|
await vi.waitFor(() => {
|
|
expect(scope.get().theme).toBe('written-before-ready')
|
|
})
|
|
})
|
|
|
|
it('fails a write loud when the on-disk document turned invalid unobserved', async () => {
|
|
const dir = await tempDir()
|
|
const path = join(dir, 'settings.yaml')
|
|
await writeFile(path, 'ui-theme:\n theme: light\n')
|
|
const ctx = await boot({ path, debounceMs: 5 })
|
|
const scope = ctx.settings.register(settingsNamespace('ui-theme'), ThemeSchema)
|
|
const broken = 'ui-theme: [unclosed\n flow: {\n'
|
|
await writeFile(path, broken)
|
|
await expect(scope.update({ theme: 'darker' })).rejects.toThrow(/invalid document/)
|
|
// The user's manual edit stays on disk untouched and the cache keeps the
|
|
// last good value.
|
|
expect(await readFile(path, 'utf8')).toBe(broken)
|
|
expect(scope.get()).toEqual({ theme: 'light' })
|
|
})
|
|
})
|