You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
4.6 KiB
117 lines
4.6 KiB
import { afterEach, describe, expect, it } from 'vitest'
|
|
import { mkdtempSync, rmSync, writeFileSync, readFileSync, readdirSync } from 'node:fs'
|
|
import { tmpdir } from 'node:os'
|
|
import { join } from 'node:path'
|
|
import { settingsSchema } from '@template/contracts/settings'
|
|
import { SettingsStore, settingsMigrations } from '../../src/main/settings/store'
|
|
|
|
const directories: string[] = []
|
|
function location(value: unknown): string {
|
|
const dir = mkdtempSync(join(tmpdir(), 'workshop-settings-upgrade-'))
|
|
directories.push(dir)
|
|
const file = join(dir, 'settings.json')
|
|
writeFileSync(file, JSON.stringify(value))
|
|
return file
|
|
}
|
|
afterEach(() => {
|
|
for (const dir of directories.splice(0)) rmSync(dir, { recursive: true, force: true })
|
|
})
|
|
const defaults = settingsSchema.parse({})
|
|
const read = (file: string): unknown => JSON.parse(readFileSync(file, 'utf8'))
|
|
|
|
describe('application settings upgrades', () => {
|
|
it('migrates legacy preferences, fills nested defaults and keeps an exact backup', () => {
|
|
const legacy = { theme: 'dark', language: 'en', window: { width: 900 }, obsolete: true }
|
|
const file = location(legacy)
|
|
const store = new SettingsStore(file)
|
|
expect(store.get()).toEqual({
|
|
...defaults,
|
|
theme: 'dark',
|
|
language: 'en',
|
|
window: { width: 900, height: defaults.window.height }
|
|
})
|
|
expect(read(file)).toEqual({ version: 1, settings: store.get() })
|
|
const backups = readdirSync(join(file, '..')).filter((name) => name.endsWith('.bak'))
|
|
expect(backups).toHaveLength(1)
|
|
expect(read(join(file, '..', backups[0]!))).toEqual(legacy)
|
|
new SettingsStore(file)
|
|
expect(readdirSync(join(file, '..')).filter((name) => name.endsWith('.bak'))).toHaveLength(1)
|
|
})
|
|
|
|
it('repairs only invalid fields and rejects invalid writes without changing disk or memory', () => {
|
|
const file = location({
|
|
version: 1,
|
|
settings: {
|
|
...defaults,
|
|
theme: 'unsupported',
|
|
language: 'en',
|
|
diagnosticUpload: 'true',
|
|
window: { width: 950, height: -1 }
|
|
}
|
|
})
|
|
const store = new SettingsStore(file)
|
|
expect(store.recoveredFromBackup).toBe(true)
|
|
expect(store.get()).toEqual({
|
|
...defaults,
|
|
language: 'en',
|
|
window: { width: 950, height: defaults.window.height }
|
|
})
|
|
const before = readFileSync(file, 'utf8')
|
|
expect(() => store.set({ language: 'invalid' as 'en' })).toThrow()
|
|
expect(readFileSync(file, 'utf8')).toBe(before)
|
|
expect(store.get().language).toBe('en')
|
|
})
|
|
|
|
it('runs sequential migrations while keeping user values and keeps metadata out of snapshots', () => {
|
|
const file = location({ version: 1, settings: { ...defaults, theme: 'dark', locale: 'en' } })
|
|
const store = new SettingsStore(file, [
|
|
...settingsMigrations,
|
|
{ version: 2, migrate: (value) => ({ ...value, language: value.locale }) },
|
|
{ version: 3, migrate: (value) => ({ ...value, window: { width: 900, height: 600 } }) }
|
|
])
|
|
expect(store.get().language).toBe('en')
|
|
expect(store.get().theme).toBe('dark')
|
|
expect(store.get()).not.toHaveProperty('version')
|
|
store.changed.subscribe((value) => expect(read(file)).toEqual({ version: 3, settings: value }))
|
|
store.set({ launchAtLogin: true })
|
|
const snapshot = store.get()
|
|
snapshot.window.width = 720
|
|
expect(store.get().window.width).toBe(900)
|
|
})
|
|
|
|
it('preserves the original file on downgrade, invalid metadata or migration failure', () => {
|
|
for (const version of [2, -1, '1']) {
|
|
const file = location({ version, settings: defaults })
|
|
const before = readFileSync(file, 'utf8')
|
|
expect(() => new SettingsStore(file)).toThrow()
|
|
expect(readFileSync(file, 'utf8')).toBe(before)
|
|
}
|
|
const file = location({ theme: 'dark' })
|
|
const before = readFileSync(file, 'utf8')
|
|
expect(
|
|
() =>
|
|
new SettingsStore(file, [
|
|
{
|
|
version: 1,
|
|
migrate: () => {
|
|
throw new Error('migration failed')
|
|
}
|
|
}
|
|
])
|
|
).toThrow('migration failed')
|
|
expect(readFileSync(file, 'utf8')).toBe(before)
|
|
expect(() => new SettingsStore(file, [{ version: 2, migrate: (value) => value }])).toThrow(
|
|
'consecutive'
|
|
)
|
|
})
|
|
|
|
it('backs up unreadable JSON before restoring defaults', () => {
|
|
const file = location({})
|
|
writeFileSync(file, '{broken')
|
|
const store = new SettingsStore(file)
|
|
expect(store.recoveredFromBackup).toBe(true)
|
|
expect(store.get()).toEqual(defaults)
|
|
const backup = readdirSync(join(file, '..')).find((name) => name.endsWith('.bak'))!
|
|
expect(readFileSync(join(file, '..', backup), 'utf8')).toBe('{broken')
|
|
})
|
|
})
|
|
|