Add PrefetchPartitions implementation (#1074)

Add implementation to prefetch partitions.
Split partitions requests for blocks by 100.
Query data handles for partitions and
download data. Add unit test
to check if after prefetch data is avialible
in cache. Add tests with failed responces.

Relates-To: OLPEDGE-1902

Signed-off-by: Liubov Didkivska <[email protected]>

Author: Liubov Didkivska

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

@@ -22,7 +22,6 @@
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/logging/Log.h>
 #include <olp/dataservice/read/Types.h>
-
 #include "Common.h"
 #include "ExtendedApiResponse.h"
 #include "ExtendedApiResponseHelpers.h"
@@ -43,13 +42,18 @@ using AppendResultFunc =
     std::function<void(ExtendedDataResponse response, ItemType item,
                        PrefetchResult& prefetch_result)>;
 
-template <typename ItemType, typename PrefetchResult>
+template <typename PrefetchStatusType>
+using PrefetchStatusCallbackType = std::function<void(PrefetchStatusType)>;
+
+template <typename ItemType, typename PrefetchResult,
+          typename PrefetchStatusType>
 class DownloadItemsJob {
  public:
-  DownloadItemsJob(DownloadFunc download,
-                   AppendResultFunc<ItemType, PrefetchResult> append_result,
-                   Callback<PrefetchResult> user_callback,
-                   PrefetchStatusCallback status_callback)
+  DownloadItemsJob(
+      DownloadFunc download,
+      AppendResultFunc<ItemType, PrefetchResult> append_result,
+      Callback<PrefetchResult> user_callback,
+      PrefetchStatusCallbackType<PrefetchStatusType> status_callback)
       : download_(std::move(download)),
         append_result_(std::move(append_result)),
         user_callback_(std::move(user_callback)),
@@ -86,7 +90,7 @@ class DownloadItemsJob {
     append_result_(response, item, prefetch_result_);
 
     if (status_callback_) {
-      status_callback_(PrefetchStatus{
+      status_callback_(PrefetchStatusType{
           requests_succeeded_ + requests_failed_, total_download_task_count_,
           GetAccumulatedBytes(accumulated_statistics_)});
     }
@@ -109,7 +113,7 @@ class DownloadItemsJob {
   DownloadFunc download_;
   AppendResultFunc<ItemType, PrefetchResult> append_result_;
   Callback<PrefetchResult> user_callback_;
-  PrefetchStatusCallback status_callback_;
+  PrefetchStatusCallbackType<PrefetchStatusType> status_callback_;
   size_t download_task_count_{0};
   size_t total_download_task_count_{0};
   size_t requests_succeeded_{0};

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

@@ -0,0 +1,111 @@
+/*
+ * Copyright (C) 2020 HERE Europe B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#pragma once
+
+#include <algorithm>
+#include <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include <olp/core/client/CancellationContext.h>
+#include <olp/core/client/PendingRequests.h>
+#include <olp/core/logging/Log.h>
+#include <olp/dataservice/read/Types.h>
+#include "Common.h"
+#include "DownloadItemsJob.h"
+#include "ExtendedApiResponse.h"
+#include "ExtendedApiResponseHelpers.h"
+#include "QueryMetadataJob.h"
+#include "TaskSink.h"
+#include "repositories/PartitionsRepository.h"
+
+namespace olp {
+namespace dataservice {
+namespace read {
+
+using PartitionDataHandleResult =
+    std::vector<std::pair<std::string, std::string>>;
+using PartitionsDataHandleExtendedResponse =
+    ExtendedApiResponse<PartitionDataHandleResult, client::ApiError,
+                        client::NetworkStatistics>;
+
+class PrefetchPartitionsHelper {
+ public:
+  using DownloadJob = DownloadItemsJob<std::string, PrefetchPartitionsResult,
+                                       PrefetchPartitionsStatus>;
+  using QueryFunc = QueryItemsFunc<std::string, std::vector<std::string>,
+                                   PartitionsDataHandleExtendedResponse>;
+
+  static client::CancellationToken Prefetch(
+      std::shared_ptr<DownloadJob> download_job,
+      const std::vector<std::string>& roots, QueryFunc query,
+      TaskSink& task_sink, size_t query_max_size, uint32_t priority) {
+    client::CancellationContext execution_context;
+
+    auto query_job = std::make_shared<QueryMetadataJob<
+        std::string, std::vector<std::string>, PrefetchPartitionsResult,
+        PartitionsDataHandleExtendedResponse, PrefetchPartitionsStatus>>(
+        std::move(query), nullptr, download_job, task_sink, execution_context,
+        priority);
+
+    auto query_size = roots.size() / query_max_size;
+    query_size += (roots.size() % query_max_size > 0) ? 1 : 0;
+
+    query_job->Initialize(query_size);
+
+    OLP_SDK_LOG_DEBUG_F("PrefetchJob", "Starting queries, requests=%zu",
+                        roots.size());
+
+    execution_context.ExecuteOrCancelled([&]() {
+      VectorOfTokens tokens;
+      tokens.reserve(query_size);
+
+      // split items to blocks
+      auto size_left = roots.size();
+      auto start = 0u;
+      while (size_left > start) {
+        auto size = std::min(query_max_size, size_left - start);
+        auto query_element = std::vector<std::string>(
+            roots.begin() + start, roots.begin() + start + size);
+
+        tokens.emplace_back(task_sink.AddTask(
+            [query_element, query_job](client::CancellationContext context) {
+              return query_job->Query(std::move(query_element), context);
+            },
+            [query_job](PartitionsDataHandleExtendedResponse response) {
+              query_job->CompleteQuery(std::move(response));
+            },
+            priority));
+
+        start += size;
+      }
+
+      return CreateToken(std::move(tokens));
+    });
+
+    return client::CancellationToken(
+        [execution_context]() mutable { execution_context.CancelOperation(); });
+  }
+};
+
+}  // namespace read
+}  // namespace dataservice
+}  // namespace olp

…dk-dataservice-read/src/PrefetchHelper.h …taservice-read/src/PrefetchTilesHelper.holp-cpp-sdk-dataservice-read/src/PrefetchHelper.h renamed to olp-cpp-sdk-dataservice-read/src/PrefetchTilesHelper.h olp-cpp-sdk-dataservice-read/src/PrefetchHelper.h renamed to olp-cpp-sdk-dataservice-read/src/PrefetchTilesHelper.h

@@ -19,47 +19,45 @@
 
 #pragma once
 
+#include <memory>
+#include <utility>
+#include <vector>
+
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/client/PendingRequests.h>
 #include <olp/core/logging/Log.h>
 #include <olp/dataservice/read/Types.h>
-
 #include "Common.h"
 #include "DownloadItemsJob.h"
 #include "ExtendedApiResponse.h"
 #include "ExtendedApiResponseHelpers.h"
 #include "QueryMetadataJob.h"
 #include "TaskSink.h"
+#include "repositories/PrefetchTilesRepository.h"
 
 namespace olp {
 namespace dataservice {
 namespace read {
 
-template <typename PrefetchItemsResult>
-using PrefetchItemsResponseCallback = Callback<PrefetchItemsResult>;
-
-class PrefetchHelper {
+class PrefetchTilesHelper {
  public:
-  template <typename ItemType, typename QueryType, typename PrefetchResult>
+  using DownloadJob =
+      DownloadItemsJob<geo::TileKey, PrefetchTilesResult, PrefetchStatus>;
+  using QueryFunc =
+      QueryItemsFunc<geo::TileKey, geo::TileKey, repository::SubQuadsResponse>;
+
   static client::CancellationToken Prefetch(
-      const std::vector<QueryType>& roots,
-      QueryItemsFunc<ItemType, QueryType> query,
-      FilterItemsFunc<ItemType> filter, DownloadFunc download,
-      AppendResultFunc<ItemType, PrefetchResult> append_result,
-      Callback<PrefetchResult> user_callback,
-      PrefetchStatusCallback status_callback, TaskSink& task_sink,
+      std::shared_ptr<DownloadJob> download_job,
+      const std::vector<geo::TileKey>& roots, QueryFunc query,
+      FilterItemsFunc<repository::SubQuadsResult> filter, TaskSink& task_sink,
       uint32_t priority) {
     client::CancellationContext execution_context;
 
-    auto download_job =
-        std::make_shared<DownloadItemsJob<ItemType, PrefetchResult>>(
-            std::move(download), std::move(append_result),
-            std::move(user_callback), std::move(status_callback));
-
-    auto query_job =
-        std::make_shared<QueryMetadataJob<ItemType, QueryType, PrefetchResult>>(
-            std::move(query), std::move(filter), download_job, task_sink,
-            execution_context, priority);
+    auto query_job = std::make_shared<
+        QueryMetadataJob<geo::TileKey, geo::TileKey, PrefetchTilesResult,
+                         repository::SubQuadsResponse, PrefetchStatus>>(
+        std::move(query), std::move(filter), download_job, task_sink,
+        execution_context, priority);
 
     query_job->Initialize(roots.size());
 
@@ -69,12 +67,12 @@ class PrefetchHelper {
     execution_context.ExecuteOrCancelled([&]() {
       VectorOfTokens tokens;
       std::transform(std::begin(roots), std::end(roots),
-                     std::back_inserter(tokens), [&](QueryType root) {
+                     std::back_inserter(tokens), [&](geo::TileKey root) {
                        return task_sink.AddTask(
                            [=](client::CancellationContext context) {
                              return query_job->Query(root, context);
                            },
-                           [=](QueryItemsResponse<ItemType> response) {
+                           [=](repository::SubQuadsResponse response) {
                              query_job->CompleteQuery(std::move(response));
                            },
                            priority);

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

@@ -19,10 +19,14 @@
 
 #pragma once
 
+#include <iterator>
+#include <string>
+#include <utility>
+#include <vector>
+
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/logging/Log.h>
 #include <olp/dataservice/read/Types.h>
-
 #include "Common.h"
 #include "ExtendedApiResponse.h"
 #include "TaskSink.h"
@@ -31,21 +35,12 @@ namespace olp {
 namespace dataservice {
 namespace read {
 
-template <typename ItemType>
-using QueryItemsResult = std::map<ItemType, std::string>;
-
-template <typename ItemType>
-using QueryItemsResponse =
-    ExtendedApiResponse<QueryItemsResult<ItemType>, client::ApiError,
-                        client::NetworkStatistics>;
-
-template <typename ItemType, typename QueryType>
-using QueryItemsFunc = std::function<QueryItemsResponse<ItemType>(
-    QueryType, client::CancellationContext)>;
+template <typename ItemType, typename QueryType, typename QueryResponseType>
+using QueryItemsFunc =
+    std::function<QueryResponseType(QueryType, client::CancellationContext)>;
 
-template <typename ItemType>
-using FilterItemsFunc =
-    std::function<QueryItemsResult<ItemType>(QueryItemsResult<ItemType>)>;
+template <typename QueryResponseType>
+using FilterItemsFunc = std::function<QueryResponseType(QueryResponseType)>;
 
 using VectorOfTokens = std::vector<olp::client::CancellationToken>;
 
@@ -60,13 +55,16 @@ static olp::client::CancellationToken CreateToken(VectorOfTokens tokens) {
       std::move(tokens)));
 }
 
-template <typename ItemType, typename QueryType, typename PrefetchResult>
+template <typename ItemType, typename QueryType, typename PrefetchResult,
+          typename QueryResponseType, typename PrefetchStatusType>
 class QueryMetadataJob {
  public:
   QueryMetadataJob(
-      QueryItemsFunc<ItemType, QueryType> query,
-      FilterItemsFunc<ItemType> filter,
-      std::shared_ptr<DownloadItemsJob<ItemType, PrefetchResult>> download_job,
+      QueryItemsFunc<ItemType, QueryType, QueryResponseType> query,
+      FilterItemsFunc<typename QueryResponseType::ResultType> filter,
+      std::shared_ptr<
+          DownloadItemsJob<ItemType, PrefetchResult, PrefetchStatusType>>
+          download_job,
       TaskSink& task_sink, client::CancellationContext execution_context,
       uint32_t priority)
       : query_(std::move(query)),
@@ -78,20 +76,19 @@ class QueryMetadataJob {
 
   void Initialize(size_t query_count) { query_count_ = query_count; }
 
-  QueryItemsResponse<ItemType> Query(QueryType root,
-                                     client::CancellationContext context) {
+  QueryResponseType Query(QueryType root, client::CancellationContext context) {
     return query_(root, context);
   }
 
-  void CompleteQuery(QueryItemsResponse<ItemType> response) {
+  void CompleteQuery(QueryResponseType response) {
     std::lock_guard<std::mutex> lock(mutex_);
 
     accumulated_statistics_ += GetNetworkStatistics(response);
 
     if (response.IsSuccessful()) {
       auto items = response.MoveResult();
-      query_result_.insert(std::make_move_iterator(items.begin()),
-                           std::make_move_iterator(items.end()));
+      std::move(items.begin(), items.end(),
+                std::inserter(query_result_, query_result_.begin()));
     } else {
       const auto& error = response.GetError();
       if (error.GetErrorCode() == client::ErrorCode::Cancelled) {
@@ -138,7 +135,8 @@ class QueryMetadataJob {
         std::transform(
             std::begin(query_result_), std::end(query_result_),
             std::back_inserter(tokens),
-            [&](const typename QueryItemsResult<ItemType>::value_type& item) {
+            [&](const typename QueryResponseType::ResultType::value_type&
+                    item) {
               const std::string& data_handle = item.second;
               const auto& item_key = item.first;
 
@@ -170,14 +168,16 @@ class QueryMetadataJob {
   }
 
  private:
-  QueryItemsFunc<ItemType, QueryType> query_;
-  FilterItemsFunc<ItemType> filter_;
+  QueryItemsFunc<ItemType, QueryType, QueryResponseType> query_;
+  FilterItemsFunc<typename QueryResponseType::ResultType> filter_;
   size_t query_count_{0};
   bool canceled_{false};
-  QueryItemsResult<ItemType> query_result_;
+  typename QueryResponseType::ResultType query_result_;
   client::NetworkStatistics accumulated_statistics_;
   boost::optional<client::ApiError> query_error_;
-  std::shared_ptr<DownloadItemsJob<ItemType, PrefetchResult>> download_job_;
+  std::shared_ptr<
+      DownloadItemsJob<ItemType, PrefetchResult, PrefetchStatusType>>
+      download_job_;
   TaskSink& task_sink_;
   client::CancellationContext execution_context_;
   uint32_t priority_;