Repository navigation
feat: dbt_docs_coverage and how each reached column comes from the traced one #1733
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hkaltai
wants to merge
13
commits into
main
Choose a base branch
from
feat/docs-coverage-and-reach-kind
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
444f1f4
feat: column reach keeps how each reached column comes from the trace…
hkaltai e3f24db
feat: dbt_docs_coverage reports which output columns of a model have …
hkaltai b7cfc04
feat: foundation for the dbt Power User tools
hkaltai 1eb722e
Merge remote-tracking branch 'origin/main' into feat/pu-mods-foundation
hkaltai 99c3bf6
Merge branch 'feat/pu-mods-foundation' into feat/docs-coverage-and-re…
hkaltai 69b26cd
fix: column reach rates a column read through a schema-qualified rela…
hkaltai 21d0494
fix: harden the dbt Power User tool foundation
hkaltai 978c8ce
style: format column reach and the impact analysis test
hkaltai 2a415fe
fix: docs coverage keeps quoted names that differ by case apart, repo…
hkaltai 36eca67
Merge branch 'feat/pu-mods-foundation' into feat/docs-coverage-and-re…
hkaltai c8e59ae
Merge remote-tracking branch 'origin/main' into feat/docs-coverage-an…
hkaltai a05cec9
test: the placeholder check leaves out dbt_docs_coverage, which is im…
hkaltai 0acf970
fix: dbt_docs_coverage failures carry an error so the CLI and MCP rep…
hkaltai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 101 additions & 0 deletions
101
packages/opencode/src/altimate/tools/dbt-adapter-access.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| import fs from "fs" | ||
| import path from "path" | ||
| import type { Tool } from "../../tool/tool" | ||
| import { projectRoot } from "../native/connections/registry" | ||
|
|
||
| /** Why a tool may not use the dbt adapter. */ | ||
| export type DbtAdapterRefusal = "read_only" | "other_project" | "no_project" | "not_started" | "not_loaded" | ||
|
|
||
| /** The project's dbt adapter, or why this call may not use it (`reason` is a sentence for the user). */ | ||
| export type DbtAdapterAccess = | ||
| | { adapter: any; refusal?: undefined; reason?: undefined } | ||
| | { adapter?: undefined; refusal: DbtAdapterRefusal; reason: string } | ||
|
|
||
| /** Test seams. */ | ||
| export const dbtAdapterAccessInternals = { | ||
| /** How long a call waits for the dbt adapter to start before it gives up; the start goes on for the next call. */ | ||
| adapterStartTimeoutMs: 120_000, | ||
| } | ||
|
|
||
| /** | ||
| * The dbt adapter for a tool call, which every adapter-backed tool goes through. Starting the adapter | ||
| * runs dbt deps and writes target/, and compiling renders Jinja, which can run SQL: a read-only call | ||
| * (no write permission, or plan mode) never starts or uses it. Nor does a session in a dbt project the | ||
| * adapter isn't set up for. The wait for the adapter to start is bounded and follows the call's abort. | ||
| */ | ||
| export async function dbtAdapterFor(ctx: Pick<Tool.Context, "abort" | "agent" | "extra">): Promise<DbtAdapterAccess> { | ||
|
hkaltai marked this conversation as resolved.
Resolved
|
||
| const signal = ctx.abort | ||
| if (ctx.extra?.forceReadOnly === true || ctx.agent === "plan") | ||
| return { | ||
| refusal: "read_only", | ||
| reason: "this needs the dbt adapter, which a read-only call doesn't start: re-run with --allow-write", | ||
|
hkaltai marked this conversation as resolved.
Resolved
|
||
| } | ||
| try { | ||
| const { getDbtAdapter, getDbtProjectRoot } = await import("../native/connections/register") | ||
| // The import yields: a call cancelled meanwhile starts nothing. | ||
| signal.throwIfAborted() | ||
| const project = await sessionProject() | ||
| signal.throwIfAborted() | ||
| if (project?.other) { | ||
| return { | ||
| refusal: "other_project", | ||
| reason: project.root | ||
| ? `the dbt adapter is set up for ${project.root}, not ${project.other}` | ||
| : `the dbt adapter isn't set up for ${project.other}`, | ||
| } | ||
| } | ||
| let stop = () => {} | ||
| let timer: ReturnType<typeof setTimeout> | undefined | ||
| const waited = new Promise<never>((_, reject) => { | ||
| stop = () => reject(signal.reason) | ||
| signal.addEventListener("abort", stop, { once: true }) | ||
| const seconds = dbtAdapterAccessInternals.adapterStartTimeoutMs / 1000 | ||
| timer = setTimeout( | ||
| () => reject(new Error(`the dbt adapter didn't start within ${seconds} s`)), | ||
| dbtAdapterAccessInternals.adapterStartTimeoutMs, | ||
| ) | ||
| }) | ||
| const adapter = await Promise.race([getDbtAdapter(), waited]).finally(() => { | ||
| signal.removeEventListener("abort", stop) | ||
| clearTimeout(timer) | ||
| }) | ||
| if (!adapter) { | ||
| // No adapter also when the project exists but the adapter failed to start: say which. | ||
| const root = await getDbtProjectRoot() | ||
| const found = !!root && fs.existsSync(path.join(root, "dbt_project.yml")) | ||
| return found | ||
| ? { refusal: "not_started", reason: "the dbt adapter didn't start" } | ||
| : { refusal: "no_project", reason: "no dbt project here" } | ||
| } | ||
| if (adapter.isInitialized?.() === false) | ||
| return { refusal: "not_loaded", reason: "the dbt adapter didn't load the project" } | ||
| return { adapter } | ||
| } catch (e) { | ||
| if (signal.aborted) throw e | ||
| return { refusal: "not_started", reason: e instanceof Error ? e.message : String(e) } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The adapter's project root and, when the session's directory is in another dbt project, that one | ||
| * (`other`, both links resolved). Undefined when the session's directory is in no dbt project: the | ||
| * adapter's own discovery (a dbt.json, or a walk up from the working directory) decides then. | ||
| */ | ||
| async function sessionProject(): Promise<{ root?: string; other?: string } | undefined> { | ||
| const { findProjectRoot } = await import("../../../../dbt-tools/src/config") | ||
| const found = findProjectRoot(projectRoot()) | ||
| if (!found) return undefined | ||
| const { getDbtProjectRoot } = await import("../native/connections/register") | ||
| const root = await getDbtProjectRoot() | ||
| const real = (p: string) => { | ||
| try { | ||
| return fs.realpathSync(p) | ||
| } catch { | ||
| return path.resolve(p) | ||
| } | ||
| } | ||
| const here = real(found) | ||
| // path.relative ignores case on win32. | ||
| if (!root) return { other: here } | ||
| return path.relative(real(root), here) ? { root: real(root), other: here } : { root } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import z from "zod" | ||
| import { Tool } from "../../tool/tool" | ||
|
|
||
| export const DbtCostEstimateTool = Tool.define("dbt_cost_estimate", { | ||
| description: "Estimate the bytes a dbt model or a SQL query would scan, from a warehouse dry run (BigQuery).", | ||
| parameters: z.object({ | ||
| model: z.string().optional().describe("Model name to compile and estimate"), | ||
| sql: z.string().optional().describe("SQL (may use Jinja) to compile and estimate"), | ||
| }), | ||
| async execute() { | ||
| return { | ||
| title: "dbt_cost_estimate: not implemented", | ||
| metadata: { success: false, error: "not implemented" }, | ||
| output: "dbt_cost_estimate is not implemented in this build of altimate-code yet.", | ||
| } | ||
| }, | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import z from "zod" | ||
| import { Tool } from "../../tool/tool" | ||
|
|
||
| export const DbtCteProfileTool = Tool.define("dbt_cte_profile", { | ||
| description: "List a dbt model's CTEs, or time one CTE with a row-count query.", | ||
| parameters: z.object({ | ||
| model: z.string().describe("Model name"), | ||
| cte: z.string().optional().describe("CTE to time; without it, the CTE list is returned"), | ||
| }), | ||
| async execute() { | ||
| return { | ||
| title: "dbt_cte_profile: not implemented", | ||
| metadata: { success: false, error: "not implemented" }, | ||
| output: "dbt_cte_profile is not implemented in this build of altimate-code yet.", | ||
| } | ||
| }, | ||
| }) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.