feat: add Flag model to SDKDataSet (#159)

Adds in missing `Flag` model to the top-level `SDKDataSet`. Additionally, both the flag/segment fields now use use `PARSE_FIELD`, so we can get an empty `unordered_map` if they are missing.
launchdarkly · Jul 6, 2023 · 09d2bd6 · 09d2bd6
1 parent f38e038
commit 09d2bd6
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 7 deletions.
diff --git a/libs/internal/include/launchdarkly/data_model/flag.hpp b/libs/internal/include/launchdarkly/data_model/flag.hpp
@@ -83,5 +83,12 @@ struct Flag {
     bool trackEvents;
     bool trackEventsFallthrough;
     std::optional<std::uint64_t> debugEventsUntilDate;
+
+    /**
+     * Returns the flag's version. Satisfies ItemDescriptor template
+     * constraints.
+     * @return Version of this flag.
+     */
+    [[nodiscard]] inline std::uint64_t Version() const { return version; }
 };
 }  // namespace launchdarkly::data_model
diff --git a/libs/internal/include/launchdarkly/data_model/sdk_data_set.hpp b/libs/internal/include/launchdarkly/data_model/sdk_data_set.hpp
@@ -1,5 +1,6 @@
 #pragma once
 
+#include <launchdarkly/data_model/flag.hpp>
 #include <launchdarkly/data_model/item_descriptor.hpp>
 #include <launchdarkly/data_model/segment.hpp>
 
@@ -14,9 +15,8 @@ namespace launchdarkly::data_model {
 struct SDKDataSet {
     using FlagKey = std::string;
     using SegmentKey = std::string;
-    // std::unordered_map<FlagKey, ItemDescriptor<Flag>> flags;
-    std::optional<std::unordered_map<SegmentKey, ItemDescriptor<Segment>>>
-        segments;
+    std::unordered_map<FlagKey, ItemDescriptor<Flag>> flags;
+    std::unordered_map<SegmentKey, ItemDescriptor<Segment>> segments;
 };
 
 }  // namespace launchdarkly::data_model
diff --git a/libs/internal/include/launchdarkly/data_model/segment.hpp b/libs/internal/include/launchdarkly/data_model/segment.hpp
@@ -48,6 +48,12 @@ struct Segment {
 
     // TODO(cwaldren): make Kind a real type that is deserialized, so we can
     // make empty string an error.
+
+    /**
+     * Returns the segment's version. Satisfies ItemDescriptor template
+     * constraints.
+     * @return Version of this segment.
+     */
     [[nodiscard]] inline std::uint64_t Version() const { return version; }
 };
 }  // namespace launchdarkly::data_model
diff --git a/libs/internal/src/serialization/json_sdk_data_set.cpp b/libs/internal/src/serialization/json_sdk_data_set.cpp
@@ -1,5 +1,6 @@
 #include <boost/core/ignore_unused.hpp>
 #include <boost/json.hpp>
+#include <launchdarkly/serialization/json_flag.hpp>
 #include <launchdarkly/serialization/json_item_descriptor.hpp>
 #include <launchdarkly/serialization/json_sdk_data_set.hpp>
 #include <launchdarkly/serialization/json_segment.hpp>
@@ -19,7 +20,8 @@ tl::expected<std::optional<data_model::SDKDataSet>, JsonError> tag_invoke(
 
     data_model::SDKDataSet data_set;
 
-    PARSE_CONDITIONAL_FIELD(data_set.segments, obj, "segments");
+    PARSE_FIELD(data_set.flags, obj, "flags");
+    PARSE_FIELD(data_set.segments, obj, "segments");
 
     return data_set;
 }

diff --git a/libs/internal/tests/data_model_serialization_test.cpp b/libs/internal/tests/data_model_serialization_test.cpp
@@ -13,7 +13,8 @@ TEST(SDKDataSetTests, DeserializesEmptyDataSet) {
         boost::json::value_to<tl::expected<data_model::SDKDataSet, JsonError>>(
             boost::json::parse("{}"));
     ASSERT_TRUE(result);
-    ASSERT_FALSE(result->segments);
+    ASSERT_TRUE(result->segments.empty());
+    ASSERT_TRUE(result->flags.empty());
 }
 
 TEST(SDKDataSetTests, ErrorOnInvalidSchema) {
@@ -29,8 +30,15 @@ TEST(SDKDataSetTests, DeserializesZeroSegments) {
         boost::json::value_to<tl::expected<data_model::SDKDataSet, JsonError>>(
             boost::json::parse(R"({"segments":{}})"));
     ASSERT_TRUE(result);
-    ASSERT_TRUE(result->segments);
-    ASSERT_TRUE(result->segments->empty());
+    ASSERT_TRUE(result->segments.empty());
+}
+
+TEST(SDKDataSetTests, DeserializesZeroFlags) {
+    auto result =
+        boost::json::value_to<tl::expected<data_model::SDKDataSet, JsonError>>(
+            boost::json::parse(R"({"flags":{}})"));
+    ASSERT_TRUE(result);
+    ASSERT_TRUE(result->flags.empty());
 }
 
 TEST(SegmentTests, DeserializesMinimumValid) {