Merge pull request #232 from zeebe-io/zell-send-with-retry

chore(client): introduce new interface for sendWithRetry

Client/Api/Commands/ICancelWorkflowInstanceCommandStep1.cs

@@ -2,7 +2,7 @@
 
 namespace Zeebe.Client.Api.Commands
 {
-    public interface ICancelWorkflowInstanceCommandStep1 : IFinalCommandStep<ICancelWorkflowInstanceResponse>
+    public interface ICancelWorkflowInstanceCommandStep1 : IFinalCommandWithRetryStep<ICancelWorkflowInstanceResponse>
     {
         // the place for new optional parameters
     }

Client/Api/Commands/IFinalCommandStep.cs

@@ -39,26 +39,5 @@ public interface IFinalCommandStep<T>
         /// <param name="timeout">the time span after request should be timed out</param>
         /// <returns>a task tracking state of success/failure of the command.</returns>
         Task<T> Send(TimeSpan? timeout = null);
-
-        /// <summary>
-        /// Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the
-        /// task returns the event that was generated by the Zeebe broker in response to the command.
-        /// If the sending of the command fails, because of broker back pressure or network issues the request is
-        /// retried until the command succeeds. The wait time between retries can be configured on the
-        /// ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds
-        /// etc. until it reaches the maximum of one minute.
-        ///
-        /// <para>Use <c>await ...SendWithRetry();</c> to wait until the response is available.</para>
-        ///
-        /// <example>
-        /// <code>
-        /// T response = await command.SendWithRetry();
-        /// </code>
-        /// </example>
-        /// </summary>
-        ///
-        /// <param name="timeout">the time span after request should be timed out</param>
-        /// <returns>a task tracking state of success/failure of the command.</returns>
-        Task<T> SendWithRetry(TimeSpan? timeout = null);
     }
 }

Client/Api/Commands/IFinalCommandWithRetryStep.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Threading.Tasks;
+
+namespace Zeebe.Client.Api.Commands
+{
+    public interface IFinalCommandWithRetryStep<T> : IFinalCommandStep<T>
+    {
+        /// <summary>
+        /// Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the
+        /// task returns the event that was generated by the Zeebe broker in response to the command.
+        /// If the sending of the command fails, because of broker back pressure or network issues the request is
+        /// retried until the command succeeds. The wait time between retries can be configured on the
+        /// ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds
+        /// etc. until it reaches the maximum of one minute.
+        ///
+        /// <para>Use <c>await ...SendWithRetry();</c> to wait until the response is available.</para>
+        ///
+        /// <example>
+        /// <code>
+        /// T response = await command.SendWithRetry();
+        /// </code>
+        /// </example>
+        /// </summary>
+        ///
+        /// <param name="timeout">the time span after request should be timed out</param>
+        /// <returns>a task tracking state of success/failure of the command.</returns>
+        Task<T> SendWithRetry(TimeSpan? timeout = null);
+    }
+}

Client/Impl/Commands/CompleteJobCommand.cs

@@ -48,10 +48,5 @@ public async Task<ICompleteJobResponse> Send(TimeSpan? timeout = null)
             await asyncReply.ResponseAsync;
             return new Responses.CompleteJobResponse();
         }
-
-        public Task<ICompleteJobResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/CreateWorkflowInstanceCommand.cs

@@ -65,10 +65,5 @@ public async Task<IWorkflowInstanceResponse> Send(TimeSpan? timeout = null)
             var response = await asyncReply.ResponseAsync;
             return new WorkflowInstanceResponse(response);
         }
-
-        public Task<IWorkflowInstanceResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/CreateWorkflowInstanceCommandWithResult.cs

@@ -51,10 +51,5 @@ public async Task<IWorkflowInstanceResult> Send(TimeSpan? timeout = null)
             var response = await asyncReply.ResponseAsync;
             return new WorkflowInstanceResultResponse(response);
         }
-
-        public Task<IWorkflowInstanceResult> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/DeployWorkflowCommand.cs

@@ -86,10 +86,5 @@ private void AddWorkflow(ByteString resource, string resourceName)
 
             request.Workflows.Add(requestObject);
         }
-
-        public Task<IDeployResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/FailJobCommand.cs

@@ -55,10 +55,5 @@ public async Task<IFailJobResponse> Send(TimeSpan? timeout = null)
             await asyncReply.ResponseAsync;
             return new FailJobResponse();
         }
-
-        public Task<IFailJobResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/PublishMessageCommand.cs

@@ -70,10 +70,5 @@ public async Task<IPublishMessageResponse> Send(TimeSpan? timeout = null)
             await asyncReply.ResponseAsync;
             return new PublishMessageResponse();
         }
-
-        public Task<IPublishMessageResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/ResolveIncidentCommand.cs

@@ -27,10 +27,5 @@ public async Task<IResolveIncidentResponse> Send(TimeSpan? timeout = null)
             await asyncReply.ResponseAsync;
             return new ResolveIncidentResponse();
         }
-
-        public Task<IResolveIncidentResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/SetVariablesCommand.cs

@@ -39,10 +39,5 @@ public async Task<ISetVariablesResponse> Send(TimeSpan? timeout = null)
             var response = await asyncReply.ResponseAsync;
             return new SetVariablesResponse(response);
         }
-
-        public Task<ISetVariablesResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/ThrowErrorCommand.cs

@@ -54,10 +54,5 @@ public async Task<IThrowErrorResponse> Send(TimeSpan? timeout = null)
             await asyncReply.ResponseAsync;
             return new Responses.ThrowErrorResponse();
         }
-
-        public Task<IThrowErrorResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/TopologyRequestCommand.cs

@@ -39,10 +39,5 @@ public async Task<ITopology> Send(TimeSpan? timeout = null)
 
             return new Topology(response);
         }
-
-        public Task<ITopology> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/Impl/Commands/UpdateRetriesCommand.cs

@@ -33,10 +33,5 @@ public async Task<IUpdateRetriesResponse> Send(TimeSpan? timeout = null)
             await asyncReply.ResponseAsync;
             return new UpdateRetriesResponse();
         }
-
-        public Task<IUpdateRetriesResponse> SendWithRetry(TimeSpan? timespan = null)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Client/ZeebeClient.cs

@@ -66,7 +66,6 @@ internal ZeebeClient(string address,
                 new Channel(address, credentials, channelOptions);
             gatewayClient = new Gateway.GatewayClient(channelToGateway);
 
-
             asyncRetryStrategy =
                 new TransientGrpcErrorRetryStrategy(sleepDurationProvider ??
                                                     DefaultWaitTimeProvider);