Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions packages/opencode/src/altimate/api/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,13 @@ export namespace AltimateApi {
return data.auth_token
}

async function request(creds: AltimateCredentials, method: string, endpoint: string, body?: unknown) {
async function request(
creds: AltimateCredentials,
method: string,
endpoint: string,
body?: unknown,
signal?: AbortSignal,
) {
const url = `${creds.altimateUrl}${endpoint}`
// altimate_change start — upstream_fix: bound every API request. Without a
// signal a stalled server holds the caller indefinitely. The abort stays
Expand All @@ -327,15 +333,16 @@ export namespace AltimateApi {
const timeout = setTimeout(() => controller.abort(), 15_000)
try {
const res = await fetch(url, {
signal: controller.signal,
signal: signal ? AbortSignal.any([controller.signal, signal]) : controller.signal,
method,
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${creds.altimateApiKey}`,
"x-tenant": creds.altimateInstanceName,
...clientHeaders(),
},
...(body ? { body: JSON.stringify(body) } : {}),
// Any body but undefined is sent: null, false, 0 and "" are JSON values too.
...(body !== undefined ? { body: JSON.stringify(body) } : {}),
})
if (!res.ok) {
throw new Error(`API ${method} ${endpoint} failed with status ${res.status}`)
Expand All @@ -347,6 +354,32 @@ 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. `signal` (a tool
* call's `ctx.abort`) cancels the request as well as the 15 s timeout.
*/
export async function apiRequest(
method: string,
endpoint: string,
body?: unknown,
signal?: AbortSignal,
): Promise<any> {
let creds: AltimateCredentials
try {
creds = await getCredentials()
} catch (e) {
const p = credentialsPath()
if (!(await Filesystem.exists(p)))
Comment thread
hkaltai marked this conversation as resolved.
Resolved
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, signal)
}

export async function listDatamates(creds?: AltimateCredentials) {
creds ??= await getCredentials()
const data = await request(creds, "GET", "/datamates/")
Expand Down
18 changes: 18 additions & 0 deletions packages/opencode/src/altimate/tool-cli/allow-list.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,19 @@ import { AltimateCoreTestgenTool } from "../tools/altimate-core-testgen"
import { AltimateCoreTrackLineageTool } from "../tools/altimate-core-track-lineage"
import { AltimateCoreValidateTool } from "../tools/altimate-core-validate"
import { DataDiffTool } from "../tools/data-diff"
import { DbtCostEstimateTool } from "../tools/dbt-cost-estimate"
import { DbtCteProfileTool } from "../tools/dbt-cte-profile"
import { DbtDeferStateTool } from "../tools/dbt-defer-state"
import { DbtDocsCoverageTool } from "../tools/dbt-docs-coverage"
import { DbtHealthTool } from "../tools/dbt-health"
import { DbtLineageTool } from "../tools/dbt-lineage"
import { DbtManifestTool } from "../tools/dbt-manifest"
import { DbtMapRelationsTool } from "../tools/dbt-map-relations"
import { DbtProfilesTool } from "../tools/dbt-profiles"
import { DbtRunResultsTool } from "../tools/dbt-run-results"
import { DbtSqlGraphTool } from "../tools/dbt-sql-graph"
import { DbtUnitTestGenTool } from "../tools/dbt-unit-test-gen"
import { DocsShareCommentsTool } from "../tools/docs-share-comments"
import { FinopsAnalyzeCreditsTool } from "../tools/finops-analyze-credits"
import { FinopsExpensiveQueriesTool } from "../tools/finops-expensive-queries"
import { FinopsQueryHistoryTool } from "../tools/finops-query-history"
Expand Down Expand Up @@ -106,10 +115,19 @@ export const EXPOSED: Record<string, Source> = {
altimate_core_track_lineage: AltimateCoreTrackLineageTool,
altimate_core_validate: AltimateCoreValidateTool,
data_diff: DataDiffTool,
dbt_cost_estimate: DbtCostEstimateTool,
dbt_cte_profile: DbtCteProfileTool,
dbt_defer_state: DbtDeferStateTool,
dbt_docs_coverage: DbtDocsCoverageTool,
dbt_health: DbtHealthTool,
dbt_lineage: DbtLineageTool,
dbt_manifest: DbtManifestTool,
dbt_map_relations: DbtMapRelationsTool,
dbt_profiles: DbtProfilesTool,
dbt_run_results: DbtRunResultsTool,
dbt_sql_graph: DbtSqlGraphTool,
dbt_unit_test_gen: DbtUnitTestGenTool,
docs_share_comments: DocsShareCommentsTool,
Comment thread
hkaltai marked this conversation as resolved.
Resolved
finops_analyze_credits: FinopsAnalyzeCreditsTool,
finops_expensive_queries: FinopsExpensiveQueriesTool,
finops_query_history: FinopsQueryHistoryTool,
Expand Down
103 changes: 103 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-adapter-access.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
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> {
Comment thread
hkaltai marked this conversation as resolved.
Resolved
const signal = ctx.abort
// A cancelled call answers nothing, refused or not.
signal.throwIfAborted()
if (ctx.extra?.forceReadOnly === true || ctx.agent === "plan")
Comment thread
hkaltai marked this conversation as resolved.
Resolved
return {
refusal: "read_only",
reason: "this needs the dbt adapter, which a read-only call doesn't start: re-run with --allow-write",
}
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> {
Comment thread
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 }
}
17 changes: 17 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-cost-estimate.ts
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"),
}),
Comment thread
hkaltai marked this conversation as resolved.
Resolved
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.",
}
},
})
17 changes: 17 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-cte-profile.ts
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.",
}
},
})
16 changes: 16 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-defer-state.ts
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.",
}
},
})
21 changes: 21 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-docs-coverage.ts
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.",
}
},
})
16 changes: 16 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-health.ts
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 DbtHealthTool = Tool.define("dbt_health", {
description: "DataPilot project health insights for the dbt project.",
parameters: z.object({
config_path: z.string().optional().describe("DataPilot config file to use"),
}),
async execute() {
return {
title: "dbt_health: not implemented",
metadata: { success: false, error: "not implemented" },
output: "dbt_health is not implemented in this build of altimate-code yet.",
}
},
})
21 changes: 21 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-map-relations.ts
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 DbtMapRelationsTool = Tool.define("dbt_map_relations", {
description: "Map each table a raw SQL query reads to the dbt ref() or source() for it, from the manifest.",
parameters: z.object({
sql: z.string().describe("Raw SQL to map"),
dialect: z.string().optional().describe("SQL dialect of the query"),
manifest_path: z
.string()
.optional()
.describe("manifest.json to match against (default: the dbt project's target/manifest.json)"),
}),
async execute() {
return {
title: "dbt_map_relations: not implemented",
metadata: { success: false, error: "not implemented" },
output: "dbt_map_relations is not implemented in this build of altimate-code yet.",
}
},
})
19 changes: 19 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-run-results.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import z from "zod"
import { Tool } from "../../tool/tool"

export const DbtRunResultsTool = Tool.define("dbt_run_results", {
description: "The latest dbt run's results from target/run_results.json: command, duration and each node's status.",
parameters: z.object({
project_dir: z
.string()
.optional()
.describe("dbt project folder (default: the dbt project found from the working directory)"),
}),
async execute() {
return {
title: "dbt_run_results: not implemented",
metadata: { success: false, error: "not implemented" },
output: "dbt_run_results is not implemented in this build of altimate-code yet.",
}
},
})
16 changes: 16 additions & 0 deletions packages/opencode/src/altimate/tools/dbt-sql-graph.ts
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 DbtSqlGraphTool = Tool.define("dbt_sql_graph", {
description: "A dbt model's SQL as a graph: its CTEs, joins and filters, and the edges between them.",
parameters: z.object({
model: z.string().describe("Model name"),
}),
async execute() {
return {
title: "dbt_sql_graph: not implemented",
metadata: { success: false, error: "not implemented" },
output: "dbt_sql_graph is not implemented in this build of altimate-code yet.",
}
},
})
20 changes: 20 additions & 0 deletions packages/opencode/src/altimate/tools/docs-share-comments.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import z from "zod"
import { Tool } from "../../tool/tool"

export const DocsShareCommentsTool = Tool.define("docs_share_comments", {
description: "Comment threads on shared dbt docs: list open threads, reply to one, or resolve one.",
parameters: z.object({
action: z.enum(["list", "reply", "resolve"]).describe("What to do"),
project: z.string().optional().describe("dbt project name the shared docs belong to"),
share_id: z.number().int().optional().describe("Shared docs id"),
group_id: z.number().int().optional().describe("Comment thread id"),
text: z.string().optional().describe("Reply text"),
Comment thread
hkaltai marked this conversation as resolved.
Resolved
}),
async execute() {
return {
title: "docs_share_comments: not implemented",
metadata: { success: false, error: "not implemented" },
output: "docs_share_comments is not implemented in this build of altimate-code yet.",
}
},
})
Loading
Loading