Files
openchamber/packages/ui/src/contexts/RuntimeAPIProvider.tsx
T

162 lines
5.6 KiB
TypeScript
Raw Normal View History

2025-12-07 19:32:53 +02:00
import React, { type JSX, type ReactNode } from 'react';
import { RuntimeAPIContext } from '@/contexts/runtimeAPIContext';
import type { FilesAPI, RuntimeAPIs } from '@/lib/api/types';
import {
approxStringBytes,
evictContentLru,
setContentBytes,
touchContent as touchContentLru,
removeContentBytes,
} from '@/sync/content-cache';
/** Wrap a FilesAPI with an in-memory LRU content cache. */
function withContentCache(files: FilesAPI): FilesAPI {
const cache = new Map<string, { content: string; path: string; size?: number; mtimeMs?: number }>();
const removeCacheEntry = (path: string) => {
cache.delete(path);
removeContentBytes(path);
};
const removeCacheEntriesByPrefix = (path: string) => {
const prefix = path.endsWith('/') ? path : `${path}/`;
for (const key of cache.keys()) {
if (key === path || key.startsWith(prefix)) {
removeCacheEntry(key);
}
}
};
/** Whether cached metadata still matches the file on disk. */
const statMatches = (
cached: { size?: number; mtimeMs?: number },
latest: { isFile: boolean; size: number; mtimeMs?: number },
): boolean => {
if (!latest.isFile) return false;
// If mtimeMs is available on both sides, it is the strongest signal.
if (cached.mtimeMs !== undefined && latest.mtimeMs !== undefined) {
return cached.mtimeMs === latest.mtimeMs && cached.size === latest.size;
}
return cached.size === latest.size;
};
const syncCacheEntry = (
path: string,
result: { content: string; path: string },
stat?: { isFile: boolean; size: number; mtimeMs?: number } | null,
): { content: string; path: string } => {
const bytes = approxStringBytes(result.content);
cache.set(path, {
...result,
size: stat?.isFile ? stat.size : undefined,
mtimeMs: stat?.isFile ? stat.mtimeMs : undefined,
});
setContentBytes(path, bytes);
const keep = new Set<string>();
evictContentLru(keep, (evictPath) => {
cache.delete(evictPath);
});
return result;
};
const readFreshFile = async (path: string, options?: Parameters<NonNullable<FilesAPI['readFile']>>[1]): Promise<{ content: string; path: string }> => {
// stat → read → stat to avoid TOCTOU:
// if the file changes between read and either stat, metadata won't match and we retry.
const statBefore = await files.statFile?.(path, options).catch(() => null);
const result = await files.readFile!(path, options);
const statAfter = await files.statFile?.(path, options).catch(() => null);
// If both stats are available and agree, the read was atomic with respect to file changes.
if (statBefore && statAfter && statBefore.isFile && statAfter.isFile) {
if (statBefore.size === statAfter.size && statBefore.mtimeMs === statAfter.mtimeMs) {
return syncCacheEntry(path, result, statAfter);
}
// File changed during read — discard and re-read once.
const retryStatBefore = await files.statFile?.(path, options).catch(() => null);
const retry = await files.readFile!(path, options);
const retryStat = await files.statFile?.(path, options).catch(() => null);
// Accept retry only if file was stable across the read.
if (retryStatBefore && retryStat && retryStatBefore.isFile && retryStat.isFile
&& retryStatBefore.size === retryStat.size && retryStatBefore.mtimeMs === retryStat.mtimeMs) {
return syncCacheEntry(path, retry, retryStat);
}
// Best-effort: file was still changing, cache what we got. Next hit will re-validate.
return syncCacheEntry(path, retry, retryStat);
}
return syncCacheEntry(path, result, statAfter ?? statBefore);
};
const cachedReadFile: FilesAPI['readFile'] = files.readFile
? async (path: string, options) => {
if (options?.allowOutsideWorkspace) {
return readFreshFile(path, options);
}
const hit = cache.get(path);
if (hit) {
// Validate cached entry is still fresh
if (files.statFile) {
const latest = await files.statFile(path, options).catch(() => {
removeCacheEntry(path);
return null;
});
if (!latest || !statMatches(hit, latest)) {
removeCacheEntry(path);
return readFreshFile(path, options);
}
}
touchContentLru(path);
return { content: hit.content, path: hit.path };
}
return readFreshFile(path, options);
}
: undefined;
// Invalidate cache on writes, deletes, renames
const cachedWriteFile: FilesAPI['writeFile'] = files.writeFile
? async (path, content) => {
removeCacheEntry(path);
return files.writeFile!(path, content);
}
: undefined;
const cachedDelete: FilesAPI['delete'] = files.delete
? async (path) => {
removeCacheEntriesByPrefix(path);
return files.delete!(path);
}
: undefined;
const cachedRename: FilesAPI['rename'] = files.rename
? async (oldPath, newPath) => {
removeCacheEntriesByPrefix(oldPath);
removeCacheEntriesByPrefix(newPath);
return files.rename!(oldPath, newPath);
}
: undefined;
return {
...files,
readFile: cachedReadFile,
writeFile: cachedWriteFile,
delete: cachedDelete,
rename: cachedRename,
};
}
2025-12-07 19:32:53 +02:00
export function RuntimeAPIProvider({ apis, children }: { apis: RuntimeAPIs; children: ReactNode }): JSX.Element {
const cachedApis = React.useMemo<RuntimeAPIs>(
() => ({
...apis,
files: withContentCache(apis.files),
}),
[apis],
);
return <RuntimeAPIContext.Provider value={cachedApis}>{children}</RuntimeAPIContext.Provider>;
2025-12-07 19:32:53 +02:00
}