Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/iceberg/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ set(ICEBERG_SOURCES
expression/expression.cc
expression/expressions.cc
expression/inclusive_metrics_evaluator.cc
expression/json_serde.cc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also need to update meson.build for any new file.

expression/literal.cc
expression/manifest_evaluator.cc
expression/predicate.cc
Expand Down
64 changes: 64 additions & 0 deletions src/iceberg/expression/json_serde.cc
Original file line number Diff line number Diff line change
@@ -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())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use internal::checked_pointer_cast here?

: 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");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My concern is large refactoring afterwards if we don't have a good design beforehand

You are correct, I will cleanup my notes and shared as design. but I don't expect too much refactoring.

}
}

#define ICEBERG_DEFINE_FROM_JSON(Model) \
template <> \
Result<std::shared_ptr<Model>> FromJson<Model>(const nlohmann::json& json) { \
return Model##FromJson(json); \
}

ICEBERG_DEFINE_FROM_JSON(Expression)

} // namespace iceberg
51 changes: 51 additions & 0 deletions src/iceberg/expression/json_serde_internal.h
Original file line number Diff line number Diff line change
@@ -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"
Copy link
Member

@wgtmac wgtmac Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this if we include iceberg/type_fwd.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) \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, as I am looking at other literals, predicates, and terms it does seem like it would be better not to have the macro.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// `json_serde_internal.cc` to define the `FromJson` function for the model.
/// `json_serde.cc` to define the `FromJson` function for the model.

ICEBERG_DECLARE_JSON_SERDE(Expression)

#undef ICEBERG_DECLARE_JSON_SERDE

} // namespace iceberg
1 change: 1 addition & 0 deletions src/iceberg/expression/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ install_headers(
'expression_visitor.h',
'expressions.h',
'inclusive_metrics_evaluator.h',
'json_serde_internal.h',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'json_serde_internal.h',

We don't install header files with internal suffix. This is automatically handled in the CMake script.

'literal.h',
'manifest_evaluator.h',
'predicate.h',
Expand Down
1 change: 1 addition & 0 deletions src/iceberg/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ iceberg_sources = files(
'expression/expression.cc',
'expression/expressions.cc',
'expression/inclusive_metrics_evaluator.cc',
'expression/json_serde.cc',
'expression/literal.cc',
'expression/manifest_evaluator.cc',
'expression/predicate.cc',
Expand Down
1 change: 1 addition & 0 deletions src/iceberg/test/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ add_iceberg_test(table_test
add_iceberg_test(expression_test
SOURCES
aggregate_test.cc
expression_json_test.cc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment for meson.build

expression_test.cc
expression_visitor_test.cc
inclusive_metrics_evaluator_test.cc
Expand Down
60 changes: 60 additions & 0 deletions src/iceberg/test/expression_json_test.cc
Original file line number Diff line number Diff line change
@@ -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);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

CheckBoolean(False::Instance(), false);
}

} // namespace iceberg
1 change: 1 addition & 0 deletions src/iceberg/test/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ iceberg_tests = {
'expression_test': {
'sources': files(
'aggregate_test.cc',
'expression_json_test.cc',
'expression_test.cc',
'expression_visitor_test.cc',
'inclusive_metrics_evaluator_test.cc',
Expand Down
Loading