Merge pull request #21 from Filify-app/feature/delete_document

Allow user to delete documents in Firestore

src/firestore/client/mod.rs

@@ -8,7 +8,8 @@ use firestore_grpc::v1::firestore_client::FirestoreClient as GrpcFirestoreClient
 use firestore_grpc::v1::run_query_request::QueryType;
 use firestore_grpc::v1::structured_query::CollectionSelector;
 use firestore_grpc::v1::{
-    CreateDocumentRequest, DocumentMask, RunQueryRequest, StructuredQuery, UpdateDocumentRequest,
+    CreateDocumentRequest, DeleteDocumentRequest, DocumentMask, RunQueryRequest, StructuredQuery,
+    UpdateDocumentRequest,
 };
 use firestore_grpc::{
     tonic::{
@@ -485,6 +486,57 @@ impl FirestoreClient {
         Ok(deserialized)
     }
 
+    /// Deletes a document from the database. Whether the document exists or not
+    /// makes no difference.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # #[tokio::main]
+    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    /// # let mut client = fireplace::firestore::test_helpers::initialise().await.unwrap();
+    /// use fireplace::firestore::collection;
+    /// use ulid::Ulid;
+    ///
+    /// let doc_ref = collection("pokemon").doc("pikachu");
+    ///
+    /// client
+    ///     .set_document(&doc_ref, &serde_json::json!({ "name": "Pikachu" }))
+    ///     .await?;
+    ///
+    /// client.delete_document(&doc_ref).await?;
+    ///
+    /// assert_eq!(
+    ///     client.get_document::<serde_json::Value>(&doc_ref).await?,
+    ///     None
+    /// );
+    ///
+    /// // We can also just "delete" non-existing documents without error
+    /// client
+    ///     .delete_document(&collection("pokemon").doc(Ulid::new()))
+    ///     .await?;
+    /// # Ok(())
+    /// # }
+    /// ```
+    pub async fn delete_document(
+        &mut self,
+        doc_ref: &DocumentReference,
+    ) -> Result<(), FirebaseError> {
+        let name = self.get_name_with(doc_ref);
+
+        let request = DeleteDocumentRequest {
+            name,
+            current_document: None,
+        };
+
+        self.client
+            .delete_document(request)
+            .await
+            .context("Failed to delete document")?;
+
+        Ok(())
+    }
+
     /// Query a collection for documents that fulfill the given criteria.
     ///
     /// Returns a [`Stream`](futures::stream::Stream) of query results,