use anyhow::{Context as _, bail};
use gobby_core::search::BM25_SCORE_REGPROCEDURE;
use postgres::Client;
use crate::setup::DEFAULT_SCHEMA;
const REQUIRED_TABLES: &[&str] = &[
"code_indexed_projects",
"code_indexed_files",
"code_symbols",
"code_content_chunks",
"code_imports",
"code_calls",
];
const REQUIRED_BM25_INDEXES: &[&str] = &["code_symbols_search_bm25", "code_content_search_bm25"];
const MIGRATION_HINT: &str = "Configure the Gobby PostgreSQL hub with the required code-index schema, `pg_search` extension, and BM25 indexes. For standalone databases, run `gcode setup --standalone --database-url <dsn>`.";
pub fn validate_runtime_schema(client: &mut Client) -> anyhow::Result<()> {
if !extension_exists(client, "pg_search")? {
bail!("PostgreSQL hub is missing required extension `pg_search`. {MIGRATION_HINT}");
}
if !procedure_exists(client, BM25_SCORE_REGPROCEDURE)? {
bail!(
"PostgreSQL hub is missing required BM25 score function `{BM25_SCORE_REGPROCEDURE}`. {MIGRATION_HINT}"
);
}
let missing_tables = missing_relations(client, REQUIRED_TABLES)?;
if !missing_tables.is_empty() {
bail!(
"PostgreSQL hub is missing required code-index tables: {}. {MIGRATION_HINT}",
missing_tables.join(", ")
);
}
let missing_indexes = missing_relations(client, REQUIRED_BM25_INDEXES)?;
if !missing_indexes.is_empty() {
bail!(
"PostgreSQL hub is missing required pg_search BM25 indexes: {}. {MIGRATION_HINT}",
missing_indexes.join(", ")
);
}
Ok(())
}
fn extension_exists(client: &mut Client, extension: &str) -> anyhow::Result<bool> {
client
.query_one(
"SELECT EXISTS(SELECT 1 FROM pg_extension WHERE extname = $1)",
&[&extension],
)
.with_context(|| format!("failed to check PostgreSQL extension `{extension}`"))?
.try_get(0)
.context("failed to decode PostgreSQL extension check")
}
fn procedure_exists(client: &mut Client, procedure: &str) -> anyhow::Result<bool> {
client
.query_one("SELECT to_regprocedure($1) IS NOT NULL", &[&procedure])
.with_context(|| format!("failed to check PostgreSQL procedure `{procedure}`"))?
.try_get(0)
.context("failed to decode PostgreSQL procedure check")
}
fn missing_relations(client: &mut Client, relations: &[&str]) -> anyhow::Result<Vec<String>> {
let mut missing = Vec::new();
for relation in relations {
let qualified = format!("{DEFAULT_SCHEMA}.{relation}");
let row = client
.query_one("SELECT to_regclass($1) IS NOT NULL", &[&qualified])
.with_context(|| format!("failed to check PostgreSQL relation `{qualified}`"))?;
let exists: bool = row
.try_get(0)
.context("failed to decode PostgreSQL relation check")?;
if !exists {
missing.push((*relation).to_string());
}
}
Ok(missing)
}
#[cfg(test)]
fn required_relation_regclass_name(relation: &str) -> String {
format!("{DEFAULT_SCHEMA}.{relation}")
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn required_schema_contract_names_code_index_tables_and_bm25_indexes() {
assert!(REQUIRED_TABLES.contains(&"code_symbols"));
assert!(REQUIRED_TABLES.contains(&"code_content_chunks"));
assert!(REQUIRED_BM25_INDEXES.contains(&"code_symbols_search_bm25"));
assert!(REQUIRED_BM25_INDEXES.contains(&"code_content_search_bm25"));
assert_eq!(BM25_SCORE_REGPROCEDURE, "pdb.score(anyelement)");
}
mod serial_db {
use super::*;
#[test]
#[cfg_attr(
not(gcode_postgres_tests),
ignore = "requires a PostgreSQL test database URL"
)]
#[serial_test::serial(serial_db)]
fn validates_runtime_schema_when_postgres_test_dsn_is_set() {
let database_url = crate::test_env::postgres_test_database_url("schema tests");
let mut client = gobby_core::postgres::connect_readwrite(&database_url)
.expect("connect test PostgreSQL hub");
assert!(validate_runtime_schema(&mut client).is_ok());
}
}
#[test]
fn missing_schema_requires_setup() {
assert!(
MIGRATION_HINT.contains("gcode setup --standalone"),
"missing runtime schema guidance must point standalone users at explicit setup"
);
}
#[test]
fn relation_validation_qualifies_public_schema() {
assert_eq!(
required_relation_regclass_name("code_symbols"),
"public.code_symbols"
);
}
}