feat: add validator for rest api types

Author: HeartLinked

src/iceberg/catalog/rest/CMakeLists.txt

@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-set(ICEBERG_REST_SOURCES rest_catalog.cc json_internal.cc)
+set(ICEBERG_REST_SOURCES rest_catalog.cc json_internal.cc validator.cc)
 
 set(ICEBERG_REST_STATIC_BUILD_INTERFACE_LIBS)
 set(ICEBERG_REST_SHARED_BUILD_INTERFACE_LIBS)

src/iceberg/catalog/rest/json_internal.cc

@@ -27,6 +27,7 @@
 #include <nlohmann/json.hpp>
 
 #include "iceberg/catalog/rest/types.h"
+#include "iceberg/catalog/rest/validator.h"
 #include "iceberg/json_internal.h"
 #include "iceberg/table_identifier.h"
 #include "iceberg/util/json_util_internal.h"
@@ -139,6 +140,7 @@ Result<RenameTableRequest> RenameTableRequestFromJson(const nlohmann::json& json
   ICEBERG_ASSIGN_OR_RAISE(auto dest_json,
                           GetJsonValue<nlohmann::json>(json, kDestination));
   ICEBERG_ASSIGN_OR_RAISE(request.destination, TableIdentifierFromJson(dest_json));
+  ICEBERG_RETURN_UNEXPECTED(Validator::Validate(request));
   return request;
 }
 
@@ -165,6 +167,7 @@ Result<LoadTableResult> LoadTableResultFromJson(const nlohmann::json& json) {
   ICEBERG_ASSIGN_OR_RAISE(
       result.config, (GetJsonValueOrDefault<std::unordered_map<std::string, std::string>>(
                          json, kConfig)));
+  ICEBERG_RETURN_UNEXPECTED(Validator::Validate(result));
   return result;
 }
 
@@ -192,6 +195,7 @@ Result<ListNamespacesResponse> ListNamespacesResponseFromJson(
     ICEBERG_ASSIGN_OR_RAISE(auto ns, NamespaceFromJson(ns_json));
     response.namespaces.push_back(std::move(ns));
   }
+  ICEBERG_RETURN_UNEXPECTED(Validator::Validate(response));
   return response;
 }
 
@@ -253,6 +257,7 @@ Result<UpdateNamespacePropertiesResponse> UpdateNamespacePropertiesResponseFromJ
                           GetJsonValue<std::vector<std::string>>(json, kRemoved));
   ICEBERG_ASSIGN_OR_RAISE(
       response.missing, GetJsonValueOrDefault<std::vector<std::string>>(json, kMissing));
+  ICEBERG_RETURN_UNEXPECTED(Validator::Validate(response));
   return response;
 }
 
@@ -279,6 +284,7 @@ Result<ListTablesResponse> ListTablesResponseFromJson(const nlohmann::json& json
     ICEBERG_ASSIGN_OR_RAISE(auto identifier, TableIdentifierFromJson(id_json));
     response.identifiers.push_back(std::move(identifier));
   }
+  ICEBERG_RETURN_UNEXPECTED(Validator::Validate(response));
   return response;
 }
 

src/iceberg/catalog/rest/meson.build

@@ -15,7 +15,11 @@
 # specific language governing permissions and limitations
 # under the License.
 
-iceberg_rest_sources = files('json_internal.cc', 'rest_catalog.cc')
+iceberg_rest_sources = files(
+    'json_internal.cc',
+    'rest_catalog.cc',
+    'validator.cc',
+)
 # cpr does not export symbols, so on Windows it must
 # be used as a static lib
 cpr_needs_static = (
@@ -46,4 +50,7 @@ iceberg_rest_dep = declare_dependency(
 meson.override_dependency('iceberg-rest', iceberg_rest_dep)
 pkg.generate(iceberg_rest_lib)
 
-install_headers(['rest_catalog.h', 'types.h'], subdir: 'iceberg/catalog/rest')
+install_headers(
+    ['rest_catalog.h', 'types.h', 'json_internal.h', 'validator.h'],
+    subdir: 'iceberg/catalog/rest',
+)

src/iceberg/catalog/rest/validator.cc

@@ -0,0 +1,110 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+#include "iceberg/catalog/rest/validator.h"
+
+#include <format>
+#include <ranges>
+#include <unordered_set>
+
+#include "iceberg/catalog/rest/types.h"
+#include "iceberg/result.h"
+
+namespace iceberg::rest {
+
+// Namespace operations
+
+Status Validator::Validate(const ListNamespacesResponse& response) { return {}; }
+
+Status Validator::Validate(const CreateNamespaceRequest& request) { return {}; }
+
+Status Validator::Validate(const CreateNamespaceResponse& response) { return {}; }
+
+Status Validator::Validate(const GetNamespaceResponse& response) { return {}; }
+
+Status Validator::Validate(const UpdateNamespacePropertiesRequest& request) {
+  // keys in updates and removals must not overlap
+  if (request.removals.empty() || request.updates.empty()) [[unlikely]] {
+    return {};
+  }
+
+  std::unordered_set<std::string> remove_set(std::from_range, request.removals);
+
+  auto common =
+      request.updates | std::views::keys |
+      std::views::filter([&](const std::string& k) { return remove_set.contains(k); }) |
+      std::ranges::to<std::vector<std::string>>();
+
+  if (!common.empty()) {
+    std::string keys;
+    bool first = true;
+    std::ranges::for_each(common, [&](const std::string& s) {
+      if (!std::exchange(first, false)) keys += ", ";
+      keys += s;
+    });
+
+    return Invalid(
+        "Invalid namespace properties update: cannot simultaneously set and remove keys: "
+        "[{}]",
+        keys);
+  }
+  return {};
+}
+
+Status Validator::Validate(const UpdateNamespacePropertiesResponse& response) {
+  return {};
+}
+
+// Table operations
+
+Status Validator::Validate(const ListTablesResponse& response) { return {}; }
+
+Status Validator::Validate(const LoadTableResult& result) {
+  if (!result.metadata) [[unlikely]] {
+    return Invalid("Invalid metadata: null");
+  }
+  return {};
+}
+
+Status Validator::Validate(const RegisterTableRequest& request) {
+  if (request.name.empty()) [[unlikely]] {
+    return Invalid("Invalid table name: empty");
+  }
+
+  if (request.metadata_location.empty()) [[unlikely]] {
+    return Invalid("Invalid metadata location: empty");
+  }
+
+  return {};
+}
+
+Status Validator::Validate(const RenameTableRequest& request) {
+  if (request.source.ns.levels.empty() || request.source.name.empty()) [[unlikely]] {
+    return Invalid("Invalid source identifier");
+  }
+
+  if (request.destination.ns.levels.empty() || request.destination.name.empty())
+      [[unlikely]] {
+    return Invalid("Invalid destination identifier");
+  }
+
+  return {};
+}
+
+}  // namespace iceberg::rest

src/iceberg/catalog/rest/validator.h

@@ -0,0 +1,71 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+
+#pragma once
+
+#include "iceberg/catalog/rest/iceberg_rest_export.h"
+#include "iceberg/catalog/rest/types.h"
+#include "iceberg/result.h"
+
+/// \file iceberg/catalog/rest/validator.h
+/// Validator for REST Catalog API types.
+
+namespace iceberg::rest {
+
+/// \brief Validator for REST Catalog API types. Validation should be called after
+/// deserializing objects from external sources to ensure data integrity before the
+/// objects are used.
+class ICEBERG_REST_EXPORT Validator {
+ public:
+  // Namespace operations
+
+  /// \brief Validates a ListNamespacesResponse object.
+  static Status Validate(const ListNamespacesResponse& response);
+
+  /// \brief Validates a CreateNamespaceRequest object.
+  static Status Validate(const CreateNamespaceRequest& request);
+
+  /// \brief Validates a CreateNamespaceResponse object.
+  static Status Validate(const CreateNamespaceResponse& response);
+
+  /// \brief Validates a GetNamespaceResponse object.
+  static Status Validate(const GetNamespaceResponse& response);
+
+  /// \brief Validates an UpdateNamespacePropertiesRequest object.
+  static Status Validate(const UpdateNamespacePropertiesRequest& request);
+
+  /// \brief Validates an UpdateNamespacePropertiesResponse object.
+  static Status Validate(const UpdateNamespacePropertiesResponse& response);
+
+  // Table operations
+
+  /// \brief Validates a ListTablesResponse object.
+  static Status Validate(const ListTablesResponse& response);
+
+  /// \brief Validates a LoadTableResult object.
+  static Status Validate(const LoadTableResult& result);
+
+  /// \brief Validates a RegisterTableRequest object.
+  static Status Validate(const RegisterTableRequest& request);
+
+  /// \brief Validates a RenameTableRequest object.
+  static Status Validate(const RenameTableRequest& request);
+};
+
+}  // namespace iceberg::rest