diff --git a/src/edge_proxy/mappers.py b/src/edge_proxy/mappers.py index 85cc0f7..1c8b385 100644 --- a/src/edge_proxy/mappers.py +++ b/src/edge_proxy/mappers.py @@ -21,6 +21,7 @@ def map_flag_result_to_response_data( }, "enabled": flag_result["enabled"], "feature_state_value": flag_result["value"], + "reason": flag_result["reason"], } diff --git a/tests/conftest.py b/tests/conftest.py index 61a50d5..7078f08 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -16,6 +16,7 @@ def environment_1_feature_states_response_list() -> typing.List[dict]: "feature_state_value": "feature_1_value", "feature": {"name": "feature_1", "type": "STANDARD", "id": 1}, "enabled": False, + "reason": "STATIC", }, { "feature_state_value": "2.3", @@ -25,6 +26,7 @@ def environment_1_feature_states_response_list() -> typing.List[dict]: "id": 2, }, "enabled": True, + "reason": "STATIC", }, ] @@ -36,6 +38,10 @@ def environment_1_feature_states_response_list_response_with_segment_override( environment_1_feature_states_response_list[1]["feature_state_value"] = ( "segment_override" ) + environment_1_feature_states_response_list[0]["reason"] = "DEFAULT" + environment_1_feature_states_response_list[1]["reason"] = ( + "TARGETING_MATCH; segment=segment_1" + ) return environment_1_feature_states_response_list @@ -47,6 +53,10 @@ def environment_1_feature_states_response_list_response_with_identity_override( "identity_override" ) environment_1_feature_states_response_list[0]["enabled"] = True + environment_1_feature_states_response_list[0]["reason"] = ( + "TARGETING_MATCH; segment=identity_overrides" + ) + environment_1_feature_states_response_list[1]["reason"] = "DEFAULT" return environment_1_feature_states_response_list diff --git a/tests/test_environments.py b/tests/test_environments.py index 245b259..2e4289c 100644 --- a/tests/test_environments.py +++ b/tests/test_environments.py @@ -276,6 +276,7 @@ async def test_refresh_environment_caches__deleted_identity_override__cached_exp "type": "STANDARD", }, "feature_state_value": "identity_override", + "reason": "TARGETING_MATCH; segment=identity_overrides", }, { "enabled": True, @@ -285,6 +286,7 @@ async def test_refresh_environment_caches__deleted_identity_override__cached_exp "type": "STANDARD", }, "feature_state_value": "2.3", + "reason": "DEFAULT", }, ], "traits": [], @@ -305,11 +307,13 @@ async def test_refresh_environment_caches__deleted_identity_override__cached_exp "enabled": False, "feature": {"id": 1, "name": "feature_1", "type": "STANDARD"}, "feature_state_value": "feature_1_value", + "reason": "STATIC", }, { "enabled": True, "feature": {"id": 2, "name": "feature_2", "type": "STANDARD"}, "feature_state_value": "2.3", + "reason": "DEFAULT", }, ], "traits": [], diff --git a/tests/test_mappers.py b/tests/test_mappers.py index 7f7744e..1afd335 100644 --- a/tests/test_mappers.py +++ b/tests/test_mappers.py @@ -17,6 +17,7 @@ def flag_result() -> dict[str, Any]: "name": "feature_1", "enabled": False, "value": "feature_1_value", + "reason": "DEFAULT", "metadata": {"id": 1}, } @@ -28,6 +29,7 @@ def multivariate_flag_result() -> dict[str, Any]: "name": "multivariate_feature", "enabled": False, "value": None, + "reason": "SPLIT; weight=50", "metadata": {"id": 4}, } @@ -72,6 +74,7 @@ def test_map_flag_result_to_response_data__return_expected( "type": "STANDARD", }, "feature_state_value": None, + "reason": "SPLIT; weight=50", } @@ -93,6 +96,7 @@ def test_map_flag_result_to_response_data__with_feature_types__return_expected( "type": "MULTIVARIATE", }, "feature_state_value": None, + "reason": "SPLIT; weight=50", } @@ -116,6 +120,7 @@ def test_map_flag_results_to_response_data__return_expected( "type": "STANDARD", }, "feature_state_value": "feature_1_value", + "reason": "DEFAULT", }, { "enabled": False, @@ -125,6 +130,7 @@ def test_map_flag_results_to_response_data__return_expected( "type": "STANDARD", }, "feature_state_value": None, + "reason": "SPLIT; weight=50", }, ] @@ -150,6 +156,7 @@ def test_map_flag_results_to_response_data__with_feature_types__return_expected( "type": "STANDARD", }, "feature_state_value": "feature_1_value", + "reason": "DEFAULT", }, { "enabled": False, @@ -159,6 +166,7 @@ def test_map_flag_results_to_response_data__with_feature_types__return_expected( "type": "MULTIVARIATE", }, "feature_state_value": None, + "reason": "SPLIT; weight=50", }, ] diff --git a/tests/test_server.py b/tests/test_server.py index a13803d..979a6d9 100644 --- a/tests/test_server.py +++ b/tests/test_server.py @@ -477,13 +477,19 @@ def test_get_flags__segment_needing_identity__returns_environment_default( # Then assert response.status_code == 200 assert response.json()["feature_state_value"] == "2.3" + assert response.json()["reason"] == "STATIC" @pytest.mark.parametrize( - "prerequisite_enabled, expected_enabled, expected_value", + "prerequisite_enabled, expected_enabled, expected_value, expected_reason", [ - (True, True, "segment_override"), - (False, False, "feature_1_value"), + ( + True, + True, + "segment_override", + "TARGETING_MATCH; segment=feature_2_on", + ), + (False, False, "feature_1_value", "DEFAULT"), ], ) def test_get_flags__segment_depending_on_flag__serves_flag_by_prerequisite( @@ -492,6 +498,7 @@ def test_get_flags__segment_depending_on_flag__serves_flag_by_prerequisite( prerequisite_enabled: bool, expected_enabled: bool, expected_value: str, + expected_reason: str, ) -> None: # Given environment = copy.deepcopy(environment_1) @@ -537,6 +544,7 @@ def test_get_flags__segment_depending_on_flag__serves_flag_by_prerequisite( assert response.status_code == 200 assert response.json()["enabled"] is expected_enabled assert response.json()["feature_state_value"] == expected_value + assert response.json()["reason"] == expected_reason def test_get_flags__segment_depending_on_environment__returns_segment_override( @@ -585,13 +593,18 @@ def test_get_flags__segment_depending_on_environment__returns_segment_override( # Then assert response.status_code == 200 assert response.json()["feature_state_value"] == "segment_override" + assert response.json()["reason"] == "TARGETING_MATCH; segment=environment_1_only" @pytest.mark.parametrize( - "identifier, expected_value", + "identifier, expected_value, expected_reason", [ - ("overridden-id", "segment_override"), - ("test_identity", "2.3"), + ( + "overridden-id", + "segment_override", + "TARGETING_MATCH; segment=feature_1_on", + ), + ("test_identity", "2.3", "DEFAULT"), ], ) def test_post_identity__segment_depending_on_flag__serves_flag_by_identity_flag( @@ -599,6 +612,7 @@ def test_post_identity__segment_depending_on_flag__serves_flag_by_identity_flag( client: TestClient, identifier: str, expected_value: str, + expected_reason: str, ) -> None: # Given environment_key = "test_environment_key" @@ -648,3 +662,4 @@ def test_post_identity__segment_depending_on_flag__serves_flag_by_identity_flag( if flag["feature"]["name"] == "feature_2" ) assert feature_2["feature_state_value"] == expected_value + assert feature_2["reason"] == expected_reason