Repository navigation
feat: dbt_health tool: DataPilot project health insights per model #1738
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
base: main
Are you sure you want to change the base?
Changes from all commits
b7cfc04
1eb722e
21d0494
b74f721
44f5c70
b25de87
1da3856
fc1d5dd
e650861
2925305
1254988
9a11b7e
0a6beb1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -347,6 +347,26 @@ export namespace AltimateApi { | |
| // altimate_change end | ||
| } | ||
|
|
||
| /** | ||
| * Calls an Altimate API endpoint with the stored credentials (Bearer key and x-tenant headers) and | ||
| * returns the parsed JSON body. Endpoint functions in other files go through this. Fails with a | ||
| * message naming the credentials file when none are stored or they can't be read. | ||
| */ | ||
| export async function apiRequest(method: string, endpoint: string, body?: unknown): Promise<any> { | ||
| let creds: AltimateCredentials | ||
| try { | ||
| creds = await getCredentials() | ||
| } catch (e) { | ||
| const p = credentialsPath() | ||
| if (!(await Filesystem.exists(p))) | ||
| throw new Error( | ||
| `No Altimate credentials are stored: sign in to Altimate in altimate-code first (they are saved to ${p}).`, | ||
| ) | ||
| throw new Error(`The Altimate credentials in ${p} can't be used: ${e instanceof Error ? e.message : String(e)}`) | ||
| } | ||
| return request(creds, method, endpoint, body) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Preserve explicitly supplied JSON bodies. If a caller supplies Change the helper's condition to
|
||
| } | ||
|
|
||
| export async function listDatamates(creds?: AltimateCredentials) { | ||
| creds ??= await getCredentials() | ||
| const data = await request(creds, "GET", "/datamates/") | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,106 @@ | ||||||||||||||||||||||||||||||||||||||||||||||
| 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 } | ||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+11
to
+12
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [🔵 LOW] Using the Suggested change:
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Declined: the adapter comes from |
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| /** 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, the gate `dbt_health` goes through (other adapter-backed tools call the adapter directly). 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> { | ||||||||||||||||||||||||||||||||||||||||||||||
| const signal = ctx.abort | ||||||||||||||||||||||||||||||||||||||||||||||
| if (ctx.agent === "plan" && ctx.extra?.forceReadOnly !== true) | ||||||||||||||||||||||||||||||||||||||||||||||
| return { | ||||||||||||||||||||||||||||||||||||||||||||||
| refusal: "read_only", | ||||||||||||||||||||||||||||||||||||||||||||||
| reason: "this needs the dbt adapter, which plan mode doesn't start: switch to the build agent", | ||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||
| if (ctx.extra?.forceReadOnly === true) | ||||||||||||||||||||||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+69
to
+71
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [🟠 MEDIUM] In an asynchronous function, synchronous file system operations (like Suggested change:
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Declined: this |
||||||||||||||||||||||||||||||||||||||||||||||
| ? { 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> { | ||||||||||||||||||||||||||||||||||||||||||||||
|
hkaltai marked this conversation as resolved.
Resolved
hkaltai marked this conversation as resolved.
Resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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 } | ||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+95
to
+105
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [🟠 MEDIUM] In an asynchronous function, synchronous file system operations like Suggested change:
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Declined: |
||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||
| 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.", | ||
| } | ||
| }, | ||
| }) |
| 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.", | ||
| } | ||
| }, | ||
| }) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import z from "zod" | ||
| import { Tool } from "../../tool/tool" | ||
|
|
||
| export const DbtDeferStateTool = Tool.define("dbt_defer_state", { | ||
| description: "dbt Power User's defer-to-production setting for a dbt project, and the profile's default target.", | ||
| parameters: z.object({ | ||
| project_dir: z.string().describe("dbt project folder"), | ||
| }), | ||
| async execute() { | ||
| return { | ||
| title: "dbt_defer_state: not implemented", | ||
| metadata: { success: false, error: "not implemented" }, | ||
| output: "dbt_defer_state is not implemented in this build of altimate-code yet.", | ||
| } | ||
| }, | ||
| }) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import z from "zod" | ||
| import { Tool } from "../../tool/tool" | ||
|
|
||
| export const DbtDocsCoverageTool = Tool.define("dbt_docs_coverage", { | ||
| description: | ||
| "Documentation coverage of a dbt model: which output columns have a description, and whether the model has one.", | ||
| parameters: z.object({ | ||
| model: z.string().describe("Model name"), | ||
| manifest_path: z | ||
| .string() | ||
| .optional() | ||
| .describe("manifest.json to read (default: the dbt project's target/manifest.json)"), | ||
| }), | ||
| async execute() { | ||
| return { | ||
| title: "dbt_docs_coverage: not implemented", | ||
| metadata: { success: false, error: "not implemented" }, | ||
| output: "dbt_docs_coverage is not implemented in this build of altimate-code yet.", | ||
| } | ||
| }, | ||
| }) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[🔵 LOW] According to the TypeScript Types review checklist, avoid using the
anytype. Consider returningPromise<unknown>or using a generic parameter likePromise<T = unknown>to ensure better type safety, as it requires callers to cast or check the type before use.Suggested change:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Declined:
apiRequestis on main and is used by endpoint functions in other files, which read the body asany. Returningunknown(or a defaulted generic) would force a cast in each of those callers, which is outside what this PR changes.dbt_healthdoesn't call it. I'd do the typing as a separate change over all its callers.