Add CancelPendingRequests in VolatileLayerClient

Add Add CancelPendingRequests in VolatileLayerClient and provide it
implementation. Add test DataserviceReadVolatileLayerClientTest.CancelPendingRequestsPartitions.

Resolves: OLPEDGE-1094
Signed-off-by: Diachenko Mykahilo <[email protected]>

Author: diachenko-mischa

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/VolatileLayerClient.h

@@ -90,6 +90,12 @@ class DATASERVICE_READ_API VolatileLayerClient final {
 
   ~VolatileLayerClient();
 
+  /**
+   * @brief Cancels all active and pending requests.
+   * @return True on success.
+   */
+  bool CancelPendingRequests();
+
   /**
    * @brief Fetches a list partitions for given volatile layer asynchronously.
    * @param request contains the complete set of request parameters.

olp-cpp-sdk-dataservice-read/src/VolatileLayerClient.cpp

@@ -40,6 +40,10 @@ VolatileLayerClient& VolatileLayerClient::operator=(
 
 VolatileLayerClient::~VolatileLayerClient() = default;
 
+bool VolatileLayerClient::CancelPendingRequests() {
+  return impl_->CancelPendingRequests();
+}
+
 client::CancellationToken VolatileLayerClient::GetPartitions(
     PartitionsRequest request, PartitionsResponseCallback callback) {
   return impl_->GetPartitions(std::move(request), std::move(callback));

olp-cpp-sdk-dataservice-read/src/VolatileLayerClientImpl.cpp

@@ -71,6 +71,11 @@ VolatileLayerClientImpl::~VolatileLayerClientImpl() {
   pending_requests_->CancelAllAndWait();
 }
 
+bool VolatileLayerClientImpl::CancelPendingRequests() {
+  OLP_SDK_LOG_TRACE(kLogTag, "CancelPendingRequests");
+  return pending_requests_->CancelAll();
+}
+
 client::CancellationToken VolatileLayerClientImpl::GetPartitions(
     PartitionsRequest request, PartitionsResponseCallback callback) {
   auto schedule_get_partitions = [&](PartitionsRequest request,

olp-cpp-sdk-dataservice-read/src/VolatileLayerClientImpl.h

@@ -46,6 +46,8 @@ class VolatileLayerClientImpl {
 
   virtual ~VolatileLayerClientImpl();
 
+  virtual bool CancelPendingRequests();
+
   virtual client::CancellationToken GetPartitions(
       PartitionsRequest request, PartitionsResponseCallback callback);
 

tests/integration/olp-cpp-sdk-dataservice-read/HttpResponses.h

@@ -179,6 +179,9 @@
 #define URL_QUERY_PARTITION_1476147 \
   R"(https://query.data.api.platform.here.com/query/v1/catalogs/)"+GetTestCatalog()+R"(/layers/hype-test-prefetch/partitions?partition=1476147&version=4)"
 
+#define URL_QUERY_VOLATILE_PARTITION_269 \
+  R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/testlayer_volatile/partitions?partition=269)"
+
 #define URL_BLOB_DATA_PREFETCH_1 \
   R"(https://blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/a7a1afdf-db7e-4833-9627-d38bee6e2f81)"
 
@@ -200,6 +203,9 @@
 #define URL_BLOB_DATA_PREFETCH_7 \
   R"(https://blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/95c5c703-e00e-4c38-841e-e419367474f1)"
 
+#define URL_VOLATILE_BLOB_DATA \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/testlayer_volatile/data/4eed6ed1-0d32-43b9-ae79-043cb4256410)"
+
 #define HTTP_RESPONSE_CONFIG_V2 \
   R"jsonString({"id":"hereos-internal-test-v2","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2","name":"hereos-internal-test-v2","summary":"hereos-internal-test-v2","description":"Used for internal testing","contacts":{},"owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"tags":[],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","replication":{"regions":[{"id":"eu-ireland","role":"primary"}]},"layers":[{"id":"hype-test-prefetch","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2:hype-test-prefetch","name":"Hype Test Prefetch","summary":"hype prefetch testing","description":"Layer for hype prefetch testing","owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"partitioningScheme":"heretile","partitioning":{"tileLevels":[],"scheme":"heretile"},"contentType":"application/x-protobuf","volume":{"volumeType":"durable"},"tags":["TEST"],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","layerType":"versioned"},{"id":"hype-test-prefetch-2","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2:hype-test-prefetch-2","name":"Hype Test Prefetch2","summary":"Layer for testing hype2 prefetching","description":"Layer for testing hype2 prefetching","owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"partitioningScheme":"heretile","partitioning":{"tileLevels":[],"scheme":"heretile"},"contentType":"application/x-protobuf","volume":{"volumeType":"durable"},"tags":["TEST"],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","layerType":"versioned"},{"id":"testlayer_res","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2:testlayer_res","name":"Resource Test Layer","summary":"testlayer_res","description":"testlayer_res","owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"partitioningScheme":"generic","partitioning":{"scheme":"generic"},"contentType":"application/x-protobuf","volume":{"volumeType":"durable"},"tags":["TEST"],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","layerType":"versioned"},{"id":"testlayer","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2:testlayer","name":"Test Layer","summary":"Test Layer","description":"A simple test layer","owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"partitioningScheme":"generic","partitioning":{"scheme":"generic"},"contentType":"application/x-protobuf","volume":{"volumeType":"durable"},"tags":["TEST"],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","layerType":"versioned"},{"id":"testlayer_gzip","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2:testlayer_gzip","name":"Test Layer","summary":"Test Layer","description":"A simple compressed test layer","owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"partitioningScheme":"generic","partitioning":{"scheme":"generic"},"contentType":"application/x-protobuf","contentEncoding":"gzip","volume":{"volumeType":"durable"},"tags":["TEST"],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","layerType":"versioned"},{"id":"multilevel_testlayer","hrn":"hrn:here:data::olp-here-test:hereos-internal-test-v2:multilevel_testlayer","name":"Multi Level Test Layer","summary":"Multi Level Test Layer","description":"A multi level test layer just for testing","owner":{"creator":{"id":"9PBigz3zyXks0OlAQv13"},"organisation":{"id":"olp-here-test"}},"partitioningScheme":"generic","partitioning":{"scheme":"generic"},"contentType":"application/x-protobuf","volume":{"volumeType":"durable"},"tags":["TEST"],"billingTags":[],"created":"2019-01-10T22:30:12.917Z","layerType":"versioned"}],"marketplaceReady":false,"version":1})jsonString"
 

tests/integration/olp-cpp-sdk-dataservice-read/VolatileLayerClientTest.cpp

@@ -730,23 +730,14 @@ TEST_F(DataserviceReadVolatileLayerClientTest, GetVolatileDataByPartitionId) {
               Send(IsGetRequest(URL_LATEST_CATALOG_VERSION), _, _, _, _))
       .Times(0);
 
-  EXPECT_CALL(
-      *network_mock_,
-      Send(IsGetRequest("https://query.data.api.platform.here.com/query/v1/"
-                        "catalogs/hereos-internal-test-v2/layers/"
-                        "testlayer_volatile/partitions?partition=269"),
-           _, _, _, _))
+  EXPECT_CALL(*network_mock_,
+              Send(IsGetRequest(URL_QUERY_VOLATILE_PARTITION_269), _, _, _, _))
       .WillOnce(ReturnHttpResponse(olp::http::NetworkResponse().WithStatus(
                                        olp::http::HttpStatusCode::OK),
                                    HTTP_RESPONSE_PARTITIONS_V2));
 
-  EXPECT_CALL(
-      *network_mock_,
-      Send(IsGetRequest(
-               "https://volatile-blob-ireland.data.api.platform.here.com/"
-               "blobstore/v1/catalogs/hereos-internal-test-v2/layers/"
-               "testlayer_volatile/data/4eed6ed1-0d32-43b9-ae79-043cb4256410"),
-           _, _, _, _))
+  EXPECT_CALL(*network_mock_,
+              Send(IsGetRequest(URL_VOLATILE_BLOB_DATA), _, _, _, _))
       .WillOnce(ReturnHttpResponse(olp::http::NetworkResponse().WithStatus(
                                        olp::http::HttpStatusCode::OK),
                                    "someData"));
@@ -769,4 +760,71 @@ TEST_F(DataserviceReadVolatileLayerClientTest, GetVolatileDataByPartitionId) {
   ASSERT_EQ("someData", data_string);
 }
 
+TEST_F(DataserviceReadVolatileLayerClientTest,
+       CancelPendingRequestsPartitions) {
+  olp::client::HRN hrn(GetTestCatalog());
+
+  auto client = std::make_unique<VolatileLayerClient>(hrn, "testlayer_volatile",
+                                                      settings_);
+  auto partitions_request = PartitionsRequest().WithFetchOption(OnlineOnly);
+  auto data_request =
+      DataRequest().WithPartitionId("269").WithFetchOption(OnlineOnly);
+
+  auto request_started = std::make_shared<std::promise<void>>();
+  auto continue_request = std::make_shared<std::promise<void>>();
+
+  {
+    olp::http::RequestId request_id;
+    NetworkCallback send_mock;
+    CancelCallback cancel_mock;
+
+    std::tie(request_id, send_mock, cancel_mock) = GenerateNetworkMockActions(
+        request_started, continue_request,
+        {olp::http::HttpStatusCode::OK, HTTP_RESPONSE_PARTITIONS_V2});
+
+    EXPECT_CALL(
+        *network_mock_,
+        Send(IsGetRequest(URL_QUERY_VOLATILE_PARTITION_269), _, _, _, _))
+        .Times(1)
+        .WillOnce(testing::Invoke(std::move(send_mock)));
+
+    EXPECT_CALL(*network_mock_, Cancel(request_id))
+        .WillOnce(testing::Invoke(std::move(cancel_mock)));
+
+    ON_CALL(*network_mock_,
+            Send(IsGetRequest(URL_VOLATILE_BLOB_DATA), _, _, _, _))
+        .WillByDefault(
+            ReturnHttpResponse(olp::http::NetworkResponse().WithStatus(
+                                   olp::http::HttpStatusCode::OK),
+                               "someData"));
+  }
+
+  auto data_future = client->GetData(data_request);
+  auto partitions_future = client->GetPartitions(partitions_request);
+
+  request_started->get_future().get();
+  client->CancelPendingRequests();
+  continue_request->set_value();
+
+  PartitionsResponse partitions_response = partitions_future.GetFuture().get();
+
+  ASSERT_FALSE(partitions_response.IsSuccessful())
+      << ApiErrorToString(partitions_response.GetError());
+
+  ASSERT_EQ(static_cast<int>(olp::http::ErrorCode::CANCELLED_ERROR),
+            partitions_response.GetError().GetHttpStatusCode());
+  ASSERT_EQ(olp::client::ErrorCode::Cancelled,
+            partitions_response.GetError().GetErrorCode());
+
+  DataResponse data_response = data_future.GetFuture().get();
+
+  ASSERT_FALSE(data_response.IsSuccessful())
+      << ApiErrorToString(data_response.GetError());
+
+  ASSERT_EQ(static_cast<int>(olp::http::ErrorCode::CANCELLED_ERROR),
+            data_response.GetError().GetHttpStatusCode());
+  ASSERT_EQ(olp::client::ErrorCode::Cancelled,
+            data_response.GetError().GetErrorCode());
+}
+
 }  // namespace