RUST-1604 Add custom bucketing fields to timeseries options (mongodb#907)

Author: isabelatkinson

src/db/options.rs

@@ -98,11 +98,7 @@ pub struct CreateCollectionOptions {
     /// Used to automatically delete documents in time series collections. See the [`create`
     /// command documentation](https://www.mongodb.com/docs/manual/reference/command/create/) for more
     /// information.
-    #[serde(
-        default,
-        deserialize_with = "serde_util::deserialize_duration_option_from_u64_seconds",
-        serialize_with = "serde_util::serialize_duration_option_as_int_secs"
-    )]
+    #[serde(default, with = "serde_util::duration_option_as_int_seconds")]
     pub expire_after_seconds: Option<Duration>,
 
     /// Options for supporting change stream pre- and post-images.
@@ -192,8 +188,10 @@ pub struct IndexOptionDefaults {
 }
 
 /// Specifies options for creating a timeseries collection.
+#[skip_serializing_none]
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, TypedBuilder)]
 #[serde(rename_all = "camelCase")]
+#[builder(field_defaults(default))]
 #[non_exhaustive]
 pub struct TimeseriesOptions {
     /// Name of the top-level field to be used for time. Inserted documents must have this field,
@@ -208,6 +206,31 @@ pub struct TimeseriesOptions {
     /// The units you'd use to describe the expected interval between subsequent measurements for a
     /// time-series.  Defaults to `TimeseriesGranularity::Seconds` if unset.
     pub granularity: Option<TimeseriesGranularity>,
+
+    /// The maximum time between timestamps in the same bucket. This value must be between 1 and
+    /// 31,536,000 seconds. If this value is set, the same value should be set for
+    /// `bucket_rounding` and `granularity` should not be set.
+    ///
+    /// This option is only available on MongoDB 6.3+.
+    #[serde(
+        default,
+        with = "serde_util::duration_option_as_int_seconds",
+        rename = "bucketMaxSpanSeconds"
+    )]
+    pub bucket_max_span: Option<Duration>,
+
+    /// The time interval that determines the starting timestamp for a new bucket. When a document
+    /// requires a new bucket, MongoDB rounds down the document's timestamp value by this interval
+    /// to set the minimum time for the bucket.  If this value is set, the same value should be set
+    /// for `bucket_max_span` and `granularity` should not be set.
+    ///
+    /// This option is only available on MongoDB 6.3+.
+    #[serde(
+        default,
+        with = "serde_util::duration_option_as_int_seconds",
+        rename = "bucketRoundingSeconds"
+    )]
+    pub bucket_rounding: Option<Duration>,
 }
 
 /// The units you'd use to describe the expected interval between subsequent measurements for a

src/index/options.rs

@@ -29,8 +29,7 @@ pub struct IndexOptions {
     #[serde(
         rename = "expireAfterSeconds",
         default,
-        deserialize_with = "serde_util::deserialize_duration_option_from_u64_seconds",
-        serialize_with = "serde_util::serialize_duration_option_as_int_secs"
+        with = "serde_util::duration_option_as_int_seconds"
     )]
     pub expire_after: Option<Duration>,
 

src/selection_criteria.rs

@@ -277,8 +277,7 @@ pub struct ReadPreferenceOptions {
     #[serde(
         rename = "maxStalenessSeconds",
         default,
-        deserialize_with = "serde_util::deserialize_duration_option_from_u64_seconds",
-        serialize_with = "serde_util::serialize_duration_option_as_int_secs"
+        with = "serde_util::duration_option_as_int_seconds"
     )]
     pub max_staleness: Option<Duration>,
 
@@ -388,7 +387,7 @@ impl ReadPreference {
 
             readpreferencetags: Option<&'a Vec<HashMap<String, String>>>,
 
-            #[serde(serialize_with = "serde_util::serialize_duration_option_as_int_secs")]
+            #[serde(serialize_with = "serde_util::duration_option_as_int_seconds::serialize")]
             maxstalenessseconds: Option<Duration>,
         }
 

src/serde_util.rs

@@ -8,28 +8,42 @@ use crate::{
     error::{Error, Result},
 };
 
-pub(crate) fn serialize_duration_option_as_int_millis<S: Serializer>(
-    val: &Option<Duration>,
-    serializer: S,
-) -> std::result::Result<S::Ok, S::Error> {
-    match val {
-        Some(duration) if duration.as_millis() > i32::MAX as u128 => {
-            serializer.serialize_i64(duration.as_millis() as i64)
+pub(crate) mod duration_option_as_int_seconds {
+    use super::*;
+
+    pub(crate) fn serialize<S: Serializer>(
+        val: &Option<Duration>,
+        serializer: S,
+    ) -> std::result::Result<S::Ok, S::Error> {
+        match val {
+            Some(duration) if duration.as_secs() > i32::MAX as u64 => {
+                serializer.serialize_i64(duration.as_secs() as i64)
+            }
+            Some(duration) => serializer.serialize_i32(duration.as_secs() as i32),
+            None => serializer.serialize_none(),
         }
-        Some(duration) => serializer.serialize_i32(duration.as_millis() as i32),
-        None => serializer.serialize_none(),
+    }
+
+    pub(crate) fn deserialize<'de, D>(
+        deserializer: D,
+    ) -> std::result::Result<Option<Duration>, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let millis = Option::<u64>::deserialize(deserializer)?;
+        Ok(millis.map(Duration::from_secs))
     }
 }
 
-pub(crate) fn serialize_duration_option_as_int_secs<S: Serializer>(
+pub(crate) fn serialize_duration_option_as_int_millis<S: Serializer>(
     val: &Option<Duration>,
     serializer: S,
 ) -> std::result::Result<S::Ok, S::Error> {
     match val {
-        Some(duration) if duration.as_secs() > i32::MAX as u64 => {
-            serializer.serialize_i64(duration.as_secs() as i64)
+        Some(duration) if duration.as_millis() > i32::MAX as u128 => {
+            serializer.serialize_i64(duration.as_millis() as i64)
         }
-        Some(duration) => serializer.serialize_i32(duration.as_secs() as i32),
+        Some(duration) => serializer.serialize_i32(duration.as_millis() as i32),
         None => serializer.serialize_none(),
     }
 }
@@ -44,16 +58,6 @@ where
     Ok(millis.map(Duration::from_millis))
 }
 
-pub(crate) fn deserialize_duration_option_from_u64_seconds<'de, D>(
-    deserializer: D,
-) -> std::result::Result<Option<Duration>, D::Error>
-where
-    D: Deserializer<'de>,
-{
-    let millis = Option::<u64>::deserialize(deserializer)?;
-    Ok(millis.map(Duration::from_secs))
-}
-
 #[allow(clippy::trivially_copy_pass_by_ref)]
 pub(crate) fn serialize_u32_option_as_i32<S: Serializer>(
     val: &Option<u32>,

src/test/spec/collection_management.rs

@@ -6,6 +6,6 @@ async fn run_unified() {
     let _guard = LOCK.run_exclusively().await;
     run_unified_tests(&["collection-management"])
         // The driver does not support modifyCollection.
-        .skip_files(&["modifyCollection-pre_and_post_images.json"])
+        .skip_files(&["modifyCollection-pre_and_post_images.json", "modifyCollection-errorResponse.json"])
         .await;
 }

src/test/spec/json/collection-management/modifyCollection-errorResponse.json

@@ -0,0 +1,118 @@
+{
+  "description": "modifyCollection-errorResponse",
+  "schemaVersion": "1.12",
+  "createEntities": [
+    {
+      "client": {
+        "id": "client0",
+        "observeEvents": [
+          "commandStartedEvent"
+        ]
+      }
+    },
+    {
+      "database": {
+        "id": "database0",
+        "client": "client0",
+        "databaseName": "collMod-tests"
+      }
+    },
+    {
+      "collection": {
+        "id": "collection0",
+        "database": "database0",
+        "collectionName": "test"
+      }
+    }
+  ],
+  "initialData": [
+    {
+      "collectionName": "test",
+      "databaseName": "collMod-tests",
+      "documents": [
+        {
+          "_id": 1,
+          "x": 1
+        },
+        {
+          "_id": 2,
+          "x": 1
+        }
+      ]
+    }
+  ],
+  "tests": [
+    {
+      "description": "modifyCollection prepareUnique violations are accessible",
+      "runOnRequirements": [
+        {
+          "minServerVersion": "5.2"
+        }
+      ],
+      "operations": [
+        {
+          "name": "createIndex",
+          "object": "collection0",
+          "arguments": {
+            "keys": {
+              "x": 1
+            }
+          }
+        },
+        {
+          "name": "modifyCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test",
+            "index": {
+              "keyPattern": {
+                "x": 1
+              },
+              "prepareUnique": true
+            }
+          }
+        },
+        {
+          "name": "insertOne",
+          "object": "collection0",
+          "arguments": {
+            "document": {
+              "_id": 3,
+              "x": 1
+            }
+          },
+          "expectError": {
+            "errorCode": 11000
+          }
+        },
+        {
+          "name": "modifyCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test",
+            "index": {
+              "keyPattern": {
+                "x": 1
+              },
+              "unique": true
+            }
+          },
+          "expectError": {
+            "isClientError": false,
+            "errorCode": 359,
+            "errorResponse": {
+              "violations": [
+                {
+                  "ids": [
+                    1,
+                    2
+                  ]
+                }
+              ]
+            }
+          }
+        }
+      ]
+    }
+  ]
+}

src/test/spec/json/collection-management/modifyCollection-errorResponse.yml

@@ -0,0 +1,59 @@
+description: "modifyCollection-errorResponse"
+
+schemaVersion: "1.12"
+
+createEntities:
+  - client:
+      id: &client0 client0
+      observeEvents: [ commandStartedEvent ]
+  - database:
+      id: &database0 database0
+      client: *client0
+      databaseName: &database0Name collMod-tests
+  - collection:
+      id: &collection0 collection0
+      database: *database0
+      collectionName: &collection0Name test
+
+initialData: &initialData
+  - collectionName: *collection0Name
+    databaseName: *database0Name
+    documents:
+      - { _id: 1, x: 1 }
+      - { _id: 2, x: 1 }
+
+tests:
+  - description: "modifyCollection prepareUnique violations are accessible"
+    runOnRequirements:
+      - minServerVersion: "5.2" # SERVER-61158
+    operations:
+      - name: createIndex
+        object: *collection0
+        arguments:
+          keys: { x: 1 }
+      - name: modifyCollection
+        object: *database0
+        arguments:
+          collection: *collection0Name
+          index:
+            keyPattern: { x: 1 }
+            prepareUnique: true
+      - name: insertOne
+        object: *collection0
+        arguments:
+          document: { _id: 3, x: 1 }
+        expectError:
+          errorCode: 11000 # DuplicateKey
+      - name: modifyCollection
+        object: *database0
+        arguments:
+          collection: *collection0Name
+          index:
+            keyPattern: { x: 1 }
+            unique: true
+        expectError:
+          isClientError: false
+          errorCode: 359 # CannotConvertIndexToUnique
+          errorResponse:
+            violations:
+               - { ids: [ 1, 2 ] }