hasura · hallettj · Mar 27, 2024 · Mar 14, 2024 · Mar 14, 2024 · Mar 14, 2024
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/configuration/src/native_queries.rs b/crates/configuration/src/native_queries.rs
@@ -22,13 +22,50 @@ pub struct NativeQuery {
     /// `schema.json`.
     pub result_type: Type,
 
-    /// Arguments for per-query customization
+    /// Arguments to be supplied for each query invocation. These will be substituted into the
+    /// given `command`.
+    ///
+    /// Argument values are standard JSON mapped from GraphQL input types, not Extended JSON.
+    /// Values will be converted to BSON according to the types specified here.
     #[serde(default)]
     pub arguments: BTreeMap<String, ObjectField>,
 
-    /// Command to run expressed as a BSON document
+    /// Command to run via MongoDB's `runCommand` API. For details on how to write commands see
+    /// https://www.mongodb.com/docs/manual/reference/method/db.runCommand/
+    ///
+    /// The command is read as Extended JSON. It may be in canonical or relaxed format, or
+    /// a mixture of both.
+    /// See https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/
+    ///
+    /// Keys and values in the command may contain placeholders of the form `{{variableName}}`
+    /// which will be substituted when the native query is executed according to the given
+    /// arguments.
+    ///
+    /// Placeholders must be inside quotes so that the command can be stored in JSON format. If the
+    /// command includes a string whose only content is a placeholder, when the variable is
+    /// substituted the string will be replaced by the type of the variable. For example in this
+    /// command,
+    ///
+    /// ```json
+    /// json!({
+    ///   "insert": "posts",
+    ///   "documents": "{{ documents }}"
+    /// })
+    /// ```
+    ///
+    /// If the type of the `documents` argument is an array then after variable substitution the
+    /// command will expand to:
+    ///
+    /// ```json
+    /// json!({
+    ///   "insert": "posts",
+    ///   "documents": [/* array of documents */]
+    /// })
+    /// ```
+    ///
     #[schemars(with = "Object")]
     pub command: bson::Document,
+    // TODO: test extjson deserialization
 
     /// Determines which servers in a cluster to read from by specifying read preference, or
     /// a predicate to apply to candidate servers.

diff --git a/crates/configuration/src/schema/database.rs b/crates/configuration/src/schema/database.rs
@@ -60,3 +60,15 @@ pub struct ObjectField {
     #[serde(default)]
     pub description: Option<String>,
 }
+
+impl ObjectField {
+    pub fn new(name: impl ToString, r#type: Type) -> (String, Self) {
+        (
+            name.to_string(),
+            ObjectField {
+                r#type,
+                description: Default::default(),
+            },
+        )
+    }
+}
diff --git a/crates/mongodb-agent-common/Cargo.toml b/crates/mongodb-agent-common/Cargo.toml
@@ -17,6 +17,7 @@ futures = "0.3.28"
 futures-util = "0.3.28"
 http = "^0.2"
 indexmap = { version = "1", features = ["serde"] } # must match the version that ndc-client uses
+indent = "^0.1"
 itertools = "^0.10"
 mongodb = "2.8"
 mongodb-support = { path = "../mongodb-support" }
@@ -25,6 +26,7 @@ regex = "1"
 schemars = { version = "^0.8.12", features = ["smol_str"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0", features = ["preserve_order"] }
+serde_with = { version = "^3.7", features = ["base64", "hex"] }
 thiserror = "1"
 time = { version = "0.3.29", features = ["formatting", "parsing", "serde"] }
 tracing = "0.1"

diff --git a/crates/mongodb-agent-common/src/interface_types/mongo_config.rs b/crates/mongodb-agent-common/src/interface_types/mongo_config.rs
@@ -1,6 +1,6 @@
 use std::collections::BTreeMap;
 
-use configuration::native_queries::NativeQuery;
+use configuration::{native_queries::NativeQuery, schema::ObjectType};
 use mongodb::Client;
 
 #[derive(Clone, Debug)]
@@ -11,4 +11,5 @@ pub struct MongoConfig {
     pub database: String,
 
     pub native_queries: BTreeMap<String, NativeQuery>,
+    pub object_types: BTreeMap<String, ObjectType>,
 }
diff --git a/crates/mongodb-agent-common/src/lib.rs b/crates/mongodb-agent-common/src/lib.rs
@@ -5,6 +5,7 @@ pub mod health;
 pub mod interface_types;
 pub mod mongodb;
 pub mod mongodb_connection;
+pub mod procedure;
 pub mod query;
 pub mod scalar_types_capabilities;
 pub mod schema;

diff --git a/crates/mongodb-agent-common/src/procedure/error.rs b/crates/mongodb-agent-common/src/procedure/error.rs
@@ -0,0 +1,22 @@
+use mongodb::bson::Bson;
+use thiserror::Error;
+
+use crate::query::arguments::ArgumentError;
+
+#[derive(Debug, Error)]
+pub enum ProcedureError {
+    #[error("error executing mongodb command: {0}")]
+    ExecutionError(#[from] mongodb::error::Error),
+
+    #[error("a required argument was not provided, \"{0}\"")]
+    MissingArgument(String),
+
+    #[error("found a non-string argument, {0}, in a string context - if you want to use a non-string argument it must be the only thing in the string with no white space around the curly braces")]
+    NonStringInStringContext(String),
+
+    #[error("object keys must be strings, but got: \"{0}\"")]
+    NonStringKey(Bson),
+
+    #[error("could not resolve arguments: {0}")]
+    UnresolvableArguments(#[from] ArgumentError),
+}