pi-lens 4.3.0 → 4.4.0

package/dist/clients/tree-sitter-cache.js

@@ -1,364 +0,0 @@
-/**
- * Tree-sitter Tree Cache
- *
- * Caches parsed ASTs so a file written once is parsed once and reused by every
- * subsystem that inspects it in the same process (#675).
- *
- * Freshness is hash-authoritative when the caller supplies content: identical
- * bytes parse to an identical tree, so a hash match is a hit even if the file's
- * mtime moved (an agent re-saving unchanged bytes must not force a reparse,
- * #890). Eviction is true LRU — hits re-insert their entry, so set() dropping
- * the Map's first key removes the least-recently-used file, not merely the
- * oldest insertion, and hot per-edit files survive scan traffic (#890).
- */
-import { logTreeSitterDiagnostic } from "./tree-sitter-logger.js";
-import * as crypto from "node:crypto";
-import * as fs from "node:fs";
-import { BoundedFifoMap } from "./bounded-cache.js";
-import { normalizeFilePath } from "./path-utils.js";
-const TREE_RETIREMENT_GRACE_MICROTASKS = 4;
-export const TREE_CACHE_COUNTER_KEYS = [
-    "lookups",
-    "hits",
-    "coldMisses",
-    "capacityMisses",
-    "contentChangedMisses",
-    "mtimeMisses",
-    "statFailedMisses",
-    "sets",
-    "replacements",
-    "evictions",
-    "clears",
-    "ghostHistoryDrops",
-];
-export function createTreeCacheCounters() {
-    // SAFETY: `Object.fromEntries` returns `Record<string, number>` — it cannot
-    // prove the key set. `TREE_CACHE_COUNTER_KEYS` is declared `as const
-    // satisfies readonly (keyof TreeCacheCounters)[]`, so the compiler already
-    // rejects a key that is not a counter; every counter is a `number` and
-    // every key gets 0, so the result has the full shape. The `satisfies`
-    // clause does NOT check the reverse direction: add a counter to
-    // `TreeCacheCounters` without adding its key here and this cast becomes a
-    // lie. `tests/clients/tree-sitter-cache.test.ts` closes that direction with
-    // a compile-time `[Exclude<keyof TreeCacheCounters, …>] extends [never]`
-    // assertion, so a missing key fails `tsc`, not just the suite.
-    return Object.fromEntries(TREE_CACHE_COUNTER_KEYS.map((key) => [key, 0]));
-}
-/** Interactive-editing default: safe LRU footprint for per-edit locality. */
-export const TREE_CACHE_DEFAULT_MAX_SIZE = 50;
-/**
- * Hard ceiling on how far a full-project scan may grow the tree cache
- * (#1715). Entry count is not the resource that matters — WASM heap is
- * (#417/#418, the leak this cache was fixed for once already) — so growing
- * capacity to fit a scan's working set must still cap the heap's worst case,
- * not just stop counting entries.
- *
- * Measured empirically on a fresh process (`heap-measure.mjs`, dropped from
- * this PR — see the PR body): parsing 800 synthetic ~3.6KB TypeScript files
- * with all 800 trees held resident (no eviction) grows `process.memoryUsage()
- * .external` by ~254MB over the same run with only 1 tree resident at a
- * time — about 330KB of non-V8 (WASM-backed) heap per resident tree on that
- * sample. At the interactive default of 50 entries that is a ~16MB
- * worst case; at this 500-entry ceiling it is a ~165MB worst case — bounded
- * and stated, not unbounded growth.
- */
-export const TREE_CACHE_SCAN_CAPACITY_CEILING = 500;
-/**
- * Derive the capacity a full-project scan should grow the tree cache to
- * (#1715): span the scan's file count so a second scan over the same files
- * reuses every tree instead of re-parsing files the LRU evicted at the
- * interactive default — bounded by `TREE_CACHE_SCAN_CAPACITY_CEILING` (or
- * its `PI_LENS_TREE_SITTER_CACHE_SCAN_CAP` override) so the heap cost stated
- * above stays a real ceiling. Never shrinks a capacity the cache already
- * has — a later, smaller scan (or an unrelated caller) must not undo an
- * earlier grow.
- */
-export function deriveScanTreeCacheCapacity(fileCount, currentMaxSize) {
-    const envRaw = process.env.PI_LENS_TREE_SITTER_CACHE_SCAN_CAP;
-    const envValue = envRaw !== undefined ? Number.parseInt(envRaw, 10) : Number.NaN;
-    const ceiling = Number.isSafeInteger(envValue) && envValue > 0
-        ? envValue
-        : TREE_CACHE_SCAN_CAPACITY_CEILING;
-    const target = Math.min(Math.max(fileCount, TREE_CACHE_DEFAULT_MAX_SIZE), ceiling);
-    return Math.max(currentMaxSize, target);
-}
-export class TreeCache {
-    // BoundedFifoMap, not BoundedLruCache, even though eviction here IS true
-    // LRU: recency is refreshed by this class's own explicit `delete`+`set`
-    // touch on a VALIDATED hit (see `get`), and only there. A `get` that
-    // promoted on every read would also promote entries `get` goes on to
-    // reject (content-hash mismatch returns null without removing), silently
-    // changing which entry eviction targets (#2442 review F7).
-    cache = new BoundedFifoMap(TREE_CACHE_DEFAULT_MAX_SIZE);
-    recentlyEvicted;
-    evictionHistoryMax;
-    debug;
-    counters = createTreeCacheCounters();
-    counterObserver;
-    treeErrorObserver;
-    constructor(maxSize = TREE_CACHE_DEFAULT_MAX_SIZE, debug = false, evictionHistoryMax = 4096, counterObserver, treeErrorObserver) {
-        this.cache.setMaxEntries(Math.max(1, Math.floor(maxSize)));
-        this.evictionHistoryMax = Math.max(1, Math.floor(evictionHistoryMax));
-        this.recentlyEvicted = new BoundedFifoMap(this.evictionHistoryMax);
-        this.counterObserver = counterObserver;
-        this.treeErrorObserver = treeErrorObserver;
-        this.debug = debug
-            ? (msg) => logTreeSitterDiagnostic({
-                subsystem: "tree-cache",
-                level: "debug",
-                message: msg,
-            })
-            : () => { };
-    }
-    recordCounter(key, amount = 1) {
-        this.counters[key] += amount;
-        this.counterObserver?.(key, amount);
-    }
-    /** Current capacity ceiling (entry count, not bytes — see class docstring). */
-    getMaxSize() {
-        return this.cache.getMaxEntries();
-    }
-    /**
-     * Resize the capacity ceiling (#1715). Growing only changes the bound —
-     * existing entries are untouched. Shrinking evicts the LRU tail down to
-     * the new size through the same `removeEntry` path eviction uses, so a
-     * shrink still frees every dropped tree's WASM heap (#417) instead of
-     * silently orphaning it. `n` is floored at 1: a cache that can hold zero
-     * entries can never record a hit.
-     */
-    setMaxSize(n) {
-        this.retireEvicted(this.cache.setMaxEntries(Math.max(1, Math.floor(n))));
-    }
-    /**
-     * Book-keep entries the bounded map dropped: ghost history, the eviction
-     * counter, and the WASM-heap tree retirement (#417/#890) that made this
-     * cache's eviction side-effect-coupled in the first place. One
-     * implementation, shared by the two paths that can overflow
-     * ({@link setMaxSize} and {@link set}) — the shape `BoundedFifoMap.set`'s
-     * `[key, value]` return exists to enable (#2442 review F7).
-     */
-    retireEvicted(evicted) {
-        for (const [key, cached] of evicted) {
-            this.rememberEviction(key, cached);
-            this.recordCounter("evictions");
-            // The bounded map already removed the entry, so retire the tree
-            // directly rather than through removeEntry's re-lookup.
-            this.retireTree(cached.tree);
-            this.debug(`Evicted: ${key}`);
-        }
-    }
-    /**
-     * Free a tree-sitter Tree's WASM-heap allocation.
-     *
-     * web-tree-sitter Trees live in the WASM heap; JS GC reclaims only the wrapper,
-     * so the underlying memory leaks unless `tree.delete()` is called explicitly
-     * (no FinalizationRegistry auto-free in 0.25). Guarded — a tree may already be
-     * deleted, or `delete()` may throw on a corrupt/aborted runtime. Retirement is
-     * deferred so direct parse callers resume before deletion; consumers still
-     * traverse without another await, or use the cache-safe callback API (#417).
-     * The eviction target is the least-recently-used entry (get() re-inserts
-     * hits), never the just-parsed tree still in a caller's hand.
-     */
-    // biome-ignore lint/suspicious/noExplicitAny: web-tree-sitter Tree
-    freeTree(tree) {
-        try {
-            if (tree && typeof tree.delete === "function")
-                tree.delete();
-        }
-        catch (error) {
-            this.treeErrorObserver?.(error);
-        }
-    }
-    retireTree(tree) {
-        let remaining = TREE_RETIREMENT_GRACE_MICROTASKS;
-        const retire = () => {
-            if (remaining-- > 0) {
-                queueMicrotask(retire);
-                return;
-            }
-            this.freeTree(tree);
-        };
-        queueMicrotask(retire);
-    }
-    /** Remove a cache entry and retire its WASM tree after current consumers run. */
-    removeEntry(key) {
-        const cached = this.cache.get(key);
-        if (cached)
-            this.retireTree(cached.tree);
-        this.cache.delete(key);
-    }
-    rememberEviction(key, cached) {
-        this.recentlyEvicted.delete(key);
-        const dropped = this.recentlyEvicted.set(key, cached.contentHash);
-        if (dropped.length > 0)
-            this.recordCounter("ghostHistoryDrops");
-    }
-    /**
-     * Generate hash for file content
-     */
-    hashContent(content) {
-        return crypto
-            .createHash("sha256")
-            .update(content)
-            .digest("hex")
-            .slice(0, 16);
-    }
-    /**
-     * Get cache key for a file
-     */
-    getCacheKey(filePath, languageId) {
-        return `${languageId}:${normalizeFilePath(filePath)}`;
-    }
-    /**
-     * Check if tree is cached and valid.
-     *
-     * When `content` is provided the content hash is AUTHORITATIVE: a hash match
-     * is a hit regardless of mtime, and the entry's stat metadata is refreshed
-     * so a save-without-change (same bytes, newer mtime) does not masquerade as
-     * a disk modification (#890). The mtime check remains the freshness signal
-     * only on the content-less path, where nothing else can prove the cached
-     * tree current (`mtimeMisses`). A stat failure invalidates on both paths —
-     * a deleted file's entry is dead weight and its WASM tree should be freed.
-     *
-     * Every hit re-inserts the entry (raw Map delete+set — NOT removeEntry,
-     * which would retire the live tree) so eviction is true LRU (#890).
-     */
-    get(filePath, content, languageId) {
-        this.recordCounter("lookups");
-        const key = this.getCacheKey(filePath, languageId);
-        const cached = this.cache.get(key);
-        if (!cached) {
-            const evictedHash = this.recentlyEvicted.get(key);
-            if (evictedHash !== undefined &&
-                content !== undefined &&
-                evictedHash === this.hashContent(content)) {
-                this.recordCounter("capacityMisses");
-            }
-            else {
-                this.recordCounter("coldMisses");
-            }
-            this.debug(`Cache miss: ${filePath}`);
-            return null;
-        }
-        // (No language-mismatch check needed: the cache key is prefixed with
-        // languageId, so a key hit already implies the language matches.)
-        if (content !== undefined) {
-            // Check content hash — authoritative when content is provided.
-            const contentHash = this.hashContent(content);
-            if (cached.contentHash !== contentHash) {
-                this.recordCounter("contentChangedMisses");
-                this.debug(`Content changed: ${filePath} (${cached.lineCount} → ${content.split("\n").length} lines)`);
-                // Keep old tree for potential incremental update, but mark as stale
-                return null;
-            }
-        }
-        try {
-            const stats = fs.statSync(filePath);
-            if (content !== undefined) {
-                // The hash already proved the tree current: an mtime delta is a
-                // save-without-change (or touch/clock drift). Refresh metadata
-                // instead of invalidating (#890). Caveat: this stamps the CURRENT
-                // disk mtime onto an entry validated against caller-supplied
-                // content — if that content lags a newer disk write, lastModified
-                // no longer vouches for the disk bytes. So lastModified means
-                // "mtime last observed on a hash-confirmed hit"; the content-less
-                // path below may only treat it as freshness proof while all
-                // callers pass content (today they all do — the undefined path is
-                // exercised only by tests).
-                if (stats.mtimeMs !== cached.lastModified) {
-                    cached.lastModified = stats.mtimeMs;
-                    this.debug(`Refreshed mtime on hash-matched entry: ${filePath}`);
-                }
-            }
-            else if (stats.mtimeMs !== cached.lastModified) {
-                // No content to hash — mtime is the only freshness proof.
-                this.recordCounter("mtimeMisses");
-                this.debug(`File modified on disk: ${filePath}`);
-                this.removeEntry(key);
-                return null;
-            }
-        }
-        catch {
-            // File might be deleted, invalidate cache
-            this.recordCounter("statFailedMisses");
-            this.removeEntry(key);
-            return null;
-        }
-        // LRU touch: re-insert so this entry becomes the newest. The SAME entry
-        // object is re-set — no tree replacement, so nothing is retired and a
-        // retired tree can never be resurrected (#890).
-        this.cache.delete(key);
-        this.cache.set(key, cached);
-        this.recordCounter("hits");
-        this.debug(`Cache hit: ${filePath} (${cached.lineCount} lines)`);
-        return cached.tree;
-    }
-    /**
-     * Store parsed tree in cache
-     */
-    set(filePath, content, languageId, tree) {
-        this.recordCounter("sets");
-        const key = this.getCacheKey(filePath, languageId);
-        const contentHash = this.hashContent(content);
-        this.recentlyEvicted.delete(key);
-        // Free the tree we're about to replace at this key (re-parse of the same
-        // file) so it doesn't leak its WASM heap.
-        if (this.cache.has(key)) {
-            this.recordCounter("replacements");
-            this.removeEntry(key);
-        }
-        // Overflow eviction itself now happens on the `this.cache.set` below —
-        // the bounded map evicts the least-recently-used entry (this class's
-        // explicit delete+set touch on a validated hit makes insertion order
-        // recency order, #890) and hands back the dropped [key, tree] pair for
-        // `retireEvicted` to free.
-        let mtime = 0;
-        try {
-            mtime = fs.statSync(filePath).mtimeMs;
-        }
-        catch {
-            // File deleted between parse and cache — cache with mtime=0;
-            // next get() will miss on mtime check and re-parse
-        }
-        this.retireEvicted(this.cache.set(key, {
-            tree,
-            contentHash,
-            languageId,
-            fileSize: Buffer.byteLength(content, "utf8"),
-            lineCount: content.split("\n").length,
-            lastModified: mtime,
-        }));
-        this.debug(`Cached: ${filePath} (${content.split("\n").length} lines)`);
-    }
-    /**
-     * Clear entire cache
-     */
-    clear() {
-        this.recordCounter("clears");
-        for (const entry of this.cache.values()) {
-            this.retireTree(entry.tree);
-        }
-        this.cache.clear();
-        this.recentlyEvicted.clear();
-        this.debug("Cache cleared");
-    }
-    /**
-     * Get cache statistics
-     */
-    getStats() {
-        let totalLines = 0;
-        let totalBytes = 0;
-        for (const entry of this.cache.values()) {
-            totalLines += entry.lineCount;
-            totalBytes += entry.fileSize;
-        }
-        return {
-            ...this.counters,
-            size: this.cache.size,
-            maxSize: this.cache.getMaxEntries(),
-            totalLines,
-            totalBytes,
-            misses: this.counters.lookups - this.counters.hits,
-        };
-    }
-}