RUST-1487 Rename "csfle" to "in-use-encryption-unstable" (#792)

Author: abr-egn

.evergreen/feature-combinations.sh

@@ -6,5 +6,5 @@
 export FEATURE_COMBINATIONS=(
     '' # default features
     '--no-default-features --features async-std-runtime,sync' # features that conflict w/ default features
-    '--features tokio-sync,zstd-compression,snappy-compression,zlib-compression,openssl-tls,aws-auth,tracing-unstable,csfle' # additive features
+    '--features tokio-sync,zstd-compression,snappy-compression,zlib-compression,openssl-tls,aws-auth,tracing-unstable,in-use-encryption-unstable' # additive features
 )

.evergreen/run-csfle-tests.sh

@@ -7,7 +7,7 @@ source ./.evergreen/env.sh
 
 set -o xtrace
 
-FEATURE_FLAGS="csfle,${TLS_FEATURE}"
+FEATURE_FLAGS="in-use-encryption-unstable,${TLS_FEATURE}"
 OPTIONS="-- -Z unstable-options --format json --report-time"
 
 if [ "$SINGLE_THREAD" = true ]; then

Cargo.toml

@@ -67,8 +67,8 @@ zstd-compression = ["zstd"]
 zlib-compression = ["flate2"]
 snappy-compression = ["snap"]
 
-# DO NOT USE; see https://jira.mongodb.org/browse/RUST-569 for the status of CSFLE support in the Rust driver.
-csfle = ["mongocrypt", "rayon", "num_cpus"]
+# The In Use Encryption API is unstable and may have backwards-incompatible changes in minor version updates.
+in-use-encryption-unstable = ["mongocrypt", "rayon", "num_cpus"]
 
 # DO NOT USE; see https://jira.mongodb.org/browse/RUST-580 for the status of tracing/logging support in the Rust driver.
 # Enables support for emitting tracing events.

src/client/executor.rs

@@ -1,7 +1,7 @@
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 use bson::RawDocumentBuf;
 use bson::{doc, RawBsonRef, RawDocument, Timestamp};
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 use futures_core::future::BoxFuture;
 use lazy_static::lazy_static;
 use serde::de::DeserializeOwned;
@@ -607,7 +607,7 @@ impl Client {
         let target_db = cmd.target_db.clone();
 
         let serialized = op.serialize_command(cmd)?;
-        #[cfg(feature = "csfle")]
+        #[cfg(feature = "in-use-encryption-unstable")]
         let serialized = {
             let guard = self.inner.csfle.read().await;
             if let Some(ref csfle) = *guard {
@@ -775,7 +775,7 @@ impl Client {
                     })
                 });
 
-                #[cfg(feature = "csfle")]
+                #[cfg(feature = "in-use-encryption-unstable")]
                 let response = {
                     let guard = self.inner.csfle.read().await;
                     if let Some(ref csfle) = *guard {
@@ -801,7 +801,7 @@ impl Client {
         }
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     fn auto_encrypt<'a>(
         &'a self,
         csfle: &'a super::csfle::ClientState,
@@ -817,7 +817,7 @@ impl Client {
         })
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     fn auto_decrypt<'a>(
         &'a self,
         csfle: &'a super::csfle::ClientState,

src/client/mod.rs

@@ -1,5 +1,5 @@
 pub mod auth;
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 pub(crate) mod csfle;
 mod executor;
 pub mod options;
@@ -10,7 +10,7 @@ use std::{
     time::{Duration, Instant},
 };
 
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 pub use self::csfle::client_builder::*;
 use derivative::Derivative;
 
@@ -113,7 +113,7 @@ struct ClientInner {
     topology: Topology,
     options: ClientOptions,
     session_pool: ServerSessionPool,
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     csfle: tokio::sync::RwLock<Option<csfle::ClientState>>,
 }
 
@@ -136,7 +136,7 @@ impl Client {
         let inner = Arc::new(ClientInner {
             topology: Topology::new(options.clone())?,
             session_pool: ServerSessionPool::new(),
-            #[cfg(feature = "csfle")]
+            #[cfg(feature = "in-use-encryption-unstable")]
             csfle: Default::default(),
             options,
         });
@@ -166,7 +166,7 @@ impl Client {
     /// # Ok(())
     /// # }
     /// ```
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     pub fn encrypted_builder(
         client_options: ClientOptions,
         key_vault_namespace: crate::Namespace,
@@ -187,7 +187,7 @@ impl Client {
         ))
     }
 
-    #[cfg(all(test, feature = "csfle"))]
+    #[cfg(all(test, feature = "in-use-encryption-unstable"))]
     pub(crate) async fn mongocryptd_spawned(&self) -> bool {
         self.inner
             .csfle
@@ -197,7 +197,7 @@ impl Client {
             .map_or(false, |cs| cs.exec().mongocryptd_spawned())
     }
 
-    #[cfg(all(test, feature = "csfle"))]
+    #[cfg(all(test, feature = "in-use-encryption-unstable"))]
     pub(crate) async fn has_mongocryptd_client(&self) -> bool {
         self.inner
             .csfle
@@ -558,14 +558,14 @@ impl Client {
         &self.inner.topology
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     pub(crate) fn weak(&self) -> WeakClient {
         WeakClient {
             inner: Arc::downgrade(&self.inner),
         }
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     pub(crate) async fn auto_encryption_opts(
         &self,
     ) -> Option<tokio::sync::RwLockReadGuard<'_, csfle::options::AutoEncryptionOptions>> {
@@ -581,13 +581,13 @@ impl Client {
     }
 }
 
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 #[derive(Clone, Debug)]
 pub(crate) struct WeakClient {
     inner: std::sync::Weak<ClientInner>,
 }
 
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 impl WeakClient {
     #[allow(dead_code)]
     pub(crate) fn upgrade(&self) -> Option<Client> {

src/coll/mod.rs

@@ -228,7 +228,7 @@ impl<T> Collection<T> {
         let mut options: Option<DropCollectionOptions> = options.into();
         resolve_options!(self, options, [write_concern]);
 
-        #[cfg(feature = "csfle")]
+        #[cfg(feature = "in-use-encryption-unstable")]
         self.drop_aux_collections(options.as_ref(), session.as_deref_mut())
             .await?;
 
@@ -253,7 +253,7 @@ impl<T> Collection<T> {
         self.drop_common(options, session).await
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     #[allow(clippy::needless_option_as_deref)]
     async fn drop_aux_collections(
         &self,
@@ -1189,9 +1189,9 @@ where
         }
 
         let ordered = options.as_ref().and_then(|o| o.ordered).unwrap_or(true);
-        #[cfg(feature = "csfle")]
+        #[cfg(feature = "in-use-encryption-unstable")]
         let encrypted = self.client().auto_encryption_opts().await.is_some();
-        #[cfg(not(feature = "csfle"))]
+        #[cfg(not(feature = "in-use-encryption-unstable"))]
         let encrypted = false;
 
         let mut cumulative_failure: Option<BulkWriteFailure> = None;

src/coll/options.rs

@@ -1070,7 +1070,7 @@ pub struct DropCollectionOptions {
     /// Map of encrypted fields for the collection.
     // Serialization is skipped because the server doesn't accept this option; it's needed for
     // preprocessing.  Deserialization needs to remain because it's used in test files.
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     #[serde(skip_serializing)]
     pub encrypted_fields: Option<Document>,
 }

src/db/mod.rs

@@ -2,7 +2,7 @@ pub mod options;
 
 use std::{fmt::Debug, sync::Arc};
 
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 use bson::doc;
 use futures_util::stream::TryStreamExt;
 
@@ -304,7 +304,7 @@ impl Database {
             coll: name.as_ref().to_string(),
         };
 
-        #[cfg(feature = "csfle")]
+        #[cfg(feature = "in-use-encryption-unstable")]
         let has_encrypted_fields = {
             self.resolve_encrypted_fields(&ns, &mut options).await;
             self.create_aux_collections(&ns, &options, session.as_deref_mut())
@@ -320,7 +320,7 @@ impl Database {
             .execute_operation(create, session.as_deref_mut())
             .await?;
 
-        #[cfg(feature = "csfle")]
+        #[cfg(feature = "in-use-encryption-unstable")]
         if has_encrypted_fields {
             let coll = self.collection::<Document>(&ns.coll);
             coll.create_index_common(
@@ -337,7 +337,7 @@ impl Database {
         Ok(())
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     async fn resolve_encrypted_fields(
         &self,
         base_ns: &Namespace,
@@ -363,7 +363,7 @@ impl Database {
         }
     }
 
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     #[allow(clippy::needless_option_as_deref)]
     async fn create_aux_collections(
         &self,

src/db/options.rs

@@ -118,7 +118,7 @@ pub struct CreateCollectionOptions {
     pub comment: Option<Bson>,
 
     /// Map of encrypted fields for the created collection.
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     pub encrypted_fields: Option<Document>,
 }
 

src/error.rs

@@ -231,9 +231,9 @@ impl Error {
         )
     }
 
-    #[cfg(all(test, feature = "csfle"))]
+    #[cfg(all(test, feature = "in-use-encryption-unstable"))]
     pub(crate) fn is_csfle_error(&self) -> bool {
-        matches!(self.kind.as_ref(), ErrorKind::Csfle(..),)
+        matches!(self.kind.as_ref(), ErrorKind::Encryption(..))
     }
 
     /// Gets the code from this error for performing SDAM updates, if applicable.
@@ -287,8 +287,8 @@ impl Error {
             ErrorKind::Transaction { message } => Some(message.clone()),
             ErrorKind::IncompatibleServer { message } => Some(message.clone()),
             ErrorKind::InvalidArgument { message } => Some(message.clone()),
-            #[cfg(feature = "csfle")]
-            ErrorKind::Csfle(err) => err.message.clone(),
+            #[cfg(feature = "in-use-encryption-unstable")]
+            ErrorKind::Encryption(err) => err.message.clone(),
             _ => None,
         }
     }
@@ -424,8 +424,8 @@ impl Error {
             | ErrorKind::MissingResumeToken
             | ErrorKind::Authentication { .. }
             | ErrorKind::GridFs(_) => {}
-            #[cfg(feature = "csfle")]
-            ErrorKind::Csfle(_) => {}
+            #[cfg(feature = "in-use-encryption-unstable")]
+            ErrorKind::Encryption(_) => {}
         }
     }
 }
@@ -471,10 +471,10 @@ impl From<std::io::ErrorKind> for ErrorKind {
     }
 }
 
-#[cfg(feature = "csfle")]
+#[cfg(feature = "in-use-encryption-unstable")]
 impl From<mongocrypt::error::Error> for ErrorKind {
     fn from(err: mongocrypt::error::Error) -> Self {
-        Self::Csfle(err)
+        Self::Encryption(err)
     }
 }
 
@@ -575,9 +575,9 @@ pub enum ErrorKind {
     MissingResumeToken,
 
     /// An error occurred during encryption or decryption.
-    #[cfg(feature = "csfle")]
+    #[cfg(feature = "in-use-encryption-unstable")]
     #[error("An error occurred during client-side encryption: {0}")]
-    Csfle(mongocrypt::error::Error),
+    Encryption(mongocrypt::error::Error),
 }
 
 impl ErrorKind {