Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

14.4 KB
Raw Blame
use std::collections::HashSet;
use std::env;
use std::io::{BufRead, BufReader, Write};
use std::process::{Child, ChildStdin, ChildStdout, Command, Stdio};
use std::time::{Duration, Instant};

use serde_json::{json, Value};

struct AgentProcess {
    child: Child,
    stdin: ChildStdin,
    stdout: BufReader<ChildStdout>,
    next_id: u64,
}

impl AgentProcess {
    fn spawn() -> Self {
        let mut child = Command::new(env!("CARGO_BIN_EXE_dbx-tdengine-driver"))
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::inherit())
            .spawn()
            .expect("start TDengine agent");
        let stdin = child.stdin.take().expect("agent stdin");
        let mut stdout = BufReader::new(child.stdout.take().expect("agent stdout"));
        let mut ready = String::new();
        stdout.read_line(&mut ready).expect("read ready line");
        assert_eq!(serde_json::from_str::<Value>(&ready).unwrap(), json!({"ready": true}));
        Self { child, stdin, stdout, next_id: 1 }
    }

    fn call(&mut self, method: &str, params: Value) -> Value {
        let id = self.next_id;
        self.next_id += 1;
        let request = json!({"jsonrpc": "2.0", "id": id, "method": method, "params": params});
        writeln!(self.stdin, "{request}").expect("write request");
        self.stdin.flush().expect("flush request");
        let mut line = String::new();
        self.stdout.read_line(&mut line).expect("read response");
        let response: Value = serde_json::from_str(&line).expect("valid JSON response");
        assert_eq!(response["id"], id, "unexpected response: {response}");
        if let Some(error) = response.get("error") {
            panic!("{method} failed: {error}");
        }
        response["result"].clone()
    }

    fn shutdown(mut self) {
        assert_eq!(self.call("shutdown", json!({})), json!({"ok": true}));
        drop(self.stdin);
        assert!(self.child.wait().expect("wait for agent").success());
    }
}

fn integration_params() -> Option<Value> {
    if env::var("TDENGINE_INTEGRATION").ok().as_deref() != Some("1") {
        return None;
    }
    Some(json!({
        "host": env::var("TDENGINE_TEST_HOST").unwrap_or_else(|_| "127.0.0.1".into()),
        "port": env::var("TDENGINE_TEST_PORT").ok().and_then(|value| value.parse::<u16>().ok()).unwrap_or(6041),
        "username": env::var("TDENGINE_TEST_USERNAME").unwrap_or_else(|_| "root".into()),
        "password": env::var("TDENGINE_TEST_PASSWORD").unwrap_or_else(|_| "taosdata".into()),
        "url_params": "timezone=Asia/Shanghai",
        "connect_timeout_secs": 20,
    }))
}

fn wait_for_database_ready(mut query: impl FnMut() -> Value, timeout: Duration) -> Result<(), String> {
    let started = Instant::now();
    loop {
        let result = query();
        let columns = result["columns"].as_array().expect("VGroup columns");
        // Servers before 3.3.8 do not expose the is_ready column.
        let Some(ready_column) = columns.iter().position(|column| column == "is_ready") else {
            return Ok(());
        };
        let rows = result["rows"].as_array().expect("VGroup rows");
        if !rows.is_empty() && rows.iter().all(|row| row[ready_column] == true) {
            return Ok(());
        }
        if started.elapsed() >= timeout {
            return Err(format!("VGroups did not become ready: {result}"));
        }
        std::thread::sleep(Duration::from_millis(200));
    }
}

fn create_database(agent: &mut AgentProcess, session_id: &str, database: &str) {
    agent.call(
        "execute_batch",
        json!({"agentSessionId": session_id, "statements": [format!("CREATE DATABASE IF NOT EXISTS {database}")]}),
    );
    wait_for_database_ready(
        || {
            agent.call(
                "execute_query",
                json!({
                    "agentSessionId": session_id,
                    "schema": database,
                    "sql": "SHOW VGROUPS",
                    "maxRows": 1000,
                    "timeoutSecs": 5
                }),
            )
        },
        Duration::from_secs(30),
    )
    .unwrap_or_else(|error| panic!("database {database}: {error}"));
}

#[test]
fn database_readiness_waits_for_every_vgroup() {
    let mut calls = 0;
    wait_for_database_ready(
        || {
            calls += 1;
            json!({"columns": ["vgid", "is_ready"], "rows": [[2, true], [3, calls > 1]]})
        },
        Duration::from_secs(1),
    )
    .unwrap();
    assert_eq!(calls, 2);
}

#[test]
fn database_readiness_rejects_empty_or_offline_vgroups() {
    for rows in [json!([]), json!([[2, false]])] {
        let error = wait_for_database_ready(|| json!({"columns": ["vgid", "is_ready"], "rows": rows}), Duration::ZERO)
            .unwrap_err();
        assert!(error.contains("VGroups did not become ready"), "{error}");
    }
}

#[test]
fn database_readiness_preserves_older_server_support() {
    wait_for_database_ready(|| json!({"columns": ["vgid", "v1_status"], "rows": [[2, "leader"]]}), Duration::ZERO)
        .unwrap();
}

#[test]
fn tdengine_websocket_live_compatibility() {
    let Some(connect_params) = integration_params() else {
        return;
    };
    let database = format!("dbx_rust_live_{}", std::process::id());
    let session_id = "tdengine-live";
    let mut agent = AgentProcess::spawn();

    let tested = agent.call("test_connection", connect_params.clone());
    assert_eq!(tested["ok"], true);
    assert_eq!(tested["databaseInfo"]["productName"], "TDengine");
    assert!(tested["databaseInfo"]["productVersion"].as_str().is_some_and(|version| !version.is_empty()));

    let mut open_params = connect_params.clone();
    open_params["agentSessionId"] = json!(session_id);
    assert_eq!(agent.call("open_session", open_params), json!({"ok": true}));

    create_database(&mut agent, session_id, &database);
    agent.call(
        "execute_batch",
        json!({
            "agentSessionId": session_id,
            "statements": [
                format!("CREATE STABLE IF NOT EXISTS {database}.meters (ts TIMESTAMP, current FLOAT, voltage INT, active BOOL, note NCHAR(32)) TAGS (location NCHAR(64), group_id INT)"),
                format!("CREATE TABLE IF NOT EXISTS {database}.d1001 USING {database}.meters TAGS ('California.SanFrancisco', 2)"),
                format!("INSERT INTO {database}.d1001 VALUES (1785808800001, 10.1, 220, true, 'first') (1785808800002, 10.2, 221, false, 'second') (1785808800003, 10.3, 222, true, 'third')")
            ]
        }),
    );

    let host = connect_params["host"].as_str().unwrap();
    let host = if host.contains(':') { format!("[{host}]") } else { host.to_string() };
    let port = connect_params["port"].as_u64().unwrap();
    let mut database_connect_params = connect_params.clone();
    database_connect_params["connection_string"] = json!(format!("ws://{host}:{port}/{database}"));
    database_connect_params["database"] = json!("");
    let database_connection = agent.call("test_connection", database_connect_params);
    assert_eq!(database_connection["databaseInfo"]["currentDatabase"], database);

    let databases = agent.call("list_databases", json!({"agentSessionId": session_id}));
    assert!(databases.as_array().unwrap().iter().any(|item| item["name"] == database));

    let tables = agent.call(
        "list_tables",
        json!({
            "agentSessionId": session_id,
            "schema": database,
            "filter": "",
            "limit": 100,
            "offset": 0,
            "object_types": []
        }),
    );
    let tables = tables.as_array().unwrap();
    assert!(tables.iter().any(|table| table["name"] == "meters" && table["table_type"] == "STABLE"));
    assert!(tables.iter().any(|table| table["name"] == "d1001" && table["parent_name"] == "meters"));

    let columns =
        agent.call("get_columns", json!({"agentSessionId": session_id, "schema": database, "table": "meters"}));
    let columns = columns.as_array().unwrap();
    assert!(columns.iter().any(|column| column["name"] == "ts" && column["is_primary_key"] == true));
    assert!(columns.iter().any(|column| column["name"] == "location" && column["comment"] == "TAG"));

    let query = agent.call(
        "execute_query",
        json!({
            "agentSessionId": session_id,
            "schema": database,
            "sql": "SELECT * FROM d1001 ORDER BY ts",
            "maxRows": 2,
            "fetchSize": 100,
            "timeoutSecs": 10
        }),
    );
    assert_eq!(query["rows"].as_array().unwrap().len(), 2);
    assert_eq!(query["truncated"], true);
    assert_eq!(query["rows"][0][0], "2026-08-04 10:00:00.001");
    assert_eq!(query["column_types"][1], "FLOAT");
    assert_eq!(query["rows"][0][1], 10.1);
    let connection_info = agent.call("connection_info", json!({"agentSessionId": session_id}));
    assert_eq!(connection_info["databaseInfo"]["currentDatabase"], database);

    let first_page = agent.call(
        "execute_query_page",
        json!({
            "agentSessionId": session_id,
            "schema": database,
            "sql": "SELECT * FROM d1001 ORDER BY ts",
            "maxRows": 2,
            "pageSize": 1,
            "timeoutSecs": 10
        }),
    );
    assert_eq!(first_page["has_more"], true);
    assert_eq!(first_page["truncated"], false);
    assert_eq!(first_page["rows"][0][1], 10.1);
    let query_session_id = first_page["session_id"].as_str().expect("paged query session");
    let final_page = agent.call(
        "fetch_query_page",
        json!({
            "agentSessionId": session_id,
            "sessionId": query_session_id,
            "pageSize": 1,
            "timeoutSecs": 10
        }),
    );
    assert_eq!(final_page["rows"].as_array().unwrap().len(), 1);
    assert_eq!(final_page["rows"][0][1], 10.2);
    assert_eq!(final_page["has_more"], false);
    assert_eq!(final_page["truncated"], true);

    let exact_limit = agent.call(
        "execute_query",
        json!({
            "agentSessionId": session_id,
            "schema": database,
            "sql": "SELECT * FROM d1001 WHERE voltage <= 221 ORDER BY ts",
            "maxRows": 2,
            "timeoutSecs": 10
        }),
    );
    assert_eq!(exact_limit["rows"].as_array().unwrap().len(), 2);
    assert_eq!(exact_limit["truncated"], false);

    let completion = agent.call(
        "completion_assistant_search_v1",
        json!({
            "agentSessionId": session_id,
            "schema": database,
            "object_kinds": ["table"],
            "mask": "met",
            "match_mode": "prefix",
            "max_results": 10
        }),
    );
    assert!(completion["candidates"].as_array().unwrap().iter().any(|candidate| candidate["name"] == "meters"));

    let ddl = agent.call("get_table_ddl", json!({"agentSessionId": session_id, "schema": database, "table": "meters"}));
    assert!(ddl.as_str().unwrap().to_ascii_uppercase().contains("CREATE"));

    let source = agent.call(
        "get_object_source",
        json!({
            "agentSessionId": session_id,
            "schema": database,
            "name": "meters",
            "object_type": "STABLE"
        }),
    );
    assert!(source["source"].as_str().unwrap().to_ascii_uppercase().contains("CREATE"));

    agent.call(
        "execute_batch",
        json!({"agentSessionId": session_id, "statements": [format!("DROP DATABASE IF EXISTS {database}")]}),
    );
    agent.shutdown();
}

/// `SHOW <db>.TABLES` has no `ORDER BY`, so TDengine may answer two identical
/// statements with different row orders. A table list must still be identical
/// whichever page size the caller asks for: paging used to skip and repeat rows,
/// which hid tables (including freshly created normal tables) from the sidebar.
#[test]
fn tdengine_websocket_live_paged_table_list_matches_the_full_list() {
    let Some(connect_params) = integration_params() else {
        return;
    };
    let database = format!("dbx_rust_page_{}", std::process::id());
    let session_id = "tdengine-live-page";
    let page_size = 100usize;
    let mut agent = AgentProcess::spawn();

    let mut open_params = connect_params.clone();
    open_params["agentSessionId"] = json!(session_id);
    assert_eq!(agent.call("open_session", open_params), json!({"ok": true}));

    create_database(&mut agent, session_id, &database);
    let mut statements =
        vec![format!("CREATE STABLE IF NOT EXISTS {database}.st_paged (ts TIMESTAMP, v INT) TAGS (gid INT)")];
    // Enough child tables that the sidebar's paging walks several pages.
    for index in 0..300 {
        statements.push(format!(
            "CREATE TABLE IF NOT EXISTS {database}.c_{index:04} USING {database}.st_paged TAGS ({index})"
        ));
    }
    statements.push(format!("CREATE TABLE IF NOT EXISTS {database}.normal_tbl (ts TIMESTAMP, v INT)"));
    agent.call("execute_batch", json!({"agentSessionId": session_id, "statements": statements}));

    fn page(agent: &mut AgentProcess, session_id: &str, database: &str, limit: usize, offset: usize) -> Value {
        agent.call(
            "list_tables",
            json!({
                "agentSessionId": session_id,
                "schema": database,
                "filter": "",
                "limit": limit,
                "offset": offset,
                "object_types": []
            }),
        )
    }
    fn names(tables: &Value) -> HashSet<(String, String)> {
        tables
            .as_array()
            .expect("table list")
            .iter()
            .map(|table| {
                (
                    table["name"].as_str().unwrap_or_default().to_string(),
                    table["table_type"].as_str().unwrap_or_default().to_string(),
                )
            })
            .collect()
    }

    let full = names(&page(&mut agent, session_id, &database, 0, 0));
    assert!(full.contains(&("normal_tbl".to_string(), "TABLE".to_string())));

    let mut seen = HashSet::new();
    let mut offset = 0usize;
    loop {
        let tables = page(&mut agent, session_id, &database, page_size, offset);
        let count = tables.as_array().expect("table page").len();
        if count == 0 {
            break;
        }
        for table in names(&tables) {
            assert!(seen.insert(table.clone()), "table {table:?} was returned twice while paging at offset {offset}");
        }
        if count < page_size {
            break;
        }
        offset += page_size;
    }
    assert_eq!(seen, full, "paging dropped or invented tables");

    agent.call(
        "execute_batch",
        json!({"agentSessionId": session_id, "statements": [format!("DROP DATABASE IF EXISTS {database}")]}),
    );
    agent.shutdown();
}