VolatileLayerClient PrefetchTiles API. (#759)

The method loads data for specified tile and levels range. This is
third and the last part of prefetch update of VolatileLayerClient.
Change only connects public API with impl and add integration tests
for it.

Resolves: OLPEDGE-794

Signed-off-by: Kostiantyn Zvieriev <[email protected]>

Author: kzvieriev

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

@@ -29,6 +29,7 @@
 #include <olp/core/geo/tiling/TileKey.h>
 #include <olp/dataservice/read/DataRequest.h>
 #include <olp/dataservice/read/PartitionsRequest.h>
+#include <olp/dataservice/read/PrefetchTilesRequest.h>
 #include <olp/dataservice/read/Types.h>
 
 namespace olp {
@@ -194,6 +195,53 @@ class DATASERVICE_READ_API VolatileLayerClient final {
    */
   bool RemoveFromCache(const geo::TileKey& tile);
 
+  /**
+   * @brief Prefetches a set of tiles asynchronously.
+   *
+   * This method recursively downloads all tile keys from the `min_level`
+   * parameter to the `max_level` parameter of the \c PrefetchTilesRequest
+   * object for the given root tiles. If min_level/max_level are the same or
+   * default, only tiles listed in \c PrefetchTilesRequest will be downloaded.
+   * Only tiles will be downloaded which are not already present in the cache,
+   * this helps reduce the network load.
+   *
+   * @note This method does not guarantee that all tiles are available offline
+   * as the cache might overflow, and data might be evicted at any point.
+   *
+   * @param request The `PrefetchTilesRequest` instance that contains
+   * a complete set of request parameters.
+   * @param callback The `PrefetchTilesResponseCallback` object that is invoked
+   * if the `PrefetchTilesResult` instance is available or an error is
+   * encountered.
+   *
+   * @return A token that can be used to cancel this request.
+   */
+  client::CancellationToken PrefetchTiles(
+      PrefetchTilesRequest request, PrefetchTilesResponseCallback callback);
+
+  /**
+   * @brief Prefetches a set of tiles asynchronously.
+   *
+   * This method recursively downloads all tile keys from the `min_level`
+   * parameter to the `max_level` parameter of the \c PrefetchTilesRequest
+   * object for the given root tiles. If min_level/max_level are the same or
+   * default, only tiles listed in \c PrefetchTilesRequest will be downloaded.
+   * Only tiles will be downloaded which are not already present in the cache,
+   * this helps reduce the network load.
+   *
+   * @note This method does not guarantee that all tiles are available offline
+   * as the cache might overflow, and data might be evicted at any point.
+   *
+   * @param request The `PrefetchTilesRequest` instance that contains
+   * a complete set of request parameters.
+   *
+   * @return `CancellableFuture` that contains the `PrefetchTilesResponse`
+   * instance with data or an error. You can also use `CancellableFuture` to
+   * cancel this request.
+   */
+  client::CancellableFuture<PrefetchTilesResponse> PrefetchTiles(
+      PrefetchTilesRequest request);
+
  private:
   std::unique_ptr<VolatileLayerClientImpl> impl_;
 };

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

@@ -72,6 +72,15 @@ bool VolatileLayerClient::RemoveFromCache(const geo::TileKey& tile) {
   return impl_->RemoveFromCache(tile);
 }
 
+client::CancellationToken VolatileLayerClient::PrefetchTiles(
+    PrefetchTilesRequest request, PrefetchTilesResponseCallback callback) {
+  return impl_->PrefetchTiles(std::move(request), std::move(callback));
+}
+
+client::CancellableFuture<PrefetchTilesResponse>
+VolatileLayerClient::PrefetchTiles(PrefetchTilesRequest request) {
+  return impl_->PrefetchTiles(std::move(request));
+}
 }  // namespace read
 }  // namespace dataservice
 }  // namespace olp

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

@@ -223,6 +223,21 @@
 #define URL_QUADKEYS_92259 \
   R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/versions/4/quadkeys/92259/depths/4)"
 
+#define URL_QUADKEYS_VOLATILE_23618364 \
+  R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/quadkeys/23618364/depths/0)"
+
+#define URL_QUADKEYS_VOLATILE_1476147 \
+  R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/quadkeys/1476147/depths/2)"
+
+#define URL_QUADKEYS_VOLATILE_5904591 \
+  R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/quadkeys/5904591/depths/1)"
+
+#define URL_QUADKEYS_VOLATILE_369036 \
+  R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/quadkeys/369036/depths/0)"
+
+#define URL_QUADKEYS_VOLATILE_92259 \
+  R"(https://query.data.api.platform.here.com/query/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/quadkeys/92259/depths/4)"
+
 #define URL_QUERY_PARTITION_23618365 \
   R"(https://query.data.api.platform.here.com/query/v1/catalogs/)"+GetTestCatalog()+R"(/layers/hype-test-prefetch/partitions?partition=23618365&version=4)"
 
@@ -253,6 +268,27 @@
 #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_BLOB_DATA_VOLATILE_PREFETCH_1 \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/a7a1afdf-db7e-4833-9627-d38bee6e2f81)"
+
+#define URL_BLOB_DATA_VOLATILE_PREFETCH_2 \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/e119d20e-c7c6-4563-ae88-8aa5c6ca75c3)"
+
+#define URL_BLOB_DATA_VOLATILE_PREFETCH_3 \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/f9a9fd8e-eb1b-48e5-bfdb-4392b3826443)"
+
+#define URL_BLOB_DATA_VOLATILE_PREFETCH_4 \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/9d515348-afce-44e8-bc6f-3693cfbed104)"
+
+#define URL_BLOB_DATA_VOLATILE_PREFETCH_5 \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/f9a9fd8e-eb1b-48e5-bfdb-4392b3826443)"
+
+#define URL_BLOB_DATA_VOLATILE_PREFETCH_6 \
+  R"(https://volatile-blob-ireland.data.api.platform.here.com/blobstore/v1/catalogs/hereos-internal-test-v2/layers/hype-test-prefetch/data/e83b397a-2be5-45a8-b7fb-ad4cb3ea13b1)"
+
+#define URL_BLOB_DATA_VOLATILE_PREFETCH_7 \
+  R"(https://volatile-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)"