fix(versioning): endpoints should return latest versions (#3209)

Flagsmith · Jan 10, 2024 · 5e16e56 · 5e16e56
1 parent 6500451
commit 5e16e56
Show file tree

Hide file tree

Showing 22 changed files with 259 additions and 50 deletions.
diff --git a/api/conftest.py b/api/conftest.py
@@ -53,6 +53,10 @@
 from projects.tags.models import Tag
 from segments.models import Condition, Segment, SegmentRule
 from task_processor.task_run_method import TaskRunMethod
+from tests.types import (
+    WithEnvironmentPermissionsCallable,
+    WithProjectPermissionsCallable,
+)
 from users.models import FFAdminUser, UserPermissionGroup
 
 trait_key = "key1"
@@ -188,7 +192,7 @@ def environment(project):
 @pytest.fixture()
 def with_environment_permissions(
     environment: Environment, staff_user: FFAdminUser
-) -> typing.Callable[[list[str], int | None], UserEnvironmentPermission]:
+) -> WithEnvironmentPermissionsCallable:
     """
     Add environment permissions to the staff_user fixture.
     Defaults to associating to the environment fixture.
@@ -211,7 +215,7 @@ def _with_environment_permissions(
 @pytest.fixture()
 def with_project_permissions(
     project: Project, staff_user: FFAdminUser
-) -> typing.Callable:
+) -> WithProjectPermissionsCallable:
     """
     Add project permissions to the staff_user fixture.
     Defaults to associating to the project fixture.

diff --git a/api/features/feature_segments/views.py b/api/features/feature_segments/views.py
@@ -7,13 +7,17 @@
 from rest_framework.generics import get_object_or_404
 from rest_framework.response import Response
 
+from environments.models import Environment
 from features.feature_segments.serializers import (
     FeatureSegmentChangePrioritiesSerializer,
     FeatureSegmentCreateSerializer,
     FeatureSegmentListSerializer,
     FeatureSegmentQuerySerializer,
 )
 from features.models import FeatureSegment
+from features.versioning.versioning_service import (
+    get_current_live_environment_feature_version,
+)
 from projects.permissions import VIEW_PROJECT
 
 from .permissions import FeatureSegmentPermissions
@@ -53,6 +57,17 @@ def get_queryset(self):
                 data=self.request.query_params
             )
             filter_serializer.is_valid(raise_exception=True)
+
+            environment_id = filter_serializer.validated_data["environment"]
+            environment = Environment.objects.get(id=environment_id)
+            if environment.use_v2_feature_versioning:
+                queryset = queryset.filter(
+                    environment_feature_version=get_current_live_environment_feature_version(
+                        environment_id=environment_id,
+                        feature_id=filter_serializer.validated_data["feature"],
+                    )
+                )
+
             return queryset.select_related("segment").filter(**filter_serializer.data)
 
         return queryset

diff --git a/api/features/versioning/versioning_service.py b/api/features/versioning/versioning_service.py
@@ -4,6 +4,7 @@
 from django.utils import timezone
 
 from features.models import FeatureState
+from features.versioning.models import EnvironmentFeatureVersion
 
 if typing.TYPE_CHECKING:
     from environments.models import Environment
@@ -50,6 +51,7 @@ def get_environment_flags_list(
             "feature",
             "feature_state_value",
             "environment_feature_version",
+            "feature_segment",
             *additional_select_related_args,
         )
         .prefetch_related(*additional_prefetch_related_args)
@@ -63,7 +65,7 @@ def get_environment_flags_list(
     for feature_state in feature_states:
         key = (
             feature_state.feature_id,
-            feature_state.feature_segment_id,
+            getattr(feature_state.feature_segment, "segment_id", None),
             feature_state.identity_id,
         )
         current_feature_state = feature_states_dict.get(key)
@@ -73,6 +75,21 @@ def get_environment_flags_list(
     return list(feature_states_dict.values())
 
 
+def get_current_live_environment_feature_version(
+    environment_id: int, feature_id: int
+) -> EnvironmentFeatureVersion | None:
+    return (
+        EnvironmentFeatureVersion.objects.filter(
+            environment_id=environment_id,
+            feature_id=feature_id,
+            published_at__isnull=False,
+            live_from__lte=timezone.now(),
+        )
+        .order_by("-live_from")
+        .first()
+    )
+
+
 def _build_environment_flags_qs_filter(
     environment: "Environment", feature_name: str = None, additional_filters: Q = None
 ) -> Q:

diff --git a/api/pyproject.toml b/api/pyproject.toml
@@ -29,7 +29,7 @@ use_parentheses = true
 multi_line_output = 3
 include_trailing_comma = true
 line_length = 79
-known_first_party=['analytics','app','custom_auth','environments','integrations','organisations','projects','segments','users','webhooks','api','audit','e2etests','features','permissions','util']
+known_first_party=['analytics','app','custom_auth','environments','integrations','organisations','projects','segments','tests','users','webhooks','api','audit','e2etests','features','permissions','util']
 known_third_party=['_pytest','apiclient','app_analytics','axes','chargebee','core','coreapi','corsheaders','dj_database_url','django','django_lifecycle','djoser','drf_writable_nested','drf_yasg','environs','google','influxdb_client','ordered_model','pyotp','pytest','pytz','requests','responses','rest_framework','rest_framework_nested','rest_framework_recursive','sentry_sdk','shortuuid','simple_history','six','telemetry','tests','trench','whitenoise']
 skip = ['migrations','.venv','.direnv']
 

diff --git a/api/tests/integration/conftest.py b/api/tests/integration/conftest.py
@@ -7,10 +7,10 @@
 from pytest_django.fixtures import SettingsWrapper
 from rest_framework import status
 from rest_framework.test import APIClient
-from tests.integration.helpers import create_mv_option_with_api
 
 from app.utils import create_hash
 from organisations.models import Organisation
+from tests.integration.helpers import create_mv_option_with_api
 
 
 @pytest.fixture()

diff --git a/api/tests/integration/edge_api/identities/test_edge_identity_featurestates_viewset.py b/api/tests/integration/edge_api/identities/test_edge_identity_featurestates_viewset.py
@@ -8,6 +8,7 @@
 from rest_framework import status
 from rest_framework.exceptions import NotFound
 from rest_framework.test import APIClient
+
 from tests.integration.helpers import create_mv_option_with_api
 
 

diff --git a/api/tests/integration/environments/identities/test_integration_identities.py b/api/tests/integration/environments/identities/test_integration_identities.py
@@ -4,13 +4,13 @@
 import pytest
 from django.urls import reverse
 from rest_framework import status
+
+from features.feature_types import MULTIVARIATE
 from tests.integration.helpers import (
     create_feature_with_api,
     create_mv_option_with_api,
 )
 
-from features.feature_types import MULTIVARIATE
-
 variant_1_value = "variant-1-value"
 variant_2_value = "variant-2-value"
 control_value = "control"

diff --git a/api/tests/integration/environments/test_clone_environment.py b/api/tests/integration/environments/test_clone_environment.py
@@ -5,6 +5,7 @@
 from pytest_lazyfixture import lazy_fixture
 from rest_framework import status
 from rest_framework.test import APIClient
+
 from tests.integration.helpers import (
     get_env_feature_states_list_with_api,
     get_feature_segement_list_with_api,

diff --git a/api/tests/integration/features/versioning/test_integration_v2_versioning.py b/api/tests/integration/features/versioning/test_integration_v2_versioning.py
@@ -5,6 +5,7 @@
 import pytest
 from django.urls import reverse
 from rest_framework import status
+
 from tests.test_helpers import generate_segment_data
 
 from .types import (

diff --git a/api/tests/types.py b/api/tests/types.py
@@ -0,0 +1,11 @@
+from typing import Callable
+
+from environments.permissions.models import UserEnvironmentPermission
+from projects.models import Project, UserProjectPermission
+
+WithProjectPermissionsCallable = Callable[
+    [list[str], Project | None], UserProjectPermission
+]
+WithEnvironmentPermissionsCallable = Callable[
+    [list[str], Project | None], UserEnvironmentPermission
+]
diff --git a/api/tests/unit/edge_api/identities/test_edge_api_identities_views.py b/api/tests/unit/edge_api/identities/test_edge_api_identities_views.py
@@ -1,5 +1,3 @@
-from typing import Callable
-
 from django.urls import reverse
 from pytest_mock import MockerFixture
 from rest_framework import status
@@ -16,6 +14,7 @@
 )
 from environments.permissions.permissions import NestedEnvironmentPermissions
 from features.models import Feature
+from tests.types import WithEnvironmentPermissionsCallable
 
 
 def test_edge_identity_view_set_get_permissions():
@@ -97,7 +96,7 @@ def test_edge_identity_viewset_returns_404_for_invalid_environment_key(admin_cli
 
 def test_get_edge_identity_overrides_for_a_feature(
     staff_client: APIClient,
-    with_environment_permissions: Callable,
+    with_environment_permissions: WithEnvironmentPermissionsCallable,
     mocker: MockerFixture,
     feature: Feature,
     environment: Environment,
@@ -166,7 +165,7 @@ def test_get_edge_identity_overrides_for_a_feature(
 
 def test_user_without_manage_identities_permission_cannot_get_edge_identity_overrides_for_a_feature(
     staff_client: APIClient,
-    with_environment_permissions: Callable,
+    with_environment_permissions: WithEnvironmentPermissionsCallable,
     feature: Feature,
     environment: Environment,
 ) -> None:

diff --git a/api/tests/unit/environments/identities/test_unit_identities_feature_states_views.py b/api/tests/unit/environments/identities/test_unit_identities_feature_states_views.py
@@ -3,12 +3,12 @@
 import pytest
 from django.urls import reverse
 from rest_framework import status
-from tests.unit.environments.helpers import get_environment_user_client
 
 from environments.permissions.constants import (
     UPDATE_FEATURE_STATE,
     VIEW_ENVIRONMENT,
 )
+from tests.unit.environments.helpers import get_environment_user_client
 
 
 def test_user_without_update_feature_state_permission_cannot_create_identity_feature_state(

diff --git a/api/tests/unit/environments/test_unit_environments_feature_states_views.py b/api/tests/unit/environments/test_unit_environments_feature_states_views.py
@@ -3,12 +3,12 @@
 import pytest
 from django.urls import reverse
 from rest_framework import status
-from tests.unit.environments.helpers import get_environment_user_client
 
 from environments.permissions.constants import (
     UPDATE_FEATURE_STATE,
     VIEW_ENVIRONMENT,
 )
+from tests.unit.environments.helpers import get_environment_user_client
 
 
 def test_user_without_update_feature_state_permission_cannot_update_feature_state(

diff --git a/api/tests/unit/environments/test_unit_environments_views.py b/api/tests/unit/environments/test_unit_environments_views.py
@@ -28,6 +28,7 @@
 )
 from projects.permissions import CREATE_ENVIRONMENT, VIEW_PROJECT
 from segments.models import Condition, SegmentRule
+from tests.types import WithEnvironmentPermissionsCallable
 from users.models import FFAdminUser
 from util.tests import Helper
 
@@ -605,7 +606,7 @@ def test_create_environment_without_required_metadata_returns_400(
 def test_view_environment_with_staff__query_count_is_expected(
     staff_client: APIClient,
     environment: Environment,
-    with_environment_permissions: Callable[[list[str], int], None],
+    with_environment_permissions: WithEnvironmentPermissionsCallable,
     project: Project,
     django_assert_num_queries: Callable[[int], None],
     environment_metadata_a: Metadata,