diff --git a/plugins/altimate-code/.claude-plugin/plugin.json b/plugins/altimate-code/.claude-plugin/plugin.json index 5c5b876..c3ca6e6 100644 --- a/plugins/altimate-code/.claude-plugin/plugin.json +++ b/plugins/altimate-code/.claude-plugin/plugin.json @@ -20,5 +20,37 @@ "databricks", "column-lineage" ], - "types": "./types/index.d.ts" + "types": "./types/index.d.ts", + "userConfig": { + "maxScanBytes": { + "type": "number", + "title": "Largest BigQuery scan without asking", + "description": "A dbt run, build or show that BigQuery estimates would scan more bytes than this is held until you allow it with /allow-scan. 0 never holds one. Other warehouses are never held.", + "default": 10737418240 + }, + "healthBlocksPush": { + "type": "boolean", + "title": "Project health blocks git push", + "description": "When on, git push is refused while the project health check finds new issues in the models you changed. Off, the issues are only shown.", + "default": false + }, + "healthConfigPath": { + "type": "string", + "title": "Project health check config", + "description": "Path to a DataPilot health check config file, relative to the dbt project. Empty uses the default checks.", + "default": "" + }, + "commentsPollSeconds": { + "type": "number", + "title": "Team comments refresh (seconds)", + "description": "How often the team's comments on shared docs are fetched again.", + "default": 900 + }, + "commentsInContext": { + "type": "boolean", + "title": "Team comments in Claude's context", + "description": "When on, the open comments on a model Claude reads or edits are added to its context. Off keeps them out of Claude's context.", + "default": true + } + } } diff --git a/plugins/altimate-code/hooks/altimate-cli.ts b/plugins/altimate-code/hooks/altimate-cli.ts index bf1bdf8..e6cda5a 100644 --- a/plugins/altimate-code/hooks/altimate-cli.ts +++ b/plugins/altimate-code/hooks/altimate-cli.ts @@ -47,3 +47,133 @@ export function later($: EngineInterface, work: () => Promise) { }) }) } + +// The plugin's own MCP server, by its key in .mcp.json. +const SERVER_KEY = 'altimate-code' +const TOOL_TIMEOUT_MS = 60_000 + +/** Resolves with the work's value, or null once `ms` pass or it fails. */ +export function within($: EngineInterface, ms: number, work: Promise): Promise { + return new Promise(resolve => { + let settled = false + const settle = (value: T | null) => { + if (settled) return + settled = true + resolve(value) + } + $.clock.after(ms, () => settle(null)) + work.then(settle, () => settle(null)) + }) +} + +let serverName: string | null = null +let connectFailedAt = -Infinity +const CONNECT_RETRY_MS = 60_000 + +/** The plugin's MCP server as $.mcp.call names it, or null when it is not connected (CLI mode); a failure is retried after a minute. */ +async function mcpServer($: EngineInterface): Promise { + if (serverName) return serverName + const now = await $.clock.now() + if (now - connectFailedAt < CONNECT_RETRY_MS) return null + const connected = await $.mcp.connect(SERVER_KEY).catch(() => null) + serverName = connected?.isConnected ? connected.server : null + if (!serverName) connectFailedAt = now + return serverName +} + +export function textOf(content: unknown): string { + if (typeof content === 'string') return content + const blocks = Array.isArray(content) ? content : Array.isArray((content as any)?.content) ? (content as any).content : [] + return blocks + .filter((block: any) => block?.type === 'text' && typeof block.text === 'string') + .map((block: any) => block.text) + .join('\n') +} + +/** + * The file a `` preview says holds the whole answer: null when the text is no such + * preview, undefined when it is one but names no file. + */ +export function persistedPath(text: string): string | null | undefined { + if (!/^\s*(?:<|<)persisted-output(?:>|>)/.test(text)) return null + return /Full output saved to: ([^\n]+?)\s*$/m.exec(text)?.[1] +} + +/** A file:// URI as a filesystem path; a Windows drive path keeps no leading slash. */ +function fileUriPath(uri: string): string { + const path = decodeURIComponent(new URL(uri).pathname) + return /^\/[A-Za-z]:/.test(path) ? path.slice(1) : path +} + +export type RunToolOptions = { + /** Straight to the CLI, whose --json carries the whole metadata. */ + cliOnly?: boolean + /** A deadline on the engine's clock: nothing starts once it has passed, and the CLI is stopped at it. */ + until?: number + /** + * The tool needs write permission (it starts the dbt adapter, or changes something): the call goes + * through the CLI with `--allow-write`, since the plugin's MCP server runs read-only. + */ + write?: boolean +} + +/** + * Runs one altimate-code data tool: through the plugin's MCP server when it is connected (no + * permission prompt, structured content when the build sends it), else `altimate tool run --json`. + * `cliOnly` goes straight to the CLI, whose --json carries the whole metadata; a structured result + * the server left out for size is fetched that way too. + */ +export async function runTool($: EngineInterface, name: string, args: Record, options: RunToolOptions = {}) { + const { until, write = false } = options + const cliOnly = options.cliOnly === true || write + // With a deadline, nothing starts once it has passed, and the CLI is stopped at it. + const left = async () => { + const ms = until === undefined ? TOOL_TIMEOUT_MS : until - (await $.clock.now()) + if (ms <= 0) throw new Error('out of time') + return ms + } + const server = cliOnly ? null : await mcpServer($) + if (server) { + const ms = await left() + try { + // The engine's MCP call has no timeout of its own: one that never answers is given up on, so a + // shared trace does not hold every later edit of that column, and the CLI is tried instead. + const result = await within($, ms, $.mcp.call(server, name, args)) + if (!result) throw new Error('altimate-code did not answer over MCP') + let text = textOf(result.content) + // A long result comes back as a preview plus a link to the full text. + const link = result.content.find((block: any) => block?.type === 'resource_link' && String(block.uri).startsWith('file://')) as + | { uri: string } + | undefined + // Claude Code (2.1.319) swaps an answer of about 49 KB or more for a preview that names the file it + // saved the whole answer to, with no link block: the answer is that file. + const saved = link ? null : persistedPath(text) + if (!link && saved === undefined) throw new Error('a cut-off preview with no file named') + // An unreadable link or file leaves only the preview: fetch the whole answer through the CLI instead. + const full = link ? await $.fs.read(fileUriPath(link.uri)).catch(() => null) : saved ? await $.fs.read(saved).catch(() => null) : text + if (full === null) throw new Error('the full result could not be read') + text = full + // Claude Code hands a tool's structured content over as one JSON text block in place of the + // text; the structured content carries the text report as `report`. + const structured = (result.structuredContent ?? (text.trim().startsWith('{') ? parseJson(text) : null)) as any + if (structured?.truncated !== true) { + return { metadata: structured, text: typeof structured?.report === 'string' ? structured.report : text, ok: !result.isError } + } + } catch { + // Fall through to the CLI: the server may have gone away mid-session, so the next call reconnects. + serverName = null + } + } + const argv = ['tool', 'run', name, '--args', JSON.stringify(args), '--json', ...(write ? ['--allow-write'] : [])] + const result = await runAltimate($, argv, await left()) + if ((result as { isStdoutTruncated?: boolean }).isStdoutTruncated) { + return { metadata: null as any, text: `${name}'s answer was larger than the 4 MiB a plugin can read`, ok: false } + } + const data = parseJson<{ status?: string; output?: string; metadata?: unknown }>(result.stdout) + // Anything but the CLI's answer object (an altimate-code that exits before a pipe drains cuts it off) is a + // failure to report and ask again, not "no such model". + if (result.exitCode === 0 && (!data || typeof data !== 'object' || typeof data.status !== 'string')) { + return { metadata: null as any, text: 'the answer could not be read', ok: false } + } + return { metadata: (data?.metadata ?? null) as any, text: data?.output ?? '', ok: result.exitCode === 0 && data?.status !== 'error' } +} diff --git a/plugins/altimate-code/hooks/dbt-command.test.ts b/plugins/altimate-code/hooks/dbt-command.test.ts new file mode 100644 index 0000000..a776fef --- /dev/null +++ b/plugins/altimate-code/hooks/dbt-command.test.ts @@ -0,0 +1,153 @@ +import { expect, test } from 'claude-code/testing' + +import { parseDbtCommand } from './dbt-command' + +/** The fields a caller decides on, without the offsets. */ +const shape = (line: string) => parseDbtCommand(line).map(({ start, end, subcommandEnd, ...rest }) => rest) + +const base = { select: [], target: null, targetPath: null, hasDefer: false, hasState: false } + +test('a plain dbt command: subcommand, selections, target and target path', () => { + expect(shape('dbt build -s stg_orders --select +fct_orders -t prod --target-path tgt')).toEqual([ + { ...base, binary: 'dbt', subcommand: 'build', select: ['stg_orders', '+fct_orders'], target: 'prod', targetPath: 'tgt' }, + ]) + expect(shape('dbt run --models a b --target=dev')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', select: ['a', 'b'], target: 'dev' }]) +}) + +test('commands joined with &&, ; and pipes each give their dbt invocation, in order', () => { + expect(shape('cd jaffle && dbt deps && dbt run -s a; dbt test | tee log.txt')).toEqual([ + { ...base, binary: 'dbt', subcommand: 'deps' }, + { ...base, binary: 'dbt', subcommand: 'run', select: ['a'] }, + { ...base, binary: 'dbt', subcommand: 'test' }, + ]) +}) + +test('uv run dbt, poetry run dbt and a path to dbt are dbt launchers', () => { + expect(shape('uv run dbt build -s a')).toEqual([{ ...base, binary: 'uv run dbt', subcommand: 'build', select: ['a'] }]) + expect(shape('poetry run dbt test')).toEqual([{ ...base, binary: 'poetry run dbt', subcommand: 'test' }]) + expect(shape('.venv/bin/dbt compile')).toEqual([{ ...base, binary: '.venv/bin/dbt', subcommand: 'compile' }]) +}) + +test('VAR=x in front of dbt is kept in the invocation; DBT_DEFER and DBT_STATE count as defer and state', () => { + const line = 'DBT_PROFILES_DIR=. dbt run -s a' + const [one] = parseDbtCommand(line) + expect(one).toEqual({ ...base, binary: 'dbt', subcommand: 'run', select: ['a'], start: 0, end: line.length, subcommandEnd: line.indexOf(' -s') }) + expect(shape('DBT_DEFER=1 DBT_STATE=prod dbt run')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', hasDefer: true, hasState: true }]) +}) + +test('--defer and --state are seen; the offsets cut the invocation out of the line', () => { + const line = 'echo hi && dbt build --defer --state prod-artifacts -s a > out.log' + const [one] = parseDbtCommand(line) + expect(one).toMatchObject({ subcommand: 'build', hasDefer: true, hasState: true }) + expect(line.slice(one!.start, one!.end)).toBe('dbt build --defer --state prod-artifacts -s a') + expect(line.slice(one!.start, one!.subcommandEnd)).toBe('dbt build') +}) + +test('a line without dbt, or one that cannot be read, gives no invocation', () => { + expect(parseDbtCommand('ls -la && git status')).toEqual([]) + expect(parseDbtCommand('echo "dbt run')).toEqual([]) + expect(parseDbtCommand('dbt run $(echo')).toEqual([]) + expect(parseDbtCommand('')).toEqual([]) + expect(parseDbtCommand('grep dbt run.log')).toEqual([]) +}) + +test('a bare dbt has no subcommand; quoted selections are unquoted', () => { + expect(shape('dbt')).toEqual([{ ...base, binary: 'dbt', subcommand: null }]) + expect(shape(`dbt ls -s "tag:nightly" --select 'path:models/staging'`)).toEqual([ + { ...base, binary: 'dbt', subcommand: 'ls', select: ['tag:nightly', 'path:models/staging'] }, + ]) +}) + +test('a heredoc, or an operator or redirection with nothing after it, makes the line unreadable', () => { + expect(parseDbtCommand('cat > run.sh < x.sh\ndbt build\nEOF\nbash x.sh")).toEqual([]) + expect(parseDbtCommand('cat <<-EOF\n\tdbt run\n\tEOF')).toEqual([]) + for (const line of ['dbt run >', 'dbt run &&', 'dbt run |', '&& dbt run', '; dbt run', 'dbt run )', 'dbt run (', '(dbt run', 'dbt run ; ;']) + expect(parseDbtCommand(line)).toEqual([]) + // A here-string is no heredoc; a subshell, a function and a trailing ; or & are fine. + expect(shape('dbt run <<< y')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run' }]) + expect(shape('(cd a && dbt run); f() { dbt test; }; dbt ls &')).toEqual([ + { ...base, binary: 'dbt', subcommand: 'run' }, + { ...base, binary: 'dbt', subcommand: 'test' }, + { ...base, binary: 'dbt', subcommand: 'ls' }, + ]) +}) + +test('parentheses inside a quoted string in a substitution are text', () => { + expect(shape('dbt run $(printf "(") -t dev')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', target: 'dev' }]) + expect(shape('dbt run "$(printf ")")" -t dev')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', target: 'dev' }]) +}) + +test('short options joined to their value, and global options that take one before the subcommand', () => { + expect(shape('dbt run -tprod -sorders -musers')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', select: ['orders', 'users'], target: 'prod' }]) + expect(shape(`dbt --warn-error-options '{"include":"all"}' -r timing.txt run -s a`)).toEqual([ + { ...base, binary: 'dbt', subcommand: 'run', select: ['a'] }, + ]) + expect(shape('dbt build --indirect-selection cautious -s a')).toEqual([{ ...base, binary: 'dbt', subcommand: 'build', select: ['a'] }]) +}) + +test('env options that take a value; DBT_TARGET and DBT_TARGET_PATH in front of dbt, which the flags override', () => { + expect(shape('env -i -u FOO dbt run')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run' }]) + expect(shape('DBT_TARGET=prod DBT_TARGET_PATH=tgt dbt run')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', target: 'prod', targetPath: 'tgt' }]) + expect(shape('DBT_TARGET=prod dbt run -t dev')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', target: 'dev' }]) +}) + +test('subshells after a keyword, case patterns, process substitution, arrays and arithmetic are read', () => { + const run = { ...base, binary: 'dbt', subcommand: 'run' } + expect(shape('time (dbt build)')).toEqual([{ ...base, binary: 'dbt', subcommand: 'build' }]) + for (const line of [ + 'if (cd proj && dbt run); then echo ok; fi', + '! (dbt run)', + '{ (dbt run); }', + 'dbt run 2> >(tee err.log)', + 'for ((i=0;i<3;i++)); do dbt run; done', + 'f() ( dbt run )', + 'case $t in\n a|b) dbt run;;\nesac', + ]) + expect(shape(line)).toEqual([run]) + expect(shape('case $t in prod) dbt run -t prod;; *) dbt run;; esac')).toEqual([{ ...run, target: 'prod' }, run]) + expect(shape('case $t in (prod) dbt run -t prod;; esac')).toEqual([{ ...run, target: 'prod' }]) + expect(shape('models=(orders users); for m in "${models[@]}"; do dbt run -s $m; done')).toEqual([{ ...run, select: ['$m'] }]) + const line = 'diff <(dbt ls -s a) <(dbt ls -s b)' + const found = parseDbtCommand(line) + expect(found.map(({ start, end }) => line.slice(start, end))).toEqual(['dbt ls -s a', 'dbt ls -s b']) +}) + +test('a function definition takes one name: `dbt run ()` is unreadable and a function named dbt is no invocation', () => { + expect(parseDbtCommand('dbt run ()')).toEqual([]) + expect(parseDbtCommand('case x in a) dbt run')).toEqual([]) + expect(shape('dbt() { echo hi; }; dbt test')).toEqual([{ ...base, binary: 'dbt', subcommand: 'test' }]) + expect(shape('function f() { dbt run; }')).toEqual([{ ...base, binary: 'dbt', subcommand: 'run' }]) +}) + +test('a case pattern named dbt is no invocation', () => { + const run = { ...base, binary: 'dbt', subcommand: 'run' } + for (const line of ['case $t in a) x;; dbt) dbt run;; esac', 'case $t in a|dbt) dbt run;; esac', 'case $t in (dbt) dbt run;; esac']) + expect(shape(line)).toEqual([run]) +}) + +test("quotes in a heredoc inside a substitution are text, so Claude's commit form stays readable", () => { + const line = `dbt run -s a && git commit -m "$(cat <<'EOF'\nfix "foo it's\nEOF\n)"` + expect(shape(line)).toEqual([{ ...base, binary: 'dbt', subcommand: 'run', select: ['a'] }]) +}) + +test('the commands of a `$(…)` or backtick substitution run too, quoted or not, nested or not', () => { + const run = { ...base, binary: 'dbt', subcommand: 'run' } + expect(shape('echo "$(dbt run -s orders)"')).toEqual([{ ...run, select: ['orders'] }]) + expect(shape('echo `dbt run`')).toEqual([run]) + expect(shape('x=$(dbt build); dbt test')).toEqual([ + { ...base, binary: 'dbt', subcommand: 'build' }, + { ...base, binary: 'dbt', subcommand: 'test' }, + ]) + expect(shape('echo $(echo $(dbt run))')).toEqual([run]) + expect(shape("echo '$(dbt run)'")).toEqual([]) + const line = 'echo "$(dbt run -s a)"' + expect(parseDbtCommand(line).map(({ start, end }) => line.slice(start, end))).toEqual(['dbt run -s a']) +}) + +test('quotes decide what a substitution is: an apostrophe inside double quotes hides nothing, single quotes hide it, and the commands come in the order written', () => { + const run = { ...base, binary: 'dbt', subcommand: 'run' } + expect(shape(`echo "it's $(dbt run)"`)).toEqual([run]) + expect(shape(`echo "it's"'$(dbt run)'`)).toEqual([]) + expect(shape('dbt run --vars "$(dbt ls)"').map(i => i.subcommand)).toEqual(['run', 'ls']) +}) diff --git a/plugins/altimate-code/hooks/dbt-command.ts b/plugins/altimate-code/hooks/dbt-command.ts new file mode 100644 index 0000000..9d7c624 --- /dev/null +++ b/plugins/altimate-code/hooks/dbt-command.ts @@ -0,0 +1,565 @@ +// The dbt invocations in a shell command line, as Claude's Bash calls write them: `dbt build -s x`, +// `cd a && dbt run`, `uv run dbt test | tee log`, `DBT_PROFILES_DIR=. dbt run`. Each comes with its +// place in the line, so a caller can rewrite one without touching the rest. A line that can't be read +// (an unclosed quote, substitution or parenthesis, an operator or redirection with nothing after it, a +// heredoc outside a `$(…)` substitution) yields no invocation. + +export type DbtInvocation = { + /** How dbt is launched, as written: `dbt`, `.venv/bin/dbt`, `uv run dbt`, `poetry run dbt`. */ + binary: string + /** The first word after the launcher's options: `build`, `run`, `test`…; null when there is none. */ + subcommand: string | null + /** Every value given to -s, --select, -m, --models or --model, in order. */ + select: string[] + /** The value of -t or --target, else of DBT_TARGET set in front of the command; null when neither. */ + target: string | null + /** The value of --target-path, else of DBT_TARGET_PATH set in front of the command; null when neither. */ + targetPath: string | null + /** --defer or --no-defer is given, or DBT_DEFER is set in front of the command. */ + hasDefer: boolean + /** --state or --defer-state is given, or DBT_STATE / DBT_DEFER_STATE is set in front of the command. */ + hasState: boolean + /** Offset of the invocation's first character (its leading VAR=x assignments included). */ + start: number + /** Offset just past its last argument (redirections and what follows a pipe excluded). */ + end: number + /** Offset just past the subcommand (past `binary` when there is none): where flags can be inserted. */ + subcommandEnd: number +} + +type Token = { kind: 'word'; text: string; start: number; end: number } | { kind: 'op'; text: string; start: number; end: number } + +const OPERATORS = ['&&', '||', ';;', '|&', '|', '&', ';', '(', ')', '\n'] +const ARRAY_ASSIGNMENT = /^[A-Za-z_][A-Za-z0-9_]*(?:\[[^\]]*\])?\+?=$/ +const REDIRECT = /^(?:\d*(?:>>|>&|>\||>|<&|<<<|<<|<>|<)|&>>?)/ + +const HEREDOC = /^<<(-?)[ \t]*(?:'([^'\n]*)'|"([^"\n]*)"|([^\s;&|()<>'"]+))/ + +/** + * Offset of the newline that ends a heredoc's closing delimiter line, where `from` is the newline before + * the body; -1 when the delimiter never comes or nothing follows it. + */ +function heredocBodyEnd(line: string, from: number, delimiter: string, strip: boolean): number { + for (let at = from + 1; ; ) { + const eol = line.indexOf('\n', at) + if (eol < 0) return -1 + const row = line.slice(at, eol) + if ((strip ? row.replace(/^\t+/, '') : row) === delimiter) return eol + at = eol + 1 + } +} + +/** Offset just past the `$(…)` or backtick substitution that opens at `at`; -1 when it is not closed. */ +function substitutionEnd(line: string, at: number): number { + if (line[at] === '`') { + const close = line.indexOf('`', at + 1) + return close < 0 ? -1 : close + 1 + } + // `at` is the opening parenthesis: it counts as the first level. + let depth = 0 + // Heredocs opened on the line being read; their bodies start on the next line. + const heredocs: { delimiter: string; strip: boolean }[] = [] + for (let j = at; j < line.length; j++) { + const c = line[j] + if (c === '\n' && heredocs.length) { + for (const { delimiter, strip } of heredocs.splice(0)) { + j = heredocBodyEnd(line, j, delimiter, strip) + if (j < 0) return -1 + } + } else if (c === '<' && line[j + 1] === '<' && line[j + 2] !== '<') { + // A heredoc's body is text: its quotes and parentheses are not read. + const heredoc = HEREDOC.exec(line.slice(j)) + if (heredoc) { + heredocs.push({ delimiter: heredoc[2] ?? heredoc[3] ?? heredoc[4]!, strip: heredoc[1] === '-' }) + j += heredoc[0].length - 1 + } + } else if (c === '\\') j++ + else if (c === "'") { + j = line.indexOf("'", j + 1) + if (j < 0) return -1 + } else if (c === '"') { + // A double-quoted string: its parentheses are text, but a substitution inside it still nests. + for (j++; j < line.length && line[j] !== '"'; j++) { + if (line[j] === '\\') j++ + else if (line[j] === '$' && line[j + 1] === '(') { + const end = substitutionEnd(line, j + 1) + if (end < 0) return -1 + j = end - 1 + } + } + if (j >= line.length) return -1 + } else if (c === '(') depth++ + else if (c === ')' && --depth === 0) return j + 1 + } + return -1 +} + +/** The words and operators of a command line, with their offsets; null when a quote or substitution is not closed. */ +function lex(line: string): Token[] | null { + const tokens: Token[] = [] + let i = 0 + let text = '' + let start = -1 + const flush = (end: number) => { + if (start >= 0) tokens.push({ kind: 'word', text, start, end }) + text = '' + start = -1 + } + while (i < line.length) { + const c = line[i]! + if (c === '\\' && line[i + 1] === '\n') { + i += 2 + continue + } + if (c === ' ' || c === '\t' || c === '\r') { + flush(i) + i++ + continue + } + if (c === '#' && start < 0) { + while (i < line.length && line[i] !== '\n') i++ + continue + } + // `<(…)` and `>(…)` (process substitution), `((…))` (arithmetic) and the `(…)` of `name=(…)` (an + // array) are one word, up to the matching parenthesis. + const paren = + (c === '<' || c === '>') && line[i + 1] === '(' && start < 0 + ? i + 1 + : c === '(' && (start < 0 ? line[i + 1] === '(' : ARRAY_ASSIGNMENT.test(text)) + ? i + : -1 + if (paren >= 0) { + const end = substitutionEnd(line, paren) + if (end < 0) return null + if (start < 0) start = i + text += line.slice(i, end) + i = end + continue + } + const redirect = REDIRECT.exec(line.slice(i)) + if (redirect && (start < 0 || !/^\d/.test(redirect[0]))) { + flush(i) + tokens.push({ kind: 'op', text: redirect[0], start: i, end: i + redirect[0].length }) + i += redirect[0].length + continue + } + const op = OPERATORS.find(one => line.startsWith(one, i)) + if (op) { + flush(i) + tokens.push({ kind: 'op', text: op, start: i, end: i + op.length }) + i += op.length + continue + } + if (start < 0) start = i + if (c === '\\') { + text += line[i + 1] ?? '' + i += 2 + } else if (c === "'") { + const close = line.indexOf("'", i + 1) + if (close < 0) return null + text += line.slice(i + 1, close) + i = close + 1 + } else if (c === '"') { + let j = i + 1 + while (j < line.length && line[j] !== '"') { + if (line[j] === '\\' && j + 1 < line.length) { + text += line[j + 1] + j += 2 + } else if ((line[j] === '$' && line[j + 1] === '(') || line[j] === '`') { + const end = substitutionEnd(line, line[j] === '$' ? j + 1 : j) + if (end < 0) return null + text += line.slice(j, end) + j = end + } else text += line[j++] + } + if (j >= line.length) return null + i = j + 1 + } else if ((c === '$' && line[i + 1] === '(') || c === '`') { + const end = substitutionEnd(line, c === '$' ? i + 1 : i) + if (end < 0) return null + text += line.slice(i, end) + i = end + } else { + text += c + i++ + } + } + flush(i) + return tokens +} + +const ASSIGNMENT = /^[A-Za-z_][A-Za-z0-9_]*=/ +// Words that may stand in front of a command without being it. +const PREFIX_WORDS = new Set(['!', '{', 'then', 'do', 'else', 'elif', 'if', 'while', 'until', 'time', 'command', 'exec', 'nohup', 'env']) +// Options of those prefix words that take a value, so the value is not read as the command. +const PREFIX_VALUE_FLAGS = new Set(['-u', '--unset', '-C', '--chdir', '-f', '--format', '-o', '--output', '-a']) +// Launchers whose `run` subcommand runs the command after their own options. +const RUNNERS = new Set(['uv', 'poetry', 'pipenv', 'pdm', 'hatch', 'rye', 'uvx']) +// Launcher options that take a value, so the value is not read as the command. +const RUNNER_VALUE_FLAGS = new Set([ + '--with', + '--with-editable', + '--with-requirements', + '--project', + '--directory', + '--python', + '-p', + '--env-file', + '--extra', + '--group', + '--package', + '--index', + '--index-url', + '--from', + '-e', + '--env', + '-C', +]) +// dbt options that take a value, so the value is not read as the subcommand or as a selector. +const DBT_VALUE_FLAGS = new Set([ + '--log-format', + '--log-format-file', + '--log-level', + '--log-level-file', + '--log-path', + '--profiles-dir', + '--project-dir', + '--profile', + '--target', + '-t', + '--target-path', + '--vars', + '--state', + '--defer-state', + '--threads', + '--printer-width', + '--exclude', + '--selector', + '--resource-type', + '--resource-types', + '--exclude-resource-type', + '--exclude-resource-types', + '--output', + '-o', + '--output-keys', + '--inline', + '--limit', + '--args', + '--macro', + '--warn-error-options', + '--record-timing-info', + '-r', + '--indirect-selection', + '--event-time-start', + '--event-time-end', + '--sample', + '--log-file-max-bytes', + '--add-package', + '--source', +]) +// Short dbt options that take a value, which may also be written joined to it: `-tprod`, `-sorders`. +const SHORT_VALUE_FLAGS = new Set(['-s', '-m', '-t', '-o', '-r']) +const SELECT_FLAGS = new Set(['-s', '--select', '-m', '--models', '--model']) + +const isDbt = (word: string) => word.split('/').pop() === 'dbt' + +/** The dbt invocations in a shell command line, in the order written; [] when there are none or the line can't be read. */ +export function parseDbtCommand(line: string): DbtInvocation[] { + if (typeof line !== 'string' || !/\bdbt\b/.test(line)) return [] + const tokens = lex(line) + const notCommand = tokens && readable(tokens) + if (!tokens || !notCommand) return [] + const found: DbtInvocation[] = [] + let simple: Token[] = [] + const finish = () => { + const invocation = readSimple(simple) + if (invocation) found.push(invocation) + simple = [] + } + for (let k = 0; k < tokens.length; k++) { + const token = tokens[k]! + if (notCommand.has(k)) continue + if (token.kind === 'op' && !/[<>]/.test(token.text)) finish() + else simple.push(token) + // The commands of a process substitution (`<(…)`, `>(…)`) run too: they are read as a line of their own. + if (token.kind === 'word' && /^[<>]\(/.test(line.slice(token.start, token.end))) { + const shift = token.start + 2 + for (const inner of parseDbtCommand(line.slice(shift, token.end - 1))) + found.push({ ...inner, start: inner.start + shift, end: inner.end + shift, subcommandEnd: inner.subcommandEnd + shift }) + } else if (token.kind === 'word') { + // So do the commands of a `$(…)` or backtick substitution in the word, outside single quotes. + for (const [from, to] of substitutionsIn(line, token.start, token.end)) { + const shift = from + for (const inner of parseDbtCommand(line.slice(from, to))) + found.push({ ...inner, start: inner.start + shift, end: inner.end + shift, subcommandEnd: inner.subcommandEnd + shift }) + } + } + } + finish() + // An inner command (in a substitution) is listed where it is written, not before the command around it. + return found.sort((a, b) => a.start - b.start) +} + +/** The commands' ranges of the `$(…)` and backtick substitutions written in line[start, end), outside single quotes. */ +function substitutionsIn(line: string, start: number, end: number): [number, number][] { + const found: [number, number][] = [] + // Single quotes hide a substitution; inside double quotes a `'` is a plain character. + let single = false + let double = false + for (let i = start; i < end; i++) { + const c = line[i] + if (single) single = c !== "'" + else if (c === '\\') i++ + else if (c === "'" && !double) single = true + else if (c === '"') double = !double + else if ((c === '$' && line[i + 1] === '(') || c === '`') { + const close = substitutionEnd(line, c === '$' ? i + 1 : i) + if (close < 0 || close > end) break + found.push([i + (c === '$' ? 2 : 1), close - 1]) + i = close - 1 + } + } + return found +} + +const isRedirect = (token: Token) => token.kind === 'op' && /[<>]/.test(token.text) + +// Words after which a command still starts, so a `(` there opens a subshell. +const COMMAND_KEYWORDS = new Set(['!', '{', 'then', 'do', 'else', 'elif', 'if', 'while', 'until', 'time']) +const NAME = /^[A-Za-z_][A-Za-z0-9_-]*$/ + +/** + * Which words are not part of a command (`case` patterns, function names) when the tokens make a command + * line the shell would run; null when they don't. A line the shell would run is one where every + * redirection has a target, every `&&`, `||` and pipe has a command on both sides, `;` and `&` follow a command, parentheses pair up + * (subshells, `name()` function definitions, `case` patterns), and a `case` reaches its `esac`. A + * heredoc counts as unreadable, since its body lines are text, not commands (one inside `$(…)` is skipped + * when the substitution is read). + */ +function readable(tokens: Token[]): Set | null { + // Indices of words that are not part of a command: `case` patterns and function names. + const notCommand = new Set() + // Open subshells and `case` statements, innermost last. + const open: ('(' | 'case')[] = [] + // Words of the command being read, its leading keywords not counted; whether an operator still waits + // for a command; whether a `case` pattern is being read, up to its `)`; and how far a `case` head + // (`case WORD in`) has been read. + let words: string[] = [] + let waiting = false + let pattern = false + let caseHead: 'none' | 'case' | 'word' = 'none' + for (let k = 0; k < tokens.length; k++) { + const token = tokens[k]! + if (token.kind === 'word') { + waiting = false + if (caseHead === 'case') caseHead = 'word' + else if (caseHead === 'word') { + if (token.text !== 'in') return false + caseHead = 'none' + pattern = true + } else if (!words.length && token.text === 'esac' && open.at(-1) === 'case') { + open.pop() + pattern = false + words = [token.text] + } else if (pattern) { + words.push(token.text) + notCommand.add(k) + } + else if (!words.length && token.text === 'case') { + open.push('case') + caseHead = 'case' + } else if (words.length || !COMMAND_KEYWORDS.has(token.text)) words.push(token.text) + continue + } + if (isRedirect(token)) { + if (/^\d*<<$/.test(token.text)) return false + if (tokens[k + 1]?.kind !== 'word') return false + // The target is not the command's word, but a redirection alone is a command (`> out`). + k++ + words.push(token.text) + waiting = false + continue + } + if (caseHead !== 'none' && token.text !== '\n') return false + switch (token.text) { + case '\n': + if (!waiting && !pattern) words = [] + continue + case '(': + // A pattern may open with `(`; where a command starts, `(` opens a subshell; after one name it + // defines a function, whose body follows. + if (pattern && !words.length) continue + if (!words.length) open.push('(') + else if ( + tokens[k + 1]?.text === ')' && + NAME.test(words.at(-1)!) && + (words.length === 1 || (words.length === 2 && words[0] === 'function')) + ) { + notCommand.add(k - 1) + if (words.length === 2) notCommand.add(k - 2) + k++ + words = [] + } else return false + continue + case ')': + if (pattern) { + if (!words.length) return false + pattern = false + words = [] + continue + } + if (open.at(-1) !== '(' || waiting) return false + open.pop() + words = [token.text] + continue + case ';;': + if (open.at(-1) !== 'case' || pattern) return false + words = [] + pattern = true + continue + case '|': + // Alternatives in a pattern. + if (pattern) { + if (!words.length) return false + words = [] + continue + } + // falls through + case '&&': + case '||': + case '|&': + if (!words.length || pattern) return false + words = [] + waiting = true + continue + default: + // `;` and `&` end the command before them. + if (!words.length || pattern) return false + words = [] + } + } + return !open.length && !waiting && !pattern && caseHead === 'none' ? notCommand : null +} + +function readSimple(tokens: Token[]): DbtInvocation | null { + // Drop redirections and their targets: what is left is the command's words. + const words: Extract[] = [] + for (let i = 0; i < tokens.length; i++) { + const token = tokens[i]! + if (token.kind === 'op') { + // A redirection takes the next word as its target (`> log`, `2>&1`). + i++ + continue + } + words.push(token) + } + if (words.length === 0) return null + const start = words[0]!.start + let i = 0 + let hasDefer = false + let hasState = false + let envTarget: string | null = null + let envTargetPath: string | null = null + // The prefix word whose options are being read (`env -u X`, `time -p`). + let prefix: string | null = null + for (; i < words.length; i++) { + const word = words[i]!.text + if (ASSIGNMENT.test(word)) { + const name = word.slice(0, word.indexOf('=')) + const assigned = word.slice(word.indexOf('=') + 1) + if (name === 'DBT_DEFER') hasDefer = true + if (name === 'DBT_STATE' || name === 'DBT_DEFER_STATE') hasState = true + if (name === 'DBT_TARGET') envTarget = assigned + if (name === 'DBT_TARGET_PATH') envTargetPath = assigned + prefix = null + continue + } + if (PREFIX_WORDS.has(word)) { + prefix = word + continue + } + if (word.startsWith('-') && prefix !== null) { + if (PREFIX_VALUE_FLAGS.has(word)) i++ + continue + } + break + } + if (i >= words.length) return null + const launcherStart = i + let binaryEnd: number + if (isDbt(words[i]!.text)) { + binaryEnd = i + } else if (RUNNERS.has(words[i]!.text.split('/').pop()!)) { + const runner = words[i]!.text.split('/').pop()! + i++ + if (runner !== 'uvx') { + if (words[i]?.text !== 'run') return null + i++ + } + while (i < words.length && words[i]!.text.startsWith('-')) { + const flag = words[i]!.text + i += RUNNER_VALUE_FLAGS.has(flag) && !flag.includes('=') ? 2 : 1 + } + // `uv run --` ends the launcher's options. + if (words[i]?.text === '--') i++ + if (i >= words.length || !isDbt(words[i]!.text)) return null + binaryEnd = i + } else return null + + const binary = words + .slice(launcherStart, binaryEnd + 1) + .map(one => one.text) + .join(' ') + let subcommand: string | null = null + let subcommandEnd = words[binaryEnd]!.end + const select: string[] = [] + let target: string | null = null + let targetPath: string | null = null + let selecting = false + for (let j = binaryEnd + 1; j < words.length; j++) { + const word = words[j]!.text + if (word.startsWith('-')) { + selecting = false + const eq = word.indexOf('=') + const joined = !word.startsWith('--') && word.length > 2 && SHORT_VALUE_FLAGS.has(word.slice(0, 2)) + const flag = joined ? word.slice(0, 2) : eq > 0 ? word.slice(0, eq) : word + const inline = joined ? word.slice(2) : eq > 0 ? word.slice(eq + 1) : null + const value = () => { + if (inline !== null) return inline + j++ + return words[j]?.text ?? null + } + if (SELECT_FLAGS.has(flag)) { + if (inline !== null) select.push(...inline.split(/\s+/).filter(Boolean)) + selecting = true + } else if (flag === '-t' || flag === '--target') target = value() + else if (flag === '--target-path') targetPath = value() + else if (flag === '--defer' || flag === '--no-defer') hasDefer = true + else if (flag === '--state' || flag === '--defer-state') { + hasState = true + value() + } else if (DBT_VALUE_FLAGS.has(flag) && inline === null) j++ + continue + } + if (selecting) { + select.push(...word.split(/\s+/).filter(Boolean)) + continue + } + if (subcommand === null) { + subcommand = word + subcommandEnd = words[j]!.end + } + } + return { + binary, + subcommand, + select, + target: target ?? envTarget, + targetPath: targetPath ?? envTargetPath, + hasDefer, + hasState, + start, + end: words[words.length - 1]!.end, + subcommandEnd, + } +} diff --git a/plugins/altimate-code/hooks/features/comments.tsx b/plugins/altimate-code/hooks/features/comments.tsx new file mode 100644 index 0000000..ecd7564 --- /dev/null +++ b/plugins/altimate-code/hooks/features/comments.tsx @@ -0,0 +1,53 @@ +// Team comments from shared dbt docs, in Claude's context and in /comments. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'comments', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/cost.tsx b/plugins/altimate-code/hooks/features/cost.tsx new file mode 100644 index 0000000..a9010a5 --- /dev/null +++ b/plugins/altimate-code/hooks/features/cost.tsx @@ -0,0 +1,53 @@ +// Cost check: BigQuery scans over the limit are held until allowed. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'cost', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/cte-profile.tsx b/plugins/altimate-code/hooks/features/cte-profile.tsx new file mode 100644 index 0000000..75dd00b --- /dev/null +++ b/plugins/altimate-code/hooks/features/cte-profile.tsx @@ -0,0 +1,53 @@ +// Profile CTEs: /profile-ctes times each CTE. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'cteProfile', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/defer.tsx b/plugins/altimate-code/hooks/features/defer.tsx new file mode 100644 index 0000000..c37aa85 --- /dev/null +++ b/plugins/altimate-code/hooks/features/defer.tsx @@ -0,0 +1,53 @@ +// Defer and target: --defer --state on dbt commands, and the target in the status line. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'defer', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/docs.tsx b/plugins/altimate-code/hooks/features/docs.tsx new file mode 100644 index 0000000..3fb211e --- /dev/null +++ b/plugins/altimate-code/hooks/features/docs.tsx @@ -0,0 +1,53 @@ +// Docs coverage and description propagation. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'docs', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/health.tsx b/plugins/altimate-code/hooks/features/health.tsx new file mode 100644 index 0000000..dc141a9 --- /dev/null +++ b/plugins/altimate-code/hooks/features/health.tsx @@ -0,0 +1,53 @@ +// Project health: new DataPilot insights on the models Claude changed. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'health', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/index.ts b/plugins/altimate-code/hooks/features/index.ts new file mode 100644 index 0000000..e314987 --- /dev/null +++ b/plugins/altimate-code/hooks/features/index.ts @@ -0,0 +1,321 @@ +// The dbt Power User features, each in its own file here, and the one place that calls them, in a +// fixed order: runs, defer, toModel, comments, cost, health, sqlGraph, docs, cteProfile. +// +// A plugin hooks each shared event once (a second hook on an event without a matcher is refused), and +// the engine refuses `$` handed to anything but a function it can name, so this file calls every +// feature's functions by name instead of looping over a list. A feature fills in its own file only. +// A function that throws is logged and skipped: one feature's failure never stops another or the call. +import type { Args, EngineInterface, EventResult, On, PluginOptions, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, EditedFile, FileCall } from '../tool-chain' +import { + register as runsRegister, + sessionStart as runsSessionStart, + turnStart as runsTurnStart, + turnComplete as runsTurnComplete, + sessionEnd as runsSessionEnd, + bandLine as runsBandLine, + bashRewrite as runsBashRewrite, + bashGate as runsBashGate, + bashAfter as runsBashAfter, + editAfter as runsEditAfter, + readOrEditAfter as runsReadOrEditAfter, + editReadsBefore as runsEditReadsBefore, +} from './runs' +import { + register as deferRegister, + sessionStart as deferSessionStart, + turnStart as deferTurnStart, + turnComplete as deferTurnComplete, + sessionEnd as deferSessionEnd, + bandLine as deferBandLine, + bashRewrite as deferBashRewrite, + bashGate as deferBashGate, + bashAfter as deferBashAfter, + editAfter as deferEditAfter, + readOrEditAfter as deferReadOrEditAfter, + editReadsBefore as deferEditReadsBefore, +} from './defer' +import { + register as toModelRegister, + sessionStart as toModelSessionStart, + turnStart as toModelTurnStart, + turnComplete as toModelTurnComplete, + sessionEnd as toModelSessionEnd, + bandLine as toModelBandLine, + bashRewrite as toModelBashRewrite, + bashGate as toModelBashGate, + bashAfter as toModelBashAfter, + editAfter as toModelEditAfter, + readOrEditAfter as toModelReadOrEditAfter, + editReadsBefore as toModelEditReadsBefore, +} from './to-model' +import { + register as commentsRegister, + sessionStart as commentsSessionStart, + turnStart as commentsTurnStart, + turnComplete as commentsTurnComplete, + sessionEnd as commentsSessionEnd, + bandLine as commentsBandLine, + bashRewrite as commentsBashRewrite, + bashGate as commentsBashGate, + bashAfter as commentsBashAfter, + editAfter as commentsEditAfter, + readOrEditAfter as commentsReadOrEditAfter, + editReadsBefore as commentsEditReadsBefore, +} from './comments' +import { + register as costRegister, + sessionStart as costSessionStart, + turnStart as costTurnStart, + turnComplete as costTurnComplete, + sessionEnd as costSessionEnd, + bandLine as costBandLine, + bashRewrite as costBashRewrite, + bashGate as costBashGate, + bashAfter as costBashAfter, + editAfter as costEditAfter, + readOrEditAfter as costReadOrEditAfter, + editReadsBefore as costEditReadsBefore, +} from './cost' +import { + register as healthRegister, + sessionStart as healthSessionStart, + turnStart as healthTurnStart, + turnComplete as healthTurnComplete, + sessionEnd as healthSessionEnd, + bandLine as healthBandLine, + bashRewrite as healthBashRewrite, + bashGate as healthBashGate, + bashAfter as healthBashAfter, + editAfter as healthEditAfter, + readOrEditAfter as healthReadOrEditAfter, + editReadsBefore as healthEditReadsBefore, +} from './health' +import { + register as sqlGraphRegister, + sessionStart as sqlGraphSessionStart, + turnStart as sqlGraphTurnStart, + turnComplete as sqlGraphTurnComplete, + sessionEnd as sqlGraphSessionEnd, + bandLine as sqlGraphBandLine, + bashRewrite as sqlGraphBashRewrite, + bashGate as sqlGraphBashGate, + bashAfter as sqlGraphBashAfter, + editAfter as sqlGraphEditAfter, + readOrEditAfter as sqlGraphReadOrEditAfter, + editReadsBefore as sqlGraphEditReadsBefore, +} from './sql-graph' +import { + register as docsRegister, + sessionStart as docsSessionStart, + turnStart as docsTurnStart, + turnComplete as docsTurnComplete, + sessionEnd as docsSessionEnd, + bandLine as docsBandLine, + bashRewrite as docsBashRewrite, + bashGate as docsBashGate, + bashAfter as docsBashAfter, + editAfter as docsEditAfter, + readOrEditAfter as docsReadOrEditAfter, + editReadsBefore as docsEditReadsBefore, +} from './docs' +import { + register as cteProfileRegister, + sessionStart as cteProfileSessionStart, + turnStart as cteProfileTurnStart, + turnComplete as cteProfileTurnComplete, + sessionEnd as cteProfileSessionEnd, + bandLine as cteProfileBandLine, + bashRewrite as cteProfileBashRewrite, + bashGate as cteProfileBashGate, + bashAfter as cteProfileBashAfter, + editAfter as cteProfileEditAfter, + readOrEditAfter as cteProfileReadOrEditAfter, + editReadsBefore as cteProfileEditReadsBefore, +} from './cte-profile' + +export type { FeatureId } from '../status-line' +export { FEATURE_IDS } from '../status-line' + +/** The elements a band line draws with: what `$.ui.resolve(e)` gave the band's hook. */ +export type BandUi = { Box: any; Button: any; Text: any; [element: string]: any } + +/** What a feature's `register` gets. */ +export type FeatureContext = { + /** The plugin's `userConfig` values (`.claude-plugin/plugin.json`), defaults filled in. */ + options: PluginOptions +} + +function failed($: EngineInterface, id: string, part: string, error: unknown) { + try { + $.ui.log(`${id} · ${part} failed: ${String(error)}`, { to: 'debug' }) + } catch {} +} + +/** Registers every feature's own hooks. */ +export function registerFeatures(on: On, context: FeatureContext) { + runsRegister(on, context) + deferRegister(on, context) + toModelRegister(on, context) + commentsRegister(on, context) + costRegister(on, context) + healthRegister(on, context) + sqlGraphRegister(on, context) + docsRegister(on, context) + cteProfileRegister(on, context) +} + +export async function featuresSessionStart($: EngineInterface, e: Args<'session.start'>) { + await runsSessionStart($, e).catch(error => failed($, 'runs', 'sessionStart', error)) + await deferSessionStart($, e).catch(error => failed($, 'defer', 'sessionStart', error)) + await toModelSessionStart($, e).catch(error => failed($, 'toModel', 'sessionStart', error)) + await commentsSessionStart($, e).catch(error => failed($, 'comments', 'sessionStart', error)) + await costSessionStart($, e).catch(error => failed($, 'cost', 'sessionStart', error)) + await healthSessionStart($, e).catch(error => failed($, 'health', 'sessionStart', error)) + await sqlGraphSessionStart($, e).catch(error => failed($, 'sqlGraph', 'sessionStart', error)) + await docsSessionStart($, e).catch(error => failed($, 'docs', 'sessionStart', error)) + await cteProfileSessionStart($, e).catch(error => failed($, 'cteProfile', 'sessionStart', error)) +} + +export async function featuresTurnStart($: EngineInterface, e: Args<'turn.start'>) { + await runsTurnStart($, e).catch(error => failed($, 'runs', 'turnStart', error)) + await deferTurnStart($, e).catch(error => failed($, 'defer', 'turnStart', error)) + await toModelTurnStart($, e).catch(error => failed($, 'toModel', 'turnStart', error)) + await commentsTurnStart($, e).catch(error => failed($, 'comments', 'turnStart', error)) + await costTurnStart($, e).catch(error => failed($, 'cost', 'turnStart', error)) + await healthTurnStart($, e).catch(error => failed($, 'health', 'turnStart', error)) + await sqlGraphTurnStart($, e).catch(error => failed($, 'sqlGraph', 'turnStart', error)) + await docsTurnStart($, e).catch(error => failed($, 'docs', 'turnStart', error)) + await cteProfileTurnStart($, e).catch(error => failed($, 'cteProfile', 'turnStart', error)) +} + +export async function featuresTurnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) { + await runsTurnComplete($, e, out).catch(error => failed($, 'runs', 'turnComplete', error)) + await deferTurnComplete($, e, out).catch(error => failed($, 'defer', 'turnComplete', error)) + await toModelTurnComplete($, e, out).catch(error => failed($, 'toModel', 'turnComplete', error)) + await commentsTurnComplete($, e, out).catch(error => failed($, 'comments', 'turnComplete', error)) + await costTurnComplete($, e, out).catch(error => failed($, 'cost', 'turnComplete', error)) + await healthTurnComplete($, e, out).catch(error => failed($, 'health', 'turnComplete', error)) + await sqlGraphTurnComplete($, e, out).catch(error => failed($, 'sqlGraph', 'turnComplete', error)) + await docsTurnComplete($, e, out).catch(error => failed($, 'docs', 'turnComplete', error)) + await cteProfileTurnComplete($, e, out).catch(error => failed($, 'cteProfile', 'turnComplete', error)) +} + +export async function featuresSessionEnd($: EngineInterface, e: Args<'session.end'>) { + await runsSessionEnd($, e).catch(error => failed($, 'runs', 'sessionEnd', error)) + await deferSessionEnd($, e).catch(error => failed($, 'defer', 'sessionEnd', error)) + await toModelSessionEnd($, e).catch(error => failed($, 'toModel', 'sessionEnd', error)) + await commentsSessionEnd($, e).catch(error => failed($, 'comments', 'sessionEnd', error)) + await costSessionEnd($, e).catch(error => failed($, 'cost', 'sessionEnd', error)) + await healthSessionEnd($, e).catch(error => failed($, 'health', 'sessionEnd', error)) + await sqlGraphSessionEnd($, e).catch(error => failed($, 'sqlGraph', 'sessionEnd', error)) + await docsSessionEnd($, e).catch(error => failed($, 'docs', 'sessionEnd', error)) + await cteProfileSessionEnd($, e).catch(error => failed($, 'cteProfile', 'sessionEnd', error)) +} + +/** Each feature's band line, in order, with its id; a feature with nothing to say is left out. */ +export async function featureBandLines($: EngineInterface, ui: BandUi): Promise<{ id: string; line: RenderElement }[]> { + const lines: { id: string; line: RenderElement }[] = [] + const add = (id: string, line: RenderElement | null | void) => { + if (line) lines.push({ id, line }) + } + add('runs', await runsBandLine($, ui).catch(error => failed($, 'runs', 'bandLine', error))) + add('defer', await deferBandLine($, ui).catch(error => failed($, 'defer', 'bandLine', error))) + add('toModel', await toModelBandLine($, ui).catch(error => failed($, 'toModel', 'bandLine', error))) + add('comments', await commentsBandLine($, ui).catch(error => failed($, 'comments', 'bandLine', error))) + add('cost', await costBandLine($, ui).catch(error => failed($, 'cost', 'bandLine', error))) + add('health', await healthBandLine($, ui).catch(error => failed($, 'health', 'bandLine', error))) + add('sqlGraph', await sqlGraphBandLine($, ui).catch(error => failed($, 'sqlGraph', 'bandLine', error))) + add('docs', await docsBandLine($, ui).catch(error => failed($, 'docs', 'bandLine', error))) + add('cteProfile', await cteProfileBandLine($, ui).catch(error => failed($, 'cteProfile', 'bandLine', error))) + return lines +} + +/** The command after every feature's rewrite, each seeing the one before's. */ +export async function featuresBashRewrite($: EngineInterface, e: BashCall): Promise { + let command = e.command + const take = (next: string | null | void) => { + if (typeof next === 'string' && next.trim() !== '') command = next + } + take(await runsBashRewrite($, { ...e, command }).catch(error => failed($, 'runs', 'bashRewrite', error))) + take(await deferBashRewrite($, { ...e, command }).catch(error => failed($, 'defer', 'bashRewrite', error))) + take(await toModelBashRewrite($, { ...e, command }).catch(error => failed($, 'toModel', 'bashRewrite', error))) + take(await commentsBashRewrite($, { ...e, command }).catch(error => failed($, 'comments', 'bashRewrite', error))) + take(await costBashRewrite($, { ...e, command }).catch(error => failed($, 'cost', 'bashRewrite', error))) + take(await healthBashRewrite($, { ...e, command }).catch(error => failed($, 'health', 'bashRewrite', error))) + take(await sqlGraphBashRewrite($, { ...e, command }).catch(error => failed($, 'sqlGraph', 'bashRewrite', error))) + take(await docsBashRewrite($, { ...e, command }).catch(error => failed($, 'docs', 'bashRewrite', error))) + take(await cteProfileBashRewrite($, { ...e, command }).catch(error => failed($, 'cteProfile', 'bashRewrite', error))) + return command +} + +/** The first feature's refusal of the Bash call, or null. */ +export async function featuresBashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + let gate: { deny: string } | null = null + const take = (next: { deny: string } | null | void) => { + if (!gate && next && typeof next.deny === 'string') gate = { deny: next.deny } + } + if (!gate) take(await runsBashGate($, e).catch(error => failed($, 'runs', 'bashGate', error))) + if (!gate) take(await deferBashGate($, e).catch(error => failed($, 'defer', 'bashGate', error))) + if (!gate) take(await toModelBashGate($, e).catch(error => failed($, 'toModel', 'bashGate', error))) + if (!gate) take(await commentsBashGate($, e).catch(error => failed($, 'comments', 'bashGate', error))) + if (!gate) take(await costBashGate($, e).catch(error => failed($, 'cost', 'bashGate', error))) + if (!gate) take(await healthBashGate($, e).catch(error => failed($, 'health', 'bashGate', error))) + if (!gate) take(await sqlGraphBashGate($, e).catch(error => failed($, 'sqlGraph', 'bashGate', error))) + if (!gate) take(await docsBashGate($, e).catch(error => failed($, 'docs', 'bashGate', error))) + if (!gate) take(await cteProfileBashGate($, e).catch(error => failed($, 'cteProfile', 'bashGate', error))) + return gate +} + +/** The context lines every feature adds after a Bash call ran. */ +export async function featuresBashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise { + const lines: string[] = [] + addLines(lines, await runsBashAfter($, e, result).catch(error => failed($, 'runs', 'bashAfter', error))) + addLines(lines, await deferBashAfter($, e, result).catch(error => failed($, 'defer', 'bashAfter', error))) + addLines(lines, await toModelBashAfter($, e, result).catch(error => failed($, 'toModel', 'bashAfter', error))) + addLines(lines, await commentsBashAfter($, e, result).catch(error => failed($, 'comments', 'bashAfter', error))) + addLines(lines, await costBashAfter($, e, result).catch(error => failed($, 'cost', 'bashAfter', error))) + addLines(lines, await healthBashAfter($, e, result).catch(error => failed($, 'health', 'bashAfter', error))) + addLines(lines, await sqlGraphBashAfter($, e, result).catch(error => failed($, 'sqlGraph', 'bashAfter', error))) + addLines(lines, await docsBashAfter($, e, result).catch(error => failed($, 'docs', 'bashAfter', error))) + addLines(lines, await cteProfileBashAfter($, e, result).catch(error => failed($, 'cteProfile', 'bashAfter', error))) + return lines +} + +/** Whether any feature's `editAfter` needs the file's text from before the edit. */ +export const EDIT_READS_BEFORE: boolean = runsEditReadsBefore || deferEditReadsBefore || toModelEditReadsBefore || commentsEditReadsBefore || costEditReadsBefore || healthEditReadsBefore || sqlGraphEditReadsBefore || docsEditReadsBefore || cteProfileEditReadsBefore + +/** The context lines every feature adds after an edit landed. */ +export async function featuresEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise { + const lines: string[] = [] + addLines(lines, await runsEditAfter($, e, result, runsEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'runs', 'editAfter', error))) + addLines(lines, await deferEditAfter($, e, result, deferEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'defer', 'editAfter', error))) + addLines(lines, await toModelEditAfter($, e, result, toModelEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'toModel', 'editAfter', error))) + addLines(lines, await commentsEditAfter($, e, result, commentsEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'comments', 'editAfter', error))) + addLines(lines, await costEditAfter($, e, result, costEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'cost', 'editAfter', error))) + addLines(lines, await healthEditAfter($, e, result, healthEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'health', 'editAfter', error))) + addLines(lines, await sqlGraphEditAfter($, e, result, sqlGraphEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'sqlGraph', 'editAfter', error))) + addLines(lines, await docsEditAfter($, e, result, docsEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'docs', 'editAfter', error))) + addLines(lines, await cteProfileEditAfter($, e, result, cteProfileEditReadsBefore ? file : { path: file.path, before: null }).catch(error => failed($, 'cteProfile', 'editAfter', error))) + return lines +} + +/** The context lines every feature adds after a read or an edit succeeded. */ +export async function featuresReadOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise { + const lines: string[] = [] + addLines(lines, await runsReadOrEditAfter($, e, result, file).catch(error => failed($, 'runs', 'readOrEditAfter', error))) + addLines(lines, await deferReadOrEditAfter($, e, result, file).catch(error => failed($, 'defer', 'readOrEditAfter', error))) + addLines(lines, await toModelReadOrEditAfter($, e, result, file).catch(error => failed($, 'toModel', 'readOrEditAfter', error))) + addLines(lines, await commentsReadOrEditAfter($, e, result, file).catch(error => failed($, 'comments', 'readOrEditAfter', error))) + addLines(lines, await costReadOrEditAfter($, e, result, file).catch(error => failed($, 'cost', 'readOrEditAfter', error))) + addLines(lines, await healthReadOrEditAfter($, e, result, file).catch(error => failed($, 'health', 'readOrEditAfter', error))) + addLines(lines, await sqlGraphReadOrEditAfter($, e, result, file).catch(error => failed($, 'sqlGraph', 'readOrEditAfter', error))) + addLines(lines, await docsReadOrEditAfter($, e, result, file).catch(error => failed($, 'docs', 'readOrEditAfter', error))) + addLines(lines, await cteProfileReadOrEditAfter($, e, result, file).catch(error => failed($, 'cteProfile', 'readOrEditAfter', error))) + return lines +} + +function addLines(lines: string[], added: readonly unknown[] | null | void) { + if (Array.isArray(added)) for (const line of added) if (typeof line === 'string' && line !== '') lines.push(line) +} diff --git a/plugins/altimate-code/hooks/features/runs.tsx b/plugins/altimate-code/hooks/features/runs.tsx new file mode 100644 index 0000000..40ad8ff --- /dev/null +++ b/plugins/altimate-code/hooks/features/runs.tsx @@ -0,0 +1,53 @@ +// Runs: every dbt command Claude runs, with its results, in /runs. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'runs', text)`. +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) {} + +/** After the session started: the place to register commands. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) {} + +/** Also called for a subagent's turns, which carry `e.agentId`. */ +export async function turnStart($: EngineInterface, e: Args<'turn.start'>) {} + +/** After the turn's answer; `out` is what the turn ended with. Also called for a subagent's turns (`e.agentId`). */ +export async function turnComplete($: EngineInterface, e: Args<'turn.complete'>, out: EventResult<'turn.complete'>) {} + +export async function sessionEnd($: EngineInterface, e: Args<'session.end'>) {} + +/** This feature's line in the band, under the lineage line; null when there is nothing to say. */ +export async function bandLine($: EngineInterface, ui: BandUi): Promise { + return null +} + +/** The command to run in place of `e.command`; null keeps it. */ +export async function bashRewrite($: EngineInterface, e: BashCall): Promise { + return null +} + +/** + * `{ deny }` refuses the Bash call; null lets it run. A gate that throws is logged and the call runs: + * a gate that must hold the call when its own check fails catches that failure and returns `{ deny }`. + */ +export async function bashGate($: EngineInterface, e: BashCall): Promise<{ deny: string } | null> { + return null +} + +export async function bashAfter($: EngineInterface, e: BashCall, result: ToolCallResult): Promise {} + +/** `file.before` holds the text from before the edit only when `editReadsBefore` is true. */ +export async function editAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: EditedFile): Promise {} + +export async function readOrEditAfter($: EngineInterface, e: FileCall, result: ToolCallResult, file: { path: string }): Promise {} + +/** Whether `editAfter` needs the file's text from before the edit (one extra read per edit). */ +export const editReadsBefore = false diff --git a/plugins/altimate-code/hooks/features/sql-graph.test.tsx b/plugins/altimate-code/hooks/features/sql-graph.test.tsx new file mode 100644 index 0000000..343d781 --- /dev/null +++ b/plugins/altimate-code/hooks/features/sql-graph.test.tsx @@ -0,0 +1,371 @@ +import { expect, mock, test } from 'claude-code/testing' + +import { cteCount, inputsOf, orderNodes } from './sql-graph' + +const ROOT = '/repo' +const FILE = `${ROOT}/models/fct_orders.sql` + +const PANE = { + plugin: 'altimate-code', + component: 'Pane', + requestId: 'altimate-sql-graph', + props: { title: 'SQL graph', isFocused: true, bodyColumns: 90, placement: 'dock', scroll: { offset: 0, bodyRows: 60 }, view: {} }, +} as const + +// The backend's answer for a model with two CTEs, as the tool returns it (response order is not dependency order). +const GRAPH = { + nodes: [ + { id: 'fct_orders', name: 'fct_orders', type: 'model', nodeId: 'model.shop.fct_orders', sql: 'select * from paid', columns: [{ name: 'order_id' }, { name: 'amount' }] }, + { id: 'paid', name: 'paid', type: 'cte', sql: 'select order_id, amount\nfrom orders\nwhere status = \'paid\'', columns: [{ name: 'order_id' }, { name: 'amount' }] }, + { id: 'orders', name: 'orders', type: 'model', nodeId: 'model.shop.stg_orders', sql: '', columns: [{ name: 'order_id' }, { name: 'amount' }, { name: 'status' }] }, + ], + edges: [ + ['orders', 'paid'], + ['paid', 'fct_orders'], + ], +} + +type Options = { answer?: Record; fail?: string; sql?: string; noProject?: boolean; ok?: boolean; hold?: Record>; holdFirst?: Promise; yml?: string } + +async function start($: any, on: any, options: Options = {}) { + const clock = mock.clock(on) + const cli: string[][] = [] + const reads: string[] = [] + on('command.register', () => ({ value: { command: 'sql-graph' } })) + on('turn.start', (_: unknown, e: { turnId: string }) => ({ turnId: e.turnId })) + on('session.end', () => ({ sessionId: 'test' })) + on('turn.complete', (_: unknown, e: { answer: string }) => ({ text: e.answer })) + on('session.start', (_: unknown, e: { cwd: string }) => ({ cwd: e.cwd })) + on('session.root', () => ({ value: ROOT })) + on('ui.open', () => ({ value: {} })) + on('ui.log', () => ({ value: undefined })) + on('ui.toast', () => ({ value: undefined })) + on('ui.render', ($$: any, e: any) => { + const { Box } = $$.ui.resolve(e) + return + }) + on('fs.exists', (_: unknown, e: { path: string }) => ({ value: !options.noProject && (e.path === `${ROOT}/dbt_project.yml` || e.path === `${ROOT}/dbt_packages/pkg/dbt_project.yml` || e.path === `${ROOT}/dbt_packages/vendor/pkg/dbt_project.yml` || e.path === `${ROOT}/vendor/pkg/dbt_project.yml` || e.path === `${ROOT}/vendor/pkg/nested/child/dbt_project.yml`) })) + on('fs.read', (_: unknown, e: { path: string }) => { + reads.push(e.path) + return { value: e.path === `${ROOT}/dbt_project.yml` ? (options.yml ?? "name: 'shop'\n") : (options.sql ?? 'select 1') } + }) + on('tool.list', () => ({ value: [] })) + on('mcp.connect', () => ({ value: { isConnected: false, reason: 'not_connected', message: 'off' } })) + on('process.run', async (_: unknown, e: { argv: readonly string[] }) => { + const [, command] = e.argv + // The integrations half of the plugin asks the CLI for its status at session start. + if (command !== 'tool') return { value: { exitCode: 1, stdout: '', stderr: 'not this test' } } + cli.push([...e.argv]) + const asked = JSON.parse(String(e.argv[e.argv.indexOf('--args') + 1] ?? '{}')).model as string + // A test can hold one model's answer to make it arrive after a newer ask's. + if (options.hold?.[asked]) await options.hold[asked] + // The first ask is held and answers with a graph of its own; later asks answer at once. + const nth = cli.length + if (options.holdFirst && nth === 1) { + await options.holdFirst + return { value: { exitCode: 0, stdout: JSON.stringify({ status: 'ok', output: '', metadata: { success: true, model: asked, nodes: [{ id: 'stale', name: 'stale', type: 'cte', sql: '', columns: [] }], edges: [] } }), stderr: '' } } + } + if (options.ok === false) return { value: { exitCode: 0, stdout: JSON.stringify({ status: 'ok', output: 'Not available: this needs the dbt adapter', metadata: { success: false, reason: 'read-only', error: 'Not available: this needs the dbt adapter' } }), stderr: '' } } + if (options.fail) return { value: { exitCode: 1, stdout: JSON.stringify({ status: 'error', output: options.fail, metadata: { success: false } }), stderr: '' } } + const metadata = { success: true, model: asked, ...(options.answer ?? GRAPH) } + return { value: { exitCode: 0, stdout: JSON.stringify({ status: 'ok', output: 'SQL graph for fct_orders', metadata }), stderr: '' } } + }) + on('tool.call', () => ({ result: { ok: true } })) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await clock.settle() + return { clock, cli, reads } +} + +const composer = { origin: { kind: 'composer' }, presentation: { isFullscreen: false, columns: 120 } } + +test('orderNodes puts each node after what feeds it, whatever order the backend listed them in', () => { + expect(orderNodes(GRAPH as any).map(node => node.id)).toEqual(['orders', 'paid', 'fct_orders']) + expect(inputsOf(GRAPH as any, 'fct_orders')).toEqual(['paid']) + expect(inputsOf(GRAPH as any, 'orders')).toEqual([]) +}) + +test('orderNodes keeps the listed order for nodes with no edges and survives a cycle', () => { + const alone = { nodes: [{ id: 'b' }, { id: 'a' }], edges: [] } as any + expect(orderNodes(alone).map(node => node.id)).toEqual(['b', 'a']) + const cycle = { nodes: [{ id: 'a' }, { id: 'b' }], edges: [['a', 'b'], ['b', 'a']] } as any + expect(orderNodes(cycle).map(node => node.id).sort()).toEqual(['a', 'b']) +}) + +test('a model is the .sql file in a dbt project\'s model folders: by file name, not by an ancestor folder, and never a macro, test, snapshot or build file', async ($, on) => { + const { clock } = await start($, on, { yml: "name: 'shop'\nmodel-paths: ['models', 'more_models']\n" }) + const reads = async (file: string) => { + await $.tool.call({ tool: 'Read', file_path: file }) + await clock.settle() + return (await $.command.run({ command: 'sql-graph', args: '', ...composer } as any)).text + } + expect(await reads(`${ROOT}/more_models/marts/dim_a.sql`)).toContain('dim_a') + expect(await reads(`${ROOT}/macros/cents.sql`)).toContain('dim_a') + expect(await reads(`${ROOT}/tests/t.sql`)).toContain('dim_a') + expect(await reads(`${ROOT}/target/compiled/shop/models/x.sql`)).toContain('dim_a') + expect(await reads(`${ROOT}/db/migrations/001.sql`)).toContain('dim_a') + expect(await reads(`${ROOT}/models/fct_orders.sql`)).toContain('fct_orders') + // A folder inside a model path keeps its name; a package's own models are not the project's. + expect(await reads(`${ROOT}/models/tests/in_models.sql`)).toContain('in_models') + expect(await reads(`${ROOT}/dbt_packages/pkg/models/p.sql`)).toContain('in_models') +}) + +test('a package installed deeper in the default folder, or under the project\'s packages-install-path, is not the project\'s model', async ($, on) => { + const { clock } = await start($, on, { yml: "name: 'shop'\npackages-install-path: vendor\n" }) + const reads = async (file: string) => { + await $.tool.call({ tool: 'Read', file_path: file }) + await clock.settle() + return (await $.command.run({ command: 'sql-graph', args: '', ...composer } as any)).text + } + expect(await reads(`${ROOT}/models/fct_orders.sql`)).toContain('fct_orders') + expect(await reads(`${ROOT}/vendor/pkg/models/v.sql`)).toContain('fct_orders') + expect(await reads(`${ROOT}/dbt_packages/vendor/pkg/models/d.sql`)).toContain('fct_orders') + // A project nested inside an installed package is a package's too: the outer project is still asked. + expect(await reads(`${ROOT}/vendor/pkg/nested/child/models/n.sql`)).toContain('fct_orders') +}) + +// A configured folder that is not the project's own vendor folder leaves the models in it alone. +for (const path of ['/vendor', 'vendor/repo/', '/vendor/repo/', `cache${ROOT}/vendor`, `/opt${ROOT}/vendor`]) + test(`a packages-install-path of ${path} hides none of the project's own models`, async ($, on) => { + const { clock } = await start($, on, { yml: `name: 'shop'\npackages-install-path: ${path}\n` }) + await $.tool.call({ tool: 'Read', file_path: `${ROOT}/vendor/pkg/models/v.sql` }) + await clock.settle() + expect((await $.command.run({ command: 'sql-graph', args: '', ...composer } as any)).text).toMatch(/SQL graph for v\b/) + }) + +for (const path of [`${ROOT}/vendor`, 'vendor/./', './vendor', 'cache/../vendor', `${ROOT}/cache/../vendor`]) + test(`a packages-install-path written ${path.startsWith('/') ? 'as an absolute path inside the project' : `as ${path}`} is the same folder`, async ($, on) => { + const { clock } = await start($, on, { yml: `name: 'shop'\npackages-install-path: ${path}\n` }) + await $.tool.call({ tool: 'Read', file_path: `${ROOT}/models/fct_orders.sql` }) + await $.tool.call({ tool: 'Read', file_path: `${ROOT}/vendor/pkg/models/v.sql` }) + await clock.settle() + expect((await $.command.run({ command: 'sql-graph', args: '', ...composer } as any)).text).toContain('fct_orders') + }) + +test('outside a dbt project a .sql read sets no default model and an edit adds no line', async ($, on) => { + const { clock, cli } = await start($, on, { noProject: true, sql: 'with a as (select 1) select * from a' }) + const edit: any = await $.tool.call({ tool: 'Edit', file_path: '/other/models/x.sql', old_string: '1', new_string: '2' }) + await clock.settle() + expect(JSON.stringify(edit.context ?? [])).not.toContain('/sql-graph') + const reply = await $.command.run({ command: 'sql-graph', args: '', ...composer } as any) + expect(reply.text).toBe('Read or edit a dbt model, or run /sql-graph .') + expect(cli).toHaveLength(0) +}) + +test('cteCount counts the CTEs a model defines, not words in comments or strings', () => { + expect(cteCount('with a as (select 1), b as (select 2), "c" as (select 3) select * from a')).toBe(3) + expect(cteCount('with recursive r as (select 1) select * from r')).toBe(1) + expect(cteCount("-- with x as (\nselect ', y as (' as s from t")).toBe(0) + expect(cteCount('select cast(a as int), b as c from t')).toBe(0) + expect(cteCount("with a as (select '--' as marker), b as (select 1) select * from b")).toBe(2) + expect(cteCount('{# with fake as (select 1) #}\nselect 1')).toBe(0) + expect(cteCount('with a (id) as (select 1), b(x, y) as (select 2, 3) select * from a')).toBe(2) +}) + +test('/sql-graph asks the tool once, with write permission, and the pane lists the nodes in dependency order', async ($, on) => { + const { clock, cli } = await start($, on) + const reply = await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + expect(reply.text).toBe('The SQL graph for fct_orders is open.') + expect(cli).toHaveLength(1) + expect(cli[0]).toContain('dbt_sql_graph') + expect(cli[0]).toContain('--allow-write') + expect(JSON.parse(cli[0]![cli[0]!.indexOf('--args') + 1]!)).toEqual({ model: 'fct_orders' }) + + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + expect(await ui.find({ type: 'Text', text: /SQL graph · fct_orders · 3 nodes/ })).toBeDefined() + // The backend lists fct_orders first; the pane draws each node after what feeds it. + expect((await ui.findAll({ type: 'Button' })).map(row => row.key)).toEqual(['node-orders', 'node-paid', 'node-fct_orders']) + expect(await ui.find({ type: 'Text', text: 'Press a row to see its SQL.' })).toBeDefined() + await ui.unmount() +}) + +test('pressing a row shows that node\'s SQL', async ($, on) => { + const { clock } = await start($, on) + await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + await ui.press({ key: 'node-paid' }) + await clock.settle() + expect(await ui.find({ type: 'Text', text: 'from orders' })).toBeDefined() + expect(await ui.find({ type: 'Text', text: "where status = 'paid'" })).toBeDefined() + await ui.unmount() +}) + +test('two nodes with one name stay two rows, each with its own inputs and SQL', async ($, on) => { + const answer = { + nodes: [ + { id: 'analytics.customers_1', name: 'customers', type: 'model', nodeId: 'model.shop.customers', sql: 'analytics.customers', columns: [] }, + { id: 'raw.customers_2', name: 'customers', type: 'source', nodeId: 'source.shop.raw.customers', sql: 'raw.customers', columns: [] }, + { id: 'LEFT_JOIN_9', name: 'LEFT_JOIN_9', type: 'LEFT_JOIN', sql: 'LEFT JOIN raw.customers', columns: [] }, + ], + edges: [ + ['analytics.customers_1', 'LEFT_JOIN_9'], + ['raw.customers_2', 'LEFT_JOIN_9'], + ], + } + const { clock } = await start($, on, { answer }) + await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + expect(await ui.find({ key: 'node-analytics.customers_1' })).toBeDefined() + expect(await ui.find({ key: 'node-raw.customers_2' })).toBeDefined() + expect(inputsOf(answer as any, 'LEFT_JOIN_9')).toEqual(['analytics.customers_1', 'raw.customers_2']) + await ui.press({ key: 'node-raw.customers_2' }) + await clock.settle() + expect(await ui.find({ type: 'Text', text: 'raw.customers' })).toBeDefined() + await ui.unmount() +}) + +test('text from the CLI, the repo and the backend is drawn without escape or control characters, and a long statement is cut', async ($, on) => { + const esc = String.fromCharCode(27) + const bad = `bad${esc}]0;owned\u0007${esc}[31mred${esc}[0m\u2028end` + const { clock } = await start($, on, { fail: bad }) + const reply = await $.command.run({ command: 'sql-graph', args: `m${esc}]0;x\u0007odel`, ...composer } as any) + await clock.settle() + expect(reply.text).not.toMatch(/[\u0000-\u0008\u000b-\u001f\u007f-\u009f\u2028\u2029]/) + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + const drawn = JSON.stringify(await ui.find({ type: 'Text', text: /bad/ })) + expect(drawn).not.toMatch(/u001b|u0007/) + expect(drawn).not.toContain('\u2028') + await ui.unmount() +}) + +test('a graph whose names, types and SQL carry escape and control characters is drawn as plain text', async ($, on) => { + const esc = String.fromCharCode(27) + const dirty = (word: string) => `${word}${esc}[31m!${esc}]0;x\u0007\u2028end` + const answer = { + nodes: [ + { id: 'a', name: dirty('src'), type: dirty('model'), sql: '', columns: [] }, + { id: 'b', name: dirty('out'), type: 'cte', sql: `select${esc}[1m 1\u0007\nfrom${esc}]0;x\u0007 a\u2028`, columns: [] }, + ], + edges: [['a', 'b']], + } + const { clock } = await start($, on, { answer }) + await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + await ui.press({ key: 'node-b' }) + await clock.settle() + const bad = /[\u0000-\u0009\u000b-\u001f\u007f-\u009f\u2028\u2029]/ + const rows = await ui.findAll({ type: 'Button' }) + expect(rows).toHaveLength(2) + for (const row of rows) expect(String((row as any).props.label)).not.toMatch(bad) + expect(String((rows[1] as any).props.label)).toContain('from src') + const texts = await ui.findAll({ type: 'Text' }) + for (const text of texts) expect(String((text as any).text ?? '')).not.toMatch(/[\u0000-\u0009\u000b-\u001f\u007f-\u009f\u2028\u2029]/) + expect(await ui.find({ type: 'Text', text: /select.*1/s })).toBeDefined() + await ui.unmount() +}) + +test('the SQL of a selected node is cut at a limit and says how much was left out', async ($, on) => { + const answer = { + nodes: [{ id: 'big', name: 'big', type: 'cte', sql: `${'x'.repeat(20_000)}TAILMARK${'x'.repeat(4_992)}`, columns: [] }], + edges: [], + } + const { clock } = await start($, on, { answer }) + await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + await ui.press({ key: 'node-big' }) + await clock.settle() + const shown = await ui.find({ type: 'Text', text: /… 5000 more characters not shown$/ }) + expect(shown).toBeDefined() + expect(JSON.stringify(shown)).not.toContain('TAILMARK') + await ui.unmount() +}) + +test('without a name /sql-graph shows the model Claude last read; with none read it says what to do and calls nothing', async ($, on) => { + const { clock, cli } = await start($, on) + const none = await $.command.run({ command: 'sql-graph', args: '', ...composer } as any) + expect(none.text).toBe('Read or edit a dbt model, or run /sql-graph .') + expect(cli).toHaveLength(0) + + await $.tool.call({ tool: 'Read', file_path: FILE }) + await clock.settle() + await $.command.run({ command: 'sql-graph', args: '', ...composer } as any) + await clock.settle() + expect(cli).toHaveLength(1) + expect(JSON.parse(cli[0]![cli[0]!.indexOf('--args') + 1]!)).toEqual({ model: 'fct_orders' }) +}) + +test('a tool failure is the pane\'s message and the command\'s reply', async ($, on) => { + const { clock } = await start($, on, { fail: 'Not available: no dbt project here' }) + const reply = await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + expect(reply.text).toBe('Not available: no dbt project here') + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + expect(await ui.find({ type: 'Text', text: 'Not available: no dbt project here' })).toBeDefined() + await ui.unmount() +}) + +test('an edit to a model adds one line with its CTE count and never calls the backend', async ($, on) => { + const { clock, cli } = await start($, on, { sql: 'with a as (select 1), b as (select 2) select * from a' }) + const result = await $.tool.call({ tool: 'Edit', file_path: FILE, old_string: '1', new_string: '2' }) + await clock.settle() + expect((result as any).context).toContain('2 CTEs · /sql-graph') + expect(cli).toHaveLength(0) +}) + +test('an edit to a model with no CTEs, or to a file that is no model, adds no line', async ($, on) => { + const { clock } = await start($, on, { sql: 'select 1' }) + const plain = await $.tool.call({ tool: 'Edit', file_path: FILE, old_string: '1', new_string: '2' }) + const macro = await $.tool.call({ tool: 'Edit', file_path: `${ROOT}/macros/m.sql`, old_string: '1', new_string: '2' }) + await clock.settle() + expect((plain as any).context ?? []).not.toContain('0 CTEs · /sql-graph') + expect(JSON.stringify((plain as any).context ?? [])).not.toContain('/sql-graph') + expect(JSON.stringify((macro as any).context ?? [])).not.toContain('/sql-graph') +}) + +test('an older ask for the same model that answers after a newer one does not replace it, and says so', async ($, on) => { + let release!: () => void + const held = new Promise(resolve => (release = resolve)) + const { clock } = await start($, on, { holdFirst: held }) + const older = $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.advance(3_000) + expect((await older).text).toBe('The SQL graph for fct_orders is loading; the pane shows it when it is ready.') + // The second ask answers at once; the first answers after it. + const newer = await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + expect(newer.text).toBe('The SQL graph for fct_orders is open.') + release() + await clock.settle() + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + expect(await ui.find({ type: 'Text', text: /SQL graph · fct_orders · 3 nodes/ })).toBeDefined() + await ui.unmount() +}) + +test('an older ask that answers after a newer one, inside the wait, replies that it was replaced', async ($, on) => { + let release!: () => void + const held = new Promise(resolve => (release = resolve)) + const { clock } = await start($, on, { holdFirst: held }) + const older = $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.advance(500) + const newer = await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + expect(newer.text).toBe('The SQL graph for fct_orders is open.') + release() + await clock.settle() + expect((await older).text).toBe('The SQL graph for fct_orders was replaced by a newer /sql-graph.') +}) + +test('an answer that lands after a new conversation started is dropped', async ($, on) => { + let release!: () => void + const held = new Promise(resolve => (release = resolve)) + const { clock } = await start($, on, { hold: { fct_orders: held } }) + const reply = $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.advance(3_000) + await reply + await $.session.end({ sessionId: 'test' } as any) + release() + await clock.settle() + const ui = await $.ui.mount({ ...PANE, surface: 'terminal' }) + expect(await ui.find({ type: 'Text', text: 'Run /sql-graph .' })).toBeDefined() + await ui.unmount() +}) + +test('a tool answer of status ok with success false is the failure it says, not an empty graph', async ($, on) => { + const { clock } = await start($, on, { ok: false }) + const reply = await $.command.run({ command: 'sql-graph', args: 'fct_orders', ...composer } as any) + await clock.settle() + expect(reply.text).toBe('Not available: this needs the dbt adapter') +}) diff --git a/plugins/altimate-code/hooks/features/sql-graph.tsx b/plugins/altimate-code/hooks/features/sql-graph.tsx new file mode 100644 index 0000000..a8fd921 --- /dev/null +++ b/plugins/altimate-code/hooks/features/sql-graph.tsx @@ -0,0 +1,314 @@ +// SQL graph: /sql-graph lists a model's CTEs, joins and filters. +// +// The plugin calls each function below at its moment, in the order features/index.ts fixes; one with +// nothing to do stays a no-op. This feature's own hooks (its commands and panes, each under a matcher +// no other part uses) go in `register`. The events the whole plugin shares (session start and end, +// turns, Bash and file tool calls, the band) come through the other functions, since a plugin hooks +// each of those once. The status-line part is set with `setStatusPart($, 'sqlGraph', text)`. +import { atom, read, update } from 'claude-code' +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import type { SqlGraphState, SqlGraphView } from '../../types' +import { later, runTool, within } from '../altimate-cli' +import { projectLayout } from '../lineage-graph' +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { BandUi, FeatureContext } from './index' + +const PANE = 'altimate-sql-graph' +const PANE_TITLE = 'SQL graph' +const COMMAND = 'sql-graph' +// How long /sql-graph waits for the graph before it replies without it; the pane shows it when it lands. +const COMMAND_WAIT_MS = 2_000 +// The compile, the warehouse metadata read and the backend call, with the dbt adapter's start: its own budget. +const TOOL_BUDGET_MS = 150_000 +const PANE_SIZE = { columns: 100, rows: 30 } + +const stateAtom = atom({ plugin: 'altimate-code', key: 'sqlGraph' } as const, null, { shape: 'sql-graph-1' }) + +const EMPTY: SqlGraphState = { lastModel: null, shown: null } + +// Folders at the top of a dbt project that hold no model, and build or package folders at any depth. A folder inside a model path keeps its name: `models/tests/orders.sql` is a model. +const NOT_MODEL_TOP = /^(macros|tests|analyses|analysis|snapshots|seeds)$/i +const NOT_MODEL_ANYWHERE = /^(target|dbt_packages|dbt_modules)$/i +// The most of a node's SQL the pane draws; a larger statement is cut, and says so. +const SQL_LIMIT = 20_000 + +/** Whether a dbt project's folder sits among the installed packages of an enclosing project: a default package folder at any depth, or its `packages-install-path`. */ +async function insideInstalledPackages($: EngineInterface, root: string): Promise { + let dir = root + for (let i = 0; i < 40; i++) { + const cut = dir.lastIndexOf('/') + if (cut <= 0) return false + dir = dir.slice(0, cut) + if (!(await $.fs.exists(`${dir}/dbt_project.yml`).catch(() => false))) continue + const inside = root.slice(dir.length).replace(/^\/+/, '').split('/') + if (inside.some(part => NOT_MODEL_ANYWHERE.test(part))) return true + const yml = await $.fs.read(`${dir}/dbt_project.yml`).catch(() => '') + const custom = /^packages-install-path:\s*['"]?([^'"#\n]+?)['"]?\s*(?:#.*)?$/m.exec(String(yml))?.[1] + // The configured folder as a path from this project: an absolute one counts only when it is inside the project. + const given = (custom ?? '').replace(/\\/g, '/') + const from = `${dir.replace(/\/+$/, '')}/` + const relative = given.startsWith('/') ? (given.startsWith(from) ? given.slice(from.length) : null) : given + const kept: string[] = [] + for (const part of relative === null ? [] : relative.split('/')) { + if (part === '..') kept.pop() + else if (part && part !== '.') kept.push(part) + } + const own = kept.join('/') + const here = inside.join('/') + // An enclosing project that does not hold this one among its packages leaves the outer ones to be asked. + if (own && (here === own || here.startsWith(`${own}/`))) return true + } + return false +} + +/** The model a SQL file holds, by its file name; null for a file outside a dbt project's model folders. */ +export async function modelOf($: EngineInterface, file: string): Promise { + if (!/\.sql$/i.test(file)) return null + const path = file.replace(/\\/g, '/') + let dir = path.slice(0, path.lastIndexOf('/')) + let root: string | null = null + for (let i = 0; i < 40 && dir; i++) { + if (await $.fs.exists(`${dir}/dbt_project.yml`).catch(() => false)) { + root = dir + break + } + const cut = dir.lastIndexOf('/') + if (cut <= 0) break + dir = dir.slice(0, cut) + } + // An installed package has a dbt_project.yml of its own: its models are not this project's. + if (!root || NOT_MODEL_ANYWHERE.test(root.split('/').slice(-2, -1)[0] ?? '')) return null + if (await insideInstalledPackages($, root)) return null + const relative = path.slice(root.length).replace(/^\/+/, '') + const folders = relative.split('/').slice(0, -1) + if (folders.some(part => NOT_MODEL_ANYWHERE.test(part)) || NOT_MODEL_TOP.test(folders[0] ?? '')) return null + const layout = projectLayout(await $.fs.read(`${root}/dbt_project.yml`).catch(() => '')) + const inside = layout.models.some(folder => { + const own = folder.replace(/^\.\/+/, '').replace(/^\.$/, '').replace(/\/+$/, '') + return own === '' || relative.startsWith(`${own}/`) + }) + return inside ? relative.slice(relative.lastIndexOf('/') + 1).replace(/\.sql$/i, '') || null : null +} + +/** How many CTEs a model's SQL defines: `with a as (…), b (c) as (…)`; comments and strings are not read. */ +export function cteCount(sql: string): number { + // One pass, so a `--` inside a string and a quote inside a comment each stay where they are. + const bare = sql.replace(/'(?:[^']|'')*'|--[^\n]*|\/\*[\s\S]*?\*\/|\{#[\s\S]*?#\}/g, ' ') + return [ + ...bare.matchAll( + /(?:\bwith\s+(?:recursive\s+)?|,\s*)(?:"[^"]+"|`[^`]+`|\w+)\s*(?:\([^)]*\)\s*)?as\s*(?:not\s+materialized\s+|materialized\s+)?\(/gi, + ), + ].length +} + +/** Text from the repo, the CLI or the backend drawn as one line of plain characters: escape sequences and control characters out. */ +function plain(text: string): string { + return text + .replace(/\u001b\][^\u0007\u001b]*(?:\u0007|\u001b\\)?/g, ' ') + .replace(/\u001b\[[0-?]*[ -/]*[@-~]/g, ' ') + .replace(/[\u0000-\u001f\u007f-\u009f\u2028\u2029]/g, ' ') +} + +/** A node's SQL as drawn: lines kept, escape sequences and other control characters out, and cut at SQL_LIMIT. */ +function sqlText(sql: string): string { + const kept = sql.slice(0, SQL_LIMIT).split('\n').map(plain).join('\n') + return sql.length > SQL_LIMIT ? `${kept}\n… ${sql.length - SQL_LIMIT} more characters not shown` : kept +} + +/** The graph's nodes in dependency order: a node comes after everything that feeds it; ties keep the backend's order. */ +export function orderNodes(graph: SqlGraphView): SqlGraphView['nodes'] { + const ids = new Set(graph.nodes.map(node => node.id)) + const pending = new Map() + const feeds = new Map() + for (const [from, to] of graph.edges) { + if (!ids.has(from) || !ids.has(to) || from === to) continue + pending.set(to, (pending.get(to) ?? 0) + 1) + feeds.set(from, [...(feeds.get(from) ?? []), to]) + } + const done = new Set() + const ordered: SqlGraphView['nodes'] = [] + // Repeated passes in the backend's order: a cycle (which SQL cannot have) falls out as the rest, unsorted. + while (ordered.length < graph.nodes.length) { + const ready = graph.nodes.filter(node => !done.has(node.id) && (pending.get(node.id) ?? 0) === 0) + const batch = ready.length ? ready : graph.nodes.filter(node => !done.has(node.id)) + for (const node of batch) { + done.add(node.id) + ordered.push(node) + for (const to of feeds.get(node.id) ?? []) pending.set(to, (pending.get(to) ?? 1) - 1) + } + if (!ready.length) break + } + return ordered.length === graph.nodes.length ? ordered : graph.nodes +} + +/** The inputs of a node: the ids with an edge into it. */ +export function inputsOf(graph: SqlGraphView, id: string): string[] { + return graph.edges.filter(([, to]) => to === id).map(([from]) => from) +} + +async function merge($: EngineInterface, change: (prev: SqlGraphState) => SqlGraphState) { + await update($, stateAtom, prev => change(prev ?? EMPTY)) +} + +// The ask that owns the pane. Only an answer to that ask is written, so an older ask for the same model, or one +// from before a new conversation, never replaces a newer one. +let latestRequest = 0 + +async function showing($: EngineInterface, request: number, change: Partial>) { + await merge($, prev => (prev.shown?.request === request ? { ...prev, shown: { ...prev.shown, ...change } } : prev)) +} + +/** Asks the tool for the model's graph and puts the answer, or why there is none, in the pane. */ +async function load($: EngineInterface, model: string): Promise<'shown' | 'failed' | 'replaced'> { + const request = ++latestRequest + await merge($, prev => ({ ...prev, shown: { model, request, graph: null, loading: true, message: null, selected: null } })) + let outcome: 'shown' | 'failed' = 'failed' + try { + const until = (await $.clock.now()) + TOOL_BUDGET_MS + // The tool starts the dbt adapter, so it needs write permission: it goes through the CLI. + const result = await runTool($, 'dbt_sql_graph', { model }, { write: true, until }) + const meta = result.metadata as { success?: boolean; error?: string; nodes?: SqlGraphView['nodes']; edges?: SqlGraphView['edges'] } | null + if (!result.ok || !meta?.success || !Array.isArray(meta.nodes) || !Array.isArray(meta.edges)) { + await showing($, request, { loading: false, message: plain(result.text || String((meta as { error?: unknown } | null)?.error ?? '') || `No SQL graph for ${model}.`) }) + } else { + await showing($, request, { loading: false, graph: { nodes: meta.nodes, edges: meta.edges } }) + outcome = 'shown' + } + } catch (error) { + await showing($, request, { loading: false, message: plain(`No SQL graph for ${model}: ${String(error)}`) }) + } + return (await read($, stateAtom))?.shown?.request === request ? outcome : 'replaced' +} + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) { + on('command.run', { command: COMMAND }, async ($, e) => { + const asked = e.args.trim() + const model = asked || (await read($, stateAtom))?.lastModel || '' + if (!model) return { text: 'Read or edit a dbt model, or run /sql-graph .' } + const shownModel = plain(model) + try { + await $.ui.open({ id: PANE, title: PANE_TITLE, ...PANE_SIZE, focus: true, closeOnEscape: true }) + } catch (error) { + return { text: plain(`Could not open the SQL graph: ${String(error)}`) } + } + // One backend call and one warehouse metadata read, per command, never per edit. + const landed = await within($, COMMAND_WAIT_MS, load($, model)) + if (landed === null) return { text: `The SQL graph for ${shownModel} is loading; the pane shows it when it is ready.` } + if (landed === 'replaced') return { text: `The SQL graph for ${shownModel} was replaced by a newer /sql-graph.` } + return { text: landed === 'shown' ? `The SQL graph for ${shownModel} is open.` : ((await read($, stateAtom))?.shown?.message ?? `No SQL graph for ${shownModel}.`) } + }) + + on('ui.render', { component: 'Pane', requestId: PANE }, async ($, e) => { + const { Box, Button, Text } = $.ui.resolve(e) + const shown = (await read($, stateAtom))?.shown + if (!shown) { + return ( + + SQL graph + Run /sql-graph <model>. + + ) + } + if (shown.loading) { + return ( + + {`SQL graph · ${plain(shown.model)}`} + Compiling the model and asking the Altimate backend… + + ) + } + if (!shown.graph) { + return ( + + {`SQL graph · ${plain(shown.model)}`} + {plain(shown.message ?? `No SQL graph for ${shown.model}.`)} + + ) + } + const graph = shown.graph + const nodes = orderNodes(graph) + const chosen = nodes.find(node => node.id === shown.selected) + const nameOf = new Map(nodes.map(node => [node.id, node.name])) + const select = (id: string) => later($, () => showing($, shown.request, { selected: id })) + return ( + + + {`SQL graph · ${plain(shown.model)} · ${nodes.length} nodes`} + + {nodes.map(node => { + const from = inputsOf(graph, node.id).map(id => nameOf.get(id) ?? id) + const text = `${plain(node.name)} (${plain(node.type)}) · ${node.columns.length} ${node.columns.length === 1 ? 'column' : 'columns'}${from.length ? ` · from ${from.map(plain).join(', ')}` : ''}` + return