RUST-352 Support for 'authorizedDatabases' option (#165)

Author: isabelatkinson

README.md

@@ -49,7 +49,7 @@ client_options.app_name = Some("My App".to_string());
 let client = Client::with_options(client_options)?;
 
 // List the names of the databases in that deployment.
-for db_name in client.list_database_names(None)? {
+for db_name in client.list_database_names(None, None)? {
     println!("{}", db_name);
 }
 ```

src/client/mod.rs

@@ -17,7 +17,13 @@ use crate::{
     error::{ErrorKind, Result},
     event::command::CommandEventHandler,
     operation::ListDatabases,
-    options::{ClientOptions, DatabaseOptions, ReadPreference, SelectionCriteria},
+    options::{
+        ClientOptions,
+        DatabaseOptions,
+        ListDatabasesOptions,
+        ReadPreference,
+        SelectionCriteria,
+    },
     sdam::{Server, Topology},
 };
 
@@ -133,17 +139,19 @@ impl Client {
     pub async fn list_databases(
         &self,
         filter: impl Into<Option<Document>>,
+        options: impl Into<Option<ListDatabasesOptions>>,
     ) -> Result<Vec<Document>> {
-        let op = ListDatabases::new(filter.into(), false);
+        let op = ListDatabases::new(filter.into(), false, options.into());
         self.execute_operation(&op, None).await
     }
 
     /// Gets the names of the databases present in the cluster the Client is connected to.
     pub async fn list_database_names(
         &self,
         filter: impl Into<Option<Document>>,
+        options: impl Into<Option<ListDatabasesOptions>>,
     ) -> Result<Vec<String>> {
-        let op = ListDatabases::new(filter.into(), true);
+        let op = ListDatabases::new(filter.into(), true, options.into());
         match self.execute_operation(&op, None).await {
             Ok(databases) => databases
                 .into_iter()

src/db/options.rs

@@ -136,3 +136,14 @@ pub struct ListCollectionsOptions {
     #[serde(serialize_with = "bson_util::serialize_batch_size", rename = "cursor")]
     pub batch_size: Option<u32>,
 }
+
+/// Specifies the options to a
+/// [`Client::list_databases`](../struct.Client.html#method.list_databases) operation.
+#[derive(Debug, Default, TypedBuilder, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ListDatabasesOptions {
+    /// Determines which databases to return based on the user's access privileges. This option is
+    /// only supported on server versions 4.0.5+.
+    #[builder(default)]
+    pub authorized_databases: Option<bool>,
+}

src/operation/list_databases/mod.rs

@@ -7,26 +7,37 @@ use serde::Deserialize;
 use crate::{
     cmap::{Command, CommandResponse, StreamDescription},
     error::Result,
-    operation::Operation,
+    operation::{append_options, Operation},
+    options::ListDatabasesOptions,
     selection_criteria::{ReadPreference, SelectionCriteria},
 };
 
 #[derive(Debug)]
 pub(crate) struct ListDatabases {
     filter: Option<Document>,
     name_only: bool,
+    options: Option<ListDatabasesOptions>,
 }
 
 impl ListDatabases {
-    pub fn new(filter: Option<Document>, name_only: bool) -> Self {
-        ListDatabases { filter, name_only }
+    pub fn new(
+        filter: Option<Document>,
+        name_only: bool,
+        options: Option<ListDatabasesOptions>,
+    ) -> Self {
+        ListDatabases {
+            filter,
+            name_only,
+            options,
+        }
     }
 
     #[cfg(test)]
     pub(crate) fn empty() -> Self {
         ListDatabases {
             filter: None,
             name_only: false,
+            options: None,
         }
     }
 }
@@ -45,6 +56,8 @@ impl Operation for ListDatabases {
             body.insert("filter", filter.clone());
         }
 
+        append_options(&mut body, self.options.as_ref())?;
+
         Ok(Command::new(
             Self::NAME.to_string(),
             "admin".to_string(),

src/operation/list_databases/test.rs

@@ -5,6 +5,7 @@ use crate::{
     cmap::{CommandResponse, StreamDescription},
     error::ErrorKind,
     operation::{ListDatabases, Operation},
+    options::ListDatabasesOptions,
     selection_criteria::ReadPreference,
 };
 
@@ -31,7 +32,7 @@ async fn build() {
 async fn build_with_name_only() {
     let name_only = true;
 
-    let list_databases_op = ListDatabases::new(None, name_only);
+    let list_databases_op = ListDatabases::new(None, name_only, None);
     let list_databases_command = list_databases_op
         .build(&StreamDescription::new_testing())
         .expect("error on build");
@@ -52,7 +53,7 @@ async fn build_with_name_only() {
 async fn build_with_filter() {
     let filter = doc! {"something" : "something else"};
 
-    let list_databases_op = ListDatabases::new(Some(filter.clone()), false);
+    let list_databases_op = ListDatabases::new(Some(filter.clone()), false, None);
     let list_databases_command = list_databases_op
         .build(&StreamDescription::new_testing())
         .unwrap();
@@ -68,6 +69,29 @@ async fn build_with_filter() {
     assert_eq!(list_databases_command.read_pref, None);
 }
 
+#[cfg_attr(feature = "tokio-runtime", tokio::test)]
+#[cfg_attr(feature = "async-std-runtime", async_std::test)]
+async fn build_with_options() {
+    let options = ListDatabasesOptions::builder()
+        .authorized_databases(true)
+        .build();
+
+    let list_databases_op = ListDatabases::new(None, false, Some(options));
+    let list_databases_command = list_databases_op
+        .build(&StreamDescription::new_testing())
+        .unwrap();
+    assert_eq!(
+        list_databases_command.body,
+        doc! {
+            "listDatabases": 1,
+            "nameOnly": false,
+            "authorizedDatabases": true
+        }
+    );
+    assert_eq!(list_databases_command.target_db, "admin");
+    assert_eq!(list_databases_command.read_pref, None);
+}
+
 #[cfg_attr(feature = "tokio-runtime", tokio::test)]
 #[cfg_attr(feature = "async-std-runtime", async_std::test)]
 async fn handle_success() {

src/sync/client.rs

@@ -4,7 +4,7 @@ use super::Database;
 use crate::{
     concern::{ReadConcern, WriteConcern},
     error::Result,
-    options::{ClientOptions, DatabaseOptions, SelectionCriteria},
+    options::{ClientOptions, DatabaseOptions, ListDatabasesOptions, SelectionCriteria},
     Client as AsyncClient,
     RUNTIME,
 };
@@ -100,12 +100,26 @@ impl Client {
     }
 
     /// Gets information about each database present in the cluster the Client is connected to.
-    pub fn list_databases(&self, filter: impl Into<Option<Document>>) -> Result<Vec<Document>> {
-        RUNTIME.block_on(self.async_client.list_databases(filter.into()))
+    pub fn list_databases(
+        &self,
+        filter: impl Into<Option<Document>>,
+        options: impl Into<Option<ListDatabasesOptions>>,
+    ) -> Result<Vec<Document>> {
+        RUNTIME.block_on(
+            self.async_client
+                .list_databases(filter.into(), options.into()),
+        )
     }
 
     /// Gets the names of the databases present in the cluster the Client is connected to.
-    pub fn list_database_names(&self, filter: impl Into<Option<Document>>) -> Result<Vec<String>> {
-        RUNTIME.block_on(self.async_client.list_database_names(filter.into()))
+    pub fn list_database_names(
+        &self,
+        filter: impl Into<Option<Document>>,
+        options: impl Into<Option<ListDatabasesOptions>>,
+    ) -> Result<Vec<String>> {
+        RUNTIME.block_on(
+            self.async_client
+                .list_database_names(filter.into(), options.into()),
+        )
     }
 }

src/sync/test.rs

@@ -35,7 +35,7 @@ fn client() {
         .expect("insert should succeed");
 
     let db_names = client
-        .list_database_names(None)
+        .list_database_names(None, None)
         .expect("list_database_names should succeed");
     assert!(db_names.contains(&function_name!().to_string()));
 }