pi-lens/dist/clients/read-guard-logger.js

Real-time code feedback for pi — LSP, linters, formatters, type-checking, structural analysis & booboo

import * as path from "node:path";
import { isTestMode } from "./env-utils.js";
import { getGlobalPiLensDir } from "./file-utils.js";
import { createNdjsonLogger } from "./ndjson-logger.js";
const READ_GUARD_LOG_DIR = getGlobalPiLensDir();
const READ_GUARD_LOG_FILE = path.join(READ_GUARD_LOG_DIR, "read-guard.log");
const READ_GUARD_LOG_BACKUP_FILE = path.join(READ_GUARD_LOG_DIR, "read-guard.log.1");
const MAX_LOG_BYTES = Math.max(128 * 1024, Number.parseInt(process.env.PI_LENS_READ_GUARD_MAX_BYTES ?? "1048576", 10) ||
    1048576);
const writer = createNdjsonLogger({
    filePath: READ_GUARD_LOG_FILE,
    maxBytes: MAX_LOG_BYTES,
    backupPath: READ_GUARD_LOG_BACKUP_FILE,
});
const VERBOSE_READ_GUARD_LOG = process.env.PI_LENS_READ_GUARD_VERBOSE === "1" ||
    process.env.PI_LENS_READ_GUARD_LOG === "verbose";
const LOG_ALLOWED_EDITS = process.env.PI_LENS_READ_GUARD_LOG_ALLOWS === "1";
const SNAPSHOT_LOG_SETTING = (process.env.PI_LENS_READ_GUARD_LOG_SNAPSHOTS ?? "1").toLowerCase();
const LOG_SNAPSHOT_VALIDATION = !["0", "false", "off"].includes(SNAPSHOT_LOG_SETTING);
function shouldLogEvent(event) {
    if (VERBOSE_READ_GUARD_LOG)
        return true;
    if (event === "edit_allowed")
        return LOG_ALLOWED_EDITS;
    if (event === "range_snapshot_validation")
        return LOG_SNAPSHOT_VALIDATION;
    return (event === "edit_blocked" ||
        event === "edit_warned" ||
        event === "exemption_added" ||
        event === "oldtext_not_found" ||
        event === "oldtext_duplicate" ||
        event === "oldtext_indent_autopatched" ||
        event === "oldtext_trailing_ws_autopatched" ||
        event === "oldtext_escape_autopatched" ||
        event === "edit_range_relocated" ||
        event === "edit_preflight_blocked" ||
        event === "edit_partial_apply" ||
        event === "touched_lines_missing");
}
export function logReadGuardEvent(entry) {
    if (isTestMode() || !shouldLogEvent(entry.event)) {
        return;
    }
    writer.log({ ts: new Date().toISOString(), ...entry });
}
export function getReadGuardLogPath() {
    return READ_GUARD_LOG_FILE;
}
/** Resolve once all enqueued read-guard writes are on disk (tests/shutdown). */
export function flushReadGuardLog() {
    return writer.flush();
}