import { chmod, mkdir, readFile, stat, symlink, writeFile } from 'node:fs/promises'; import { join } from 'node:path'; import { afterEach, describe, expect, it } from 'vitest'; import { connectionFingerprint, readConfig, writeConfig } from '../src/config.js'; import { getPrivatePaths, normalizeConnection, parseManifestPath, parsePushExclude, parsePushInclude, } from '../src/paths.js'; import { createTemporaryDirectory, removeTemporaryDirectory } from './helpers.js'; const temporaryDirectories: string[] = []; function createConfig() { const connection = normalizeConnection({ password: 'correct horse battery staple', remotePath: 'pi-sync-webdav/', url: 'https://example.com/dav', username: 'alice', }); return { connection: { ...connection, readOnly: false }, pushExclude: [parsePushExclude('.DS_Store'), parsePushExclude('themes/cache')], pushInclude: [parsePushInclude('settings.json'), parsePushInclude('themes')], syncState: { connectionFingerprint: connectionFingerprint(connection), managedPaths: [parseManifestPath('settings.json'), parseManifestPath('themes/dark.json')], }, version: 1 as const, }; } afterEach(async () => { await Promise.all(temporaryDirectories.splice(0).map(removeTemporaryDirectory)); }); describe('private configuration', () => { it('returns undefined only when config.json is absent', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); await expect(readConfig(root)).resolves.toBeUndefined(); }); it('writes and reads a canonical, private configuration', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await writeConfig(root, config); await expect(readConfig(root)).resolves.toEqual(config); const configPath = getPrivatePaths(root).configFile; expect((await stat(configPath)).isFile()).toBe(true); if (process.platform !== 'win32') { expect((await stat(configPath)).mode & 0o777).toBe(0o600); } }); it('reads a configuration without pushExclude as no custom exclusions', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await writeConfig(root, config); const configFile = getPrivatePaths(root).configFile; const stored = JSON.parse(await readFile(configFile, 'utf8')) as Record; delete stored.pushExclude; await writeFile(configFile, `${JSON.stringify(stored, null, 2)}\n`, 'utf8'); await expect(readConfig(root)).resolves.toEqual({ ...config, pushExclude: [] }); }); it('reads private configuration without mutating it', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await writeConfig(root, config); const path = getPrivatePaths(root).configFile; const before = await stat(path); await expect(readConfig(root)).resolves.toEqual(config); const after = await stat(path); expect(after.mode).toBe(before.mode); expect(after.mtimeMs).toBe(before.mtimeMs); }); it('rejects obsolete pending package state', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); await expect( writeConfig(root, { ...createConfig(), pendingPackageOperations: [{ action: 'install', source: 'npm:example-package' }], } as unknown as Parameters[1]), ).rejects.toThrow('Invalid plugin configuration'); }); it('rejects malformed and unknown on-disk config fields without exposing secrets', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const paths = getPrivatePaths(root); await mkdir(paths.directory, { recursive: true }); await chmod(paths.directory, 0o700); await writeFile(paths.configFile, '{"password":"correct horse battery staple"}', 'utf8'); await chmod(paths.configFile, 0o600); await expect(readConfig(root)).rejects.toThrow('Invalid plugin configuration'); await writeFile( paths.configFile, JSON.stringify({ ...createConfig(), unexpected: true }), 'utf8', ); await chmod(paths.configFile, 0o600); await expect(readConfig(root)).rejects.toThrow('Invalid plugin configuration'); }); it('rejects unsafe persisted managed paths before writing configuration', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await expect( writeConfig(root, { ...config, syncState: { ...config.syncState, managedPaths: [ 'themes/settings:stream', ] as unknown as typeof config.syncState.managedPaths, }, }), ).rejects.toThrow('Invalid plugin configuration'); }); it('rejects colliding push includes and managed paths', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await expect( writeConfig(root, { ...config, pushInclude: [parsePushInclude('Themes'), parsePushInclude('themes')], }), ).rejects.toThrow('Invalid plugin configuration'); await expect( writeConfig(root, { ...config, syncState: { ...config.syncState, managedPaths: [ parseManifestPath('themes'), parseManifestPath('themes-dark'), parseManifestPath('Themes/dark.json'), ], }, }), ).rejects.toThrow('Invalid plugin configuration'); }); it('rejects invalid, duplicate, and push-selection-conflicting exclusion rules', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await expect( writeConfig(root, { ...config, pushExclude: ['themes/../escape'] as unknown as typeof config.pushExclude, }), ).rejects.toThrow('Invalid push exclude'); await expect( writeConfig(root, { ...config, pushExclude: [parsePushExclude('cache'), parsePushExclude('Cache')], }), ).rejects.toThrow('Invalid plugin configuration'); await expect( writeConfig(root, { ...config, pushExclude: [parsePushExclude('themes')] }), ).rejects.toThrow('Invalid plugin configuration'); }); it('validates before replacing an existing configuration', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); temporaryDirectories.push(root); const config = createConfig(); await writeConfig(root, config); const previous = await readFile(getPrivatePaths(root).configFile, 'utf8'); await expect( writeConfig(root, { ...config, pushInclude: [parseManifestPath('themes/nested.json')], }), ).rejects.toThrow('Invalid push include'); expect(await readFile(getPrivatePaths(root).configFile, 'utf8')).toBe(previous); }); it('rejects a symlinked private directory', async () => { const root = await createTemporaryDirectory('pi-sync-webdav-config-'); const external = await createTemporaryDirectory('pi-sync-webdav-external-'); temporaryDirectories.push(root, external); const type = process.platform === 'win32' ? 'junction' : 'dir'; await symlink(external, join(root, 'pi-sync-webdav'), type); await expect(writeConfig(root, createConfig())).rejects.toThrow( 'Unsafe private configuration directory', ); }); it('uses a stable fingerprint for canonical equivalents and changes it with the connection identity', () => { const first = normalizeConnection({ password: 'one', remotePath: 'backup/', url: 'https://example.com/dav', username: 'alice', }); const equivalent = normalizeConnection({ password: 'two', remotePath: 'backup', url: 'https://example.com/dav/', username: 'alice', }); const changedUrl = normalizeConnection({ password: 'two', remotePath: 'backup', url: 'https://example.com/other', username: 'alice', }); const changedPath = normalizeConnection({ password: 'two', remotePath: 'other-backup', url: 'https://example.com/dav/', username: 'alice', }); const changedUser = normalizeConnection({ password: 'two', remotePath: 'backup', url: 'https://example.com/dav/', username: 'bob', }); expect(connectionFingerprint(first)).toBe(connectionFingerprint(equivalent)); expect(connectionFingerprint(first)).not.toBe(connectionFingerprint(changedUrl)); expect(connectionFingerprint(first)).not.toBe(connectionFingerprint(changedPath)); expect(connectionFingerprint(first)).not.toBe(connectionFingerprint(changedUser)); }); });