wgtmac commented on code in PR #532: URL: https://github.com/apache/iceberg-cpp/pull/532#discussion_r2734664179
########## src/iceberg/expression/json_serde_internal.h: ########## @@ -0,0 +1,51 @@ +/* + * 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 <nlohmann/json_fwd.hpp> + +#include "iceberg/expression/expression.h" +#include "iceberg/iceberg_export.h" +#include "iceberg/result.h" + +/// \file iceberg/expression/json_serde_internal.h +/// JSON serialization and deserialization for expressions. + +namespace iceberg { + +template <typename Model> +Result<Model> FromJson(const nlohmann::json& json); + +#define ICEBERG_DECLARE_JSON_SERDE(Model) \ + ICEBERG_EXPORT Result<std::shared_ptr<Model>> Model##FromJson( \ + const nlohmann::json& json); \ + \ + template <typename Model> \ + ICEBERG_EXPORT Result<std::shared_ptr<Model>> FromJson(const nlohmann::json& json); \ + \ + ICEBERG_EXPORT nlohmann::json ToJson(const Model& model); + +/// \note Don't forget to add `ICEBERG_DEFINE_FROM_JSON` to the end of +/// `json_serde_internal.cc` to define the `FromJson` function for the model. Review Comment: ```suggestion /// `json_serde.cc` to define the `FromJson` function for the model. ``` ########## src/iceberg/expression/meson.build: ########## @@ -24,6 +24,7 @@ install_headers( 'expression_visitor.h', 'expressions.h', 'inclusive_metrics_evaluator.h', + 'json_serde_internal.h', Review Comment: ```suggestion ``` We don't install header files with internal suffix. This is automatically handled in the CMake script. ########## src/iceberg/expression/json_serde_internal.h: ########## @@ -0,0 +1,51 @@ +/* + * 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 <nlohmann/json_fwd.hpp> + +#include "iceberg/expression/expression.h" +#include "iceberg/iceberg_export.h" +#include "iceberg/result.h" + +/// \file iceberg/expression/json_serde_internal.h +/// JSON serialization and deserialization for expressions. + +namespace iceberg { + +template <typename Model> +Result<Model> FromJson(const nlohmann::json& json); + +#define ICEBERG_DECLARE_JSON_SERDE(Model) \ Review Comment: Do we need this macro definition actually? I think the rest models have a lot of variants so we define the macro for convenience. Expressions do not have that much so perhaps we can just follow the style in `iceberg/json_internal.h` to define ToJson and XXXFromJson explicitly? ########## src/iceberg/test/expression_json_test.cc: ########## @@ -0,0 +1,60 @@ +/* + * 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 <memory> +#include <vector> + +#include <gmock/gmock.h> +#include <gtest/gtest.h> +#include <nlohmann/json.hpp> + +#include "iceberg/expression/expression.h" +#include "iceberg/expression/expressions.h" +#include "iceberg/expression/json_serde_internal.h" +#include "iceberg/expression/literal.h" +#include "iceberg/expression/predicate.h" +#include "iceberg/expression/term.h" +#include "iceberg/test/matchers.h" + +namespace iceberg { + +class ExpressionJsonTest : public ::testing::Test { + protected: + void CheckBoolean(std::shared_ptr<Expression> expr, bool value) { + auto json = ToJson(*expr); + EXPECT_TRUE(json.is_boolean()); + EXPECT_EQ(json.get<bool>(), value); + + auto result = ExpressionFromJson(json); + ASSERT_THAT(result, IsOk()); + if (value) { + EXPECT_EQ(result.value()->op(), Expression::Operation::kTrue); + } else { + EXPECT_EQ(result.value()->op(), Expression::Operation::kFalse); + } + } +}; + +// Test boolean constant expressions +TEST_F(ExpressionJsonTest, CheckBooleanExpression) { + CheckBoolean(True::Instance(), true); Review Comment: I think `CheckBoolean` is unlikely to be reused by other test cases. What about: 1. Remove explicit class definition of `ExpressionJsonTest` and use `TEST(ExpressionJsonTest, BooleanExpression)` instead. 2. Make `CheckBoolean` as lambda function inside this test case. ########## src/iceberg/expression/json_serde.cc: ########## @@ -0,0 +1,64 @@ +/* + * 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 <format> +#include <string> +#include <utility> +#include <vector> + +#include <nlohmann/json.hpp> + +#include "iceberg/expression/expressions.h" +#include "iceberg/expression/json_serde_internal.h" +#include "iceberg/expression/literal.h" +#include "iceberg/util/json_util_internal.h" +#include "iceberg/util/macros.h" + +namespace iceberg { + +Result<std::shared_ptr<Expression>> ExpressionFromJson(const nlohmann::json& json) { + // Handle boolean + if (json.is_boolean()) { + return json.get<bool>() ? std::dynamic_pointer_cast<Expression>(True::Instance()) + : std::dynamic_pointer_cast<Expression>(False::Instance()); + } + return JsonParseError("Only boolean are currently supported"); +} + +nlohmann::json ToJson(const Expression& expr) { + switch (expr.op()) { + case Expression::Operation::kTrue: + return true; + + case Expression::Operation::kFalse: + return false; + default: + throw std::logic_error("Only booleans are currently supported"); Review Comment: BTW, what is the plan of work item breakdown? This PR is trivial enough that I cannot see how do we want to work with different operations, predicates, literals, etc. My concern is large refactoring afterwards if we don't have a good design beforehand. ########## src/iceberg/expression/json_serde.cc: ########## @@ -0,0 +1,64 @@ +/* + * 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 <format> +#include <string> +#include <utility> +#include <vector> + +#include <nlohmann/json.hpp> + +#include "iceberg/expression/expressions.h" +#include "iceberg/expression/json_serde_internal.h" +#include "iceberg/expression/literal.h" +#include "iceberg/util/json_util_internal.h" +#include "iceberg/util/macros.h" + +namespace iceberg { + +Result<std::shared_ptr<Expression>> ExpressionFromJson(const nlohmann::json& json) { + // Handle boolean + if (json.is_boolean()) { + return json.get<bool>() ? std::dynamic_pointer_cast<Expression>(True::Instance()) + : std::dynamic_pointer_cast<Expression>(False::Instance()); + } + return JsonParseError("Only boolean are currently supported"); +} + +nlohmann::json ToJson(const Expression& expr) { + switch (expr.op()) { + case Expression::Operation::kTrue: + return true; + + case Expression::Operation::kFalse: + return false; + default: + throw std::logic_error("Only booleans are currently supported"); Review Comment: Please note that we cannot throw in any case. It is fine to throw `IcebergException` with an error message indicating a unimplemented state for now. ########## src/iceberg/expression/json_serde.cc: ########## @@ -0,0 +1,64 @@ +/* + * 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 <format> +#include <string> +#include <utility> +#include <vector> + +#include <nlohmann/json.hpp> + +#include "iceberg/expression/expressions.h" +#include "iceberg/expression/json_serde_internal.h" +#include "iceberg/expression/literal.h" +#include "iceberg/util/json_util_internal.h" +#include "iceberg/util/macros.h" + +namespace iceberg { + +Result<std::shared_ptr<Expression>> ExpressionFromJson(const nlohmann::json& json) { + // Handle boolean + if (json.is_boolean()) { + return json.get<bool>() ? std::dynamic_pointer_cast<Expression>(True::Instance()) Review Comment: Can we use `internal::checked_pointer_cast` here? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
