fix: refactor Variation methods for correctness & clarity

contract-tests/server-contract-tests/test-suppressions.txt

@@ -1,111 +1,3 @@
-# SC-214431
-evaluation/parameterized/bad attribute reference errors - clause with no attribute/test-flag/evaluate flag with detail
-evaluation/parameterized/bad attribute reference errors - empty path component/test-flag/evaluate flag with detail
-evaluation/parameterized/bad attribute reference errors - tilde followed by invalid escape character/test-flag/evaluate flag with detail
-evaluation/parameterized/bad attribute reference errors - tilde followed by nothing/test-flag/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/off variation too low/off variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/off variation too high/off variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/flag is off but has no off variation/flag is off but has no off variation/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/fallthrough variation too low/fallthrough variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/fallthrough variation too high/fallthrough variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/target variation too low/target variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/target variation too high/target variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/rule variation too low/rule variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (bool)/rule variation too high/rule variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/off variation too low/off variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/off variation too high/off variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/flag is off but has no off variation/flag is off but has no off variation/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/fallthrough variation too low/fallthrough variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/fallthrough variation too high/fallthrough variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/target variation too low/target variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/target variation too high/target variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/rule variation too low/rule variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (int)/rule variation too high/rule variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/off variation too low/off variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/off variation too high/off variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/flag is off but has no off variation/flag is off but has no off variation/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/fallthrough variation too low/fallthrough variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/fallthrough variation too high/fallthrough variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/target variation too low/target variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/target variation too high/target variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/rule variation too low/rule variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (double)/rule variation too high/rule variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/off variation too low/off variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/off variation too high/off variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/flag is off but has no off variation/flag is off but has no off variation/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/fallthrough variation too low/fallthrough variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/fallthrough variation too high/fallthrough variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/target variation too low/target variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/target variation too high/target variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/rule variation too low/rule variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (string)/rule variation too high/rule variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/off variation too low/off variation too low/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/off variation too low/off variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/off variation too high/off variation too high/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/off variation too high/off variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/flag is off but has no off variation/flag is off but has no off variation/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/flag is off but has no off variation/flag is off but has no off variation/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/fallthrough variation too low/fallthrough variation too low/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/fallthrough variation too low/fallthrough variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/fallthrough variation too high/fallthrough variation too high/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/fallthrough variation too high/fallthrough variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/target variation too low/target variation too low/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/target variation too low/target variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/target variation too high/target variation too high/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/target variation too high/target variation too high/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/rule variation too low/rule variation too low/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/rule variation too low/rule variation too low/evaluate flag with detail
-evaluation/parameterized/evaluation failures (any)/rule variation too high/rule variation too high/evaluate flag without detail
-evaluation/parameterized/evaluation failures (any)/rule variation too high/rule variation too high/evaluate flag with detail
-evaluation/parameterized/prerequisites/prerequisite cycle is detected at top level, recursion stops/prerequisite cycle is detected at top level, recursion stops/evaluate flag with detail
-evaluation/parameterized/prerequisites/prerequisite cycle is detected at top level, recursion stops/prerequisite cycle is detected at top level, recursion stops/evaluate all flags
-evaluation/parameterized/prerequisites/prerequisite cycle is detected at deeper level, recursion stops/prerequisite cycle is detected at deeper level, recursion stops/evaluate flag with detail
-evaluation/parameterized/prerequisites/prerequisite cycle is detected at deeper level, recursion stops/prerequisite cycle is detected at deeper level, recursion stops/evaluate all flags
-evaluation/parameterized/rollout or experiment - error for empty variations list in rollout/fallthrough rollout/fallthrough rollout/evaluate flag with detail
-evaluation/parameterized/rollout or experiment - error for empty variations list in rollout/rule rollout/rule rollout/evaluate flag with detail
-evaluation/parameterized/segment recursion/cycle is detected at top level, recursion stops/cycle is detected at top level, recursion stops/evaluate flag with detail
-evaluation/parameterized/segment recursion/cycle is detected below top level, recursion stops/cycle is detected below top level, recursion stops/evaluate flag with detail
-events/summary events/prerequisites
-events/feature events/full feature event for tracked flag/without reason/single kind default/malformed flag/type: bool
-events/feature events/full feature event for tracked flag/without reason/single kind default/malformed flag/type: int
-events/feature events/full feature event for tracked flag/without reason/single kind default/malformed flag/type: double
-events/feature events/full feature event for tracked flag/without reason/single kind default/malformed flag/type: string
-events/feature events/full feature event for tracked flag/without reason/single kind default/malformed flag/type: any
-events/feature events/full feature event for tracked flag/without reason/single kind non-default/valid flag/type: bool
-events/feature events/full feature event for tracked flag/without reason/single kind non-default/malformed flag/type: bool
-events/feature events/full feature event for tracked flag/without reason/single kind non-default/malformed flag/type: int
-events/feature events/full feature event for tracked flag/without reason/single kind non-default/malformed flag/type: double
-events/feature events/full feature event for tracked flag/without reason/single kind non-default/malformed flag/type: string
-events/feature events/full feature event for tracked flag/without reason/single kind non-default/malformed flag/type: any
-events/feature events/full feature event for tracked flag/without reason/multi-kind/valid flag/type: bool
-events/feature events/full feature event for tracked flag/without reason/multi-kind/malformed flag/type: bool
-events/feature events/full feature event for tracked flag/without reason/multi-kind/malformed flag/type: int
-events/feature events/full feature event for tracked flag/without reason/multi-kind/malformed flag/type: double
-events/feature events/full feature event for tracked flag/without reason/multi-kind/malformed flag/type: string
-events/feature events/full feature event for tracked flag/without reason/multi-kind/malformed flag/type: any
-events/feature events/full feature event for tracked flag/with reason/single kind default/valid flag/type: bool
-events/feature events/full feature event for tracked flag/with reason/single kind default/malformed flag/type: bool
-events/feature events/full feature event for tracked flag/with reason/single kind default/malformed flag/type: int
-events/feature events/full feature event for tracked flag/with reason/single kind default/malformed flag/type: double
-events/feature events/full feature event for tracked flag/with reason/single kind default/malformed flag/type: string
-events/feature events/full feature event for tracked flag/with reason/single kind default/malformed flag/type: any
-events/feature events/full feature event for tracked flag/with reason/single kind non-default/valid flag/type: bool
-events/feature events/full feature event for tracked flag/with reason/single kind non-default/malformed flag/type: bool
-events/feature events/full feature event for tracked flag/with reason/single kind non-default/malformed flag/type: int
-events/feature events/full feature event for tracked flag/with reason/single kind non-default/malformed flag/type: double
-events/feature events/full feature event for tracked flag/with reason/single kind non-default/malformed flag/type: string
-events/feature events/full feature event for tracked flag/with reason/single kind non-default/malformed flag/type: any
-events/feature events/full feature event for tracked flag/with reason/multi-kind/valid flag/type: bool
-events/feature events/full feature event for tracked flag/with reason/multi-kind/malformed flag/type: bool
-events/feature events/full feature event for tracked flag/with reason/multi-kind/malformed flag/type: int
-events/feature events/full feature event for tracked flag/with reason/multi-kind/malformed flag/type: double
-events/feature events/full feature event for tracked flag/with reason/multi-kind/malformed flag/type: string
-events/feature events/full feature event for tracked flag/with reason/multi-kind/malformed flag/type: any
-events/feature events/evaluating all flags generates no events
-events/feature prerequisite events/without reasons
-events/feature prerequisite events/with reasons
-events/experimentation/experiment in rule
-events/experimentation/experiment in fallthrough
 streaming/updates/flag patch with same version is not applied
 streaming/updates/segment patch with same version is not applied
 streaming/updates/flag patch with lower version is not applied
@@ -162,7 +54,3 @@ context type/convert/old user to context/{"key": "a", "avatar": "b"}
 context type/convert/old user to context/{"key": "a", "avatar": null}
 context type/convert/old user to context/{"key": "a", "ip": "b"}
 context type/convert/old user to context/{"key": "a", "ip": null}
-
-# These appear to only fail in CI, but not locally on Mac. Requires investigation.
-evaluation/bucketing/bucket by non-key attribute/in rollouts/invalid value type
-evaluation/bucketing/bucket by non-key attribute/in rollouts/attribute not found

libs/internal/include/launchdarkly/data_model/flag.hpp

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <launchdarkly/data/evaluation_reason.hpp>
 #include <launchdarkly/data_model/context_aware_reference.hpp>
 #include <launchdarkly/data_model/context_kind.hpp>
 #include <launchdarkly/data_model/rule_clause.hpp>
@@ -21,7 +22,7 @@
     using FlagVersion = std::uint64_t;
     using Date = std::uint64_t;
 
     struct Rollout {
         enum class Kind {
             kUnrecognized = 0,
             kExperiment = 1,
@@ -104,5 +105,8 @@
      * @return Version of this flag.
      */
     [[nodiscard]] inline std::uint64_t Version() const { return version; }
+
+    [[nodiscard]] bool IsExperimentationEnabled(
+        std::optional<EvaluationReason> const& reason) const;
 };
 }  // namespace launchdarkly::data_model

libs/internal/include/launchdarkly/events/data/common_events.hpp

@@ -62,6 +62,7 @@ struct FeatureEventParams {
     std::optional<Reason> reason;
     bool require_full_event;
     std::optional<Date> debug_events_until_date;
+    std::optional<std::string> prereq_of;
 };
 
 struct FeatureEventBase {
@@ -72,6 +73,7 @@ struct FeatureEventBase {
     Value value;
     std::optional<Reason> reason;
     Value default_;
+    std::optional<std::string> prereq_of;
 
     explicit FeatureEventBase(FeatureEventParams const& params);
 };

libs/internal/src/data_model/flag.cpp

@@ -6,7 +6,7 @@
                                                     Flag::Weight weight_)
     : WeightedVariation(variation_, weight_, false) {}
 
 Flag::Rollout::WeightedVariation::WeightedVariation(Flag::Variation variation_,
                                                     Flag::Weight weight_,
                                                     bool untracked_)
     : variation(variation_), weight(weight_), untracked(untracked_) {}
@@ -26,4 +26,26 @@
       bucketBy("key"),
       contextKind("user") {}
 
+bool Flag::IsExperimentationEnabled(
+    std::optional<EvaluationReason> const& reason) const {
+    if (!reason) {
+        return false;
+    }
+    if (reason->InExperiment()) {
+        return true;
+    }
+    switch (reason->Kind()) {
+        case EvaluationReason::Kind::kFallthrough:
+            return this->trackEventsFallthrough;
+        case EvaluationReason::Kind::kRuleMatch:
+            if (!reason->RuleIndex() ||
+                reason->RuleIndex() >= this->rules.size()) {
+                return false;
+            }
+            return this->rules.at(*reason->RuleIndex()).trackEvents;
+        default:
+            return false;
+    }
+}
+
 }  // namespace launchdarkly::data_model

libs/internal/src/events/common_events.cpp

@@ -8,5 +8,6 @@ FeatureEventBase::FeatureEventBase(FeatureEventParams const& params)
       variation(params.variation),
       value(params.value),
       reason(params.reason),
-      default_(params.default_) {}
+      default_(params.default_),
+      prereq_of(params.prereq_of) {}
 }  // namespace launchdarkly::events

libs/internal/src/serialization/events/json_events.cpp

@@ -39,6 +39,9 @@
         obj.emplace("reason", boost::json::value_from(*event.reason));
     }
     obj.emplace("default", boost::json::value_from(event.default_));
+    if (event.prereq_of) {
+        obj.emplace("prereqOf", *event.prereq_of);
+    }
 }
 
 void tag_invoke(boost::json::value_from_tag const& tag,
@@ -53,7 +56,7 @@
 
 namespace launchdarkly::events::server_side {
 
 void tag_invoke(boost::json::value_from_tag const&,
                 boost::json::value& json_value,
                 IndexEvent const& event) {
     auto& obj = json_value.emplace_object();

libs/server-sdk/src/CMakeLists.txt

@@ -43,6 +43,7 @@ add_library(${LIBNAME}
         data_store/persistent/expiration_tracker.hpp
         data_store/persistent/persistent_data_store.cpp
         data_store/persistent/expiration_tracker.cpp
+        events/event_factory.cpp
         )
 
 if (MSVC OR (NOT BUILD_SHARED_LIBS))

libs/server-sdk/src/all_flags_state/all_flags_state_builder.hpp

@@ -7,9 +7,6 @@
 
 namespace launchdarkly::server_side {
 
-bool IsExperimentationEnabled(data_model::Flag const& flag,
-                              std::optional<EvaluationReason> const& reason);
-
 bool IsSet(AllFlagsState::Options options, AllFlagsState::Options flag);
 bool NotSet(AllFlagsState::Options options, AllFlagsState::Options flag);