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
21 changes: 21 additions & 0 deletions packages/opencode/src/altimate/api/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,27 @@ 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> {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[🔵 LOW] Please avoid using the any type. If its use is necessary, please add a comment explaining the reason. Consider using a generic type parameter or unknown instead to improve type safety.

Suggested change:

Suggested change
export async function apiRequest(method: string, endpoint: string, body?: unknown): Promise<any> {
export async function apiRequest<T = unknown>(method: string, endpoint: string, body?: unknown): Promise<T> {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apiRequest returns whatever JSON the endpoint sends, and callers in other files give it their own result type. I added a comment saying so rather than changing the signature, so the existing callers (which rely on the untyped result) keep compiling. Comment is in efc72f6.

// The body is whatever JSON the endpoint returns; each endpoint function in other files types its own result.
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)
}

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,
finops_analyze_credits: FinopsAnalyzeCreditsTool,
finops_expensive_queries: FinopsExpensiveQueriesTool,
finops_query_history: FinopsQueryHistoryTool,
Expand Down
102 changes: 102 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,102 @@
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 =
// The adapter is the untyped dbt integration object from the dbt-integration package.
| { adapter: any; refusal?: undefined; reason?: undefined }
| { adapter?: undefined; refusal: DbtAdapterRefusal; reason: string }
Comment on lines +10 to +13

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[🔵 LOW] The adapter property is explicitly typed as any without an explanatory comment. According to the TypeScript typing guidelines, you should avoid using any, or if it is necessary (e.g., the underlying adapter type is not strongly typed), provide a comment explaining the reason.

Suggested change:

Suggested change
export type DbtAdapterAccess =
| { adapter: any; refusal?: undefined; reason?: undefined }
| { adapter?: undefined; refusal: DbtAdapterRefusal; reason: string }
export type DbtAdapterAccess =
| {
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- adapter type is not strictly defined yet
adapter: any; refusal?: undefined; reason?: undefined
}
| { adapter?: undefined; refusal: DbtAdapterRefusal; reason: string }

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a comment on the any explaining that the adapter is the untyped dbt integration object (in efc72f6).


/** 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
Comment thread
hkaltai marked this conversation as resolved.
Resolved
* 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.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",
}
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"),
}),
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.",
}
},
})
Loading
Loading