fix: Identity overrides empty in SDK document with v2 versioning (#6840)

Author: khvn26

api/features/models.py

@@ -618,6 +618,8 @@ def type(self) -> str:
     @property
     def is_live(self) -> bool:
         if self.environment.use_v2_feature_versioning:  # type: ignore[union-attr]
+            if self.identity_id is not None:
+                return True
             return (
                 self.environment_feature_version_id is not None
                 and self.environment_feature_version.is_live  # type: ignore[union-attr]

api/tests/integration/sdk/test_sdk_environment_document.py

@@ -0,0 +1,52 @@
+import json
+
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.test import APIClient
+
+from features.versioning.tasks import enable_v2_versioning
+
+
+def test_get_environment_document__v2_versioning_with_identity_override__identity_features_populated(
+    admin_client: APIClient,
+    server_side_sdk_client: APIClient,
+    feature: int,
+    identity_featurestate: int,
+    environment: int,
+    environment_api_key: str,
+) -> None:
+    """Reproduce https://github.com/Flagsmith/flagsmith/issues/6839
+
+    When Feature Versioning v2 is enabled, identity overrides should still
+    appear in the SDK document with their identity_features populated.
+    """
+
+    # Given - identity overrides are enabled in local eval
+    url = reverse(
+        "api-v1:environments:environment-detail",
+        args=[environment_api_key],
+    )
+    response = admin_client.get(url)
+    environment_data = response.json()
+    environment_data["use_identity_overrides_in_local_eval"] = True
+    admin_client.put(
+        url,
+        data=json.dumps(environment_data),
+        content_type="application/json",
+    )
+
+    # and v2 feature versioning is enabled after identity override exists
+    enable_v2_versioning(environment)
+
+    # When
+    response = server_side_sdk_client.get("/api/v1/environment-document/")
+
+    # Then
+    assert response.status_code == status.HTTP_200_OK
+
+    identity_overrides = response.json()["identity_overrides"]
+    assert len(identity_overrides) == 1
+
+    identity_override = identity_overrides[0]
+    assert len(identity_override["identity_features"]) > 0
+    assert identity_override["identity_features"][0]["feature"]["id"] == feature

api/tests/unit/environments/test_unit_environments_views_sdk_environment.py

@@ -1,10 +1,12 @@
 import time
 from typing import TYPE_CHECKING
+from unittest.mock import ANY
 
 import pytest
 from django.urls import reverse
 from django.utils import timezone
 from django.utils.http import http_date
+from pytest_lazyfixture import lazy_fixture  # type: ignore[import-untyped]
 from rest_framework import status
 from rest_framework.test import APIClient
 
@@ -121,6 +123,105 @@ def test_get_environment_document(
     )
 
 
+@pytest.mark.parametrize(
+    "environment_",
+    (
+        lazy_fixture("environment"),
+        lazy_fixture("environment_v2_versioning"),
+    ),
+)
+def test_get_environment_document__identity_overrides(
+    project: Project,
+    environment_: Environment,
+) -> None:
+    # Given
+    api_key = EnvironmentAPIKey.objects.create(environment=environment_)
+    client = APIClient()
+    client.credentials(HTTP_X_ENVIRONMENT_KEY=api_key.key)
+
+    feature = Feature.objects.create(name="test_feature", project=project)
+    for i in range(2):
+        identity = Identity.objects.create(
+            environment=environment_,
+            identifier=f"identity_{i}",
+        )
+        identity_feature_state = FeatureState.objects.create(
+            identity=identity,
+            feature=feature,
+            environment=environment_,
+        )
+        FeatureStateValue.objects.filter(feature_state=identity_feature_state).update(
+            string_value="overridden",
+            type=STRING,
+        )
+
+    url = reverse("api-v1:environment-document")
+
+    # When
+    response = client.get(url)
+
+    # Then
+    assert response.status_code == status.HTTP_200_OK
+    assert sorted(
+        response.data["identity_overrides"],
+        key=lambda x: x["identifier"],
+    ) == [
+        {
+            "composite_key": ANY,
+            "created_date": ANY,
+            "django_id": ANY,
+            "environment_api_key": environment_.api_key,
+            "identifier": "identity_0",
+            "dashboard_alias": None,
+            "identity_features": [
+                {
+                    "django_id": ANY,
+                    "enabled": False,
+                    "feature": {
+                        "id": feature.id,
+                        "name": "test_feature",
+                        "type": "STANDARD",
+                    },
+                    "feature_segment": None,
+                    "feature_state_value": "overridden",
+                    "featurestate_uuid": ANY,
+                    "multivariate_feature_state_values": [],
+                }
+            ],
+            "identity_traits": [],
+            "identity_uuid": ANY,
+        },
+        {
+            "composite_key": ANY,
+            "created_date": ANY,
+            "django_id": ANY,
+            "environment_api_key": environment_.api_key,
+            "identifier": "identity_1",
+            "dashboard_alias": None,
+            "identity_features": [
+                {
+                    "django_id": ANY,
+                    "enabled": False,
+                    "feature": {
+                        "id": feature.id,
+                        "name": "test_feature",
+                        "type": "STANDARD",
+                    },
+                    "feature_segment": None,
+                    "feature_state_value": "overridden",
+                    "featurestate_uuid": ANY,
+                    "multivariate_feature_state_values": [],
+                }
+            ],
+            "identity_traits": [],
+            "identity_uuid": ANY,
+        },
+    ]
+    assert response.headers[FLAGSMITH_UPDATED_AT_HEADER] == str(
+        environment_.updated_at.timestamp()
+    )
+
+
 def test_get_environment_document_fails_with_invalid_key(
     organisation_one: "Organisation",
     organisation_one_project_one: "Project",

api/tests/unit/features/test_unit_features_models.py

@@ -720,6 +720,22 @@ def test_feature_state_is_live(version, live_from, expected_is_live, environment
     )
 
 
+def test_feature_state_is_live__identity_override_v2_versioning__returns_true(
+    environment_v2_versioning: Environment,
+    identity: Identity,
+    feature: Feature,
+) -> None:
+    # Given
+    feature_state = FeatureState.objects.create(
+        identity=identity,
+        feature=feature,
+        environment=environment_v2_versioning,
+    )
+
+    # When / Then
+    assert feature_state.is_live is True
+
+
 def test_creating_a_feature_with_defaults_does_not_set_defaults_if_disabled(  # type: ignore[no-untyped-def]
     project, environment
 ):