feat!: Remove FeatureContext.feature_key, SegmentResult.key

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "tests/engine_tests/engine-test-data"]
 	path = tests/engine_tests/engine-test-data
 	url = https://github.com/flagsmith/engine-test-data.git
-	tag = v2.5.0
+	tag = v3.0.0

flag_engine/context/types.py

@@ -57,7 +57,6 @@ class SegmentRule(TypedDict):
 
 class FeatureContext(TypedDict, Generic[FeatureMetadataT]):
     key: str
-    feature_key: str
     name: str
     enabled: bool
     value: Any

flag_engine/result/types.py

@@ -12,7 +12,6 @@
 
 
 class FlagResult(TypedDict, Generic[FeatureMetadataT]):
-    feature_key: str
     name: str
     enabled: bool
     value: Any
@@ -21,7 +20,6 @@ class FlagResult(TypedDict, Generic[FeatureMetadataT]):
 
 
 class SegmentResult(TypedDict, Generic[SegmentMetadataT]):
-    key: str
     name: str
     metadata: NotRequired[SegmentMetadataT]
 

flag_engine/segments/evaluator.py

@@ -63,7 +63,6 @@ def get_evaluation_result(
             continue
 
         segment_result: SegmentResult[SegmentMetadataT] = {
-            "key": segment_context["key"],
             "name": segment_context["name"],
         }
         if segment_metadata := segment_context.get("metadata"):
@@ -72,19 +71,19 @@ def get_evaluation_result(
 
         if overrides := segment_context.get("overrides"):
             for override_feature_context in overrides:
-                feature_key = override_feature_context["feature_key"]
+                feature_name = override_feature_context["name"]
                 if (
-                    feature_key not in segment_feature_contexts
+                    feature_name not in segment_feature_contexts
                     or override_feature_context.get(
                         "priority",
                         constants.DEFAULT_PRIORITY,
                     )
-                    < (segment_feature_contexts[feature_key]["feature_context"]).get(
+                    < (segment_feature_contexts[feature_name]["feature_context"]).get(
                         "priority",
                         constants.DEFAULT_PRIORITY,
                     )
                 ):
-                    segment_feature_contexts[feature_key] = (
+                    segment_feature_contexts[feature_name] = (
                         FeatureContextWithSegmentName(
                             feature_context=override_feature_context,
                             segment_name=segment_context["name"],
@@ -99,13 +98,12 @@ def get_evaluation_result(
     for feature_context in (context.get("features") or {}).values():
         feature_name = feature_context["name"]
         if feature_context_with_segment_name := segment_feature_contexts.get(
-            feature_context["feature_key"],
+            feature_context["name"],
         ):
             feature_context = feature_context_with_segment_name["feature_context"]
             flag_result: FlagResult[FeatureMetadataT]
             flags[feature_name] = flag_result = {
                 "enabled": feature_context["enabled"],
-                "feature_key": feature_context["feature_key"],
                 "name": feature_context["name"],
                 "reason": f"TARGETING_MATCH; segment={feature_context_with_segment_name['segment_name']}",
                 "value": feature_context.get("value"),
@@ -153,7 +151,6 @@ def get_flag_result_from_feature_context(
             if start_percentage <= percentage_value < limit:
                 flag_result = {
                     "enabled": feature_context["enabled"],
-                    "feature_key": feature_context["feature_key"],
                     "name": feature_context["name"],
                     "reason": f"SPLIT; weight={weight}",
                     "value": variant["value"],
@@ -165,7 +162,6 @@ def get_flag_result_from_feature_context(
     if flag_result is None:
         flag_result = {
             "enabled": feature_context["enabled"],
-            "feature_key": feature_context["feature_key"],
             "name": feature_context["name"],
             "reason": "DEFAULT",
             "value": feature_context["value"],

tests/unit/conftest.py

@@ -53,16 +53,12 @@ def segment(segment_rule: SegmentRule) -> SegmentContext:
 
 @pytest.fixture()
 def feature_state_1() -> FeatureContext:
-    return FeatureContext(
-        feature_key="1", key="1", name="feature_1", value=None, enabled=True
-    )
+    return FeatureContext(key="1", name="feature_1", value=None, enabled=True)
 
 
 @pytest.fixture()
 def feature_state_2() -> FeatureContext:
-    return FeatureContext(
-        feature_key="2", key="2", name="feature_2", value=None, enabled=False
-    )
+    return FeatureContext(key="2", name="feature_2", value=None, enabled=False)
 
 
 @pytest.fixture()
@@ -89,8 +85,8 @@ def context(
     return {
         "environment": environment,
         "features": {
-            feature_state_1["feature_key"]: feature_state_1,
-            feature_state_2["feature_key"]: feature_state_2,
+            feature_state_1["name"]: feature_state_1,
+            feature_state_2["name"]: feature_state_2,
         },
         "segments": {segment["key"]: segment},
         "identity": identity,
@@ -126,7 +122,6 @@ def context_in_segment(
                 "overrides": [
                     {
                         "key": "4",
-                        "feature_key": "1",
                         "name": "feature_1",
                         "enabled": False,
                         "value": "segment_override",

tests/unit/segments/test_segments_evaluator.py

@@ -803,7 +803,6 @@ def test_segment_condition_matches_context_value_for_modulo(
             10,
             {
                 "enabled": False,
-                "feature_key": "1",
                 "name": "my_feature",
                 "reason": "SPLIT; weight=30",
                 "value": "foo",
@@ -813,7 +812,6 @@ def test_segment_condition_matches_context_value_for_modulo(
             40,
             {
                 "enabled": False,
-                "feature_key": "1",
                 "name": "my_feature",
                 "reason": "SPLIT; weight=30",
                 "value": "bar",
@@ -823,7 +821,6 @@ def test_segment_condition_matches_context_value_for_modulo(
             70,
             {
                 "enabled": False,
-                "feature_key": "1",
                 "name": "my_feature",
                 "reason": "DEFAULT",
                 "value": "control",
@@ -850,7 +847,6 @@ def test_get_flag_result_from_feature_context__calls_returns_expected(
     # and have a feature context with some multivariate feature options and associated values
     feature_context: FeatureContext = {
         "key": expected_feature_context_key,
-        "feature_key": "1",
         "enabled": False,
         "name": "my_feature",
         "value": "control",
@@ -892,7 +888,6 @@ def test_get_flag_result_from_feature_context__null_key__calls_returns_expected(
 
     feature_context: FeatureContext = {
         "key": expected_feature_context_key,
-        "feature_key": "1",
         "enabled": False,
         "name": "my_feature",
         "value": "control",
@@ -912,7 +907,6 @@ def test_get_flag_result_from_feature_context__null_key__calls_returns_expected(
     # the value of the feature state is the default one
     assert result == {
         "enabled": False,
-        "feature_key": "1",
         "name": "my_feature",
         "reason": "DEFAULT",
         "value": "control",