/** * Frontend leveled logging facade. * * TRACES: | DR-204 * * ## Why this exists * * The Rust half of the app is disciplined about logging: the `log` crate behind * `env_logger`, `LevelFilter::Info` by default, `RUST_LOG` to turn the volume up * without a rebuild (see `src-tauri/src/lib.rs`). The frontend had nothing — * every `console.log` written during development shipped to end users and ran on * every device, forever. * * This module is the frontend's `log` crate: four levels, a compile-environment * default, and a runtime override that is the moral equivalent of `RUST_LOG`. * * ## Levels * * `debug < info < warn < error`. A message is emitted when its level is at or * above the active level. * * - **debug** — the default for anything chatty: per-tick state, cache hits, * "entered this branch". Dev only. * - **info** — lifecycle/state events worth having in a user's console when * they are diagnosing something: sign-in, playback start, mode transfer. * - **warn** — recovered-from problems. Always emitted. * - **error** — failures the user may notice. Always emitted. * * ## Defaults * * Dev builds (`import.meta.env.DEV`) default to `debug`; production builds * default to `warn`. Production deliberately keeps **warn and error** — this is * a user-facing media client talking to a server that may or may not be there, * and a silent failure is far worse to support than a noisy console. Only the * chatter (`debug`/`info`) is suppressed. * * ## Runtime override (the `RUST_LOG` equivalent) * * A user filing a bug can turn verbose logging on in a shipped build without a * rebuild, from the webview console: * * ```js * localStorage.setItem("jellytau:logLevel", "debug"); // then reload * localStorage.removeItem("jellytau:logLevel"); // back to the default * ``` * * The key is read **once at module init** (so the level cannot change halfway * through a session and confuse a bug report) and every read is guarded — SSR * has no `localStorage`, and a webview with storage disabled *throws* on access * rather than returning `null`. Either way we fall back to the build default. * * ## Scopes * * `createLogger("VideoPlayer")` replaces the hand-rolled `"[VideoPlayer] …"` * prefixes that used to be typed into every call site. * * ```ts * const log = createLogger("VideoPlayer"); * log.debug("seeking to", position, { mode }); * ``` * * ## Pass-through, not a wrapper * * When a level is enabled the call goes straight to `console.*` with the * arguments **untouched** — no stringification, no JSON, no cloning — so object * references stay live and expandable in devtools. The scope is folded into the * leading string argument when there is one (keeping `console` grouping and * substitution behaviour intact), and passed as its own leading argument * otherwise. `console` is looked up at call time so `vi.spyOn(console, …)` and * devtools console overrides still see everything. * * `debug` maps to `console.log` rather than `console.debug` on purpose: * `console.debug` lands in the browser's "Verbose" bucket, which is hidden by * default in both Chrome DevTools and the WebKit inspector, so mapping there * would make dev logging invisible in exactly the builds that want it. */ /** Severity ordering. Higher wins. */ const LEVEL_RANK = { debug: 10, info: 20, warn: 30, error: 40, } as const; /** A log level, in the same vocabulary as the Rust `log` crate. */ export type LogLevel = keyof typeof LEVEL_RANK; /** The `localStorage` key that overrides the build-default level. */ export const LOG_LEVEL_STORAGE_KEY = "jellytau:logLevel"; /** Which `console` method backs each level. See the module header for `debug`. */ const CONSOLE_METHOD: Record = { debug: "log", info: "info", warn: "warn", error: "error", }; /** A scoped logger. One method per level, all variadic like `console.*`. */ export interface Logger { debug(...args: unknown[]): void; info(...args: unknown[]): void; warn(...args: unknown[]): void; error(...args: unknown[]): void; } /** * Coerce arbitrary input to a `LogLevel`, or `null` when it is not one. * Case- and whitespace-insensitive, because this parses human-typed input. */ export function parseLogLevel(raw: unknown): LogLevel | null { if (typeof raw !== "string") return null; const normalised = raw.trim().toLowerCase(); return normalised in LEVEL_RANK ? (normalised as LogLevel) : null; } /** The level a build defaults to with no override present. */ export function defaultLogLevel(): LogLevel { return import.meta.env?.DEV ? "debug" : "warn"; } /** * Read the override from `localStorage`, or `null` when there is none. * * Never throws. `localStorage` is absent under SSR and *throws on access* in a * webview with storage disabled or a blocked third-party context — logging must * not be the thing that takes the app down. */ export function readStoredLogLevel(): LogLevel | null { try { if (typeof localStorage === "undefined" || localStorage === null) return null; return parseLogLevel(localStorage.getItem(LOG_LEVEL_STORAGE_KEY)); } catch { return null; } } let activeLevel: LogLevel = readStoredLogLevel() ?? defaultLogLevel(); /** The level currently in force. */ export function getLogLevel(): LogLevel { return activeLevel; } /** * Change the active level for the rest of the session. * * Does **not** persist — write {@link LOG_LEVEL_STORAGE_KEY} for that. Mainly * here for tests and for a future settings toggle. */ export function setLogLevel(level: LogLevel): void { activeLevel = level; } /** * Re-read the override and reapply the build default. Called once implicitly at * module init; exposed so tests can exercise the override without a fresh * module registry. */ export function resetLogLevel(): LogLevel { activeLevel = readStoredLogLevel() ?? defaultLogLevel(); return activeLevel; } /** Would a message at `level` be emitted right now? */ export function isLevelEnabled(level: LogLevel): boolean { return LEVEL_RANK[level] >= LEVEL_RANK[activeLevel]; } /** * Create a logger tagged with `scope`. * * The scope replaces the `"[Scope] …"` prefixes that used to be hand-written * into each call, so call sites pass the message alone. */ export function createLogger(scope: string): Logger { const tag = `[${scope}]`; const emit = (level: LogLevel, args: unknown[]): void => { if (!isLevelEnabled(level)) return; // Look `console` up at call time: test spies and devtools overrides replace // the method on the object, and a cached reference would bypass them. const method = CONSOLE_METHOD[level]; // Fold the tag into a leading string so format specifiers (`%s`, `%o`) and // multi-line messages still read as one message. Non-string leading args // (an Error, an object) are left strictly alone. if (typeof args[0] === "string") { console[method](`${tag} ${args[0]}`, ...args.slice(1)); } else { console[method](tag, ...args); } }; return { debug: (...args: unknown[]) => emit("debug", args), info: (...args: unknown[]) => emit("info", args), warn: (...args: unknown[]) => emit("warn", args), error: (...args: unknown[]) => emit("error", args), }; }