RUST-2090/gridfs helpers (#1351)

Author: abr-egn

src/action/gridfs.rs

@@ -7,9 +7,9 @@ mod find;
 mod rename;
 mod upload;
 
-pub use delete::Delete;
+pub use delete::{Delete, DeleteByName};
 pub use download::{OpenDownloadStream, OpenDownloadStreamByName};
 pub use drop::Drop;
 pub use find::{Find, FindOne};
-pub use rename::Rename;
+pub use rename::{Rename, RenameByName};
 pub use upload::OpenUploadStream;

src/action/gridfs/delete.rs

@@ -17,6 +17,18 @@ impl GridFsBucket {
     pub fn delete(&self, id: Bson) -> Delete {
         Delete { bucket: self, id }
     }
+
+    /// Deletes the [`FilesCollectionDocument`] with the given name and its associated chunks from
+    /// this bucket. This method returns an error if the name does not match any files in the
+    /// bucket.
+    ///
+    /// `await` will return [`Result<()>`].
+    pub fn delete_by_name(&self, filename: impl Into<String>) -> DeleteByName {
+        DeleteByName {
+            bucket: self,
+            filename: filename.into(),
+        }
+    }
 }
 
 #[cfg(feature = "sync")]
@@ -29,6 +41,15 @@ impl crate::sync::gridfs::GridFsBucket {
     pub fn delete(&self, id: Bson) -> Delete {
         self.async_bucket.delete(id)
     }
+
+    /// Deletes the [`FilesCollectionDocument`] with the given name and its associated chunks from
+    /// this bucket. This method returns an error if the name does not match any files in the
+    /// bucket.
+    ///
+    /// [`run`](DeleteByName::run) will return [`Result<()>`].
+    pub fn delete_by_name(&self, filename: impl Into<String>) -> DeleteByName {
+        self.async_bucket.delete_by_name(filename)
+    }
 }
 
 /// Deletes a specific [`FilesCollectionDocument`] and its associated chunks.  Construct with
@@ -66,3 +87,55 @@ impl<'a> Action for Delete<'a> {
         Ok(())
     }
 }
+
+/// Deletes a named [`FilesCollectionDocument`] and its associated chunks.  Construct with
+/// [`GridFsBucket::delete_by_name`].
+#[must_use]
+pub struct DeleteByName<'a> {
+    bucket: &'a GridFsBucket,
+    filename: String,
+}
+
+#[action_impl]
+impl<'a> Action for DeleteByName<'a> {
+    type Future = DeleteByNameFuture;
+
+    async fn execute(self) -> Result<()> {
+        use futures_util::stream::{StreamExt, TryStreamExt};
+        let ids: Vec<_> = self
+            .bucket
+            .files()
+            .find(doc! { "filename": self.filename.clone() })
+            .projection(doc! { "_id": 1 })
+            .await?
+            .with_type::<bson::Document>()
+            .map(|r| match r {
+                Ok(mut d) => d
+                    .remove("_id")
+                    .ok_or_else(|| crate::error::Error::internal("_id field expected")),
+                Err(e) => Err(e),
+            })
+            .try_collect()
+            .await?;
+
+        let count = self
+            .bucket
+            .files()
+            .delete_many(doc! { "_id": { "$in": ids.clone() } })
+            .await?
+            .deleted_count;
+        self.bucket
+            .chunks()
+            .delete_many(doc! { "files_id": { "$in": ids } })
+            .await?;
+
+        if count == 0 {
+            return Err(ErrorKind::GridFs(GridFsErrorKind::FileNotFound {
+                identifier: GridFsFileIdentifier::Filename(self.filename),
+            })
+            .into());
+        }
+
+        Ok(())
+    }
+}

src/action/gridfs/rename.rs

@@ -1,6 +1,10 @@
 use bson::{doc, Bson};
 
-use crate::{action::action_impl, error::Result, gridfs::GridFsBucket};
+use crate::{
+    action::action_impl,
+    error::{ErrorKind, GridFsErrorKind, GridFsFileIdentifier, Result},
+    gridfs::GridFsBucket,
+};
 
 impl GridFsBucket {
     /// Renames the file with the given 'id' to the provided `new_filename`. This method returns an
@@ -14,6 +18,22 @@ impl GridFsBucket {
             new_filename: new_filename.into(),
         }
     }
+
+    /// Renames all revisions of the file with the given name to the provided `new_filename`. This
+    /// method returns an error if the name does not match any files in the bucket.
+    ///
+    /// `await` will return [`Result<()>`].
+    pub fn rename_by_name(
+        &self,
+        filename: impl Into<String>,
+        new_filename: impl Into<String>,
+    ) -> RenameByName {
+        RenameByName {
+            bucket: self,
+            filename: filename.into(),
+            new_filename: new_filename.into(),
+        }
+    }
 }
 
 #[cfg(feature = "sync")]
@@ -25,6 +45,18 @@ impl crate::sync::gridfs::GridFsBucket {
     pub fn rename(&self, id: Bson, new_filename: impl Into<String>) -> Rename {
         self.async_bucket.rename(id, new_filename)
     }
+
+    /// Renames all revisions of the file with the given name to the provided `new_filename`. This
+    /// method returns an error if the name does not match any files in the bucket.
+    ///
+    /// [`run`](RenameByName::run) will return [`Result<()>`].
+    pub fn rename_by_name(
+        &self,
+        filename: impl Into<String>,
+        new_filename: impl Into<String>,
+    ) -> RenameByName {
+        self.async_bucket.rename_by_name(filename, new_filename)
+    }
 }
 
 /// Renames a file.  Construct with [`GridFsBucket::rename`].
@@ -51,3 +83,36 @@ impl<'a> Action for Rename<'a> {
         Ok(())
     }
 }
+
+/// Renames a file selected by name.  Construct with [`GridFsBucket::rename_by_name`].
+#[must_use]
+pub struct RenameByName<'a> {
+    bucket: &'a GridFsBucket,
+    filename: String,
+    new_filename: String,
+}
+
+#[action_impl]
+impl<'a> Action for RenameByName<'a> {
+    type Future = RenameByNameFuture;
+
+    async fn execute(self) -> Result<()> {
+        let count = self
+            .bucket
+            .files()
+            .update_many(
+                doc! { "filename": self.filename.clone() },
+                doc! { "$set": { "filename": self.new_filename } },
+            )
+            .await?
+            .matched_count;
+        if count == 0 {
+            return Err(ErrorKind::GridFs(GridFsErrorKind::FileNotFound {
+                identifier: GridFsFileIdentifier::Filename(self.filename),
+            })
+            .into());
+        }
+
+        Ok(())
+    }
+}

src/test/spec/json/gridfs/delete.json

@@ -497,7 +497,7 @@
             }
           },
           "expectError": {
-            "isError": true
+            "isClientError": true
           }
         }
       ],
@@ -650,7 +650,7 @@
             }
           },
           "expectError": {
-            "isError": true
+            "isClientError": true
           }
         }
       ],

src/test/spec/json/gridfs/delete.yml

@@ -141,7 +141,7 @@ tests:
         object: *bucket0
         arguments:
           id: { $oid: "000000000000000000000000" }
-        expectError: { isError: true } # FileNotFound
+        expectError: { isClientError: true } # FileNotFound
     outcome:
       - collectionName: *bucket0_files_collectionName
         databaseName: *database0Name
@@ -170,7 +170,7 @@ tests:
         object: *bucket0
         arguments:
           id: { $oid: "000000000000000000000004" }
-        expectError: { isError: true } # FileNotFound
+        expectError: { isClientError: true } # FileNotFound
     outcome:
       - collectionName: *bucket0_files_collectionName
         databaseName: *database0Name