[DEVEX-222] Added Tombstone method with options and made the old obsolete

Author: oskardudycz

src/KurrentDB.Client/Streams/KurrentDBClient.Delete.cs

@@ -52,7 +52,8 @@ CancellationToken cancellationToken
 
 	public class DeleteOptions : OperationOptions;
 
-	public static class KurrentDBClientObsoleteDeleteExtensions {
+	[Obsolete("Those extensions may be removed in the future versions", false)]
+	public static class ObsoleteKurrentDBClientDeleteExtensions {
 		/// <summary>
 		/// Deletes a stream asynchronously.
 		/// </summary>

src/KurrentDB.Client/Streams/KurrentDBClient.Tombstone.cs

@@ -8,32 +8,80 @@ public partial class KurrentDBClient {
 		/// </summary>
 		/// <param name="streamName">The name of the stream to tombstone.</param>
 		/// <param name="expectedState">The expected <see cref="StreamState"/> of the stream being deleted.</param>
-		/// <param name="deadline"></param>
-		/// <param name="userCredentials">The optional <see cref="UserCredentials"/> to perform operation with.</param>
+		/// <param name="options">Optional settings for the tombstone operation, e.g. deadline, user credentials etc.</param>
 		/// <param name="cancellationToken">The optional <see cref="System.Threading.CancellationToken"/>.</param>
 		/// <returns></returns>
 		public Task<DeleteResult> TombstoneAsync(
 			string streamName,
 			StreamState expectedState,
-			TimeSpan? deadline = null,
-			UserCredentials? userCredentials = null,
-			CancellationToken cancellationToken = default) => TombstoneInternal(new TombstoneReq {
-			Options = new TombstoneReq.Types.Options {
-				StreamIdentifier = streamName
-			}
-		}.WithAnyStreamRevision(expectedState), deadline, userCredentials, cancellationToken);
+			TombstoneOptions? options = null,
+			CancellationToken cancellationToken = default
+		) =>
+			TombstoneInternal(
+				new TombstoneReq {
+					Options = new TombstoneReq.Types.Options {
+						StreamIdentifier = streamName
+					}
+				}.WithAnyStreamRevision(expectedState),
+				options,
+				cancellationToken
+			);
 
-		private async Task<DeleteResult> TombstoneInternal(TombstoneReq request, TimeSpan? deadline,
-			UserCredentials? userCredentials, CancellationToken cancellationToken) {
+		async Task<DeleteResult> TombstoneInternal(
+			TombstoneReq request,
+			TombstoneOptions? options,
+			CancellationToken cancellationToken
+		) {
 			_log.LogDebug("Tombstoning stream {streamName}.", request.Options.StreamIdentifier);
 
 			var channelInfo = await GetChannelInfo(cancellationToken).ConfigureAwait(false);
-			using var call = new EventStore.Client.Streams.Streams.StreamsClient(
-				channelInfo.CallInvoker).TombstoneAsync(request,
-				KurrentDBCallOptions.CreateNonStreaming(Settings, deadline, userCredentials, cancellationToken));
+			using var call = new Streams.StreamsClient(channelInfo.CallInvoker).TombstoneAsync(
+				request,
+				KurrentDBCallOptions.CreateNonStreaming(
+					Settings,
+					options?.Deadline,
+					options?.UserCredentials,
+					cancellationToken
+				)
+			);
+
 			var result = await call.ResponseAsync.ConfigureAwait(false);
 
 			return new DeleteResult(new Position(result.Position.CommitPosition, result.Position.PreparePosition));
 		}
 	}
+
+	[Obsolete("Those extensions may be removed in the future versions", false)]
+	public static class ObsoleteKurrentDBClientTombstoneExtensions {
+		/// <summary>
+		/// Tombstones a stream asynchronously. Note: Tombstoned streams can never be recreated.
+		/// </summary>
+		/// <param name="dbClient"></param>
+		/// <param name="streamName">The name of the stream to tombstone.</param>
+		/// <param name="expectedState">The expected <see cref="StreamState"/> of the stream being deleted.</param>
+		/// <param name="deadline"></param>
+		/// <param name="userCredentials">The optional <see cref="UserCredentials"/> to perform operation with.</param>
+		/// <param name="cancellationToken">The optional <see cref="System.Threading.CancellationToken"/>.</param>
+		/// <returns></returns>
+		[Obsolete(
+			"This method may be removed in future releases. Use the overload with TombstoneOptions parameter",
+			false
+		)]
+		public static Task<DeleteResult> TombstoneAsync(
+			KurrentDBClient dbClient,
+			string streamName,
+			StreamState expectedState,
+			TimeSpan? deadline = null,
+			UserCredentials? userCredentials = null,
+			CancellationToken cancellationToken = default
+		) =>
+			dbClient.TombstoneAsync(
+				streamName,
+				expectedState,
+				new TombstoneOptions { Deadline = deadline, UserCredentials = userCredentials },
+				cancellationToken
+			);
+	}
+
+	public class TombstoneOptions : OperationOptions;
 }

test/KurrentDB.Client.Tests/Security/SecurityFixture.cs

@@ -258,6 +258,6 @@ await Streams.SetStreamMetadataAsync(
 	}
 
 	public Task<DeleteResult> DeleteStream(string streamId, UserCredentials? userCredentials = null) =>
-		Streams.TombstoneAsync(streamId, StreamState.Any, userCredentials: userCredentials)
+		Streams.TombstoneAsync(streamId, StreamState.Any, new TombstoneOptions { UserCredentials = userCredentials })
 			.WithTimeout(TimeSpan.FromMilliseconds(TimeoutMs));
 }

test/KurrentDB.Client.Tests/Streams/DeleteTests.cs

@@ -113,7 +113,11 @@ public async Task with_timeout_stream_revision_delete_fails_when_operation_expir
 	public async Task with_timeout_any_stream_revision_tombstoning_fails_when_operation_expired() {
 		var stream = Fixture.GetStreamName();
 		var rpcException = await Assert.ThrowsAsync<RpcException>(
-			() => Fixture.Streams.TombstoneAsync(stream, StreamState.Any, TimeSpan.Zero)
+			() => Fixture.Streams.TombstoneAsync(
+				stream,
+				StreamState.Any,
+				new TombstoneOptions { Deadline = TimeSpan.Zero }
+			)
 		);
 
 		Assert.Equal(StatusCode.DeadlineExceeded, rpcException.StatusCode);
@@ -124,7 +128,11 @@ public async Task with_timeout_stream_revision_tombstoning_fails_when_operation_
 		var stream = Fixture.GetStreamName();
 
 		var rpcException = await Assert.ThrowsAsync<RpcException>(
-			() => Fixture.Streams.TombstoneAsync(stream, StreamState.StreamRevision(0), TimeSpan.Zero)
+			() => Fixture.Streams.TombstoneAsync(
+				stream,
+				StreamState.StreamRevision(0),
+				new TombstoneOptions { Deadline = TimeSpan.Zero }
+			)
 		);
 
 		Assert.Equal(StatusCode.DeadlineExceeded, rpcException.StatusCode);