Merge pull request #177 from matteobortolazzo/dev

v3.3.0

Author: matteobortolazzo

CHANGELOG.md

@@ -1,3 +1,15 @@
+# 3.3.0 (2022-10-20)
+
+## Features
+
+* **Bulk Delete**: Adds support to replication ([#171](https://github.com/matteobortolazzo/couchdb-net/issues/171))
+* **Revision Support**: Support for revisions in add and update ([#170](https://github.com/matteobortolazzo/couchdb-net/pull/170))
+
+## Bug Fixes
+
+* **Replication**: Added replication methods in `ICouchDatabase` interface ([#173](https://github.com/matteobortolazzo/couchdb-net/pull/173))
+* **Document ID**: Support IDs with special characters ([#172](https://github.com/matteobortolazzo/couchdb-net/pull/172))
+* 
 # 3.2.0 (2022-07-03)
 
 ## Features

LATEST_CHANGE.md

@@ -1,13 +1,9 @@
 ## Features
 
-* **Replication**: Adds support to replication ([#151](https://github.com/matteobortolazzo/couchdb-net/pull/151))
-* **Attachments**: Adds DownloadAttachmentAsStreamAsync ([#152](https://github.com/matteobortolazzo/couchdb-net/pull/152))
-* **IsMatch**: Support multiline regex ([#161](https://github.com/matteobortolazzo/couchdb-net/pull/161))
+* **Bulk Delete**: Adds support to replication ([#171](https://github.com/matteobortolazzo/couchdb-net/issues/171))
+* **Revision Support**: Support for revisions in add and update ([#170](https://github.com/matteobortolazzo/couchdb-net/pull/170))
 
 ## Bug Fixes
 
-* **ElementAt**: Fixes query on .NET 6. ([#156](https://github.com/matteobortolazzo/couchdb-net/pull/156))
-* **Attachments**: Fixes attachments in FindAsync. ([#159](https://github.com/matteobortolazzo/couchdb-net/pull/159))
-* **Attachments**: Fixes attachments uploads ([#159](https://github.com/matteobortolazzo/couchdb-net/pull/159))
-* **Attachments**: Fixes Bad Request on attachment upload. ([#164](https://github.com/matteobortolazzo/couchdb-net/pull/164))
-* **GetInfoAsync**: Fixed 32-bit integer overflow. ([#165](https://github.com/matteobortolazzo/couchdb-net/pull/165))
+* **Replication**: Added replication methods in `ICouchDatabase` interface ([#173](https://github.com/matteobortolazzo/couchdb-net/pull/173)) 
+* **Document ID**: Support IDs with special characters ([#172](https://github.com/matteobortolazzo/couchdb-net/pull/172)) 

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();
@@ -389,6 +391,17 @@ string downloadFilePath = await rebels.DownloadAttachment(attachment, downloadFo
 Stream responseStream = await rebels.DownloadAttachmentAsStreamAsync(attachment);
 ```
 
+## Revisions
+
+The options for `FindAsync(..)` and `AddOrUpdateAsync(..)` support passing revision:
+
+```csharp
+await _rebels.FindAsync("1", new FindOptions { Rev = "1-xxx" });
+await _rebels.AddOrUpdateAsync(r, new AddOrUpdateOptions { Rev = "1-xxx" });
+```
+
+For attachements revisions are supported by `CouchAttachment` class which is passing `DocumentRev` to `DownloadAttachmentAsync(..)` and `DownloadAttachmentAsStreamAsync(..)`.
+
 ## DB Changes Feed
 
 The following *feed modes* are supported: `normal`, `longpool` and `continuous`.
@@ -731,14 +744,16 @@ Also, the configurator has `ConfigureFlurlClient` to set custom HTTP client opti
 
 ## Contributors
 
-[Ben Origas](https://github.com/borigas): Features, ideas and tests like SSL custom validation, multi queryable, async deadlock, cookie authenication and many others.
+[Ben Origas](https://github.com/borigas): Features, ideas and tests like SSL custom validation, multi queryable, async deadlock, cookie authentication and many others.
 
 [n9](https://github.com/n9): Proxy authentication, some bug fixes, suggestions and the great feedback on the changes feed feature!
 
 [Marc](https://github.com/bender-ristone): NullValueHandling, bug fixes and suggestions!
 
 [Panos](https://github.com/panoukos41): Help with Views and Table splitting.
 
-[Benjamin Höglinger-Stelzer](https://github.com/nefarius), [mwasson74](https://github.com/mwasson74), [Emre ÇAĞLAR](https://github.com/emrecaglar): Attachments improvments and fixes.
+[Benjamin Höglinger-Stelzer](https://github.com/nefarius), [mwasson74](https://github.com/mwasson74), [Emre ÇAĞLAR](https://github.com/emrecaglar): Attachments improvements and fixes.
+
+[Dhiren Sham](https://github.com/dhirensham): Implementing replication.
 
-[Dhiren Sham](https://github.com/dhirensham): Implementing replication.
+[Dmitriy Larionov](https://github.com/dmlarionov): Revisions improvements.

src/CouchDB.Driver/CouchDatabase.cs

@@ -26,6 +26,7 @@
 using System.Net;
 using System.Text.RegularExpressions;
 using CouchDB.Driver.Views;
+using CouchDB.Driver.DatabaseApiMethodOptions;
 
 namespace CouchDB.Driver
 {
@@ -73,16 +74,20 @@ internal CouchDatabase(IFlurlClient flurlClient, CouchOptions options, QueryCont
         #region Find
 
         /// <inheritdoc />
-        public async Task<TSource?> FindAsync(string docId, bool withConflicts = false,
-            CancellationToken cancellationToken = default)
+        public Task<TSource?> FindAsync(string docId, bool withConflicts = false, CancellationToken cancellationToken = default) 
+            => FindAsync(docId, new FindOptions { Conflicts = withConflicts }, cancellationToken);
+
+        /// <inheritdoc />
+        public async Task<TSource?> FindAsync(string docId, FindOptions options, CancellationToken cancellationToken = default)
         {
             IFlurlRequest request = NewRequest()
-                    .AppendPathSegment(docId);
+                    .AppendPathSegment(Uri.EscapeDataString(docId));
 
-            if (withConflicts)
-            {
+            if (options.Conflicts)
                 request = request.SetQueryParam("conflicts", "true");
-            }
+
+            if (options.Rev != null)
+                request = request.SetQueryParam("rev", options.Rev);
 
             IFlurlResponse? response = await request
                 .AllowHttpStatus(HttpStatusCode.NotFound)
@@ -187,22 +192,24 @@ private void InitAttachments(TSource document)
         #region Writing
 
         /// <inheritdoc />
-        public async Task<TSource> AddAsync(TSource document, bool batch = false, CancellationToken cancellationToken = default)
+        public Task<TSource> AddAsync(TSource document, bool batch = false, CancellationToken cancellationToken = default)
+            => AddAsync(document, new AddOptions { Batch = batch }, cancellationToken);
+
+        /// <inheritdoc />
+        public async Task<TSource> AddAsync(TSource document, AddOptions options, CancellationToken cancellationToken = default)
         {
             Check.NotNull(document, nameof(document));
 
             if (!string.IsNullOrEmpty(document.Id))
             {
-                return await AddOrUpdateAsync(document, batch, cancellationToken)
+                return await AddOrUpdateAsync(document, new AddOrUpdateOptions { Batch = options.Batch }, cancellationToken)
                     .ConfigureAwait(false);
             }
 
             IFlurlRequest request = NewRequest();
 
-            if (batch)
-            {
+            if (options.Batch)
                 request = request.SetQueryParam("batch", "ok");
-            }
 
             document.SplitDiscriminator = _discriminator;
             DocumentSaveResponse response = await request
@@ -219,7 +226,11 @@ await UpdateAttachments(document, cancellationToken)
         }
 
         /// <inheritdoc />
-        public async Task<TSource> AddOrUpdateAsync(TSource document, bool batch = false, CancellationToken cancellationToken = default)
+        public Task<TSource> AddOrUpdateAsync(TSource document, bool batch = false, CancellationToken cancellationToken = default)
+            => AddOrUpdateAsync(document, new AddOrUpdateOptions { Batch = batch }, cancellationToken);
+
+        /// <inheritdoc />
+        public async Task<TSource> AddOrUpdateAsync(TSource document, AddOrUpdateOptions options, CancellationToken cancellationToken = default)
         {
             Check.NotNull(document, nameof(document));
 
@@ -229,12 +240,13 @@ public async Task<TSource> AddOrUpdateAsync(TSource document, bool batch = false
             }
 
             IFlurlRequest request = NewRequest()
-                .AppendPathSegment(document.Id);
+                .AppendPathSegment(Uri.EscapeDataString(document.Id));
 
-            if (batch)
-            {
+            if (options.Batch)
                 request = request.SetQueryParam("batch", "ok");
-            }
+
+            if (options.Rev != null)
+                request = request.SetQueryParam("rev", options.Rev);
 
             document.SplitDiscriminator = _discriminator;
             DocumentSaveResponse response = await request
@@ -256,7 +268,7 @@ public async Task RemoveAsync(TSource document, bool batch = false, Cancellation
             Check.NotNull(document, nameof(document));
 
             IFlurlRequest request = NewRequest()
-                .AppendPathSegment(document.Id);
+                .AppendPathSegment(Uri.EscapeDataString(document.Id));
 
             if (batch)
             {
@@ -307,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)
         {
@@ -336,7 +377,7 @@ private async Task UpdateAttachments(TSource document, CancellationToken cancell
                     new FileStream(attachment.FileInfo.FullName, FileMode.Open));
 
                 AttachmentResult response = await NewRequest()
-                    .AppendPathSegment(document.Id)
+                    .AppendPathSegment(Uri.EscapeDataString(document.Id))
                     .AppendPathSegment(Uri.EscapeUriString(attachment.Name))
                     .WithHeader("Content-Type", attachment.ContentType)
                     .WithHeader("If-Match", document.Rev)
@@ -354,8 +395,8 @@ private async Task UpdateAttachments(TSource document, CancellationToken cancell
             foreach (CouchAttachment attachment in document.Attachments.GetDeletedAttachments())
             {
                 AttachmentResult response = await NewRequest()
-                    .AppendPathSegment(document.Id)
-                    .AppendPathSegment(attachment.Name)
+                    .AppendPathSegment(Uri.EscapeDataString(document.Id))
+                    .AppendPathSegment(Uri.EscapeDataString(attachment.Name))
                     .WithHeader("If-Match", document.Rev)
                     .DeleteAsync(cancellationToken)
                     .ReceiveJson<AttachmentResult>()
@@ -623,7 +664,7 @@ public async Task<Stream> DownloadAttachmentAsStreamAsync(CouchAttachment attach
             }
 
             return await NewRequest()
-                .AppendPathSegment(attachment.DocumentId)
+                .AppendPathSegment(Uri.EscapeDataString(attachment.DocumentId))
                 .AppendPathSegment(Uri.EscapeUriString(attachment.Name))
                 .WithHeader("If-Match", attachment.DocumentRev)
                 .GetStreamAsync(cancellationToken)

src/CouchDB.Driver/DatabaseApiMethodOptions/AddOptions.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CouchDB.Driver.DatabaseApiMethodOptions
+{
+    /// <summary>
+    /// Options relevant to saving a new document (supported by both PUT /{db}/{docid} and POST /{db}).
+    /// Check https://docs.couchdb.org/en/stable/api/database/common.html#post--db
+    /// Check https://docs.couchdb.org/en/stable/api/document/common.html#put--db-docid
+    /// </summary>
+    public class AddOptions
+    {
+        /// <summary>
+        /// Stores document in batch mode. Check https://docs.couchdb.org/en/stable/api/database/common.html#api-doc-batch-writes
+        /// </summary>
+        public bool Batch { get; set; } = false;
+    }
+}

src/CouchDB.Driver/DatabaseApiMethodOptions/AddOrUpdateOptions.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CouchDB.Driver.DatabaseApiMethodOptions
+{
+    /// <summary>
+    /// Options relevant to saving a document (supported by PUT HTTP-method).
+    /// Check https://docs.couchdb.org/en/stable/api/document/common.html#put--db-docid
+    /// </summary>
+    public class AddOrUpdateOptions
+    {
+        /// <summary>
+        /// Stores document in batch mode. Check https://docs.couchdb.org/en/stable/api/database/common.html#api-doc-batch-writes
+        /// </summary>
+        public bool Batch { get; set; } = false;
+
+        /// <summary>
+        /// Document’s revision if updating an existing document.
+        /// </summary>
+        public string? Rev { get; set; }
+    }
+}

src/CouchDB.Driver/DatabaseApiMethodOptions/FindOptions.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CouchDB.Driver.DatabaseApiMethodOptions
+{
+    /// <summary>
+    /// Options relevant to getting a document (supported by GET HTTP-method).
+    /// Check https://docs.couchdb.org/en/stable/api/document/common.html#get--db-docid
+    /// </summary>
+    public class FindOptions
+    {
+        /// <summary>
+        /// Includes information about conflicts in document. Default is false
+        /// </summary>
+        public bool Conflicts { get; set; } = false;
+
+        /// <summary>
+        /// Retrieves document of specified revision. Optional
+        /// </summary>
+        public string? Rev { get; set; }
+    }
+}

src/CouchDB.Driver/ICouchClient.cs

@@ -164,6 +164,30 @@ Task<ICouchDatabase<TSource>> GetOrCreateDatabaseAsync<TSource>(int? shards = nu
         /// <returns>A task that represents the asynchronous operation. The task result contains the sequence of all active tasks.</returns>
         Task<IEnumerable<CouchActiveTask>> GetActiveTasksAsync(CancellationToken cancellationToken = default);
 
+        /// <summary>
+        /// Configures a database replication operation.
+        /// </summary>
+        /// <param name="source">Fully qualified source database URL or an object which contains the full URL of the source database with additional parameters like headers.</param>
+        /// <param name="target">Fully qualified target database URL or an object which contains the full URL of the target database with additional parameters like headers.</param>
+        /// <param name="replication">An instance of <see cref="CouchReplication"/>.</param>
+        /// <param name="persistent">Persist the operation to the replication database.</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
+        /// <returns>Returns True if the operation succeeded, False otherwise.</returns>
+        Task<bool> ReplicateAsync(string source, string target, CouchReplication? replication = null,
+            bool persistent = true, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Removes a database replication operation.
+        /// </summary>
+        /// <param name="source">Fully qualified source database URL or an object which contains the full URL of the source database with additional parameters like headers.</param>
+        /// <param name="target">Fully qualified target database URL or an object which contains the full URL of the target database with additional parameters like headers.</param>
+        /// <param name="replication">An instance of <see cref="CouchReplication"/>.</param>
+        /// <param name="persistent"></param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
+        /// <returns>Returns True if the operation succeeded, False otherwise.</returns>
+        Task<bool> RemoveReplicationAsync(string source, string target, CouchReplication? replication = null,
+            bool persistent = true, CancellationToken cancellationToken = default);
+
         /// <summary>
         /// Get the database name for the given type.
         /// </summary>