Carlos Florêncio
198 lines
10 KiB
TypeScript
198 lines
10 KiB
TypeScript
/**
|
|
* Namespaced debug logger for development.
|
|
*
|
|
* Active when any of the following is true:
|
|
* - `NODE_ENV !== "production"` (i.e. `make dev`)
|
|
* - `NEXT_PUBLIC_KANDEV_DEBUG=true` at build time (inlined into the bundle)
|
|
* - `window.__KANDEV_DEBUG === true` at runtime (set by `layout.tsx` when
|
|
* the server-side env var is present, e.g. `make start-debug`)
|
|
*
|
|
* The runtime `window` check exists because `make start-debug` re-uses the
|
|
* already-built production web bundle and only flips the env var on the
|
|
* server process. Without the runtime fallback, the inlined `process.env`
|
|
* value stays `false` in the client bundle and no logs surface.
|
|
*
|
|
* The `debug()` call itself is free, but JavaScript evaluates its arguments
|
|
* before the call — so callers that compute expensive values (O(n) maps,
|
|
* `.reduce()`, spread of large objects) must guard with the exported constant:
|
|
*
|
|
* if (IS_DEBUG) { debug(...); }
|
|
*
|
|
* In a production build with no flag set, both `process.env` checks fold to
|
|
* `false` and the `window` check short-circuits at runtime, so the guarded
|
|
* block is effectively a no-op.
|
|
*
|
|
* Output format is logfmt-ish so logs are flat and grep/copy-friendly:
|
|
*
|
|
* [namespace] message key1=value key2="value with space" key3={"nested":1}
|
|
*
|
|
* ## Namespace convention
|
|
*
|
|
* Names use `<domain>:<aspect>` so a devtools console filter can narrow on
|
|
* either part. Known namespaces in this codebase (keep this list current
|
|
* when adding new loggers — it's the cheat-sheet for triage):
|
|
*
|
|
* Git / Changes panel pipeline (bug: stale until refresh)
|
|
* [git-status:subscribe] useSessionGitStatus subscribe/unsubscribe cycle
|
|
* [ws:dispatch] every WS message — inbound notifications and
|
|
* outbound sends (`message="send"`). Streaming
|
|
* chunk traffic is denylisted.
|
|
* [git-status:ws] git event handler — status_update / commit_created / ...
|
|
* [git-status:store] setGitStatus — overwrite decision + prev/next counts
|
|
* [git-status:derive] useSessionGit file aggregation across repos
|
|
*
|
|
* Files panel pipeline (bug: stuck loading skeleton)
|
|
* [agentctl:status] per-session agentctl status transitions
|
|
* [file-browser:load] tree loader — init / ready-flip / start / retry / gave-up
|
|
* [file-browser:changes] session.workspace.file.changes events + folder refresh
|
|
*
|
|
* Task-create dialog (bug: "No compatible agent profiles for <executor>")
|
|
* [executor-compat:specs] remote-auth catalog fetch (count + agent ids)
|
|
* [executor-compat] per-agent compat decision: ok + reason
|
|
* (no-spec / no-creds / files-match / env-secret / …)
|
|
* [executor-compat:autopick]
|
|
* useDefaultSelectionsEffect decision per fire:
|
|
* skip/defer/pick + reason + which profile was set.
|
|
* Triage path when "No compatible" lingers after
|
|
* specs land — diff the decision sequence against
|
|
* the catalog log to localise the culprit.
|
|
* [executor-compat:workflow-autopick]
|
|
* useWorkflowAgentProfileEffect decision per fire:
|
|
* no-workflow / locked / locked-missing /
|
|
* workflow-no-override. The last branch restores
|
|
* localStorage `lastId` against the unfiltered
|
|
* `agentProfiles` — set_to of an executor-incompatible
|
|
* id is the smoking gun for that race.
|
|
*
|
|
* Dockview column widths (bug: sidebar/center/right widths wrong during
|
|
* env-prepare and on first task switch with cleared localStorage)
|
|
* [dockview:widths] Per-event width-pipeline snapshots:
|
|
* build-default-{entry,done} first paint / reset
|
|
* env-switch-{resize,resize-col,done}
|
|
* cross-task switch
|
|
* preset-apply / preset-post-layout
|
|
* layout-selector preset switch:
|
|
* applied widths + snapshot before
|
|
* and after the rAF api.layout
|
|
* fixups-capture target captured vs cap in
|
|
* applyLayoutFixups; caller=<chain>,
|
|
* cols=<n>, sidebarOverCap=true means
|
|
* the recorded target is unreachable
|
|
* container-resize DOM ResizeObserver fired
|
|
* sash-drag-end user-released sash
|
|
* store-sync live widths → store pinnedWidths
|
|
* enforce-restore target rewind via resizeView
|
|
* Snapshot format (formatWidthsSnapshot):
|
|
* L=240 C=842 R=320 cols=3 api=1402x900 tgt=L240/R320
|
|
* `tgt=` is the pinned-targets map (drives the
|
|
* enforcement loop); mismatch with L/R is the
|
|
* smoking gun for a stale-target bug.
|
|
*
|
|
* Chat panel rendering (bug: remote-executor agent reply persisted but UI
|
|
* doesn't render it until the user refreshes the page)
|
|
* [chat:virtuoso] VirtuosoMessageList render-branch snapshots
|
|
* (fallback vs virtuoso) and VirtuosoBody mount —
|
|
* captures itemCount / firstItemIndex /
|
|
* initialTopMostItemIndex at the moment Virtuoso
|
|
* first anchors its scroll. If itemCount at
|
|
* `mount` is < the final item count, Virtuoso
|
|
* anchored on an earlier item and the new last
|
|
* item lands below the fold.
|
|
* [chat:virtuoso:scrollParent] `useVisibleScrollParent` lifecycle —
|
|
* ref-callback-ready / ref-callback-defer /
|
|
* ro-attach / ro-ready. A long delay between
|
|
* items growing and `ro-ready` firing is the
|
|
* smoking gun for the mount-too-early race.
|
|
* [chat:virtuoso:firstIndex] `useStableFirstItemIndex` transitions —
|
|
* init + key-list deltas. A non-monotonic
|
|
* `delta` between two transitions means
|
|
* Virtuoso saw the keyspace shift in a way
|
|
* that throws off scroll anchoring.
|
|
* [chat:prepare-progress] PrepareProgress status / autoExpand / expanded
|
|
* transitions per session. Status stuck on
|
|
* "preparing" with `expanded=true` while
|
|
* Virtuoso is mounted explains the
|
|
* agent-reply-pushed-below-fold scenario.
|
|
*
|
|
* Other
|
|
* [ws:connection] WS hook mount + status transitions
|
|
* [dockview:*] layout restore / save / env-switch / session-tabs / task-select
|
|
* [messages:*] message fetch / process / lazyload
|
|
* [session:env-mapping] session → environment ID mapping
|
|
*
|
|
* Tip: in Chrome devtools the console filter input takes substrings and regex.
|
|
* Use `[git-status:` for the whole git pipeline, `[ws:dispatch] action=session.git`
|
|
* to scope WS dispatch to git, etc.
|
|
*
|
|
* Usage:
|
|
* const debug = createDebugLogger("git-status:ws");
|
|
* debug("status_update received", { sessionId, fileCount });
|
|
*
|
|
* Logs go through `console.debug`, which the log interceptor mirrors into the
|
|
* ring buffer (see `lib/logger/intercept.ts`), so they also end up in
|
|
* Improve Kandev reports without extra plumbing.
|
|
*/
|
|
|
|
export type DebugLogger = (...args: unknown[]) => void;
|
|
|
|
export const IS_DEBUG =
|
|
process.env.NODE_ENV !== "production" ||
|
|
process.env.NEXT_PUBLIC_KANDEV_DEBUG === "true" ||
|
|
(typeof window !== "undefined" && window.__KANDEV_DEBUG === true);
|
|
|
|
const NOOP: DebugLogger = () => {};
|
|
|
|
const BARE_VALUE_RE = /^[A-Za-z0-9_\-:./@+]+$/;
|
|
|
|
function formatValue(value: unknown): string {
|
|
if (value === null) return "null";
|
|
if (value === undefined) return "undefined";
|
|
if (typeof value === "string") {
|
|
return BARE_VALUE_RE.test(value) ? value : JSON.stringify(value);
|
|
}
|
|
if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint") {
|
|
return String(value);
|
|
}
|
|
if (value instanceof Error) {
|
|
return JSON.stringify({ name: value.name, message: value.message });
|
|
}
|
|
try {
|
|
return JSON.stringify(value);
|
|
} catch {
|
|
return String(value);
|
|
}
|
|
}
|
|
|
|
function isPlainObject(value: unknown): value is Record<string, unknown> {
|
|
if (value === null || typeof value !== "object") return false;
|
|
if (Array.isArray(value)) return false;
|
|
const proto = Object.getPrototypeOf(value);
|
|
return proto === Object.prototype || proto === null;
|
|
}
|
|
|
|
function flattenArgs(args: unknown[]): string {
|
|
const parts: string[] = [];
|
|
for (const arg of args) {
|
|
if (typeof arg === "string") {
|
|
parts.push(arg);
|
|
continue;
|
|
}
|
|
if (isPlainObject(arg)) {
|
|
for (const [key, val] of Object.entries(arg)) {
|
|
parts.push(`${key}=${formatValue(val)}`);
|
|
}
|
|
continue;
|
|
}
|
|
parts.push(formatValue(arg));
|
|
}
|
|
return parts.join(" ");
|
|
}
|
|
|
|
export function createDebugLogger(namespace: string): DebugLogger {
|
|
if (!IS_DEBUG) return NOOP;
|
|
const prefix = `[${namespace}]`;
|
|
return (...args: unknown[]) => {
|
|
console.debug(`${prefix} ${flattenArgs(args)}`);
|
|
};
|
|
}
|