@openfairygui/backend 0.2.0-alpha.0 → 0.2.0-alpha.10

package/src/services/runtime-service.ts

@@ -1,4 +1,5 @@
-import { NodeIO, readProjectAsUam } from '@openfairygui/core';
+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';
@@ -8,16 +9,71 @@ import type {
 	BackendFileHandle,
 	BackendResult,
 	BackendSessionSnapshot,
+	BackendCapabilityUnavailableError,
 	InProcessLockConflictError,
+	OpenProjectSessionInput,
 	SessionNotFoundError,
 } from '../runtime.js';
-import { resolveCanonicalProjectRoot } from '../path-policy.js';
+import { normalizeComparablePath, resolveCanonicalProjectRoot } from '../path-policy.js';
 import { createSessionNotFoundError, toSessionSnapshot } from './session-utils.js';
 
 function randomId(): string {
 	return `${Date.now().toString(36)}-${Math.random().toString(36).slice(2, 10)}`;
 }
 
+function createCapabilityUnavailableError(
+	capability: BackendCapabilityUnavailableError['capability'],
+): BackendCapabilityUnavailableError {
+	const artifactCapability = capability === 'artifact.publish' || capability === 'artifact.restore';
+	return {
+		code: 'capability_unavailable',
+		message: artifactCapability
+			? `${capability} requires the Node bridge boundary exposed by @openfairygui/backend/node.`
+			: `${capability} requires an injected BackendFileSystem adapter.`,
+		capability,
+		requiredAdapter: capability === 'fileSystem' ? 'BackendFileSystem' : undefined,
+		requiredHost: artifactCapability ? 'node' : undefined,
+		bridgeBoundary: artifactCapability ? 'external-bridge' : undefined,
+	};
+}
+
+function createProjectReaderFileSystem(fileSystem: NonNullable<BackendContext['fileSystem']>): FileSystem {
+	return {
+		readFile(filePath: string): Promise<string> {
+			return fileSystem.readFile(filePath);
+		},
+		readFileRaw(filePath: string): Promise<Uint8Array> {
+			return fileSystem.readFileRaw(filePath);
+		},
+		writeFile(filePath: string, content: string): Promise<void> {
+			return fileSystem.writeFile(filePath, content);
+		},
+		writeFileRaw(filePath: string, data: Uint8Array): Promise<void> {
+			return fileSystem.writeFileRaw(filePath, data);
+		},
+		async mkdir(dirPath: string): Promise<void> {
+			await fileSystem.mkdir(dirPath, { recursive: true });
+		},
+		readdir(dirPath: string): Promise<string[]> {
+			return fileSystem.readdir(dirPath);
+		},
+		async exists(filePath: string): Promise<boolean> {
+			try {
+				await fileSystem.stat(filePath);
+				return true;
+			} catch {
+				return false;
+			}
+		},
+		join(...paths: string[]): string {
+			return fileSystem.join(...paths);
+		},
+		dirname(filePath: string): string {
+			return fileSystem.dirname(filePath);
+		},
+	};
+}
+
 export class RuntimeService {
 	public constructor(
 		private readonly context: BackendContext,
@@ -26,12 +82,23 @@ export class RuntimeService {
 		private readonly jobService: JobService,
 	) {}
 
-	public async openSession(input: { projectPath: string }): Promise<BackendResult<BackendSessionSnapshot, InProcessLockConflictError | AdvisoryLockConflictError>> {
+	public async openSession(input: {
+		projectPath: string;
+	}): Promise<
+		BackendResult<
+			BackendSessionSnapshot,
+			InProcessLockConflictError | AdvisoryLockConflictError | BackendCapabilityUnavailableError
+		>
+	> {
 		const startedAt = Date.now();
-		const resolved = await resolveCanonicalProjectRoot(this.context.fileSystem, input.projectPath);
+		if (!this.context.fileSystem) {
+			return failure('runtime', startedAt, createCapabilityUnavailableError('fileSystem'));
+		}
+		const fileSystem = this.context.fileSystem;
+		const resolved = await resolveCanonicalProjectRoot(fileSystem, input.projectPath);
 		const { fairyPath, canonicalProjectPath, canonicalPathKey } = resolved;
 		const existingSessionId = this.context.sessionsByPath.get(canonicalPathKey);
-		const lockFilePath = this.context.fileSystem.join(canonicalProjectPath, '.openfairygui.backend.lock');
+		const lockFilePath = fileSystem.join(canonicalProjectPath, '.openfairygui.backend.lock');
 
 		if (existingSessionId) {
 			return failure('runtime', startedAt, {
@@ -46,16 +113,23 @@ export class RuntimeService {
 
 		let advisoryLock: BackendFileHandle | null = null;
 		try {
-			advisoryLock = await this.context.fileSystem.openExclusive(lockFilePath);
-			await advisoryLock.writeFile(JSON.stringify({
-				pid: process.pid,
-				createdAt: new Date().toISOString(),
-				canonicalPathKey,
-			}));
+			advisoryLock = await fileSystem.openExclusive(lockFilePath);
+			await advisoryLock.writeFile(
+				JSON.stringify(
+					this.context.host?.lockMetadata?.({
+						canonicalPathKey,
+						canonicalProjectPath,
+						lockFilePath,
+					}) ?? {
+						createdAt: new Date().toISOString(),
+						canonicalPathKey,
+					},
+				),
+			);
 			await advisoryLock.close();
 
-			const io = new NodeIO();
-			const project = await readProjectAsUam(io, fairyPath);
+			const reader = new ProjectReader(createProjectReaderFileSystem(fileSystem));
+			const project = liftDocumentToUamProject(await reader.read(fairyPath));
 			const sessionId = randomId();
 			const session: BackendSessionState = {
 				sessionId,
@@ -63,6 +137,7 @@ export class RuntimeService {
 				canonicalProjectPath,
 				canonicalPathKey,
 				lockFilePath,
+				fileSystem,
 				project,
 				revision: 0,
 				lastSavedRevision: 0,
@@ -80,7 +155,7 @@ export class RuntimeService {
 				revision: session.revision,
 			});
 		} catch (error) {
-			if ((error as NodeJS.ErrnoException)?.code === 'EEXIST') {
+			if (typeof error === 'object' && error !== null && 'code' in error && error.code === 'EEXIST') {
 				return failure('runtime', startedAt, {
 					code: 'lock_conflict',
 					kind: 'advisory_lock_conflict',
@@ -91,35 +166,99 @@ export class RuntimeService {
 			}
 			if (advisoryLock) {
 				await advisoryLock.close().catch(() => undefined);
-				await this.context.fileSystem.unlink(lockFilePath).catch(() => undefined);
+				await fileSystem.unlink(lockFilePath).catch(() => undefined);
 			}
 			throw error;
 		}
 	}
 
-	public async closeSession(
-		input: { sessionId: string },
-	): Promise<BackendResult<{ sessionId: string; closed: true }, SessionNotFoundError>> {
+	public openProjectSession(input: OpenProjectSessionInput): BackendResult<BackendSessionSnapshot> {
+		const startedAt = Date.now();
+		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 existingSessionId = this.context.sessionsByPath.get(canonicalPathKey);
+		if (existingSessionId) {
+			return failure('runtime', startedAt, {
+				code: 'lock_conflict',
+				kind: 'in_process_session_exists',
+				message: `Project is already open in this backend runtime: ${canonicalProjectPath}`,
+				canonicalPathKey,
+				holderSessionId: existingSessionId,
+			});
+		}
+
+		const session: BackendSessionState = {
+			sessionId,
+			fairyPath: storage?.fairyPath ?? canonicalProjectPath,
+			canonicalProjectPath,
+			canonicalPathKey,
+			lockFilePath: '',
+			fileSystem: storage?.fileSystem,
+			project: normalizeUamProject(input.project),
+			revision: 0,
+			lastSavedRevision: 0,
+			dirty: false,
+			lockHeld: false,
+			closed: false,
+		};
+		this.context.sessions.set(sessionId, session);
+		this.context.sessionsByPath.set(canonicalPathKey, sessionId);
+		this.cacheService.refreshSession(session);
+		this.eventService.emit({ kind: 'session.opened', sessionId, canonicalPathKey, revision: session.revision });
+
+		return success('runtime', startedAt, toSessionSnapshot(session, this.context.capabilities), {
+			sessionId: session.sessionId,
+			revision: session.revision,
+		});
+	}
+
+	public async closeSession(input: {
+		sessionId: string;
+	}): Promise<BackendResult<{ sessionId: string; closed: true }, SessionNotFoundError>> {
 		const startedAt = Date.now();
 		const session = this.context.sessions.get(input.sessionId);
 		if (!session || session.closed) {
 			return failure('runtime', startedAt, createSessionNotFoundError(input.sessionId));
 		}
 
-		this.eventService.emit({ kind: 'session.closeRequested', sessionId: session.sessionId, canonicalPathKey: session.canonicalPathKey, revision: session.revision });
-		await this.context.fileSystem.unlink(session.lockFilePath).catch(() => undefined);
+		this.eventService.emit({
+			kind: 'session.closeRequested',
+			sessionId: session.sessionId,
+			canonicalPathKey: session.canonicalPathKey,
+			revision: session.revision,
+		});
+		if (this.context.fileSystem && session.lockFilePath) {
+			await this.context.fileSystem.unlink(session.lockFilePath).catch(() => undefined);
+		}
 		session.lockHeld = false;
 		session.closed = true;
 		this.context.sessions.delete(session.sessionId);
 		this.context.sessionsByPath.delete(session.canonicalPathKey);
 		this.cacheService.removeSession(session.sessionId);
 		this.jobService.removeSession(session.sessionId);
-		this.eventService.emit({ kind: 'session.closed', sessionId: session.sessionId, canonicalPathKey: session.canonicalPathKey, revision: session.revision });
+		this.eventService.emit({
+			kind: 'session.closed',
+			sessionId: session.sessionId,
+			canonicalPathKey: session.canonicalPathKey,
+			revision: session.revision,
+		});
 		this.eventService.removeSession(session.sessionId);
 
-		return success('runtime', startedAt, {
-			sessionId: session.sessionId,
-			closed: true,
-		}, { sessionId: session.sessionId, revision: session.revision });
+		return success(
+			'runtime',
+			startedAt,
+			{
+				sessionId: session.sessionId,
+				closed: true,
+			},
+			{ sessionId: session.sessionId, revision: session.revision },
+		);
 	}
 }

package/src/storage.ts

@@ -0,0 +1,192 @@
+import type { FileSystem as CoreProjectFileSystem } from '@openfairygui/core/project-io';
+import type { BackendFileHandle, BackendFileStat, BackendFileSystem } from './runtime.js';
+
+type StorageStatKind = 'file' | 'directory';
+
+export interface BackendStorageStatLike {
+	kind?: StorageStatKind;
+	type?: StorageStatKind;
+	isFile?(): boolean;
+	isDirectory?(): boolean;
+}
+
+export interface BackendAsyncStorageAdapter {
+	readFile(filePath: string): Promise<string>;
+	readFileRaw(filePath: string): Promise<Uint8Array>;
+	writeFile(filePath: string, content: string): Promise<void>;
+	writeFileRaw(filePath: string, data: Uint8Array): Promise<void>;
+	mkdir(dirPath: string, options?: { recursive?: boolean }): Promise<void>;
+	readdir(dirPath: string): Promise<string[]>;
+	exists?(filePath: string): Promise<boolean>;
+	stat?(filePath: string): Promise<BackendStorageStatLike>;
+	resolvePath?(filePath: string): Promise<string>;
+	openExclusive?(filePath: string): Promise<BackendFileHandle>;
+	unlink?(filePath: string): Promise<void>;
+	join?(...paths: string[]): string;
+	dirname?(filePath: string): string;
+	resolve?(...paths: string[]): string;
+}
+
+class StorageFileStat implements BackendFileStat {
+	public constructor(private readonly kind: StorageStatKind) {}
+
+	public isFile(): boolean {
+		return this.kind === 'file';
+	}
+
+	public isDirectory(): boolean {
+		return this.kind === 'directory';
+	}
+}
+
+function createPathError(code: string, message: string): Error & { code: string } {
+	const error = new Error(message) as Error & { code: string };
+	error.code = code;
+	return error;
+}
+
+function normalizeStoragePath(value: string): string {
+	const normalized = value.replace(/\\/g, '/').replace(/\/+/g, '/');
+	const absolute = normalized.startsWith('/');
+	const rawSegments = normalized.split('/').filter((segment) => segment.length > 0);
+	const segments: string[] = [];
+
+	for (const segment of rawSegments) {
+		if (segment === '.') continue;
+		if (segment === '..') {
+			if (segments.length > 0) segments.pop();
+			continue;
+		}
+		segments.push(segment);
+	}
+
+	const joined = segments.join('/');
+	if (absolute) return joined ? `/${joined}` : '/';
+	return joined || '.';
+}
+
+function joinStoragePath(...paths: string[]): string {
+	return normalizeStoragePath(paths.filter((part) => part.length > 0).join('/'));
+}
+
+function dirnameStoragePath(filePath: string): string {
+	const normalized = normalizeStoragePath(filePath);
+	if (normalized === '/' || normalized === '.') return '.';
+	const absolute = normalized.startsWith('/');
+	const parts = normalized.split('/').filter((part) => part.length > 0);
+	parts.pop();
+	if (parts.length === 0) return absolute ? '/' : '.';
+	return `${absolute ? '/' : ''}${parts.join('/')}`;
+}
+
+function statFromLike(stat: BackendStorageStatLike): BackendFileStat {
+	if (typeof stat.isFile === 'function' && typeof stat.isDirectory === 'function') {
+		return stat as BackendFileStat;
+	}
+	const kind = stat.kind ?? stat.type;
+	if (kind === 'file' || kind === 'directory') return new StorageFileStat(kind);
+	throw createPathError('EINVAL', 'Storage stat must provide kind/type or isFile()/isDirectory().');
+}
+
+async function inferStat(storage: BackendAsyncStorageAdapter, filePath: string): Promise<BackendFileStat> {
+	if (storage.stat) return statFromLike(await storage.stat(filePath));
+
+	try {
+		await storage.readdir(filePath);
+		return new StorageFileStat('directory');
+	} catch {
+		// Try file probes below.
+	}
+
+	try {
+		await storage.readFileRaw(filePath);
+		return new StorageFileStat('file');
+	} catch {
+		try {
+			await storage.readFile(filePath);
+			return new StorageFileStat('file');
+		} catch {
+			throw createPathError('ENOENT', `Storage path not found: ${filePath}`);
+		}
+	}
+}
+
+export type BackendStorageFileSystem = BackendFileSystem & CoreProjectFileSystem;
+
+export function createBackendStorageFileSystem(storage: BackendAsyncStorageAdapter): BackendStorageFileSystem {
+	const lockedPaths = new Set<string>();
+
+	const fileSystem: BackendStorageFileSystem = {
+		stat(filePath: string): Promise<BackendFileStat> {
+			return inferStat(storage, fileSystem.resolve(filePath));
+		},
+		readdir(dirPath: string): Promise<string[]> {
+			return storage.readdir(fileSystem.resolve(dirPath));
+		},
+		readFile(filePath: string): Promise<string> {
+			return storage.readFile(fileSystem.resolve(filePath));
+		},
+		readFileRaw(filePath: string): Promise<Uint8Array> {
+			return storage.readFileRaw(fileSystem.resolve(filePath));
+		},
+		writeFile(filePath: string, content: string): Promise<void> {
+			return storage.writeFile(fileSystem.resolve(filePath), content);
+		},
+		writeFileRaw(filePath: string, data: Uint8Array): Promise<void> {
+			return storage.writeFileRaw(fileSystem.resolve(filePath), data);
+		},
+		mkdir(dirPath: string, options?: { recursive?: boolean }): Promise<void> {
+			return storage.mkdir(fileSystem.resolve(dirPath), options);
+		},
+		async exists(filePath: string): Promise<boolean> {
+			if (storage.exists) return storage.exists(fileSystem.resolve(filePath));
+			try {
+				await fileSystem.stat(filePath);
+				return true;
+			} catch {
+				return false;
+			}
+		},
+		resolvePath(filePath: string): Promise<string> {
+			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}`);
+			}
+			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);
+				},
+			};
+		},
+		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().');
+		},
+		join(...paths: string[]): string {
+			return storage.join ? storage.join(...paths) : joinStoragePath(...paths);
+		},
+		dirname(filePath: string): string {
+			return storage.dirname ? storage.dirname(filePath) : dirnameStoragePath(filePath);
+		},
+		resolve(...paths: string[]): string {
+			return storage.resolve ? storage.resolve(...paths) : joinStoragePath(...paths);
+		},
+	};
+
+	return fileSystem;
+}