Remove methods in service classes which are non cancellable (#113)

reportportal · Mar 7, 2023 · 4e58da0 · 4e58da0
1 parent 8b3f163
commit 4e58da0
Show file tree

Hide file tree

Showing 18 changed files with 120 additions and 516 deletions.
diff --git a/src/ReportPortal.Client/Abstractions/Resources/IAsyncLaunchResource.cs b/src/ReportPortal.Client/Abstractions/Resources/IAsyncLaunchResource.cs
@@ -15,33 +15,24 @@ public interface IAsyncLaunchResource
         /// </summary>
         /// <param name="uuid">UUID of specified launch.</param>
         /// <param name="request">Information about representation of launch to finish.</param>
-        /// <returns>A message from service.</returns>
-        Task<LaunchFinishedResponse> FinishAsync(string uuid, FinishLaunchRequest request);
-
-        /// <inheritdoc cref="FinishAsync(string, FinishLaunchRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchFinishedResponse> FinishAsync(string uuid, FinishLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<LaunchFinishedResponse> FinishAsync(string uuid, FinishLaunchRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Asynchronously merge several launches.
         /// </summary>
         /// <param name="request">Request for merging.</param>
-        /// <returns>Returns the model of merged launches.</returns>
-        Task<LaunchResponse> MergeAsync(MergeLaunchesRequest request);
-
-        /// <inheritdoc cref="MergeAsync(MergeLaunchesRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchResponse> MergeAsync(MergeLaunchesRequest request, CancellationToken cancellationToken);
+        /// <returns>Returns the model of merged launches.</returns>
+        Task<LaunchResponse> MergeAsync(MergeLaunchesRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Asynchronously starts new launch.
         /// </summary>
         /// <param name="request">Information about launch.</param>
-        /// <returns>Information about started launch.</returns>
-        Task<LaunchCreatedResponse> StartAsync(StartLaunchRequest request);
-
-        /// <inheritdoc cref="StartAsync(StartLaunchRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchCreatedResponse> StartAsync(StartLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>Information about started launch.</returns>
+        Task<LaunchCreatedResponse> StartAsync(StartLaunchRequest request, CancellationToken cancellationToken = default);
     }
 }
diff --git a/src/ReportPortal.Client/Abstractions/Resources/IAsyncLogItemResource.cs b/src/ReportPortal.Client/Abstractions/Resources/IAsyncLogItemResource.cs
@@ -14,22 +14,16 @@ public interface IAsyncLogItemResource
         /// Asynchronously creates a new log item.
         /// </summary>
         /// <param name="request">Information about representation of log item.</param>
-        /// <returns>Representation of just created log item.</returns>
-        Task<LogItemCreatedResponse> CreateAsync(CreateLogItemRequest request);
-
-        /// <inheritdoc cref="CreateAsync(CreateLogItemRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LogItemCreatedResponse> CreateAsync(CreateLogItemRequest request, CancellationToken cancellationToken);
+        /// <returns>Representation of just created log item.</returns>
+        Task<LogItemCreatedResponse> CreateAsync(CreateLogItemRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Asynchronously creates a new log item.
         /// </summary>
         /// <param name="requests">Information about representation of log item.</param>
-        /// <returns>Representation of just created log item.</returns>
-        Task<LogItemsCreatedResponse> CreateAsync(CreateLogItemRequest[] requests);
-
-        /// <inheritdoc cref="CreateAsync(CreateLogItemRequest[])"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LogItemsCreatedResponse> CreateAsync(CreateLogItemRequest[] requests, CancellationToken cancellationToken);
+        /// <returns>Representation of just created log item.</returns>
+        Task<LogItemsCreatedResponse> CreateAsync(CreateLogItemRequest[] requests, CancellationToken cancellationToken = default);
     }
 }
diff --git a/src/ReportPortal.Client/Abstractions/Resources/IAsyncTestItemResource.cs b/src/ReportPortal.Client/Abstractions/Resources/IAsyncTestItemResource.cs
@@ -15,34 +15,25 @@ public interface IAsyncTestItemResource
         /// </summary>
         /// <param name="uuid">ID of specified test item.</param>
         /// <param name="request">Information about representation of test item to finish.</param>
-        /// <returns>A message from service.</returns>
-        Task<MessageResponse> FinishAsync(string uuid, FinishTestItemRequest request);
-
-        /// <inheritdoc cref="FinishAsync(string, FinishTestItemRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<MessageResponse> FinishAsync(string uuid, FinishTestItemRequest request, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<MessageResponse> FinishAsync(string uuid, FinishTestItemRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Asynchronously creates a new test item.
         /// </summary>
         /// <param name="request">Information about representation of test item.</param>
-        /// <returns>Representation of created test item.</returns>
-        Task<TestItemCreatedResponse> StartAsync(StartTestItemRequest request);
-
-        /// <inheritdoc cref="StartAsync(StartTestItemRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<TestItemCreatedResponse> StartAsync(StartTestItemRequest request, CancellationToken cancellationToken);
+        /// <returns>Representation of created test item.</returns>
+        Task<TestItemCreatedResponse> StartAsync(StartTestItemRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Asynchronously creates a new test item.
         /// </summary>
         /// <param name="uuid">UUID of parent item.</param>
         /// <param name="model">Information about representation of test item.</param>
-        /// <returns>Representation of created test item.</returns>
-        Task<TestItemCreatedResponse> StartAsync(string uuid, StartTestItemRequest model);
-
-        /// <inheritdoc cref="StartAsync(string, StartTestItemRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<TestItemCreatedResponse> StartAsync(string uuid, StartTestItemRequest model, CancellationToken cancellationToken);
+        /// <returns>Representation of created test item.</returns>
+        Task<TestItemCreatedResponse> StartAsync(string uuid, StartTestItemRequest model, CancellationToken cancellationToken = default);
     }
 }
diff --git a/src/ReportPortal.Client/Abstractions/Resources/ILaunchResource.cs b/src/ReportPortal.Client/Abstractions/Resources/ILaunchResource.cs
@@ -14,138 +14,106 @@ public interface ILaunchResource
         /// <summary>
         /// Analyzes launches.
         /// </summary>
-        /// <returns>A message from service.</returns>
-        Task<MessageResponse> AnalyzeAsync(AnalyzeLaunchRequest request);
-
-        /// <inheritdoc cref="AnalyzeAsync(AnalyzeLaunchRequest)"/>
+        /// <param name="request">A request how to analyze the launch.</param>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<MessageResponse> AnalyzeAsync(AnalyzeLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<MessageResponse> AnalyzeAsync(AnalyzeLaunchRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Finishes specified launch.
         /// </summary>
         /// <param name="uuid">UUID of specified launch.</param>
         /// <param name="request">Information about representation of launch to finish.</param>
-        /// <returns>A message from service.</returns>
-        Task<LaunchFinishedResponse> FinishAsync(string uuid, FinishLaunchRequest request);
-
-        /// <inheritdoc cref="FinishAsync(string, FinishLaunchRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchFinishedResponse> FinishAsync(string uuid, FinishLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<LaunchFinishedResponse> FinishAsync(string uuid, FinishLaunchRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Deletes specified launch.
         /// </summary>
         /// <param name="id">ID of the launch to delete.</param>
-        /// <returns>A message from service.</returns>
-        Task<MessageResponse> DeleteAsync(long id);
-
-        /// <inheritdoc cref="DeleteAsync(long)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<MessageResponse> DeleteAsync(long id, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<MessageResponse> DeleteAsync(long id, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Returns specified launch by ID.
         /// </summary>
         /// <param name="id">ID of the launch to retrieve.</param>
-        /// <returns>A representation of launch.</returns>
-        Task<LaunchResponse> GetAsync(long id);
-
-        /// <inheritdoc cref="GetAsync(long)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchResponse> GetAsync(long id, CancellationToken cancellationToken);
+        /// <returns>A representation of launch.</returns>
+        Task<LaunchResponse> GetAsync(long id, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Returns specified launch by UUID.
         /// </summary>
         /// <param name="uuid">UUID of the launch to retrieve.</param>
-        /// <returns>A representation of launch.</returns>
-        Task<LaunchResponse> GetAsync(string uuid);
-
-        /// <inheritdoc cref="GetAsync(long)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchResponse> GetAsync(string uuid, CancellationToken cancellationToken);
+        /// <returns>A representation of launch.</returns>
+        Task<LaunchResponse> GetAsync(string uuid, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Returns a list of launches for current project.
         /// </summary>
+        /// <param name="cancellationToken">Cancellation token.</param>
         /// <returns>A list of launches.</returns>
-        Task<Content<LaunchResponse>> GetAsync();
+        Task<Content<LaunchResponse>> GetAsync(CancellationToken cancellationToken = default);
 
-        /// <inheritdoc cref="GetAsync()"/>
+        /// <summary>
+        /// Returns a list of launches for current project.
+        /// </summary>
         /// <param name="filterOption">Specified criterias for retrieving launches.</param>
-        Task<Content<LaunchResponse>> GetAsync(FilterOption filterOption);
-
-        /// <inheritdoc cref="GetAsync()"/>
-        /// <param name="cancellationToken">Cancellation token.</param>
-        Task<Content<LaunchResponse>> GetAsync(CancellationToken cancellationToken);
-
-        /// <inheritdoc cref="GetAsync(FilterOption)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<Content<LaunchResponse>> GetAsync(FilterOption filterOption, CancellationToken cancellationToken);
+        /// <returns>A list of launches.</returns>
+        Task<Content<LaunchResponse>> GetAsync(FilterOption filterOption, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Returns a list of debug launches for current project.
         /// </summary>
+        /// <param name="cancellationToken">Cancellation token.</param>
         /// <returns>A list of launches.</returns>
-        Task<Content<LaunchResponse>> GetDebugAsync();
+        Task<Content<LaunchResponse>> GetDebugAsync(CancellationToken cancellationToken = default);
 
-        /// <inheritdoc cref="GetDebugAsync()"/>
+        /// <summary>
+        /// Returns a list of debug launches for current project.
+        /// </summary>
         /// <param name="filterOption">Specified criterias for retrieving launches.</param>
-        Task<Content<LaunchResponse>> GetDebugAsync(FilterOption filterOption);
-
-        /// <inheritdoc cref="GetDebugAsync()"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<Content<LaunchResponse>> GetDebugAsync(CancellationToken cancellationToken);
-
-        /// <inheritdoc cref="GetDebugAsync(FilterOption)"/>
-        /// <param name="cancellationToken">Cancellation token.</param>
-        Task<Content<LaunchResponse>> GetDebugAsync(FilterOption filterOption, CancellationToken cancellationToken);
+        /// <returns>A list of launches.</returns>
+        Task<Content<LaunchResponse>> GetDebugAsync(FilterOption filterOption, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Merge several launches.
         /// </summary>
         /// <param name="request">Request for merging.</param>
-        /// <returns>Returns the model of merged launches.</returns>
-        Task<LaunchResponse> MergeAsync(MergeLaunchesRequest request);
-
-        /// <inheritdoc cref="MergeAsync(MergeLaunchesRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchResponse> MergeAsync(MergeLaunchesRequest request, CancellationToken cancellationToken);
+        /// <returns>Returns the model of merged launches.</returns>
+        Task<LaunchResponse> MergeAsync(MergeLaunchesRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Starts new launch.
         /// </summary>
         /// <param name="request">Information about launch.</param>
-        /// <returns>Information about started launch.</returns>
-        Task<LaunchCreatedResponse> StartAsync(StartLaunchRequest request);
-
-        /// <inheritdoc cref="StartAsync(StartLaunchRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchCreatedResponse> StartAsync(StartLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>Information about started launch.</returns>
+        Task<LaunchCreatedResponse> StartAsync(StartLaunchRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Stopes specified launch even if inner tests are not finished yet.
         /// </summary>
         /// <param name="id">ID of specified launch.</param>
         /// <param name="request">Information about representation of launch to finish.</param>
-        /// <returns>A message from service.</returns>
-        Task<LaunchFinishedResponse> StopAsync(long id, FinishLaunchRequest request);
-
-        /// <inheritdoc cref="StopAsync(long, FinishLaunchRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<LaunchFinishedResponse> StopAsync(long id, FinishLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<LaunchFinishedResponse> StopAsync(long id, FinishLaunchRequest request, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Update specified launch.
         /// </summary>
         /// <param name="id">ID of launch to update.</param>
         /// <param name="request">Information about launch.</param>
-        /// <returns>A message from service.</returns>
-        Task<MessageResponse> UpdateAsync(long id, UpdateLaunchRequest request);
-
-        /// <inheritdoc cref="UpdateAsync(long, UpdateLaunchRequest)"/>
         /// <param name="cancellationToken">Cancellation token.</param>
-        Task<MessageResponse> UpdateAsync(long id, UpdateLaunchRequest request, CancellationToken cancellationToken);
+        /// <returns>A message from service.</returns>
+        Task<MessageResponse> UpdateAsync(long id, UpdateLaunchRequest request, CancellationToken cancellationToken = default);
     }
 }