Initial C Bindings for Cosmos DB SDK for Rust

sdk/cosmos/.dict.txt

@@ -9,9 +9,16 @@ backoff
 pluggable
 cloneable
 
+# Here at Cosmos DB, we upserts, they're the best ;)
+upsert
+upserts
+upserted
+upserting
+
 # Cosmos' docs all use "Autoscale" as a single word, rather than a compound "AutoScale" or "Auto Scale"
 autoscale
 
 # Words used within the Cosmos Native Client (azure_data_cosmos_native)
 azurecosmos
 cosmosclient
+cstring

sdk/cosmos/azure_data_cosmos/src/models/mod.rs

@@ -98,7 +98,7 @@ pub struct SystemProperties {
 ///
 /// Returned by [`DatabaseClient::read()`](crate::clients::DatabaseClient::read()).
 #[non_exhaustive]
-#[derive(Clone, Default, Debug, Deserialize, PartialEq, Eq)]
+#[derive(Clone, Default, Debug, Deserialize, Serialize, PartialEq, Eq)]
 pub struct DatabaseProperties {
     /// The ID of the database.
     pub id: String,

sdk/cosmos/azure_data_cosmos_native/CMakeLists.txt

@@ -1,8 +1,9 @@
 # cSpell:ignore cosmosctest CRATETYPES endforeach
 
-project(cosmosctest C)
 cmake_minimum_required(VERSION 4.1)
 
+project(cosmosctest C)
+
 # CMake automatically uses this option, but we should define it.
 option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
 
@@ -18,11 +19,14 @@ FetchContent_MakeAvailable(Corrosion)
 
 corrosion_import_crate(
     MANIFEST_PATH ./Cargo.toml
-    CRATETYPES staticlib cdylib
+    PROFILE dev
 )
 
 set(TEST_FILES
-    ./c_tests/version.c)
+    ./c_tests/version.c
+    ./c_tests/item_crud.c
+    ./c_tests/context_memory_management.c
+    ./c_tests/error_handling.c)
 
 foreach(test_file ${TEST_FILES})
     get_filename_component(test_name ${test_file} NAME_WE)

sdk/cosmos/azure_data_cosmos_native/Cargo.toml

@@ -14,7 +14,26 @@ name = "azurecosmos"
 crate-type = ["cdylib", "staticlib"]
 
 [dependencies]
-azure_data_cosmos = { path = "../azure_data_cosmos" }
+futures.workspace = true
+serde_json = { workspace = true, features = ["raw_value"] }
+azure_core.workspace = true
+azure_data_cosmos = { path = "../azure_data_cosmos", features = [ "key_auth", "preview_query_engine" ] }
+tracing.workspace = true
+tracing-subscriber = { workspace = true, optional = true, features = ["fmt", "env-filter"] }
+
+[target.'cfg(target_family = "wasm")'.dependencies]
+# The 'rt-multi-thread' feature is not supported in wasm targets
+tokio = { workspace = true, optional = true, features = ["rt", "macros"] }
+
+[target.'cfg(not(target_family = "wasm"))'.dependencies]
+tokio = { workspace = true, optional = true, features = ["rt-multi-thread", "macros"] }
+
+[features]
+default = ["tokio", "reqwest", "reqwest_native_tls", "tracing"]
+tokio = ["dep:tokio"]
+reqwest = ["azure_core/reqwest"]
+reqwest_native_tls = ["azure_core/reqwest_native_tls"]
+tracing = ["dep:tracing-subscriber"]
 
 [build-dependencies]
 cbindgen = "0.29.0"

sdk/cosmos/azure_data_cosmos_native/build.rs

@@ -3,10 +3,12 @@
 
 // cSpell:ignore SOURCEVERSION, SOURCEBRANCH, BUILDID, BUILDNUMBER, COSMOSCLIENT, cosmosclient, libcosmosclient, cbindgen
 
+use std::collections::HashMap;
+
 fn main() {
     let build_id = format!(
         "$Id: {}, Version: {}, Commit: {}, Branch: {}, Build ID: {}, Build Number: {}, Timestamp: {}$",
-        env!("CARGO_PKG_NAME"),
+        "azurecosmos",
         env!("CARGO_PKG_VERSION"),
         option_env!("BUILD_SOURCEVERSION").unwrap_or("unknown"),
         option_env!("BUILD_SOURCEBRANCH").unwrap_or("unknown"),
@@ -19,26 +21,73 @@ fn main() {
     );
     println!("cargo:rustc-env=BUILD_IDENTIFIER={}", build_id);
 
-    let mut header: String = r"// Copyright (c) Microsoft Corporation. All rights reserved.
+    let header: String = r"// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 // This file is auto-generated by cbindgen. Do not edit manually.
 // cSpell: disable
 "
     .to_string();
-    header.push_str(&format!("// Build identifier: {}\n", build_id));
+
+    let config = cbindgen::Config {
+        language: cbindgen::Language::C,
+        header: Some(header),
+        after_includes: Some(
+            "\n// Specifies the version of cosmosclient this header file was generated from.\n// This should match the version of libcosmosclient you are referencing.\n#define COSMOSCLIENT_H_VERSION \"".to_string()
+                + env!("CARGO_PKG_VERSION")
+                + "\"",
+        ),
+        cpp_compat: true,
+        parse: cbindgen::ParseConfig {
+            parse_deps: true,
+            include: Some(vec!["azure_data_cosmos".into()]),
+            ..Default::default()
+        },
+        style: cbindgen::Style::Both,
+        enumeration: cbindgen::EnumConfig {
+            rename_variants: cbindgen::RenameRule::QualifiedScreamingSnakeCase,
+            ..Default::default()
+        },
+        documentation_length: cbindgen::DocumentationLength::Full,
+        documentation_style: cbindgen::DocumentationStyle::Doxy,
+        export: cbindgen::ExportConfig {
+            prefix: Some("cosmos_".into()),
+            exclude: vec!["PartitionKeyValue".into()],
+
+            // From what I can tell, there's no way to set a rename rule for types :(
+            rename: HashMap::from([
+                ("RuntimeContext".into(), "runtime_context".into()),
+                ("CallContext".into(), "call_context".into()),
+                ("CosmosError".into(), "error".into()),
+                ("CosmosErrorCode".into(), "error_code".into()),
+                ("CosmosClient".into(), "client".into()),
+                ("DatabaseClient".into(), "database_client".into()),
+                ("ContainerClient".into(), "container_client".into()),
+                ("ClientOptions".into(), "client_options".into()),
+                ("QueryOptions".into(), "query_options".into()),
+                ("CreateDatabaseOptions".into(), "create_database_options".into()),
+                ("ReadDatabaseOptions".into(), "read_database_options".into()),
+                ("DeleteDatabaseOptions".into(), "delete_database_options".into()),
+                ("CreateContainerOptions".into(), "create_container_options".into()),
+                ("ReadContainerOptions".into(), "read_container_options".into()),
+                ("DeleteContainerOptions".into(), "delete_container_options".into()),
+                ("ItemOptions".into(), "item_options".into()),
+                ("RuntimeOptions".into(), "runtime_options".into()),
+                ("CallContextOptions".into(), "call_context_options".into()),
+            ]),
+            ..Default::default()
+        },
+        ..Default::default()
+    };
 
     let crate_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap();
-    cbindgen::Builder::new()
+    let Ok(bindings) = cbindgen::Builder::new()
         .with_crate(crate_dir)
-        .with_language(cbindgen::Language::C)
-        .with_after_include(format!(
-            "\n// Specifies the version of cosmosclient this header file was generated from.\n// This should match the version of libcosmosclient you are referencing.\n#define COSMOSCLIENT_H_VERSION \"{}\"",
-            env!("CARGO_PKG_VERSION")
-        ))
-        .with_cpp_compat(true)
-        .with_header(header)
+        .with_config(config)
         .generate()
-        .expect("unable to generate bindings")
-        .write_to_file("include/cosmosclient.h");
+    else {
+        println!("cargo:error=Failed to generate C bindings for azure_data_cosmos_native");
+        return;
+    };
+    bindings.write_to_file("include/azurecosmos.h");
 }