dre-core 0.4.4

DRE core engine: project parsing, validation and the run path
Documentation
//! A single read-only query on a configured connection, for external integrations.

use dre_protocol::host::{Execution, LogSink};
use serde_json::{Value, json};
use sqlparser::ast::{
    Expr, ObjectName, Query, SetExpr, Statement, TableFactor, Visit, Visitor, visit_statements,
};
use sqlparser::dialect::{DatabricksDialect, DuckDbDialect, GenericDialect, PostgreSqlDialect};
use sqlparser::parser::Parser;
use std::sync::Arc;

use crate::profiles::{Entry, Role};
use crate::project::{PluginKind, Project};

pub fn execute(project: &Project, profile: &str, sql: &str, max_rows: u64) -> Result<Value, String> {
    if max_rows == 0 || max_rows > 100_000 {
        return Err("max_rows must be between 1 and 100000".into());
    }
    let target = match project.profiles.entry(Role::Connection, profile) {
        Entry::Use(target) => target,
        _ => return Err(format!("connection `{profile}` has no entry for this target")),
    };
    let dialect: Box<dyn sqlparser::dialect::Dialect> = match target.kind.as_str() {
        "duckdb" => Box::new(DuckDbDialect {}),
        "postgres" => Box::new(PostgreSqlDialect {}),
        "databricks" => Box::new(DatabricksDialect {}),
        _ => Box::new(GenericDialect {}),
    };
    let statements = Parser::parse_sql(dialect.as_ref(), sql)
        .map_err(|e| format!("expected a single read-only query: {e}"))?;
    let mut safe = statements.len() == 1;
    let _ = visit_statements(&statements, |statement| {
        if !matches!(statement, Statement::Query(_)) {
            safe = false;
        }
        std::ops::ControlFlow::<()>::Continue(())
    });
    /// Refuses anything but reads, and functions that reach files, programs or the network.
    struct ReadOnly {
        dialect: Option<&'static crate::dialect::Dialect>,
        refused: Option<String>,
    }
    impl ReadOnly {
        fn function(&mut self, name: &ObjectName) -> std::ops::ControlFlow<()> {
            let name = name.to_string();
            if self.dialect.is_some_and(|d| d.denies(&name)) {
                self.refused = Some(name);
                return std::ops::ControlFlow::Break(());
            }
            std::ops::ControlFlow::Continue(())
        }
    }
    impl Visitor for ReadOnly {
        type Break = ();
        fn pre_visit_query(&mut self, query: &Query) -> std::ops::ControlFlow<()> {
            fn reads(body: &SetExpr) -> bool {
                match body {
                    SetExpr::Select(select) => select.into.is_none(),
                    SetExpr::SetOperation { left, right, .. } => reads(left) && reads(right),
                    SetExpr::Query(query) => reads(&query.body),
                    SetExpr::Values(_) | SetExpr::Table(_) => true,
                    _ => false,
                }
            }
            if !reads(&query.body) || !query.locks.is_empty() || !query.pipe_operators.is_empty() {
                std::ops::ControlFlow::Break(())
            } else {
                std::ops::ControlFlow::Continue(())
            }
        }
        fn pre_visit_table_factor(&mut self, factor: &TableFactor) -> std::ops::ControlFlow<()> {
            match factor {
                // `FROM 'file.csv'`: a path, not a table.
                TableFactor::Table { name, .. }
                    if name
                        .0
                        .iter()
                        .any(|p| p.as_ident().is_some_and(|i| i.quote_style == Some('\''))) =>
                {
                    self.refused = Some(name.to_string());
                    std::ops::ControlFlow::Break(())
                }
                // A table function, not a table that happens to share a function's name.
                TableFactor::Table {
                    name, args: Some(_), ..
                }
                | TableFactor::Function { name, .. } => self.function(name),
                _ => std::ops::ControlFlow::Continue(()),
            }
        }
        fn pre_visit_expr(&mut self, expr: &Expr) -> std::ops::ControlFlow<()> {
            match expr {
                Expr::Function(f) => self.function(&f.name),
                _ => std::ops::ControlFlow::Continue(()),
            }
        }
    }
    let mut guard = ReadOnly {
        dialect: crate::dialect::of(&target.kind),
        refused: None,
    };
    safe &= statements.visit(&mut guard).is_continue();
    if let Some(name) = guard.refused {
        return Err(format!(
            "`{name}` reads files, runs programs or reaches the network; `dre query` refuses it and nothing was run"
        ));
    }
    if !safe {
        return Err("expected a single read-only query; nothing was run".into());
    }
    let plugin =
        crate::run::find_plugin(project, PluginKind::Source, &target.kind).map_err(|e| e.to_string())?;
    let log: LogSink =
        Arc::new(|name, message| eprintln!("{name}: {}", crate::secrets::mask_source_error(message, false)));
    let mut process = plugin
        .start(log, Some(&project.root))
        .map_err(|e| e.to_string())?;
    let session_read_only = process.has(dre_protocol::CAP_READ_ONLY);
    // Databricks has no read-only session capability. Its single-SELECT guard is
    // enforced here; database permissions remain the user's enforcement boundary.
    if !session_read_only && target.kind != "databricks" {
        return Err(format!(
            "the {} plugin cannot guarantee a read-only connection",
            target.kind
        ));
    }
    let connection = crate::run::render_connection(target)?;
    if session_read_only {
        process.open_sandboxed(connection)
    } else {
        process.open(connection, false)
    }
    .map_err(|e| crate::secrets::mask_source_error(&e.to_string(), false).into_owned())?;
    let mut rows = Vec::new();
    let mut columns = Vec::new();
    let result = process
        .execute(sql, Some(max_rows + 1), |schema, batch| {
            if columns.is_empty() {
                columns = crate::rows::column_types(schema);
            }
            let left = (max_rows + 1).saturating_sub(rows.len() as u64) as usize;
            let batch = batch.slice(0, left.min(batch.num_rows()));
            rows.extend(
                crate::values::batch_rows(&batch)
                    .into_iter()
                    .map(|row| serde_json::to_value(row).unwrap()),
            );
            Ok(())
        })
        .map_err(|e| crate::secrets::mask_source_error(&e.to_string(), false).into_owned())?;
    if let Execution::Result { schema, .. } = result {
        if columns.is_empty() {
            columns = crate::rows::column_types(&schema);
        }
    } else {
        return Err("the query returned no result set".into());
    }
    let truncated = rows.len() as u64 > max_rows;
    rows.truncate(max_rows as usize);
    let _ = process.close();
    Ok(
        json!({"schema_version": "dre/rows/v1", "columns": columns, "row_count": rows.len(), "rows": rows,
        "truncated": truncated, "read_only_enforcement": if session_read_only {"session"} else {"SQL validation; use a read-only Databricks database role"}, "connection": profile, "target": project.target_name}),
    )
}