feat: add LDValue_SerializeJSON C binding (#458)

cwaldren-ld · web-flow · commit 90eb880b7b76 · 2024-10-30T10:24:56.000-07:00
This adds a new API to the `LDValue` interface for serializing to a JSON
string.

Example:

```c
LDValue foo = LDValue_NewBool(true);
char *json = LDValue_SerializeJSON(foo);
// json is the string 'true'
LDMemory_FreeString(json);
LDValue_Free(foo);
```

It's easier to view this PR commit to commit. The first one was
necessary in order to access the boost::json tag_invoke implementations
in `common`, where `LDValue` is implemented. Luckily, I only needed to
pull over the `value` headers and some utilities.

One thing to note is that boost serializes numbers using scientific
notation (e.g. `17` serializes to `1.7E1`). Kind of an odd choice, but
it is to JSON spec.

BEGIN_COMMIT_OVERRIDE
refactor: move json_errors, primitives, and value from internal to common lib
feat: add LDValue_SerializeJSON C binding
END_COMMIT_OVERRIDE
diff --git a/contract-tests/client-contract-tests/src/client_entity.cpp b/contract-tests/client-contract-tests/src/client_entity.cpp
@@ -6,8 +6,8 @@
 #include <launchdarkly/context_builder.hpp>
 #include <launchdarkly/serialization/json_context.hpp>
 #include <launchdarkly/serialization/json_evaluation_reason.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 #include <launchdarkly/value.hpp>
 
 #include <chrono>
diff --git a/contract-tests/server-contract-tests/src/client_entity.cpp b/contract-tests/server-contract-tests/src/client_entity.cpp
@@ -6,8 +6,8 @@
 #include <launchdarkly/context_builder.hpp>
 #include <launchdarkly/serialization/json_context.hpp>
 #include <launchdarkly/serialization/json_evaluation_reason.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 #include <launchdarkly/server_side/serialization/json_all_flags_state.hpp>
 #include <launchdarkly/value.hpp>
 
diff --git a/libs/client-sdk/src/data_sources/data_source_event_handler.cpp b/libs/client-sdk/src/data_sources/data_source_event_handler.cpp
@@ -3,7 +3,7 @@
 #include <launchdarkly/encoding/base_64.hpp>
 #include <launchdarkly/serialization/json_evaluation_result.hpp>
 #include <launchdarkly/serialization/json_item_descriptor.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
 #include <boost/core/ignore_unused.hpp>
diff --git a/libs/client-sdk/src/flag_manager/flag_persistence.cpp b/libs/client-sdk/src/flag_manager/flag_persistence.cpp
@@ -5,7 +5,7 @@
 
 #include <launchdarkly/serialization/json_evaluation_result.hpp>
 #include <launchdarkly/serialization/json_item_descriptor.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
 
 #include <utility>
 
diff --git a/libs/common/include/launchdarkly/bindings/c/value.h b/libs/common/include/launchdarkly/bindings/c/value.h
@@ -191,6 +191,21 @@ LDValue_GetString(LDValue val);
 LD_EXPORT(unsigned int)
 LDValue_Count(LDValue val);
 
+/**
+ * Serializes the LDValue to a JSON value. The returning string should be
+ * freed with @ref LDMemory_FreeString.
+ *
+ * Please note that numbers are serialized using scientific notation;
+ * for example the number 17 would be serialized as '1.7E1'.
+ *
+ * @param val Target LDValue. Must not be NULL.
+ * @return A string containing the JSON representation of the LDValue. The
+ * string should be freed with @ref LDMemory_FreeString.
+ *
+ */
+LD_EXPORT(char*)
+LDValue_SerializeJSON(LDValue val);
+
 /**
  * Obtain iterator over an array-type @ref LDValue, otherwise NULL.
  *
diff --git a/libs/common/include/launchdarkly/detail/serialization/json_errors.hpp b/libs/common/include/launchdarkly/detail/serialization/json_errors.hpp
diff --git a/libs/common/include/launchdarkly/detail/serialization/json_primitives.hpp b/libs/common/include/launchdarkly/detail/serialization/json_primitives.hpp
@@ -1,6 +1,6 @@
 #pragma once
 
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 #include <tl/expected.hpp>
 
 #include <boost/core/ignore_unused.hpp>
diff --git a/libs/common/include/launchdarkly/detail/serialization/json_value.hpp b/libs/common/include/launchdarkly/detail/serialization/json_value.hpp
@@ -1,6 +1,6 @@
 #pragma once
 
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 #include <launchdarkly/value.hpp>
 
 #include <boost/json/fwd.hpp>
diff --git a/libs/common/src/CMakeLists.txt b/libs/common/src/CMakeLists.txt
@@ -14,6 +14,7 @@ file(GLOB HEADER_LIST CONFIGURE_DEPENDS
         "${LaunchDarklyCommonSdk_SOURCE_DIR}/include/launchdarkly/data/*.hpp"
         "${LaunchDarklyCommonSdk_SOURCE_DIR}/include/launchdarkly/logging/*.hpp"
         "${LaunchDarklyCommonSdk_SOURCE_DIR}/include/launchdarkly/data_sources/*.hpp"
+        "${LaunchDarklyCommonSdk_SOURCE_DIR}/include/launchdarkly/data_sources/persistence/*.hpp"
 )
 
 # Automatic library: static or dynamic based on user config.
@@ -53,6 +54,8 @@ add_library(${LIBNAME} OBJECT
         bindings/c/memory_routines.cpp
         bindings/c/data_source/error_info.cpp
         bindings/c/logging/log_level.cpp
+        serialization/json_errors.cpp
+        serialization/json_value.cpp
         log_level.cpp
         config/persistence_builder.cpp
         config/logging_builder.cpp
diff --git a/libs/common/src/bindings/c/value.cpp b/libs/common/src/bindings/c/value.cpp
@@ -7,6 +7,10 @@
 #include <launchdarkly/detail/unreachable.hpp>
 #include <launchdarkly/value.hpp>
 
+#include <launchdarkly/detail/serialization/json_value.hpp>
+
+#include <boost/json.hpp>
+
 using launchdarkly::Value;
 
 #define AS_VALUE(x) reinterpret_cast<Value*>(x)
@@ -95,6 +99,18 @@ LD_EXPORT(unsigned int) LDValue_Count(LDValue val) {
     }
 }
 
+LD_EXPORT(char*) LDValue_SerializeJSON(LDValue val) {
+    LD_ASSERT_NOT_NULL(val);
+
+    auto const value = AS_VALUE(val);
+
+    auto boost_value = boost::json::value_from(*value);
+
+    std::string json = boost::json::serialize(boost_value);
+
+    return strdup(json.c_str());
+}
+
 LD_EXPORT(LDValue_ArrayIter) LDValue_ArrayIter_New(LDValue val) {
     LD_ASSERT_NOT_NULL(val);
 
diff --git a/libs/common/src/serialization/json_errors.cpp b/libs/common/src/serialization/json_errors.cpp
@@ -1,4 +1,4 @@
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 namespace launchdarkly {
 
diff --git a/libs/common/src/serialization/json_value.cpp b/libs/common/src/serialization/json_value.cpp
@@ -1,7 +1,8 @@
-#include <boost/json.hpp>
 #include <launchdarkly/detail/unreachable.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
-#include <launchdarkly/serialization/value_mapping.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
+
+#include <boost/json.hpp>
 
 namespace launchdarkly {
 // NOLINTBEGIN modernize-return-braced-init-list
diff --git a/libs/common/tests/bindings/value_test.cpp b/libs/common/tests/bindings/value_test.cpp
@@ -4,6 +4,8 @@
 #include "launchdarkly/bindings/c/object_builder.h"
 #include "launchdarkly/bindings/c/value.h"
 
+#include "launchdarkly/bindings/c/memory_routines.h"
+
 TEST(ValueCBindingTests, CanCreateNull) {
     auto* ptr = LDValue_NewNull();
 
@@ -168,3 +170,56 @@ TEST(ValueCBindingTests, CanCreateObject) {
 
     LDValue_Free(val_ptr);
 }
+
+// Helper to serialize an LDValue, automatically converts to
+// std::string and frees the result using LDMemory_FreeString.
+std::string serialize(LDValue const val) {
+    char* serialized = LDValue_SerializeJSON(val);
+    std::string result(serialized);
+    LDMemory_FreeString(serialized);
+    return result;
+}
+
+TEST(ValueCBindingTests, CanSerializeToJSON) {
+    auto* null_val = LDValue_NewNull();
+    auto* bool_val_true = LDValue_NewBool(true);
+    auto* bool_val_false = LDValue_NewBool(false);
+
+    auto* num_val = LDValue_NewNumber(17);
+    auto* float_val = LDValue_NewNumber(3.141);
+    auto* str_val = LDValue_NewString("Potato");
+
+    EXPECT_EQ("null", serialize(null_val));
+    EXPECT_EQ("true", serialize(bool_val_true));
+    EXPECT_EQ("false", serialize(bool_val_false));
+    EXPECT_EQ("1.7E1", serialize(num_val));
+    EXPECT_EQ("3.141E0", serialize(float_val));
+    EXPECT_EQ("\"Potato\"", serialize(str_val));
+
+    // Object builder is going to take care of freeing all the primitives
+    // (except for bool_val_false.)
+    auto* object_builder = LDObjectBuilder_New();
+    LDObjectBuilder_Add(object_builder, "null", null_val);
+    LDObjectBuilder_Add(object_builder, "bool", bool_val_true);
+    LDObjectBuilder_Add(object_builder, "num", num_val);
+    LDObjectBuilder_Add(object_builder, "float", float_val);
+    LDObjectBuilder_Add(object_builder, "str", str_val);
+
+    auto* obj_ptr = LDObjectBuilder_Build(object_builder);
+
+    EXPECT_EQ(
+        "{\"bool\":true,\"float\":3.141E0,\"null\":null,\"num\":1.7E1,\"str\":"
+        "\"Potato\"}",
+        serialize(obj_ptr));
+
+    LDValue_Free(obj_ptr);
+
+    // Array builder is going to take care of freeing bool_val_false.
+    auto* array_builder = LDArrayBuilder_New();
+    LDArrayBuilder_Add(array_builder, bool_val_false);
+    auto* array_ptr = LDArrayBuilder_Build(array_builder);
+
+    EXPECT_EQ("[false]", serialize(array_ptr));
+
+    LDValue_Free(array_ptr);
+}
diff --git a/libs/common/tests/value_test.cpp b/libs/common/tests/value_test.cpp
@@ -1,6 +1,6 @@
 #include <gtest/gtest.h>
 
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 
 #include <boost/json.hpp>
 
diff --git a/libs/internal/include/launchdarkly/serialization/json_context.hpp b/libs/internal/include/launchdarkly/serialization/json_context.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/context.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 #include <tl/expected.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_context_aware_reference.hpp b/libs/internal/include/launchdarkly/serialization/json_context_aware_reference.hpp
@@ -3,7 +3,7 @@
 #include <launchdarkly/attribute_reference.hpp>
 #include <launchdarkly/data_model/context_aware_reference.hpp>
 #include <launchdarkly/serialization/json_context_kind.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
 #include <boost/json.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_context_kind.hpp b/libs/internal/include/launchdarkly/serialization/json_context_kind.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data_model/context_kind.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json.hpp>
 #include <tl/expected.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_evaluation_reason.hpp b/libs/internal/include/launchdarkly/serialization/json_evaluation_reason.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data/evaluation_reason.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 #include <tl/expected.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_evaluation_result.hpp b/libs/internal/include/launchdarkly/serialization/json_evaluation_result.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data/evaluation_result.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 #include <tl/expected.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_flag.hpp b/libs/internal/include/launchdarkly/serialization/json_flag.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data_model/flag.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 
diff --git a/libs/internal/include/launchdarkly/serialization/json_item_descriptor.hpp b/libs/internal/include/launchdarkly/serialization/json_item_descriptor.hpp
@@ -1,8 +1,8 @@
 #pragma once
 
 #include <launchdarkly/data_model/item_descriptor.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
 #include <boost/json.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_rule_clause.hpp b/libs/internal/include/launchdarkly/serialization/json_rule_clause.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data_model/rule_clause.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 #include <tl/expected.hpp>
diff --git a/libs/internal/include/launchdarkly/serialization/json_sdk_data_set.hpp b/libs/internal/include/launchdarkly/serialization/json_sdk_data_set.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data_model/sdk_data_set.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 
diff --git a/libs/internal/include/launchdarkly/serialization/json_segment.hpp b/libs/internal/include/launchdarkly/serialization/json_segment.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <launchdarkly/data_model/segment.hpp>
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 
 #include <boost/json/fwd.hpp>
 
diff --git a/libs/internal/include/launchdarkly/serialization/value_mapping.hpp b/libs/internal/include/launchdarkly/serialization/value_mapping.hpp
@@ -1,7 +1,6 @@
 #pragma once
 
-#include <launchdarkly/serialization/json_errors.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
 
 #include <boost/core/ignore_unused.hpp>
 #include <boost/json.hpp>
diff --git a/libs/internal/src/CMakeLists.txt b/libs/internal/src/CMakeLists.txt
@@ -30,9 +30,7 @@ add_library(${LIBNAME} OBJECT
         serialization/events/json_events.cpp
         serialization/json_attributes.cpp
         serialization/json_context.cpp
-        serialization/json_errors.cpp
         serialization/json_evaluation_reason.cpp
-        serialization/json_value.cpp
         serialization/value_mapping.cpp
         serialization/json_evaluation_result.cpp
         serialization/json_sdk_data_set.cpp
diff --git a/libs/internal/src/serialization/events/json_events.cpp b/libs/internal/src/serialization/events/json_events.cpp
@@ -1,6 +1,6 @@
 #include <launchdarkly/serialization/events/json_events.hpp>
 #include <launchdarkly/serialization/json_evaluation_reason.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 
 namespace launchdarkly::events {
 void tag_invoke(boost::json::value_from_tag const& tag,
diff --git a/libs/internal/src/serialization/json_attributes.cpp b/libs/internal/src/serialization/json_attributes.cpp
@@ -1,5 +1,5 @@
 #include <launchdarkly/serialization/json_attributes.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 
 #include <boost/core/ignore_unused.hpp>
 #include <boost/json.hpp>
diff --git a/libs/internal/src/serialization/json_context.cpp b/libs/internal/src/serialization/json_context.cpp
@@ -1,8 +1,8 @@
 #include <launchdarkly/context_builder.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 #include <launchdarkly/serialization/json_attributes.hpp>
 #include <launchdarkly/serialization/json_context.hpp>
-#include <launchdarkly/serialization/json_primitives.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
 
 #include <boost/core/ignore_unused.hpp>
 #include <boost/json.hpp>
diff --git a/libs/internal/src/serialization/json_evaluation_reason.cpp b/libs/internal/src/serialization/json_evaluation_reason.cpp
@@ -1,4 +1,4 @@
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 #include <launchdarkly/serialization/json_evaluation_reason.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
diff --git a/libs/internal/src/serialization/json_evaluation_result.cpp b/libs/internal/src/serialization/json_evaluation_result.cpp
@@ -1,7 +1,7 @@
-#include <launchdarkly/serialization/json_errors.hpp>
+#include <launchdarkly/detail/serialization/json_errors.hpp>
 #include <launchdarkly/serialization/json_evaluation_reason.hpp>
 #include <launchdarkly/serialization/json_evaluation_result.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
 #include <boost/core/ignore_unused.hpp>
diff --git a/libs/internal/src/serialization/json_flag.cpp b/libs/internal/src/serialization/json_flag.cpp
@@ -2,7 +2,7 @@
 #include <launchdarkly/serialization/json_context_aware_reference.hpp>
 #include <launchdarkly/serialization/json_flag.hpp>
 #include <launchdarkly/serialization/json_rule_clause.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
 namespace launchdarkly {
diff --git a/libs/internal/src/serialization/json_primitives.cpp b/libs/internal/src/serialization/json_primitives.cpp
@@ -1,4 +1,4 @@
-#include <launchdarkly/serialization/json_primitives.hpp>
+#include <launchdarkly/detail/serialization/json_primitives.hpp>
 
 namespace launchdarkly {
 tl::expected<std::optional<bool>, JsonError> tag_invoke(
diff --git a/libs/internal/src/serialization/json_rule_clause.cpp b/libs/internal/src/serialization/json_rule_clause.cpp
@@ -2,7 +2,7 @@
 #include <boost/json.hpp>
 #include <launchdarkly/serialization/json_context_aware_reference.hpp>
 #include <launchdarkly/serialization/json_rule_clause.hpp>
-#include <launchdarkly/serialization/json_value.hpp>
+#include <launchdarkly/detail/serialization/json_value.hpp>
 #include <launchdarkly/serialization/value_mapping.hpp>
 
 namespace launchdarkly {
diff --git a/libs/internal/src/serialization/json_segment.cpp b/libs/internal/src/serialization/json_segment.cpp
diff --git a/libs/internal/tests/data_model_serialization_test.cpp b/libs/internal/tests/data_model_serialization_test.cpp
diff --git a/libs/server-sdk/src/all_flags_state/json_all_flags_state.cpp b/libs/server-sdk/src/all_flags_state/json_all_flags_state.cpp
diff --git a/libs/server-sdk/src/data_systems/background_sync/sources/polling/polling_data_source.cpp b/libs/server-sdk/src/data_systems/background_sync/sources/polling/polling_data_source.cpp
diff --git a/libs/server-sdk/src/integrations/data_reader/kinds.cpp b/libs/server-sdk/src/integrations/data_reader/kinds.cpp

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#include <launchdarkly/serialization/json_errors.hpp>`
	`1`	`+#include <launchdarkly/detail/serialization/json_errors.hpp>`
`2`	`2`
`3`	`3`	`namespace launchdarkly {`
`4`	`4`