Correct Protect, Release and RemoveFromCache. (#1034)

Protect, Release and RemoveFromCache are sync and offline methods. If
versioned client created with boost::none version and no online calls
made yet, version is not initialized. In that case, the methods should
fail.

Resolves: OLPEDGE-2255

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

Author: kzvieriev

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

@@ -351,6 +351,9 @@ class DATASERVICE_READ_API VersionedLayerClient final {
    *
    * @param partition_id The partition ID that should be removed.
    *
+   * @note Before calling the API, specify a layer version. You can set it using
+   * the constructor or after the first online request.
+   *
    * @return True if partition data is removed successfully; false otherwise.
    */
   bool RemoveFromCache(const std::string& partition_id);
@@ -360,6 +363,9 @@ class DATASERVICE_READ_API VersionedLayerClient final {
    *
    * @param tile The tile key that should be removed.
    *
+   * @note Before calling the API, specify a layer version. You can set it using
+   * the constructor or after the first online request.
+   *
    * @return True if tile data is removed successfully; false otherwise.
    */
   bool RemoveFromCache(const geo::TileKey& tile);
@@ -405,6 +411,9 @@ class DATASERVICE_READ_API VersionedLayerClient final {
    * @note Please do not call `Protect` while the `Release` call for the same
    * catalog and layer is in progress.
    *
+   * @note Before calling the API, specify a layer version. You can set it using
+   * the constructor or after the first online request.
+   *
    * @param tiles The list of tile keys to be protected.
    *
    * @return True if some keys were successfully added to the protected list;
@@ -423,6 +432,9 @@ class DATASERVICE_READ_API VersionedLayerClient final {
    * @note Please make sure that `Protect` will not be called for the same
    * catalog and layer while the `Release` call is in progress.
    *
+   * @note Before calling the API, specify a layer version. You can set it using
+   * the constructor or after the first online request.
+   *
    * @param tiles The list of tile keys to be removed from protection.
    *
    * @return True if some keys were successfully removed from the protected

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

@@ -444,8 +444,15 @@ bool VersionedLayerClientImpl::RemoveFromCache(
   repository::PartitionsCacheRepository partitions_cache_repository(
       catalog_, settings_.cache);
   boost::optional<model::Partition> partition;
+  auto version = catalog_version_.load();
+  if (version == kInvalidVersion) {
+    OLP_SDK_LOG_WARNING(
+        kLogTag, "Method RemoveFromCache failed, version is not initialized");
+    return false;
+  }
+
   if (!partitions_cache_repository.ClearPartitionMetadata(
-          catalog_version_.load(), partition_id, layer_id_, partition)) {
+          version, partition_id, layer_id_, partition)) {
     return false;
   }
 
@@ -463,8 +470,15 @@ bool VersionedLayerClientImpl::RemoveFromCache(const geo::TileKey& tile) {
   read::QuadTreeIndex cached_tree;
   repository::PartitionsCacheRepository partitions_cache_repository(
       catalog_, settings_.cache);
-  if (partitions_cache_repository.FindQuadTree(
-          layer_id_, catalog_version_.load(), tile, cached_tree)) {
+  auto version = catalog_version_.load();
+  if (version == kInvalidVersion) {
+    OLP_SDK_LOG_WARNING(
+        kLogTag, "Method RemoveFromCache failed, version is not initialized");
+    return false;
+  }
+
+  if (partitions_cache_repository.FindQuadTree(layer_id_, version, tile,
+                                               cached_tree)) {
     auto data = cached_tree.Find(tile, false);
     if (!data) {
       return true;
@@ -481,8 +495,7 @@ bool VersionedLayerClientImpl::RemoveFromCache(const geo::TileKey& tile) {
         }
       }
       return partitions_cache_repository.ClearQuadTree(
-          layer_id_, cached_tree.GetRootTile(), kQuadTreeDepth,
-          catalog_version_.load());
+          layer_id_, cached_tree.GetRootTile(), kQuadTreeDepth, version);
     }
     return result;
   }
@@ -619,6 +632,11 @@ bool VersionedLayerClientImpl::Protect(const TileKeys& tiles) {
     return false;
   }
   auto version = catalog_version_.load();
+  if (version == kInvalidVersion) {
+    OLP_SDK_LOG_WARNING(kLogTag,
+                        "Method Protect failed, version is not initialized");
+    return false;
+  }
 
   auto tiles_dependency_resolver =
       ProtectDependencyResolver(catalog_, layer_id_, version, settings_);
@@ -636,6 +654,11 @@ bool VersionedLayerClientImpl::Release(const TileKeys& tiles) {
     return false;
   }
   auto version = catalog_version_.load();
+  if (version == kInvalidVersion) {
+    OLP_SDK_LOG_WARNING(kLogTag,
+                        "Method Release failed, version is not initialized");
+    return false;
+  }
 
   auto tiles_dependency_resolver =
       ReleaseDependencyResolver(catalog_, layer_id_, version, settings_);