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..ffa5f78 --- /dev/null +++ b/plugins/altimate-code/hooks/dbt-command.test.ts @@ -0,0 +1,132 @@ +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'] }]) +}) diff --git a/plugins/altimate-code/hooks/dbt-command.ts b/plugins/altimate-code/hooks/dbt-command.ts new file mode 100644 index 0000000..6c77970 --- /dev/null +++ b/plugins/altimate-code/hooks/dbt-command.ts @@ -0,0 +1,535 @@ +// 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 }) + } + } + finish() + 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.test.ts b/plugins/altimate-code/hooks/features/defer.test.ts new file mode 100644 index 0000000..9243b92 --- /dev/null +++ b/plugins/altimate-code/hooks/features/defer.test.ts @@ -0,0 +1,265 @@ +import { expect, mock, test } from 'claude-code/testing' + +import { effective, rewriteDeferCommand, runsInProject, statusText } from './defer' + +const on = { stateDir: '/work/prod-state' } + +test('dbt build -s x gets --defer --state right after the subcommand', () => { + expect(rewriteDeferCommand('dbt build -s x', on)).toBe('dbt build --defer --state /work/prod-state -s x') +}) + +test('each dbt invocation in cd a && dbt run is rewritten, the rest of the line is left as it is', () => { + expect(rewriteDeferCommand('cd a && dbt run', on)).toBe('cd a && dbt run --defer --state /work/prod-state') + expect(rewriteDeferCommand('dbt run && dbt test | tee log', on)).toBe('dbt run --defer --state /work/prod-state && dbt test --defer --state /work/prod-state | tee log') +}) + +test('a quoted --directory or --project option is not followed', () => { + expect(runsInProject('uv run "--directory=../b" dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject("uv run '--directory' ../b dbt run", '/repo/a', '/repo/a')).toBe(false) +}) + +test('uv run dbt test is rewritten after the subcommand, and --favor-state follows the setting', () => { + expect(rewriteDeferCommand('uv run dbt test', { ...on, favorState: true })).toBe('uv run dbt test --defer --state /work/prod-state --favor-state') +}) + +test('a command with --state, --defer or --no-defer already is not changed', () => { + expect(rewriteDeferCommand('dbt build --state ./old', on)).toBe('dbt build --state ./old') + expect(rewriteDeferCommand('dbt build --no-defer', on)).toBe('dbt build --no-defer') + expect(rewriteDeferCommand('DBT_STATE=./old dbt build', on)).toBe('DBT_STATE=./old dbt build') +}) + +test('defer off or no dbt command: no rewrite', () => { + expect(rewriteDeferCommand('dbt build', {})).toBe('dbt build') + expect(rewriteDeferCommand('dbt build', { stateDir: null })).toBe('dbt build') + expect(rewriteDeferCommand('ls -la && echo dbt', on)).toBe('ls -la && echo dbt') +}) + +test('commands that do not defer are left without --defer, and the target goes to every command that takes one', () => { + const both = { ...on, target: 'qa', defaultTarget: 'dev' } + expect(rewriteDeferCommand('dbt ls -s x', on)).toBe('dbt ls --defer --state /work/prod-state -s x') + expect(rewriteDeferCommand('dbt deps', both)).toBe('dbt deps') + expect(rewriteDeferCommand('dbt source freshness', both)).toBe('dbt source --target qa freshness') + expect(rewriteDeferCommand('dbt debug', both)).toBe('dbt debug --target qa') + expect(rewriteDeferCommand('dbt retry', both)).toBe('dbt retry') +}) + +test('an inline DBT_TARGET keeps the target of that command only', () => { + const options = { target: 'qa', defaultTarget: 'dev' } + expect(rewriteDeferCommand('DBT_TARGET=ci dbt run', options)).toBe('DBT_TARGET=ci dbt run') + expect(rewriteDeferCommand('DBT_TARGET=ci dbt run && dbt test', options)).toBe('DBT_TARGET=ci dbt run && dbt test --target qa') +}) + +test('a command for another project, by cd or --project-dir, is not rewritten', () => { + expect(runsInProject('dbt run', '/repo/a', '/repo/a')).toBe(true) + expect(runsInProject('cd models && dbt run', '/repo/a', '/repo/a')).toBe(true) + expect(runsInProject('cd a && dbt run', '/repo', '/repo/a')).toBe(true) + expect(runsInProject('cd ../b && dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('dbt run && cd ../b && dbt test', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('dbt run --project-dir ../b', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('DBT_PROJECT_DIR=../b dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('dbt run', '/repo', '/repo/a')).toBe(false) + expect(runsInProject('cd ~/other && dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('ls', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('{ cd ../b; dbt run; }', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('if cd ../b; then dbt run; fi', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('cd -P ../b && dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('cd ~/x && dbt run --project-dir /repo/a', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('pushd ../b && dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('uv run --directory ../b dbt run', '/repo/a', '/repo/a')).toBe(false) + // The project named with --project-dir is this one when it resolves to it. + expect(runsInProject('dbt run --project-dir a', '/repo', '/repo/a')).toBe(true) + expect(runsInProject('dbt run --project-dir b', '/repo', '/repo/a')).toBe(false) + expect(runsInProject('dbt run --project-dir nested', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('cd ../b; (cd ../a); dbt run', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('out=`cd ../b && dbt run`', '/repo/a', '/repo/a')).toBe(false) + expect(runsInProject('cd a && dbt run --project-dir .', '/repo', '/repo/a')).toBe(true) + expect(runsInProject('dbt run --project-dir ./models/..', '/repo/a', '/repo/a')).toBe(true) +}) + +test('a folder change or project named outside the dbt command itself is not trusted', () => { + const run = (command: string) => runsInProject(command, '/repo/a', '/repo/a') + // A project named by another command or in a comment does not vouch for a different dbt command. + expect(run('cd ../b && dbt run --project-dir ../a && dbt test')).toBe(false) + expect(run('cd ../b; echo --project-dir ../a; dbt run')).toBe(false) + expect(run('dbt run # --project-dir ../a')).toBe(false) + // Folder changes that are not followed leave the folder unknown. + expect(run('cd && dbt run')).toBe(false) + expect(run('popd && dbt run')).toBe(false) + expect(run('command cd ../b && dbt run')).toBe(false) + expect(run('env -C ../b dbt run')).toBe(false) + expect(run('env --chdir=../b dbt run')).toBe(false) + expect(run('cd ./$SUB && dbt run')).toBe(false) + expect(run('cd `pwd`/../b && dbt run')).toBe(false) + expect(run("command 'cd' ../b && dbt run")).toBe(false) + expect(run('env "-C" ../b dbt run')).toBe(false) + expect(run('dbt run "--project-dir" ../b')).toBe(false) + expect(run('cd "\'.\'"/.. && dbt run')).toBe(false) + expect(run('cd "a"/.. && dbt run')).toBe(false) + expect(run('popd; dbt run')).toBe(false) + expect(run('cd\ndbt run')).toBe(false) + expect(run('cd ../b && dbt ls <(cd ../a; dbt ls)')).toBe(false) + expect(run('cd models && dbt run')).toBe(true) +}) + +test('DBT_STATE or DBT_TARGET exported earlier in the line is left alone, and an inner invocation keeps its place', () => { + expect(rewriteDeferCommand('export DBT_STATE=/mine && dbt build', on)).toBe('export DBT_STATE=/mine && dbt build') + expect(rewriteDeferCommand('export OTHER=x DBT_STATE=/mine DBT_TARGET=prod && dbt build', { ...on, target: 'qa', defaultTarget: 'dev' })).toBe('export OTHER=x DBT_STATE=/mine DBT_TARGET=prod && dbt build') + expect(rewriteDeferCommand('export OTHER="two words" DBT_STATE=/mine && dbt build', on)).toBe('export OTHER="two words" DBT_STATE=/mine && dbt build') + expect(rewriteDeferCommand('export OTHER="a;b" DBT_STATE=/mine DBT_TARGET=prod && dbt build', { ...on, target: 'qa', defaultTarget: 'dev' })).toBe('export OTHER="a;b" DBT_STATE=/mine DBT_TARGET=prod && dbt build') + expect(rewriteDeferCommand('export DBT_TARGET=prod && dbt build', { target: 'qa', defaultTarget: 'dev' })).toBe('export DBT_TARGET=prod && dbt build') + expect(rewriteDeferCommand('dbt ls <(dbt ls)', on)).toBe('dbt ls --defer --state /work/prod-state <(dbt ls --defer --state /work/prod-state)') +}) + +test('a Windows session folder, with either slash, is the project it names', () => { + expect(runsInProject('dbt run', 'C:\\repo', 'C:/repo')).toBe(true) + expect(runsInProject('cd models && dbt run', 'C:/repo', 'C:\\repo')).toBe(true) + expect(runsInProject('cd C:\\other && dbt run', 'C:/repo', 'C:/repo')).toBe(false) + expect(runsInProject('cd a && dbt run', 'C:\\repo', 'C:/repo/a')).toBe(true) +}) + +test('a path with spaces is quoted', () => { + expect(rewriteDeferCommand('dbt run', { stateDir: "/my state/o'k" })).toBe(`dbt run --defer --state '/my state/o'\\''k'`) +}) + +test('the session target is added when it differs from the default and the command names none', () => { + const options = { target: 'prod', defaultTarget: 'dev' } + expect(rewriteDeferCommand('dbt run -s x', options)).toBe('dbt run --target prod -s x') + expect(rewriteDeferCommand('dbt run -t qa', options)).toBe('dbt run -t qa') + expect(rewriteDeferCommand('dbt run', { target: 'dev', defaultTarget: 'dev' })).toBe('dbt run') + expect(rewriteDeferCommand('dbt run', { ...on, ...options })).toBe('dbt run --defer --state /work/prod-state --target prod') +}) + +test('the override decides, and the status text shows target and defer', () => { + const state: any = { projectDir: '/p', enabled: true, favorState: false, mode: 'local', stateDir: '/work/prod', reason: null, override: null, defaultTarget: 'dev', targets: ['dev', 'prod'], target: null, failedAt: null } + expect(statusText(state)).toBe('dbt dev · defer prod') + expect(effective(state).stateDir).toBe('/work/prod') + expect(effective({ ...state, override: false }).stateDir).toBeNull() + expect(statusText({ ...state, override: false, target: 'prod' })).toBe('dbt prod') + expect(statusText({ ...state, projectDir: null })).toBeNull() +}) + +const ROOT = '/repo' + +/** A dbt project at /repo whose defer setting the CLI reports as `answer`; Bash commands are recorded. */ +function start($: any, on: any, answer: Record, fail: { times: number } = { times: 0 }) { + const bash: string[] = [] + const statuses: (string | undefined)[] = [] + const reads: string[] = [] + const clock = mock.clock(on) + on('command.register', (_: unknown, e: any) => ({ value: { command: e.name } })) + on('session.start', (_: unknown, e: { cwd: string }) => ({ cwd: e.cwd })) + on('session.root', () => ({ value: ROOT })) + on('fs.exists', (_: unknown, e: { path: string }) => ({ value: e.path === `${ROOT}/dbt_project.yml` })) + on('process.run', (_: unknown, e: { readonly argv: readonly string[] }) => { + if (!e.argv.includes('dbt_defer_state')) return { value: { exitCode: 0, stdout: '{}', stderr: '' } } + reads.push(e.argv.join(' ')) + if (fail.times-- > 0) return { value: { exitCode: 1, stdout: '', stderr: 'not ready' } } + return { + value: { exitCode: 0, stdout: JSON.stringify({ status: 'success', output: '', metadata: { success: true, ...answer } }), stderr: '' }, + } + }) + on('ui.status', (_: unknown, e: any) => { + statuses.push(e.text) + return { value: undefined } + }) + on('tool.call', (_: unknown, e: any) => { + bash.push(e.command) + return { result: { ok: true } } + }) + return { bash, statuses, reads, clock } +} + +const DEFER = { enabled: true, favorState: true, mode: 'local', stateDir: '/work/prod-state', defaultTarget: 'dev', targets: ['dev', 'prod'] } + +test('through the plugin, Claude’s dbt commands run with --defer --state when the project setting is on', async ($, on) => { + const seen = start($, on, DEFER) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'dbt build -s x' }) + await $.tool.call({ tool: 'Bash', command: 'dbt build --state ./mine' }) + expect(seen.bash).toEqual(['dbt build --defer --state /work/prod-state --favor-state -s x', 'dbt build --state ./mine']) + expect(seen.statuses.at(-1)).toContain('dbt dev · defer prod-state') +}) + +test('/defer off stops the rewrite for the session, /defer on brings it back, /target adds --target', async ($, on) => { + const seen = start($, on, DEFER) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + const run = (command: string, args: string) => $.command.run({ command, args, origin: { kind: 'composer' }, presentation: { isFullscreen: false, columns: 120 } }) + + expect((await run('defer', 'off')).text).toContain('Defer off') + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + expect((await run('defer', 'on')).text).toContain('Defer on') + expect((await run('target', 'prod')).text).toContain('--target prod') + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + expect((await run('target', 'nope')).text).toContain('No target "nope"') + expect((await run('defer', 'status')).text).toContain('state: /work/prod-state (favor state)') + expect(seen.bash).toEqual(['dbt run', 'dbt run --defer --state /work/prod-state --favor-state --target prod']) +}) + +test('with defer off in the project nothing is rewritten and /defer on says why it cannot', async ($, on) => { + const seen = start($, on, { enabled: false, mode: 'none', defaultTarget: 'dev', targets: ['dev'] }) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + const reply = await $.command.run({ command: 'defer', args: 'on', origin: { kind: 'composer' }, presentation: { isFullscreen: false, columns: 120 } }) + expect(reply.text).toContain('cannot be turned on') + expect(seen.bash).toEqual(['dbt run']) +}) + +test('a configured but switched-off setting can be turned on for the session', async ($, on) => { + const seen = start($, on, { ...DEFER, enabled: false }) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + const run = (command: string, args: string) => $.command.run({ command, args, origin: { kind: 'composer' }, presentation: { isFullscreen: false, columns: 120 } }) + expect((await run('defer', 'on')).text).toContain('Defer on') + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + expect(seen.bash).toEqual(['dbt run', 'dbt run --defer --state /work/prod-state --favor-state']) +}) + +test('a dbt command for another project is left as it is', async ($, on) => { + const seen = start($, on, DEFER) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'cd ../other && dbt run' }) + await $.tool.call({ tool: 'Bash', command: 'dbt run --project-dir ../other' }) + await $.tool.call({ tool: 'Bash', command: 'cd models && dbt run' }) + expect(seen.bash).toEqual(['cd ../other && dbt run', 'dbt run --project-dir ../other', 'cd models && dbt run --defer --state /work/prod-state --favor-state']) +}) + +test('the setting is read once, on the first dbt command, and a command without dbt reads nothing', async ($, on) => { + const seen = start($, on, DEFER) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'ls' }) + expect(seen.reads).toEqual([]) + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + await $.tool.call({ tool: 'Bash', command: 'dbt test' }) + expect(seen.reads.length).toBe(1) +}) + +test('a read that failed is tried again after a minute, not for the rest of the session', async ($, on) => { + const seen = start($, on, DEFER, { times: 1 }) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + await seen.clock.advance(61_000) + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + expect(seen.bash).toEqual(['dbt run', 'dbt run', 'dbt run --defer --state /work/prod-state --favor-state']) + expect(seen.reads.length).toBe(2) +}) + +test('a new session clears the status line and the overrides of the one before', async ($, on) => { + const seen = start($, on, DEFER) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.command.run({ command: 'target', args: 'prod', origin: { kind: 'composer' }, presentation: { isFullscreen: false, columns: 120 } }) + expect(seen.statuses.at(-1)).toContain('dbt prod') + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + expect(String(seen.statuses.at(-1))).not.toContain('dbt prod') + await $.tool.call({ tool: 'Bash', command: 'dbt run' }) + expect(seen.bash.at(-1)).toBe('dbt run --defer --state /work/prod-state --favor-state') +}) + +test('a command that only mentions dbt does not read the setting', async ($, on) => { + const seen = start($, on, DEFER) + await $.session.start({ cwd: ROOT, surface: 'terminal', isInteractive: true }) + await $.tool.call({ tool: 'Bash', command: 'cat dbt_project.yml' }) + await $.tool.call({ tool: 'Bash', command: 'git commit -m "dbt"' }) + expect(seen.reads).toEqual([]) + expect(seen.bash).toEqual(['cat dbt_project.yml', 'git commit -m "dbt"']) +}) diff --git a/plugins/altimate-code/hooks/features/defer.tsx b/plugins/altimate-code/hooks/features/defer.tsx new file mode 100644 index 0000000..a26fd51 --- /dev/null +++ b/plugins/altimate-code/hooks/features/defer.tsx @@ -0,0 +1,361 @@ +// 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 { atom, read, update } from 'claude-code' +import type { Args, EngineInterface, EventResult, On, RenderElement, ToolCallResult } from 'claude-code' + +import { runTool } from '../altimate-cli' +import { parseDbtCommand } from '../dbt-command' +import { setStatusPart } from '../status-line' +import type { BashCall, ContextLines, EditedFile, FileCall } from '../tool-chain' +import type { DeferState } from '../../types' +import type { BandUi, FeatureContext } from './index' + +const deferAtom = atom({ plugin: 'altimate-code', key: 'defer' } as const, null as DeferState | null) + +// Commands that do not defer (dbt before 1.8 refuses the option on some of them, and `retry` reads the +// previous run's results from `--state`, which would point at the wrong ones) and commands that take no target. +const NO_DEFER = new Set(['deps', 'clean', 'debug', 'init', 'retry', 'docs', 'source']) +const NO_TARGET = new Set(['deps', 'clean', 'init', 'retry']) + +const quote = (text: string) => (/^[\w@%+=:,./-]+$/.test(text) ? text : `'${text.replace(/'/g, `'\\''`)}'`) + +export type RewriteOptions = { + /** The directory to defer to; null or undefined means defer is off. */ + stateDir?: string | null + favorState?: boolean + /** The session's target; added to a command without one when it differs from the profile's default. */ + target?: string | null + defaultTarget?: string | null +} + +/** + * The shell command with `--defer --state ` (and `--favor-state`) and `--target ` inserted + * right after the subcommand of each dbt invocation that does not already set them; the command itself + * when nothing needs to change. + */ +export function rewriteDeferCommand(command: string, options: RewriteOptions): string { + const { stateDir, favorState = false, target, defaultTarget } = options + if (!stateDir && !target) return command + let out = command + // DBT_STATE or DBT_TARGET exported in the line is the user's own choice: none of its dbt commands gets the flag + // (a line with an `export` and the variable anywhere in it counts, whatever the quoting). + const exportedState = /\bexport\b/.test(command) && /\bDBT_(?:STATE|DEFER|DEFER_STATE|FAVOR_STATE)=/.test(command) + const exportedTarget = /\bexport\b/.test(command) && /\bDBT_TARGET=/.test(command) + // From the last invocation to the first, so the offsets of those before stay right. + for (const one of [...parseDbtCommand(command)].sort((a, b) => b.subcommandEnd - a.subcommandEnd)) { + if (!one.subcommand) continue + const flags: string[] = [] + if (stateDir && !exportedState && !NO_DEFER.has(one.subcommand) && !one.hasDefer && !one.hasState && !/\bDBT_(?:DEFER|DEFER_STATE|FAVOR_STATE)=/.test(command.slice(one.start, one.end))) flags.push('--defer', '--state', quote(stateDir), ...(favorState ? ['--favor-state'] : [])) + if (target && !NO_TARGET.has(one.subcommand) && target !== defaultTarget && one.target === null && !exportedTarget && !/\bDBT_TARGET=/.test(command.slice(one.start, one.end))) flags.push('--target', quote(target)) + if (flags.length === 0) continue + out = `${out.slice(0, one.subcommandEnd)} ${flags.join(' ')}${out.slice(one.subcommandEnd)}` + } + return out +} + +type DeferAnswer = { + success?: boolean + enabled?: boolean + favorState?: boolean + mode?: 'local' | 'remote' | 'none' + stateDir?: string + reason?: string + defaultTarget?: string + targets?: string[] +} + +const dirname = (path: string) => path.replace(/[\\/]+[^\\/]*$/, '') || '/' + +/** The dbt project the session works in: the folder or one above it with a dbt_project.yml, else the only one a level below. */ +async function findProject($: EngineInterface): Promise { + const root = await $.session.root().catch(() => null) + if (!root) return null + for (let dir = root, i = 0; i < 40; i++) { + if (await $.fs.exists(`${dir}/dbt_project.yml`).catch(() => false)) return dir + const parent = dirname(dir) + if (parent === dir) break + dir = parent + } + const below: string[] = [] + for (const entry of await $.fs.list(root).catch(() => [])) { + if (entry.kind !== 'dir' || entry.name.startsWith('.') || entry.name === 'node_modules') continue + if (await $.fs.exists(`${root}/${entry.name}/dbt_project.yml`).catch(() => false)) below.push(`${root}/${entry.name}`) + } + return below.length === 1 ? below[0]! : null +} + +// Where a command runs from: the session folder, moved by each `cd` or `pushd` in the command. +const CD = /(?:^|[;&|(\n{!]\s*|\b(?:if|elif|while|until|then|do|else|time)\s+)(?:cd|pushd)[ \t]+("[^"]+"|'[^']+'|[^\s;&|)]+)/gm +const PROJECT_DIR = /(?:--project-dir[ =]|\bDBT_PROJECT_DIR=)("[^"]+"|'[^']+'|[^\s;&|)]+)/g +const UNQUOTE = /^['"]|['"]$/g + +/** `target` seen from `base`, as an absolute path with forward slashes (a drive letter kept); null when it cannot be known. */ +function resolvePath(base: string, target: string): string | null { + if (/^~|[$`]/.test(target)) return null + const from = base.replace(/\\/g, '/') + const to = target.replace(/\\/g, '/') + const drive = /^[A-Za-z]:/.exec(to)?.[0] ?? /^[A-Za-z]:/.exec(from)?.[0] ?? '' + const path = /^[A-Za-z]:\//.test(to) ? to.slice(2) : to.startsWith('/') ? to : `${from.slice(drive.length)}/${to}` + const out: string[] = [] + for (const part of path.split('/')) { + if (part === '' || part === '.') continue + if (part === '..') out.pop() + else out.push(part) + } + return `${drive}/${out.join('/')}` +} + +/** + * Whether the command's dbt runs in the project the settings were read for: not when it moves to another + * folder (`cd`, `pushd`, `--project-dir`, `DBT_PROJECT_DIR`, uv's `--directory`) or one it cannot work out. + */ +export function runsInProject(command: string, root: string, projectDir: string): boolean { + // A folder change this does not follow (`popd`, `env -C`, `command cd`, a `cd` with no folder) leaves the folder unknown. + // Quotes and backslashes are dropped for this check: `command 'cd' ../b` and `env "-C" ../b` change folder like their plain forms. + const plain = command.replace(/["'\\]/g, '') + if (/\s--(?:directory|project)[\s=]/.test(command) || /\s--(?:directory|project)[\s=]/.test(plain)) return false + if (/(?:^|[\s;&|(){}!])(?:popd|chdir)(?=[\s;&|)]|$)|\benv\s+(?:\S+\s+)*(?:-C|--chdir)\b/.test(plain)) return false + const cdWords = plain.match(/(?:^|[\s;&|(){}!])(?:cd|pushd)(?=[\s;&|)]|$)/g)?.length ?? 0 + if (cdWords !== [...command.matchAll(CD)].length) return false + // A folder change inside a subshell or command substitution leaves the parent's folder unchanged or unknown. + if (cdWords > 0 && /[(`]/.test(plain)) return false + const invocations = parseDbtCommand(command) + // The outermost command that starts first, not an invocation inside a `<(...)` that ends up first in the list. + const first = [...invocations].sort((a, b) => a.start - b.start)[0] + const project = resolvePath(projectDir, '.') + if (!first || !project) return false + const inside = (dir: string | null) => !!dir && (dir === project || dir.startsWith(`${project.replace(/\/+$/, '')}/`)) + let dir = resolvePath(root, '.') + let before = dir + for (const match of command.matchAll(CD)) { + if (!dir) return false + // A folder word that goes on after its quotes (`"."/..`) is not one this can work out. + if (!/^(?:[\s;&|)]|$)/.test(command.slice(match.index + match[0].length))) return false + const word = match[1]!.replace(UNQUOTE, '') + // `cd -P dir`, `cd -`: not a folder this can work out. + dir = word.startsWith('-') ? null : resolvePath(dir, word) + if (match.index < first.start) before = dir + else if (!inside(dir)) return false + } + // A project named outright is the one to judge; otherwise the folder the command runs from. + const named = [...command.matchAll(PROJECT_DIR)] + // A project option written with quotes (`"--project-dir" ../b`) is only seen in the plain copy: unknown. + if (named.length !== (plain.match(/--project-dir[ =]|\bDBT_PROJECT_DIR=/g)?.length ?? 0)) return false + if (named.length === 0) return inside(before) + // Only a single dbt invocation, with the project named inside it, is judged: elsewhere in the line it is another command's. + if (invocations.length !== 1 || !before) return false + if (named.some(match => match.index < first.start || match.index >= first.end)) return false + // Exactly the project: a folder below it may be a separate dbt project with its own settings. + return named.every(match => resolvePath(before!, match[1]!.replace(UNQUOTE, '')) === project) +} + +/** The flags the state's override and answer lead to: the state dir only while defer is on. */ +export function effective(state: DeferState | null): RewriteOptions { + if (!state) return {} + const on = state.override ?? state.enabled + return { + stateDir: on ? state.stateDir : null, + favorState: state.favorState, + target: state.target, + defaultTarget: state.defaultTarget, + } +} + +/** The status line's part: "dbt dev · defer prod" (target, then defer). */ +export function statusText(state: DeferState | null): string | null { + if (!state?.projectDir) return null + const target = state.target ?? state.defaultTarget + const on = state.override ?? state.enabled + const parts: string[] = [] + if (target) parts.push(`dbt ${target}`) + if (on && state.stateDir) parts.push(`defer ${state.stateDir.split(/[\\/]/).filter(Boolean).pop() ?? 'on'}`) + return parts.length ? parts.join(' · ') : null +} + +async function load($: EngineInterface, previous: DeferState | null): Promise { + const projectDir = await findProject($) + const state: DeferState = { + projectDir, + enabled: false, + favorState: false, + mode: 'none', + stateDir: null, + reason: null, + override: previous?.override ?? null, + defaultTarget: null, + targets: [], + target: previous?.target ?? null, + failedAt: null, + } + if (!projectDir) return state + const answer = await runTool($, 'dbt_defer_state', { project_dir: projectDir }, { cliOnly: true }).catch(() => null) + const data = answer?.ok && (answer.metadata as DeferAnswer | null)?.success !== false ? (answer.metadata as DeferAnswer | null) : null + if (!data) return { ...state, reason: answer?.text || 'altimate-code did not answer', failedAt: await $.clock.now() } + return { + ...state, + enabled: data.enabled === true && typeof data.stateDir === 'string', + favorState: data.favorState === true, + mode: data.mode ?? 'none', + stateDir: data.stateDir ?? null, + reason: data.reason ?? null, + defaultTarget: data.defaultTarget ?? null, + targets: data.targets ?? [], + } +} + +// The read in flight, shared by whoever needs the answer first. +let loading: Promise | null = null +// Counts the sessions: an answer read for an earlier one is dropped. +let generation = 0 +// A read that failed (the CLI timed out or was not ready) is tried again after this long. +const RETRY_MS = 60_000 + +/** The state the project's setting gives, read on first need and kept for the session (a failed read is tried again after a minute); /defer reset reads it again. */ +async function ensure($: EngineInterface): Promise { + const have = await read($, deferAtom) + if (have && (have.failedAt === null || (await $.clock.now()) - have.failedAt < RETRY_MS)) return have + const mine = generation + const started = (loading ??= load($, have).then(async state => { + if (mine === generation) await publish($, state) + return state + })) + let state: DeferState + try { + state = await started + } finally { + // Another session's read must not be dropped by a caller that was waiting on this one; a read that rejected is not kept. + if (loading === started) loading = null + } + return mine === generation ? state : await ensure($) +} + +async function publish($: EngineInterface, state: DeferState) { + await update($, deferAtom, () => state) + await setStatusPart($, 'defer', statusText(state)) +} + +function describe(state: DeferState | null): string { + if (!state?.projectDir) return 'defer: no dbt project found in this folder.' + const on = state.override ?? state.enabled + const lines = [ + `defer: ${on && state.stateDir ? 'on' : 'off'}${state.override !== null ? ` (set with /defer ${state.override ? 'on' : 'off'} for this session)` : ''}`, + `project: ${state.projectDir}`, + `mode: ${state.mode}`, + ] + if (state.stateDir) lines.push(`state: ${state.stateDir}${state.favorState ? ' (favor state)' : ''}`) + if (state.reason) lines.push(`note: ${state.reason}`) + lines.push(`target: ${state.target ?? state.defaultTarget ?? 'profile default'}${state.target ? ' (session)' : ''}`) + if (state.targets.length) lines.push(`targets: ${state.targets.join(', ')}`) + return lines.join('\n') +} + +/** Adds this feature's own hooks. */ +export function register(on: On, context: FeatureContext) { + on('command.run', { command: 'defer' }, async ($, e) => { + const word = e.args.trim().toLowerCase() + const started = generation + let state = await ensure($) + if (word === 'on' || word === 'off') { + if (word === 'on' && !state.stateDir) { + await publish($, state) + return { text: `Defer cannot be turned on: ${state.reason ?? 'no state directory is configured for this project (dbt.deferConfigPerProject).'}` } + } + state = { ...state, override: word === 'on' } + // A session that started while the setting was read has its own state. + if (started === generation) await publish($, state) + return { text: `Defer ${word} for this session.\n${describe(state)}` } + } + if (word === 'reset') { + const mine = generation + state = await load($, null) + // A session that started while this read ran has its own state. + if (mine === generation) await publish($, state) + return { text: `Defer and target back to the project's settings.\n${describe(state)}` } + } + if (word === '' || word === 'status') { + return { text: describe(state) } + } + return { text: 'Usage: /defer [status|on|off|reset]' } + }) + + on('command.run', { command: 'target' }, async ($, e) => { + const name = e.args.trim() + const started = generation + let state = await ensure($) + if (name === '') { + return { text: `target: ${state.target ?? state.defaultTarget ?? 'profile default'}${state.target ? ' (session)' : ''}${state.targets.length ? `\ntargets: ${state.targets.join(', ')}` : ''}` } + } + if (name === 'reset') { + state = { ...state, target: null } + await publish($, state) + return { text: `Target back to the profile default${state.defaultTarget ? ` (${state.defaultTarget})` : ''}.` } + } + if (!/^[\w.-]+$/.test(name)) return { text: `Not a target name: ${name}` } + if (state.targets.length && !state.targets.includes(name)) { + return { text: `No target "${name}" in the profile. Targets: ${state.targets.join(', ')}` } + } + if (!state.projectDir) return { text: 'No dbt project found in this folder, so there is no target to set.' } + state = { ...state, target: name } + if (started === generation) await publish($, state) + return { text: `dbt commands now run with --target ${name} (this session).` } + }) +} + +/** After the session started: registers the commands. The project's setting is read when first needed. */ +export async function sessionStart($: EngineInterface, e: Args<'session.start'>) { + await $.command.register({ name: 'defer', description: "Show or set whether dbt commands defer to the production manifest", argumentHint: '[status|on|off|reset]' }) + await $.command.register({ name: 'target', description: "Set the dbt target for this session's dbt commands", argumentHint: '[|reset]' }) + // A new session starts from the project's own settings, not from the last one's overrides. + generation++ + loading = null + await update($, deferAtom, () => null) + await setStatusPart($, 'defer', null) +} + +/** 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 { + // Most commands name no dbt: they never cost the settings read. + if (!/\bdbt\b/.test(e.command) || parseDbtCommand(e.command).length === 0) return null + const state = await ensure($) + if (!state.projectDir) return null + const root = await $.session.root().catch(() => null) + if (!root || !runsInProject(e.command, root, state.projectDir)) return null + const command = rewriteDeferCommand(e.command, effective(state)) + return command === e.command ? null : command +} + +/** + * `{ 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.tsx b/plugins/altimate-code/hooks/features/sql-graph.tsx new file mode 100644 index 0000000..756f1bd --- /dev/null +++ b/plugins/altimate-code/hooks/features/sql-graph.tsx @@ -0,0 +1,53 @@ +// 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 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/to-model.tsx b/plugins/altimate-code/hooks/features/to-model.tsx new file mode 100644 index 0000000..4308a3e --- /dev/null +++ b/plugins/altimate-code/hooks/features/to-model.tsx @@ -0,0 +1,53 @@ +// Raw SQL to a dbt model: /to-model. +// +// 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($, 'toModel', 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/integrations.tsx b/plugins/altimate-code/hooks/integrations.tsx index 256131b..36b71be 100644 --- a/plugins/altimate-code/hooks/integrations.tsx +++ b/plugins/altimate-code/hooks/integrations.tsx @@ -3,7 +3,10 @@ import type { EngineInterface, Register } from 'claude-code' import type { Busy, Expanded, Form, IntegrationsStatus, Provider, ProviderId, WorkspaceChoice } from '../types' import { MISSING_BINARY, later, parseJson, runAltimate } from './altimate-cli' +import { featureBandLines, featuresSessionStart, registerFeatures } from './features' import { lineageBand, registerLineage, startLineage } from './lineage' +import { setStatusPart } from './status-line' +import { installToolChain } from './tool-chain' const PANE = 'altimate-integrations' const PANE_TITLE = 'Altimate integrations' @@ -102,7 +105,8 @@ async function refresh($: EngineInterface, subcommand: 'status' | 'detect' = 'st const next = parseStatus(result.stdout) if (next) { await update($, status, () => next) - showStatusLine($, next) + if (mine !== latestRefresh) return + await showStatusLine($, next) } else { const failure = parseJson<{ message?: string }>(result.stdout)?.message ?? firstLine(result.stderr.replace(ANSI, '')) await update($, message, () => failure ?? 'altimate returned no integrations status.') @@ -115,7 +119,8 @@ async function refresh($: EngineInterface, subcommand: 'status' | 'detect' = 'st } } -function showStatusLine($: EngineInterface, current: IntegrationsStatus) { +/** The integrations part of the plugin's status line (status-line.ts adds the features' parts). */ +async function showStatusLine($: EngineInterface, current: IntegrationsStatus) { const linked = current.providers.filter(one => one.state === 'connected') const synced = linked.filter(one => one.sync === 'synced').length const waiting = current.providers.filter(one => one.state === 'detected' || one.found || one.state === 'available').length @@ -124,7 +129,7 @@ function showStatusLine($: EngineInterface, current: IntegrationsStatus) { if (attention > 0) parts.push(`${attention} needs attention`) if (synced > 0) parts.push(`${synced} synced`) if (waiting > 0) parts.push(`${waiting} found`) - $.ui.status(parts.join(' · ')) + await setStatusPart($, 'integrations', parts.join(' · ')) } /** The timeout that fits what the command runs: one provider's sync or disconnect. */ @@ -551,7 +556,7 @@ function nameOf(id: ProviderId): string { return { github: 'GitHub', jira: 'Jira', linear: 'Linear' }[id] } -export const register: Register = on => { +export const register: Register = (on, options) => { on('session.start', async ($, e, next) => { const started = await next(e) await $.command.register({ @@ -560,6 +565,8 @@ export const register: Register = on => { }) // The lineage half failing to start must not stop this pane's own setup below. await startLineage($).catch(error => $.ui.log(`lineage-pane · could not start: ${String(error)}`)) + // Each feature's own start (its commands); one failing is logged and the rest go on. + await featuresSessionStart($, e) // A press that was running when an earlier session ended can never finish, so it must not block this one. await update($, busy, () => null) // A `-p` run or the SDK has nobody to show the band to, so it does not scan the machine. @@ -580,10 +587,24 @@ export const register: Register = on => { }) on('ui.render', { component: 'AbovePrompt' }, async ($, e, next) => { - // One band per plugin: the lineage impact line rides under the integrations one, or alone. + // One band per plugin: the lineage impact line rides under the integrations one, or alone; each + // feature's line rides under the lineage one. if (e.props.hasSurvey) return next(e) - const lineage = await lineageBand($, $.ui.resolve(e)) - const pass = async () => lineage ?? next(e) + const ui = $.ui.resolve(e) + const lineage = await lineageBand($, ui) + const extra = await featureBandLines($, ui) + const tail = + extra.length === 0 ? ( + lineage + ) : ( + + {lineage} + {extra.map(one => ( + {one.line} + ))} + + ) + const pass = async () => tail ?? next(e) const current = await read($, status) if (!current || (await read($, isBandHidden))) return pass() @@ -639,7 +660,7 @@ export const register: Register = on => {