Merge pull request #22 from hasura/update-errors

Update-errors

Merging without review as we want a version with fixed capabilities ASAP, and all tests pass.

.github/workflows/deploy-stage.yaml

@@ -144,6 +144,10 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/v') }}
     steps:
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          rustflags: "" # defaults to "-D warnings", set to empty string to allow warnings
+
       - uses: actions/checkout@v4
 
       - uses: actions/download-artifact@v4
@@ -183,6 +187,9 @@ jobs:
 
           mkdir -p "${ROOT}/release/connector-definition/.hasura-connector/"
           cat "${ROOT}/ci/templates/connector-metadata.yaml" | envsubst > "${ROOT}/release/connector-definition/.hasura-connector/connector-metadata.yaml"
+
+          cargo run --package ndc-clickhouse-cli -- --connector-context-path "${ROOT}/release/connector-definition" init
+
           tar -czvf "${ROOT}/release/artifacts/connector-definition.tgz" --directory "${ROOT}/release/connector-definition/" .
 
       - uses: actions/upload-artifact@v4

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.10]
+
+- Correct CLI implementation of Init command (used to behave the same as update)
+- Update sdk & errors
+- Fix version returned by capabilities
+- Fix parameter escaping, enabling complex data types as parameters
+- Remove deprecated JSON data type, see [clickhouse docs](https://clickhouse.com/docs/en/sql-reference/data-types/object-data-type)
+
 ## [0.2.9]
 
 - Change namespaceing to use `.` separator instead of `_`. We assume table names are less likely to contain periods, so this reduces likelyhood of naming conflicts.This will change generated type names and will thus manifest as a breaking change for some users

Cargo.toml

@@ -6,5 +6,5 @@ members = [
 ]
 resolver = "2"
 
-package.version = "0.2.9"
+package.version = "0.2.10"
 package.edition = "2021"

crates/common/src/clickhouse_parser.rs

@@ -46,7 +46,6 @@ peg::parser! {
         / date_time()
         / date32()
         / date()
-        / json()
         / uuid()
         / ipv4()
         / ipv6()
@@ -86,7 +85,6 @@ peg::parser! {
     rule date32() -> DT = "Date32" { DT::Date32 }
     rule date_time() -> DT = "DateTime" tz:("(" tz:single_quoted_string_value()? ")" { tz })? { DT::DateTime { timezone: tz.flatten().map(|s| s.to_owned()) } }
     rule date_time64() -> DT = "DateTime64(" precision:integer_value() tz:(comma_separator() tz:single_quoted_string_value()? { tz })? ")" { DT::DateTime64{ precision, timezone: tz.flatten().map(|s| s.to_owned())} }
-    rule json() -> DT = "JSON" { DT::Json }
     rule uuid() -> DT = "UUID" { DT::Uuid }
     rule ipv4() -> DT = "IPv4" { DT::IPv4 }
     rule ipv6() -> DT = "IPv6" { DT::IPv6 }

crates/common/src/clickhouse_parser/datatype.rs

@@ -87,7 +87,7 @@ impl Display for AggregateFunctionParameter {
 
 /// A parsed representation of a clickhouse datatype string
 /// This should support the full scope of clickhouse types
-/// To create one from a string slice, use try_from()
+/// To create one from a string slice, use from_str()
 #[derive(Debug, Clone, PartialEq)]
 pub enum ClickHouseDataType {
     Nullable(Box<ClickHouseDataType>),
@@ -133,7 +133,6 @@ pub enum ClickHouseDataType {
         precision: u32,
         timezone: Option<SingleQuotedString>,
     },
-    Json,
     Uuid,
     IPv4,
     IPv6,
@@ -203,7 +202,6 @@ impl Display for ClickHouseDataType {
                 }
                 write!(f, ")")
             }
-            DT::Json => write!(f, "JSON"),
             DT::Uuid => write!(f, "UUID"),
             DT::IPv4 => write!(f, "IPv4"),
             DT::IPv6 => write!(f, "IPv6"),

crates/common/src/config_file.rs

@@ -3,7 +3,7 @@ use std::collections::BTreeMap;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 /// the main configuration file
 pub struct ServerConfigFile {
     #[serde(rename = "$schema")]
@@ -22,6 +22,16 @@ pub struct ServerConfigFile {
     pub queries: BTreeMap<String, ParameterizedQueryConfigFile>,
 }
 
+impl Default for ServerConfigFile {
+    fn default() -> Self {
+        Self {
+            schema: CONFIG_SCHEMA_FILE_NAME.to_string(),
+            tables: Default::default(),
+            queries: Default::default(),
+        }
+    }
+}
+
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 pub struct TableConfigFile {
     /// The table name

crates/ndc-clickhouse-cli/src/database_introspection.rs

@@ -11,8 +11,10 @@ use common::{
 pub struct TableInfo {
     pub table_name: String,
     pub table_schema: String,
+    #[allow(dead_code)]
     pub table_catalog: String,
     pub table_comment: Option<String>,
+    #[allow(dead_code)]
     pub table_type: TableType,
     pub primary_key: Option<String>,
     pub view_definition: String,
@@ -23,6 +25,7 @@ pub struct TableInfo {
 pub struct ColumnInfo {
     pub column_name: String,
     pub data_type: String,
+    #[allow(dead_code)]
     pub is_nullable: bool,
     pub is_in_primary_key: bool,
 }

crates/ndc-clickhouse-cli/src/main.rs

@@ -60,24 +60,25 @@ struct CliArgs {
         env = "HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH"
     )]
     context_path: Option<PathBuf>,
-    #[arg(long = "clickhouse-url", value_name = "URL", env = "CLICKHOUSE_URL")]
-    clickhouse_url: String,
-    #[arg(long = "clickhouse-username", value_name = "USERNAME", env = "CLICKHOUSE_USERNAME", default_value_t = String::from("default"))]
-    clickhouse_username: String,
-    #[arg(
-        long = "clickhouse-password",
-        value_name = "PASSWORD",
-        env = "CLICKHOUSE_PASSWORD"
-    )]
-    clickhouse_password: String,
     #[command(subcommand)]
     command: Command,
 }
 
 #[derive(Clone, Subcommand)]
 enum Command {
     Init {},
-    Update {},
+    Update {
+        #[arg(long = "clickhouse-url", value_name = "URL", env = "CLICKHOUSE_URL")]
+        url: String,
+        #[arg(long = "clickhouse-username", value_name = "USERNAME", env = "CLICKHOUSE_USERNAME", default_value_t = String::from("default"))]
+        username: String,
+        #[arg(
+            long = "clickhouse-password",
+            value_name = "PASSWORD",
+            env = "CLICKHOUSE_PASSWORD"
+        )]
+        password: String,
+    },
     Validate {},
     Watch {},
 }
@@ -93,11 +94,6 @@ enum LogLevel {
     Trace,
 }
 
-struct Context {
-    context_path: PathBuf,
-    connection: ConnectionConfig,
-}
-
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     let args = CliArgs::parse();
@@ -107,33 +103,41 @@ async fn main() -> Result<(), Box<dyn Error>> {
         Some(path) => path,
     };
 
-    let connection = ConnectionConfig {
-        url: args.clickhouse_url,
-        username: args.clickhouse_username,
-        password: args.clickhouse_password,
-    };
-
-    let context = Context {
-        context_path,
-        connection,
-    };
-
     match args.command {
         Command::Init {} => {
-            let introspection = introspect_database(&context.connection).await?;
-            let config = update_tables_config(&context.context_path, &introspection).await?;
-            validate_table_config(&context.context_path, &config).await?;
+            let config = ServerConfigFile::default();
+            let config_schema = schema_for!(ServerConfigFile);
+
+            let file_path = context_path.join(CONFIG_FILE_NAME);
+            let schema_file_path = context_path.join(CONFIG_SCHEMA_FILE_NAME);
+
+            fs::write(&file_path, serde_json::to_string_pretty(&config)?).await?;
+            fs::write(
+                &schema_file_path,
+                serde_json::to_string_pretty(&config_schema)?,
+            )
+            .await?;
         }
-        Command::Update {} => {
-            let introspection = introspect_database(&context.connection).await?;
-            let config = update_tables_config(&context.context_path, &introspection).await?;
-            validate_table_config(&context.context_path, &config).await?;
+        Command::Update {
+            url,
+            username,
+            password,
+        } => {
+            let connection = ConnectionConfig {
+                url,
+                username,
+                password,
+            };
+
+            let introspection = introspect_database(&connection).await?;
+            let config = update_tables_config(&context_path, &introspection).await?;
+            validate_table_config(&context_path, &config).await?;
         }
         Command::Validate {} => {
-            let file_path = context.context_path.join(CONFIG_FILE_NAME);
+            let file_path = context_path.join(CONFIG_FILE_NAME);
             let config = read_config_file(&file_path).await?;
             if let Some(config) = config {
-                validate_table_config(&context.context_path, &config).await?;
+                validate_table_config(&context_path, &config).await?;
             }
         }
         Command::Watch {} => {

crates/ndc-clickhouse/Cargo.toml

@@ -8,7 +8,7 @@ async-trait = "0.1.78"
 bytes = "1.6.0"
 common = { path = "../common" }
 indexmap = "2.1.0"
-ndc-sdk = { git = "https://github.com/hasura/ndc-sdk-rs", tag = "v0.1.4", package = "ndc-sdk" }
+ndc-sdk = { git = "https://github.com/hasura/ndc-sdk-rs", tag = "v0.1.5", package = "ndc-sdk" }
 prometheus = "0.13.3"
 reqwest = { version = "0.12.3", features = [
   "json",