matteobortolazzo#171 - Support bulk delete

Author: matteobortolazzo

README.md

@@ -277,6 +277,8 @@ var list = await rebels.QueryAsync(someMangoJson);
 var list = await rebels.QueryAsync(someMangoObject);
 // Bulk
 await rebels.AddOrUpdateRangeAsync(moreRebels);
+await rebels.DeleteRangeAsync(ids);
+await rebels.DeleteRangeAsync(moreRebels);
 // Utils
 await rebels.CompactAsync();
 var info = await rebels.GetInfoAsync();

src/CouchDB.Driver/CouchDatabase.cs

@@ -319,6 +319,35 @@ await UpdateAttachments(document, cancellationToken)
             return documents;
         }
 
+        /// <inheritdoc />
+        public Task DeleteRangeAsync(IEnumerable<TSource> documents, CancellationToken cancellationToken = default)
+        {
+            DocumentId[] docIds = documents.Cast<DocumentId>().ToArray();
+            return DeleteRangeAsync(docIds, cancellationToken);
+        }
+
+        /// <inheritdoc />
+        public async Task DeleteRangeAsync(IEnumerable<DocumentId> documentIds, CancellationToken cancellationToken = default)
+        {
+            Check.NotNull(documentIds, nameof(documentIds));
+
+            var documents = documentIds
+                .Select(docId => new
+                {
+                    _id = docId.Id,
+                    _rev = docId.Rev,
+                    _deleted = true
+                })
+                .ToArray();
+
+            await NewRequest()
+                .AppendPathSegment("_bulk_docs")
+                .PostJsonAsync(new { docs = documents }, cancellationToken)
+                .ReceiveJson<DocumentSaveResponse[]>()
+                .SendRequestAsync()
+                .ConfigureAwait(false);
+        }
+
         /// <inheritdoc />
         public async Task EnsureFullCommitAsync(CancellationToken cancellationToken = default)
         {

src/CouchDB.Driver/ICouchDatabase.cs

@@ -118,6 +118,22 @@ public interface ICouchDatabase<TSource>: IOrderedQueryable<TSource>
         /// <returns>A task that represents the asynchronous operation. The task result contains the elements created or updated.</returns>
         Task<IEnumerable<TSource>> AddOrUpdateRangeAsync(IList<TSource> documents, CancellationToken cancellationToken = default);
 
+        /// <summary>
+        /// Delete multiple documents based on their ID and revision.
+        /// </summary>
+        /// <param name="documents">The documents to delete.</param>
+        /// <param name="cancellationToken"> <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
+        /// <returns>A task that represents the asynchronous operation.</returns>
+        Task DeleteRangeAsync(IEnumerable<TSource> documents, CancellationToken cancellationToken = default);
+        
+        /// <summary>
+        /// Delete multiple documents based on their ID and revision.
+        /// </summary>
+        /// <param name="documentIds">Documents to delete</param>
+        /// <param name="cancellationToken"> <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
+        /// <returns>A task that represents the asynchronous operation.</returns>
+        Task DeleteRangeAsync(IEnumerable<DocumentId> documentIds, CancellationToken cancellationToken = default);
+        
         /// <summary>
         /// Executes the specified view function from the specified design document.
         /// </summary>

src/CouchDB.Driver/Types/DocumentId.cs

@@ -0,0 +1,26 @@
+using CouchDB.Driver.Types;
+
+namespace CouchDB.Driver;
+
+public class DocumentId
+{
+    public DocumentId(string id, string rev)
+    {
+        Id = id;
+        Rev = rev;
+    }
+
+    public DocumentId(CouchDocument document)
+    {
+        Id = document.Id;
+        Rev = document.Rev;
+    }
+        
+    public string Id { get; }
+    public string Rev { get; }
+        
+    public static implicit operator DocumentId(CouchDocument documentId)
+    {
+        return new DocumentId(documentId.Id,  documentId.Rev);
+    }
+}

src/azure-pipelines.yaml

@@ -1,6 +1,6 @@
 variables:
   BuildConfiguration: Release
-  PackageVersion: '3.2.0'
+  PackageVersion: '3.3.0'
 
 trigger:
   branches:

tests/CouchDB.Driver.UnitTests/Database_Tests.cs

@@ -3,6 +3,7 @@
 using Flurl.Http.Testing;
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net.Http;
 using System.Threading.Tasks;
 using CouchDB.Driver.Extensions;
@@ -357,6 +358,50 @@ public async Task AddOrUpdateRange()
                 .ShouldHaveCalled("http://localhost/rebels/_bulk_docs")
                 .WithVerb(HttpMethod.Post);
         }
+        
+        [Fact]
+        public async Task DeleteRange()
+        {
+            using var httpTest = new HttpTest();
+            // Response
+            httpTest.RespondWithJson(new[] {
+                new { Id = "111", Ok = true, Rev = "111" },
+                new { Id = "222", Ok = true, Rev = "222" },
+            });
+            // Logout
+            httpTest.RespondWithJson(new { ok = true });
+
+            var moreRebels = new[] {
+                new Rebel { Name = "Luke", Id = "1" },
+                new Rebel { Name = "Leia", Id = "2" }
+            }.Cast<DocumentId>().ToArray();
+            await _rebels.DeleteRangeAsync(moreRebels);
+            httpTest
+                .ShouldHaveCalled("http://localhost/rebels/_bulk_docs")
+                .WithVerb(HttpMethod.Post);
+        }
+        
+        [Fact]
+        public async Task DeleteRange_Docs()
+        {
+            using var httpTest = new HttpTest();
+            // Response
+            httpTest.RespondWithJson(new[] {
+                new { Id = "111", Ok = true, Rev = "111" },
+                new { Id = "222", Ok = true, Rev = "222" },
+            });
+            // Logout
+            httpTest.RespondWithJson(new { ok = true });
+
+            var moreRebels = new[] {
+                new Rebel { Name = "Luke", Id = "1" },
+                new Rebel { Name = "Leia", Id = "2" }
+            };
+            await _rebels.DeleteRangeAsync(moreRebels);
+            httpTest
+                .ShouldHaveCalled("http://localhost/rebels/_bulk_docs")
+                .WithVerb(HttpMethod.Post);
+        }
 
         #endregion