@openfairygui/backend 0.2.0-alpha.8 → 0.2.0

package/src/services/runtime-service.ts

@@ -1,20 +1,25 @@
-import { ProjectReader, type FileSystem } from '@openfairygui/core/project-io';
-import { liftDocumentToUamProject, normalizeUamProject } from '@openfairygui/core/uam';
-import { failure, success, type BackendContext, type BackendSessionState } from './context.js';
-import type { CacheService } from './cache-service.js';
-import type { EventService } from './event-service.js';
-import type { JobService } from './job-service.js';
+import { type FileSystem, ProjectReader, ProjectWriter } from '@openfairygui/core/project-io';
+import {
+	liftDocumentToUamProject,
+	materializeUamProject,
+	normalizeUamProject,
+	type UamProject,
+} from '@openfairygui/core/uam';
+import { normalizeComparablePath, resolveCanonicalProjectRoot } from '../path-policy.js';
 import type {
 	AdvisoryLockConflictError,
-	BackendFileHandle,
+	BackendCapabilityUnavailableError,
 	BackendResult,
+	BackendSessionLock,
 	BackendSessionSnapshot,
-	BackendCapabilityUnavailableError,
 	InProcessLockConflictError,
 	OpenProjectSessionInput,
 	SessionNotFoundError,
 } from '../runtime.js';
-import { normalizeComparablePath, resolveCanonicalProjectRoot } from '../path-policy.js';
+import type { CacheService } from './cache-service.js';
+import { type BackendContext, type BackendSessionState, failure, success } from './context.js';
+import type { EventService } from './event-service.js';
+import type { JobService } from './job-service.js';
 import { createSessionNotFoundError, toSessionSnapshot } from './session-utils.js';
 
 function randomId(): string {
@@ -74,6 +79,94 @@ function createProjectReaderFileSystem(fileSystem: NonNullable<BackendContext['f
 	};
 }
 
+function createCaptureFileSystem(
+	files: Map<string, string | Uint8Array>,
+	directories: Set<string>,
+): FileSystem {
+	const normalize = (filePath: string): string => filePath.replace(/\\/g, '/').replace(/\/+/g, '/');
+	return {
+		async readFile(filePath: string): Promise<string> {
+			const value = files.get(normalize(filePath));
+			if (typeof value !== 'string') throw new Error(`Captured text file was not found: ${filePath}`);
+			return value;
+		},
+		async readFileRaw(filePath: string): Promise<Uint8Array> {
+			const value = files.get(normalize(filePath));
+			if (!(value instanceof Uint8Array)) throw new Error(`Captured binary file was not found: ${filePath}`);
+			return value.slice();
+		},
+		async writeFile(filePath: string, content: string): Promise<void> {
+			files.set(normalize(filePath), content);
+		},
+		async writeFileRaw(filePath: string, data: Uint8Array): Promise<void> {
+			files.set(normalize(filePath), data.slice());
+		},
+		async mkdir(dirPath: string): Promise<void> {
+			directories.add(normalize(dirPath));
+		},
+		async readdir(): Promise<string[]> {
+			return [];
+		},
+		async exists(filePath: string): Promise<boolean> {
+			return files.has(normalize(filePath));
+		},
+		join(...paths: string[]): string {
+			return normalize(paths.filter(Boolean).join('/'));
+		},
+		dirname(filePath: string): string {
+			const normalized = normalize(filePath);
+			const separator = normalized.lastIndexOf('/');
+			return separator < 0 ? '' : normalized.slice(0, separator);
+		},
+		async unlink(filePath: string): Promise<void> {
+			files.delete(normalize(filePath));
+		},
+	};
+}
+
+function capturedFilesEqual(left: Map<string, string | Uint8Array>, right: Map<string, string | Uint8Array>): boolean {
+	if (left.size !== right.size) return false;
+	for (const [filePath, leftValue] of left) {
+		const rightValue = right.get(filePath);
+		if (typeof leftValue === 'string') {
+			if (leftValue !== rightValue) return false;
+			continue;
+		}
+		if (!(rightValue instanceof Uint8Array) || leftValue.length !== rightValue.length) return false;
+		for (let index = 0; index < leftValue.length; index += 1) {
+			if (leftValue[index] !== rightValue[index]) return false;
+		}
+	}
+	return true;
+}
+
+function capturedDirectoriesEqual(left: Set<string>, right: Set<string>): boolean {
+	return left.size === right.size && [...left].every((directory) => right.has(directory));
+}
+
+async function hasFullUamFidelity(
+	document: Awaited<ReturnType<ProjectReader['read']>>,
+	project: UamProject,
+): Promise<boolean> {
+	const sourceFiles = new Map<string, string | Uint8Array>();
+	const materializedFiles = new Map<string, string | Uint8Array>();
+	const sourceDirectories = new Set<string>();
+	const materializedDirectories = new Set<string>();
+	try {
+		await Promise.all([
+			new ProjectWriter(createCaptureFileSystem(sourceFiles, sourceDirectories)).write(document, 'Project.fairy'),
+			new ProjectWriter(createCaptureFileSystem(materializedFiles, materializedDirectories)).write(
+				materializeUamProject(project),
+				'Project.fairy',
+			),
+		]);
+	} catch {
+		return false;
+	}
+	return capturedFilesEqual(sourceFiles, materializedFiles)
+		&& capturedDirectoriesEqual(sourceDirectories, materializedDirectories);
+}
+
 export class RuntimeService {
 	public constructor(
 		private readonly context: BackendContext,
@@ -111,10 +204,10 @@ export class RuntimeService {
 			});
 		}
 
-		let advisoryLock: BackendFileHandle | null = null;
+		let sessionLock: BackendSessionLock | null = null;
 		try {
-			advisoryLock = await fileSystem.openExclusive(lockFilePath);
-			await advisoryLock.writeFile(
+			sessionLock = await fileSystem.acquireSessionLock(lockFilePath);
+			await sessionLock.writeMetadata(
 				JSON.stringify(
 					this.context.host?.lockMetadata?.({
 						canonicalPathKey,
@@ -126,10 +219,9 @@ export class RuntimeService {
 					},
 				),
 			);
-			await advisoryLock.close();
-
 			const reader = new ProjectReader(createProjectReaderFileSystem(fileSystem));
-			const project = liftDocumentToUamProject(await reader.read(fairyPath));
+			const document = await reader.read(fairyPath, { hydrateResourceBytes: true });
+			const project = liftDocumentToUamProject(document);
 			const sessionId = randomId();
 			const session: BackendSessionState = {
 				sessionId,
@@ -137,10 +229,15 @@ export class RuntimeService {
 				canonicalProjectPath,
 				canonicalPathKey,
 				lockFilePath,
+				sessionLock,
 				fileSystem,
 				project,
+				uamFidelity: (await hasFullUamFidelity(document, project)) ? 'full' : 'unsupported',
 				revision: 0,
 				lastSavedRevision: 0,
+				pendingStaleSourceFiles: new Map(),
+				pendingStaleResourceFolders: new Map(),
+				pendingStaleBranchDirectories: new Map(),
 				dirty: false,
 				lockHeld: true,
 				closed: false,
@@ -155,6 +252,7 @@ export class RuntimeService {
 				revision: session.revision,
 			});
 		} catch (error) {
+			if (sessionLock) await sessionLock.release().catch(() => undefined);
 			if (typeof error === 'object' && error !== null && 'code' in error && error.code === 'EEXIST') {
 				return failure('runtime', startedAt, {
 					code: 'lock_conflict',
@@ -164,9 +262,11 @@ export class RuntimeService {
 					lockFilePath,
 				});
 			}
-			if (advisoryLock) {
-				await advisoryLock.close().catch(() => undefined);
-				await fileSystem.unlink(lockFilePath).catch(() => undefined);
+			if (typeof error === 'object' && error !== null && 'code' in error && error.code === 'ENOTSUP') {
+				return failure('runtime', startedAt, {
+					...createCapabilityUnavailableError('fileSystem'),
+					message: error instanceof Error ? error.message : String(error),
+				});
 			}
 			throw error;
 		}
@@ -177,12 +277,14 @@ export class RuntimeService {
 		const sessionId = input.sessionId ?? randomId();
 		const storage = input.storage;
 		const memoryProjectPath = `memory://${sessionId}`;
-		const canonicalProjectPath = storage?.canonicalProjectPath
-			?? input.canonicalProjectPath
-			?? (storage ? storage.fileSystem.dirname(storage.fairyPath) || '.' : memoryProjectPath);
-		const canonicalPathKey = storage?.canonicalPathKey
-			?? input.canonicalPathKey
-			?? (storage ? normalizeComparablePath(canonicalProjectPath) : canonicalProjectPath.toLowerCase());
+		const canonicalProjectPath =
+			storage?.canonicalProjectPath ??
+			input.canonicalProjectPath ??
+			(storage ? storage.fileSystem.dirname(storage.fairyPath) || '.' : memoryProjectPath);
+		const canonicalPathKey =
+			storage?.canonicalPathKey ??
+			input.canonicalPathKey ??
+			(storage ? normalizeComparablePath(canonicalProjectPath) : canonicalProjectPath.toLowerCase());
 		const existingSessionId = this.context.sessionsByPath.get(canonicalPathKey);
 		if (existingSessionId) {
 			return failure('runtime', startedAt, {
@@ -200,10 +302,15 @@ export class RuntimeService {
 			canonicalProjectPath,
 			canonicalPathKey,
 			lockFilePath: '',
+			sessionLock: null,
 			fileSystem: storage?.fileSystem,
 			project: normalizeUamProject(input.project),
+			uamFidelity: 'full',
 			revision: 0,
 			lastSavedRevision: 0,
+			pendingStaleSourceFiles: new Map(),
+			pendingStaleResourceFolders: new Map(),
+			pendingStaleBranchDirectories: new Map(),
 			dirty: false,
 			lockHeld: false,
 			closed: false,
@@ -234,9 +341,8 @@ export class RuntimeService {
 			canonicalPathKey: session.canonicalPathKey,
 			revision: session.revision,
 		});
-		if (this.context.fileSystem && session.lockFilePath) {
-			await this.context.fileSystem.unlink(session.lockFilePath).catch(() => undefined);
-		}
+		await session.sessionLock?.release().catch(() => undefined);
+		session.sessionLock = null;
 		session.lockHeld = false;
 		session.closed = true;
 		this.context.sessions.delete(session.sessionId);

package/src/services/session-project-writer.ts

@@ -0,0 +1,69 @@
+import type { Document } from '@openfairygui/core';
+import { type FileSystem, type ProjectBranchDirectory, type ProjectSourceFile, ProjectWriter } from '@openfairygui/core/project-io';
+import type { BackendFileSystem } from '../runtime.js';
+
+function createWriterFileSystem(
+	fileSystem: BackendFileSystem,
+	writtenPaths: string[],
+	failedPaths: string[],
+): FileSystem {
+	async function trackWrite<T>(targetPath: string, write: () => Promise<T>): Promise<T> {
+		try {
+			const result = await write();
+			writtenPaths.push(targetPath);
+			return result;
+		} catch (error) {
+			failedPaths.push(targetPath);
+			throw error;
+		}
+	}
+
+	return {
+		readFile: (path) => fileSystem.readFile(path),
+		readFileRaw: (path) => fileSystem.readFileRaw(path),
+		writeFile: (path, content) =>
+			trackWrite(path, async () => {
+				await fileSystem.mkdir(fileSystem.dirname(path), { recursive: true });
+				await fileSystem.writeFile(path, content);
+			}),
+		writeFileRaw: (path, data) =>
+			trackWrite(path, async () => {
+				await fileSystem.mkdir(fileSystem.dirname(path), { recursive: true });
+				await fileSystem.writeFileRaw(path, data);
+			}),
+		mkdir: (path) => fileSystem.mkdir(path, { recursive: true }),
+		readdir: (path) => fileSystem.readdir(path),
+		async exists(path): Promise<boolean> {
+			try {
+				await fileSystem.stat(path);
+				return true;
+			} catch {
+				return false;
+			}
+		},
+		join: (...paths) => fileSystem.join(...paths),
+		dirname: (path) => fileSystem.dirname(path),
+		unlink: (path) => trackWrite(path, () => fileSystem.unlink(path)),
+		rmdir: (path) => trackWrite(path, () => fileSystem.rmdir(path)),
+	};
+}
+
+export async function writeSessionProject(input: {
+	fileSystem: BackendFileSystem;
+	document: Document;
+	fairyPath: string;
+	staleSourceFiles: ProjectSourceFile[];
+	staleResourceFolders: import('@openfairygui/core/project-io').ProjectResourceFolder[];
+	staleBranchDirectories: ProjectBranchDirectory[];
+	writtenPaths: string[];
+	failedPaths: string[];
+}): Promise<void> {
+	const writer = new ProjectWriter(
+		createWriterFileSystem(input.fileSystem, input.writtenPaths, input.failedPaths),
+	);
+	await writer.write(input.document, input.fairyPath, {
+		staleSourceFiles: input.staleSourceFiles,
+		staleResourceFolders: input.staleResourceFolders,
+		staleBranchDirectories: input.staleBranchDirectories,
+	});
+}

package/src/services/session-utils.ts

@@ -5,17 +5,20 @@ import type {
 	SessionStaleWriteError,
 } from '../runtime.js';
 import type { BackendSessionState } from './context.js';
-import { cloneCapabilitiesSnapshot } from './snapshot-utils.js';
 
-export function toSessionSnapshot(session: BackendSessionState, capabilities: BackendCapabilities): BackendSessionSnapshot {
+export function toSessionSnapshot(
+	session: BackendSessionState,
+	capabilities: BackendCapabilities,
+): BackendSessionSnapshot {
 	return {
 		sessionId: session.sessionId,
 		canonicalProjectPath: session.canonicalProjectPath,
 		revision: session.revision,
 		lastSavedRevision: session.lastSavedRevision,
 		dirty: session.dirty,
+		uamFidelity: session.uamFidelity,
 		lockHeld: session.lockHeld,
-		capabilities: cloneCapabilitiesSnapshot(capabilities),
+		capabilities: structuredClone(capabilities),
 	};
 }
 

package/src/storage.ts

@@ -1,5 +1,5 @@
 import type { FileSystem as CoreProjectFileSystem } from '@openfairygui/core/project-io';
-import type { BackendFileHandle, BackendFileStat, BackendFileSystem } from './runtime.js';
+import type { BackendFileStat, BackendFileSystem, BackendSessionLock } from './runtime.js';
 
 type StorageStatKind = 'file' | 'directory';
 
@@ -19,9 +19,15 @@ export interface BackendAsyncStorageAdapter {
 	readdir(dirPath: string): Promise<string[]>;
 	exists?(filePath: string): Promise<boolean>;
 	stat?(filePath: string): Promise<BackendStorageStatLike>;
+	/** Stable cross-context path identity; also scopes the default Web Lock name. */
 	resolvePath?(filePath: string): Promise<string>;
-	openExclusive?(filePath: string): Promise<BackendFileHandle>;
-	unlink?(filePath: string): Promise<void>;
+	/**
+	 * Optional replacement for Web Locks. Acquisition must be atomic across browser contexts, remain held
+	 * until release(), and recover automatically when the owning document terminates.
+	 */
+	acquireSessionLock?(lockPath: string): Promise<BackendSessionLock>;
+	unlink(filePath: string): Promise<void>;
+	rmdir(dirPath: string): Promise<void>;
 	join?(...paths: string[]): string;
 	dirname?(filePath: string): string;
 	resolve?(...paths: string[]): string;
@@ -45,6 +51,44 @@ function createPathError(code: string, message: string): Error & { code: string
 	return error;
 }
 
+function getWebLockManager(): LockManager | null {
+	if (typeof navigator === 'undefined') return null;
+	const lockManager = (navigator as Navigator & { locks?: LockManager }).locks;
+	return lockManager && typeof lockManager.request === 'function' ? lockManager : null;
+}
+
+function acquireWebSessionLock(lockManager: LockManager, lockName: string): Promise<BackendSessionLock> {
+	return new Promise((resolve, reject) => {
+		let releasePlatformLock = (): void => undefined;
+		const held = new Promise<void>((release) => {
+			releasePlatformLock = release;
+		});
+		void lockManager
+			.request(lockName, { mode: 'exclusive', ifAvailable: true }, async (lock) => {
+				if (!lock) {
+					reject(createPathError('EEXIST', `Browser session lock is already held: ${lockName}`));
+					return;
+				}
+				let released = false;
+				resolve({
+					// Web Locks are the authority; a persisted marker would survive abrupt document termination.
+					writeMetadata(): Promise<void> {
+						return Promise.resolve();
+					},
+					release(): Promise<void> {
+						if (!released) {
+							released = true;
+							releasePlatformLock();
+						}
+						return Promise.resolve();
+					},
+				});
+				await held;
+			})
+			.catch(reject);
+	});
+}
+
 function normalizeStoragePath(value: string): string {
 	const normalized = value.replace(/\\/g, '/').replace(/\/+/g, '/');
 	const absolute = normalized.startsWith('/');
@@ -114,8 +158,12 @@ async function inferStat(storage: BackendAsyncStorageAdapter, filePath: string):
 export type BackendStorageFileSystem = BackendFileSystem & CoreProjectFileSystem;
 
 export function createBackendStorageFileSystem(storage: BackendAsyncStorageAdapter): BackendStorageFileSystem {
-	const lockedPaths = new Set<string>();
-
+	if (typeof storage.unlink !== 'function') {
+		throw createPathError('ENOTSUP', 'Storage adapter must provide unlink() for project resource lifecycle writes.');
+	}
+	if (typeof storage.rmdir !== 'function') {
+		throw createPathError('ENOTSUP', 'Storage adapter must provide rmdir() for project resource folder lifecycle writes.');
+	}
 	const fileSystem: BackendStorageFileSystem = {
 		stat(filePath: string): Promise<BackendFileStat> {
 			return inferStat(storage, fileSystem.resolve(filePath));
@@ -151,31 +199,23 @@ export function createBackendStorageFileSystem(storage: BackendAsyncStorageAdapt
 			const resolved = fileSystem.resolve(filePath);
 			return storage.resolvePath ? storage.resolvePath(resolved) : Promise.resolve(resolved);
 		},
-		async openExclusive(filePath: string): Promise<BackendFileHandle> {
-			const resolved = fileSystem.resolve(filePath);
-			if (storage.openExclusive) return storage.openExclusive(resolved);
-			if (lockedPaths.has(resolved) || await fileSystem.exists(resolved)) {
-				throw createPathError('EEXIST', `Storage path already exists: ${resolved}`);
+		async acquireSessionLock(lockPath: string): Promise<BackendSessionLock> {
+			const resolved = fileSystem.resolve(lockPath);
+			if (storage.acquireSessionLock) return storage.acquireSessionLock(resolved);
+			const lockManager = getWebLockManager();
+			if (!lockManager) {
+				throw createPathError(
+					'ENOTSUP',
+					'Browser openSession requires Web Locks or BackendAsyncStorageAdapter.acquireSessionLock().',
+				);
 			}
-			lockedPaths.add(resolved);
-			let closed = false;
-			return {
-				async writeFile(content: string): Promise<void> {
-					if (closed) throw createPathError('EBADF', `Storage lock handle is closed: ${resolved}`);
-					await fileSystem.mkdir(fileSystem.dirname(resolved), { recursive: true });
-					await storage.writeFile(resolved, content);
-				},
-				async close(): Promise<void> {
-					closed = true;
-					lockedPaths.delete(resolved);
-				},
-			};
+			return acquireWebSessionLock(lockManager, `@openfairygui/backend:${resolved}`);
 		},
 		unlink(filePath: string): Promise<void> {
-			const resolved = fileSystem.resolve(filePath);
-			lockedPaths.delete(resolved);
-			if (storage.unlink) return storage.unlink(resolved);
-			throw createPathError('ENOTSUP', 'Storage adapter does not provide unlink().');
+			return storage.unlink(fileSystem.resolve(filePath));
+		},
+		rmdir(dirPath: string): Promise<void> {
+			return storage.rmdir(fileSystem.resolve(dirPath));
 		},
 		join(...paths: string[]): string {
 			return storage.join ? storage.join(...paths) : joinStoragePath(...paths);