sidekick-shared 0.27.6 → 0.28.0

package/dist/esm/sessionPreviews.js

@@ -0,0 +1,522 @@
+/**
+ * Cheap, bounded previews of provider-native session files (Node-only).
+ *
+ * `listRecentSessions` answers "what happened in this workspace" but labels
+ * every discovered session before applying its limit, so its cost scales with
+ * total session count. This module inverts the order of operations: enumerate
+ * with stats only, sort by mtime, apply `since`/`limit`, and only then do
+ * bounded content reads for the survivors. That keeps a "recent sessions"
+ * surface cheap even against a machine with thousands of accumulated sessions.
+ *
+ * Prompt extraction delegates to each provider's `extractSessionLabel` (Claude
+ * Code reads only the first 8 KiB; Codex prefers the sqlite thread title, else
+ * a bounded first-user-message scan that skips injected context). The first
+ * timestamp and workspace path come from one generic prefix parse in this
+ * module. A session whose opening events are larger than the prefix budget
+ * yields `null` fields rather than an error.
+ *
+ * @module sessionPreviews
+ */
+import * as fs from 'fs';
+function emptyPrefixScan() {
+    return { firstTimestamp: null, workspacePath: null };
+}
+const DEFAULT_PREFIX_BYTES = 16 * 1024;
+const DEFAULT_LIMIT = 50;
+const DEFAULT_CONCURRENCY = 4;
+const MAX_CONCURRENCY = 16;
+/**
+ * Reads a bounded preview of one session file. Returns `null` when the file is
+ * missing or unreadable; malformed content degrades to `null` fields instead
+ * of throwing.
+ */
+export function readSessionPreview(provider, sessionPath, options = {}) {
+    let sizeBytes;
+    let modifiedAt;
+    try {
+        const stats = fs.statSync(sessionPath);
+        sizeBytes = stats.size;
+        // Inside the try: an out-of-range mtime RangeErrors on serialization,
+        // and this function's contract is to degrade, not throw.
+        modifiedAt = stats.mtime.toISOString();
+    }
+    catch {
+        let metadata;
+        try {
+            metadata = provider.getSessionMetadata?.(sessionPath);
+        }
+        catch {
+            return null;
+        }
+        if (!metadata)
+            return null;
+        sizeBytes = 0;
+        try {
+            modifiedAt = metadata.mtime.toISOString();
+        }
+        catch {
+            return null;
+        }
+    }
+    let firstUserPrompt = null;
+    try {
+        firstUserPrompt = provider.extractSessionLabel(sessionPath);
+    }
+    catch {
+        // Label extraction is best-effort.
+    }
+    let sessionId = '';
+    try {
+        sessionId = provider.getSessionId(sessionPath);
+    }
+    catch {
+        // A provider that cannot identify the file still yields a usable preview.
+    }
+    const prefixBudget = options.maxPrefixBytes ?? DEFAULT_PREFIX_BYTES;
+    const prefix = prefixBudget > 0 ? scanPrefix(sessionPath, prefixBudget) : emptyPrefixScan();
+    return {
+        provider: provider.id,
+        sessionId,
+        filePath: sessionPath,
+        modifiedAt,
+        sizeBytes,
+        firstUserPrompt,
+        firstTimestamp: prefix.firstTimestamp,
+        workspacePath: prefix.workspacePath,
+    };
+}
+/** Event-loop-safe counterpart to readSessionPreview with per-call degradation status. */
+export async function readSessionPreviewAsync(provider, sessionPath, options = {}) {
+    let labels;
+    const diagnostics = [];
+    try {
+        labels = await extractLabelsAsync(provider, [sessionPath], options);
+    }
+    catch {
+        labels = new Map([[sessionPath, null]]);
+        diagnostics.push({
+            providerId: provider.id,
+            kind: 'read_failed',
+            severity: 'warning',
+            phase: 'read',
+            message: `${provider.id} session label was unavailable.`,
+        });
+    }
+    const info = await statSessionFileAsync(provider, sessionPath);
+    if (!info) {
+        return {
+            preview: null,
+            diagnostics: dedupeDiagnostics([...diagnostics, ...providerDiagnostics(provider)]),
+        };
+    }
+    const preview = await readSessionPreviewFromInfoAsync(provider, info, labels.get(sessionPath) ?? null, options);
+    return {
+        preview,
+        diagnostics: dedupeDiagnostics([...diagnostics, ...providerDiagnostics(provider)]),
+    };
+}
+/**
+ * Lists previews across providers, newest first. Enumeration is stat-only;
+ * content is read only for the post-`limit` survivors.
+ */
+export function listSessionPreviews(providers, options = {}) {
+    const limit = Math.max(0, options.limit ?? DEFAULT_LIMIT);
+    const sinceMs = resolveSinceMs(options.since);
+    const candidates = [];
+    for (const provider of providers) {
+        for (const file of enumerateSessionFiles(provider, options.workspacePath)) {
+            const mtimeMs = file.mtime.getTime();
+            if (sinceMs !== null && mtimeMs <= sinceMs)
+                continue;
+            candidates.push({ provider, path: file.path, mtimeMs });
+        }
+    }
+    candidates.sort((left, right) => right.mtimeMs - left.mtimeMs);
+    const previews = [];
+    for (const candidate of candidates.slice(0, limit)) {
+        const preview = readSessionPreview(candidate.provider, candidate.path, options);
+        if (preview)
+            previews.push(preview);
+    }
+    return previews;
+}
+/**
+ * Lists previews without blocking the caller loop on corpus-wide synchronous
+ * work. SQLite-backed providers perform at most one subprocess per call.
+ */
+export async function listSessionPreviewsAsync(providers, options = {}) {
+    const limit = Math.max(0, options.limit ?? DEFAULT_LIMIT);
+    const sinceMs = resolveSinceMs(options.since);
+    const candidates = [];
+    const operationDiagnostics = [];
+    await Promise.all(providers.map(async (provider) => {
+        let files = [];
+        try {
+            files = provider.listSessionFilesAsync
+                ? await provider.listSessionFilesAsync(options.workspacePath)
+                : await enumerateSessionFilesAsyncFallback(provider, options.workspacePath, options);
+        }
+        catch {
+            files = [];
+            operationDiagnostics.push({
+                providerId: provider.id,
+                kind: 'read_failed',
+                severity: 'error',
+                phase: 'enumerate',
+                message: `${provider.id} session enumeration failed.`,
+            });
+        }
+        for (const info of files) {
+            const mtimeMs = info.mtime.getTime();
+            if (sinceMs !== null && mtimeMs <= sinceMs)
+                continue;
+            candidates.push({ provider, info });
+        }
+    }));
+    candidates.sort((left, right) => right.info.mtime.getTime() - left.info.mtime.getTime());
+    const selected = candidates.slice(0, limit);
+    const labels = new Map();
+    await Promise.all(providers.map(async (provider) => {
+        const paths = selected
+            .filter((item) => item.provider === provider)
+            .map((item) => item.info.path);
+        if (paths.length === 0)
+            return;
+        try {
+            labels.set(provider, await extractLabelsAsync(provider, paths, options));
+        }
+        catch {
+            labels.set(provider, new Map(paths.map((sessionPath) => [sessionPath, null])));
+            operationDiagnostics.push({
+                providerId: provider.id,
+                kind: 'read_failed',
+                severity: 'warning',
+                phase: 'read',
+                message: `${provider.id} session labels were unavailable.`,
+            });
+        }
+    }));
+    const previews = await mapWithConcurrency(selected, async ({ provider, info }) => {
+        const preview = await readSessionPreviewFromInfoAsync(provider, info, labels.get(provider)?.get(info.path) ?? info.label ?? null, options);
+        await yieldControl(options);
+        return preview;
+    }, concurrency(options));
+    return {
+        previews: previews.filter((preview) => preview !== null),
+        hasMore: candidates.length > limit,
+        diagnostics: dedupeDiagnostics([
+            ...operationDiagnostics,
+            ...providers.flatMap(providerDiagnostics),
+        ]),
+    };
+}
+function resolveSinceMs(since) {
+    if (since === undefined)
+        return null;
+    const ms = since instanceof Date ? since.getTime() : Date.parse(since);
+    if (!Number.isFinite(ms)) {
+        // An unparseable cutoff used to mean "no cutoff", silently returning
+        // every session. Fail loudly instead so a typo cannot masquerade as a
+        // full listing.
+        throw new RangeError(`Invalid \`since\` value: ${String(since)}`);
+    }
+    return ms;
+}
+function enumerateSessionFiles(provider, workspacePath) {
+    try {
+        if (workspacePath) {
+            return provider
+                .findAllSessions(workspacePath)
+                .map(statSessionFile)
+                .filter((info) => info !== null);
+        }
+        if (provider.listAllSessionFiles)
+            return provider.listAllSessionFiles();
+        // Best-effort global fallback for providers without listAllSessionFiles:
+        // correct for project-folder-shaped providers, empty otherwise.
+        const results = [];
+        const seen = new Set();
+        for (const folder of provider.getAllProjectFolders()) {
+            for (const sessionPath of provider.findSessionsInDirectory(folder.dir)) {
+                if (seen.has(sessionPath))
+                    continue;
+                seen.add(sessionPath);
+                const info = statSessionFile(sessionPath);
+                if (info)
+                    results.push(info);
+            }
+        }
+        return results;
+    }
+    catch {
+        return [];
+    }
+}
+function statSessionFile(sessionPath) {
+    try {
+        return { path: sessionPath, mtime: fs.statSync(sessionPath).mtime };
+    }
+    catch {
+        return null;
+    }
+}
+async function statSessionFileAsync(provider, sessionPath) {
+    try {
+        const stat = await fs.promises.stat(sessionPath);
+        return {
+            path: sessionPath,
+            mtime: stat.mtime,
+            sizeBytes: stat.size,
+            sessionId: safeSessionId(provider, sessionPath),
+        };
+    }
+    catch {
+        let metadata = null;
+        try {
+            // Async first: for DB-backed synthetic paths the sync variant can spawn
+            // a blocking sqlite3 subprocess, defeating this API's event-loop safety.
+            if (provider.getSessionMetadataAsync) {
+                metadata = await provider.getSessionMetadataAsync(sessionPath);
+            }
+            else {
+                metadata = provider.getSessionMetadata?.(sessionPath) ?? null;
+            }
+        }
+        catch {
+            metadata = null;
+        }
+        if (!metadata)
+            return null;
+        return {
+            path: sessionPath,
+            mtime: metadata.mtime,
+            sizeBytes: 0,
+            sessionId: safeSessionId(provider, sessionPath),
+        };
+    }
+}
+async function extractLabelsAsync(provider, sessionPaths, options) {
+    if (provider.extractSessionLabelsAsync) {
+        // Callers deliberately do not retry through the synchronous provider path
+        // if this batch fails: DB-backed providers could otherwise spawn once per
+        // session after their single async batch failed.
+        return provider.extractSessionLabelsAsync(sessionPaths);
+    }
+    const values = new Map();
+    for (const sessionPath of sessionPaths) {
+        values.set(sessionPath, await extractLabelWithYield(provider, sessionPath, options));
+    }
+    return values;
+}
+async function enumerateSessionFilesAsyncFallback(provider, workspacePath, options) {
+    await yieldControl(options);
+    const paths = workspacePath
+        ? provider.findAllSessions(workspacePath)
+        : provider.listAllSessionFiles
+            ? provider.listAllSessionFiles().map((item) => item.path)
+            : provider
+                .getAllProjectFolders()
+                .flatMap((folder) => provider.findSessionsInDirectory(folder.dir));
+    return (await mapWithConcurrency([...new Set(paths)], async (sessionPath) => {
+        const info = await statSessionFileAsync(provider, sessionPath);
+        await yieldControl(options);
+        return info;
+    }, concurrency(options))).filter((item) => item !== null);
+}
+async function readSessionPreviewFromInfoAsync(provider, info, firstUserPrompt, options) {
+    let modifiedAt;
+    try {
+        modifiedAt = info.mtime.toISOString();
+    }
+    catch {
+        return null;
+    }
+    const prefixBudget = options.maxPrefixBytes ?? DEFAULT_PREFIX_BYTES;
+    const prefix = prefixBudget > 0 ? await scanPrefixAsync(info.path, prefixBudget) : emptyPrefixScan();
+    return {
+        provider: provider.id,
+        sessionId: info.sessionId ?? safeSessionId(provider, info.path),
+        filePath: info.path,
+        modifiedAt,
+        sizeBytes: info.sizeBytes ?? 0,
+        firstUserPrompt,
+        firstTimestamp: prefix.firstTimestamp ?? info.createdAt?.toISOString() ?? null,
+        workspacePath: prefix.workspacePath ?? info.workspacePath ?? null,
+    };
+}
+async function extractLabelWithYield(provider, sessionPath, options) {
+    await yieldControl(options);
+    try {
+        return provider.extractSessionLabel(sessionPath);
+    }
+    catch {
+        return null;
+    }
+}
+function safeSessionId(provider, sessionPath) {
+    try {
+        return provider.getSessionId(sessionPath);
+    }
+    catch {
+        return '';
+    }
+}
+function concurrency(options) {
+    const requested = options.concurrency ?? DEFAULT_CONCURRENCY;
+    if (!Number.isFinite(requested))
+        return DEFAULT_CONCURRENCY;
+    return Math.min(MAX_CONCURRENCY, Math.max(1, Math.floor(requested)));
+}
+async function yieldControl(options) {
+    if (options.yieldBetweenReads) {
+        await options.yieldBetweenReads();
+        return;
+    }
+    await new Promise((resolve) => setImmediate(resolve));
+}
+async function mapWithConcurrency(values, mapper, maxConcurrency) {
+    const results = new Array(values.length);
+    let cursor = 0;
+    await Promise.all(Array.from({ length: Math.min(maxConcurrency, values.length) }, async () => {
+        while (true) {
+            const index = cursor++;
+            if (index >= values.length)
+                return;
+            results[index] = await mapper(values[index]);
+        }
+    }));
+    return results;
+}
+function providerDiagnostics(provider) {
+    try {
+        return [...(provider.getLastOperationStatus?.().diagnostics ?? [])];
+    }
+    catch {
+        return [];
+    }
+}
+function dedupeDiagnostics(diagnostics) {
+    const seen = new Set();
+    return diagnostics.filter((diagnostic) => {
+        const key = `${diagnostic.providerId}\0${diagnostic.kind}\0${diagnostic.phase}`;
+        if (seen.has(key))
+            return false;
+        seen.add(key);
+        return true;
+    });
+}
+/**
+ * Parses complete JSONL lines out of the first `maxPrefixBytes` of a file,
+ * taking the first top-level `timestamp` string and the first workspace path
+ * (top-level `cwd`, or `payload.cwd` on a Codex `session_meta` row). Partial
+ * trailing lines and malformed rows are skipped; never throws.
+ */
+function scanPrefix(sessionPath, maxPrefixBytes) {
+    const result = { firstTimestamp: null, workspacePath: null };
+    let content;
+    let sawWholeFile;
+    try {
+        const descriptor = fs.openSync(sessionPath, 'r');
+        try {
+            const size = fs.fstatSync(descriptor).size;
+            const readBytes = Math.min(size, Math.max(1, maxPrefixBytes));
+            const buffer = Buffer.alloc(readBytes);
+            fs.readSync(descriptor, buffer, 0, readBytes, 0);
+            content = buffer.toString('utf8');
+            sawWholeFile = readBytes >= size;
+        }
+        finally {
+            fs.closeSync(descriptor);
+        }
+    }
+    catch {
+        return result;
+    }
+    const lines = content.split('\n');
+    // The final chunk after the last newline is a partial line unless the whole
+    // file fit in the prefix.
+    const completeLines = sawWholeFile ? lines : lines.slice(0, -1);
+    for (const line of completeLines) {
+        const trimmed = line.trim();
+        if (!trimmed)
+            continue;
+        let parsed;
+        try {
+            parsed = JSON.parse(trimmed);
+        }
+        catch {
+            continue;
+        }
+        if (parsed === null || typeof parsed !== 'object')
+            continue;
+        if (result.firstTimestamp === null && typeof parsed.timestamp === 'string') {
+            result.firstTimestamp = parsed.timestamp;
+        }
+        if (result.workspacePath === null) {
+            if (typeof parsed.cwd === 'string' && parsed.cwd) {
+                result.workspacePath = parsed.cwd;
+            }
+            else if (parsed.type === 'session_meta') {
+                const payload = parsed.payload;
+                if (payload && typeof payload.cwd === 'string' && payload.cwd) {
+                    result.workspacePath = payload.cwd;
+                }
+            }
+        }
+        if (result.firstTimestamp !== null && result.workspacePath !== null)
+            break;
+    }
+    return result;
+}
+async function scanPrefixAsync(sessionPath, maxPrefixBytes) {
+    const result = { firstTimestamp: null, workspacePath: null };
+    let handle = null;
+    try {
+        handle = await fs.promises.open(sessionPath, 'r');
+        const stats = await handle.stat();
+        const readBytes = Math.min(stats.size, Math.max(1, maxPrefixBytes));
+        const buffer = Buffer.alloc(readBytes);
+        const { bytesRead } = await handle.read(buffer, 0, readBytes, 0);
+        parsePrefixInto(result, buffer.toString('utf8', 0, bytesRead), bytesRead >= stats.size);
+    }
+    catch {
+        return result;
+    }
+    finally {
+        await handle?.close().catch(() => undefined);
+    }
+    return result;
+}
+function parsePrefixInto(result, content, sawWholeFile) {
+    const lines = content.split('\n');
+    const completeLines = sawWholeFile ? lines : lines.slice(0, -1);
+    for (const line of completeLines) {
+        const trimmed = line.trim();
+        if (!trimmed)
+            continue;
+        let parsed;
+        try {
+            parsed = JSON.parse(trimmed);
+        }
+        catch {
+            continue;
+        }
+        if (parsed === null || typeof parsed !== 'object')
+            continue;
+        if (result.firstTimestamp === null && typeof parsed.timestamp === 'string') {
+            result.firstTimestamp = parsed.timestamp;
+        }
+        if (result.workspacePath === null) {
+            if (typeof parsed.cwd === 'string' && parsed.cwd)
+                result.workspacePath = parsed.cwd;
+            else if (parsed.type === 'session_meta') {
+                const payload = parsed.payload;
+                if (payload && typeof payload.cwd === 'string' && payload.cwd) {
+                    result.workspacePath = payload.cwd;
+                }
+            }
+        }
+        if (result.firstTimestamp !== null && result.workspacePath !== null)
+            break;
+    }
+}