feat: enable feature versioning for environments in newly created projects

api/app/settings/common.py

@@ -1242,6 +1242,7 @@
 FLAGSMITH_ON_FLAGSMITH_SERVER_API_URL = env(
     "FLAGSMITH_ON_FLAGSMITH_SERVER_API_URL", default=FLAGSMITH_ON_FLAGSMITH_API_URL
 )
+USE_GLOBAL_FLAGSMITH_CLIENTS = True
 
 FLAGSMITH_ON_FLAGSMITH_FEATURE_EXPORT_ENVIRONMENT_ID = env.int(
     "FLAGSMITH_ON_FLAGSMITH_FEATURE_EXPORT_ENVIRONMENT_ID",

api/app/settings/test.py

@@ -66,3 +66,5 @@
 ENABLE_POSTPONE_DECORATOR = False
 
 DEBUG = True
+
+USE_GLOBAL_FLAGSMITH_CLIENTS = False

api/environments/models.py

@@ -1,3 +1,4 @@
+import datetime
 import logging
 import typing
 import uuid
@@ -15,6 +16,7 @@
     AFTER_DELETE,
     AFTER_SAVE,
     AFTER_UPDATE,
+    BEFORE_CREATE,
     LifecycleModel,
     hook,
 )
@@ -49,6 +51,7 @@
 )
 from features.models import Feature, FeatureSegment, FeatureState
 from features.multivariate.models import MultivariateFeatureStateValue
+from integrations.flagsmith.client import get_client
 from metadata.models import Metadata
 from projects.models import Project
 from segments.models import Segment
@@ -195,6 +198,22 @@ def delete_environment_document_from_cache(self) -> None:
         ):
             environment_document_cache.delete(self.api_key)
 
+    @hook(BEFORE_CREATE)  # type: ignore[misc]
+    def enable_v2_versioning(self) -> None:
+        flagsmith_client = get_client("local", local_eval=True)
+        organisation = self.project.organisation
+        flag = flagsmith_client.get_identity_flags(
+            organisation.flagsmith_identifier,
+            traits={"organisation_id": organisation.id},
+        ).get_flag("enable_feature_versioning_for_new_projects")
+
+        if (
+            flag.enabled
+            and self.project.created_date.date()
+            >= datetime.date.fromisoformat(str(flag.value))
+        ):
+            self.use_v2_feature_versioning = True
+
     def __str__(self):  # type: ignore[no-untyped-def]
         return "Project %s - Environment %s" % (self.project.name, self.name)
 

api/integrations/flagsmith/client.py

@@ -25,13 +25,15 @@
 def get_client(name: str = "default", local_eval: bool = False) -> Flagsmith:
     global _flagsmith_clients
 
-    try:
-        _flagsmith_client = _flagsmith_clients[name]
-    except (KeyError, TypeError):
-        kwargs = _get_client_kwargs()
-        kwargs["enable_local_evaluation"] = local_eval
-        _flagsmith_client = Flagsmith(**kwargs)
-        _flagsmith_clients[name] = _flagsmith_client
+    if settings.USE_GLOBAL_FLAGSMITH_CLIENTS and (
+        client := _flagsmith_clients.get(name)
+    ):
+        return client
+
+    kwargs = _get_client_kwargs()
+    kwargs["enable_local_evaluation"] = local_eval
+    _flagsmith_client = Flagsmith(**kwargs)
+    _flagsmith_clients[name] = _flagsmith_client
 
     return _flagsmith_client
 

api/tests/types.py

@@ -1,3 +1,4 @@
+import typing
 from typing import Callable, Literal
 
 from environments.permissions.models import UserEnvironmentPermission
@@ -17,3 +18,9 @@
 ]
 
 AdminClientAuthType = Literal["user", "master_api_key"]
+
+
+class TestFlagData(typing.NamedTuple):
+    feature_name: str
+    enabled: bool
+    value: typing.Any

api/tests/unit/conftest.py

@@ -1,16 +1,24 @@
+import typing
 from unittest.mock import MagicMock
 
 import pytest
 from django.core.cache import BaseCache
+from flag_engine.environments.models import EnvironmentModel
+from flag_engine.features.models import FeatureModel, FeatureStateModel
+from flag_engine.organisations.models import OrganisationModel
+from flag_engine.projects.models import ProjectModel
+from flagsmith.offline_handlers import BaseOfflineHandler
 from pytest_django.fixtures import SettingsWrapper
 from pytest_mock import MockerFixture
 
 from environments.enums import EnvironmentDocumentCacheMode
 from environments.models import Environment
+from features.feature_types import STANDARD
 from features.models import Feature
 from organisations.models import Organisation, OrganisationRole
 from projects.models import Project
 from projects.tags.models import Tag
+from tests.types import TestFlagData
 from users.models import FFAdminUser
 from util.mappers import map_environment_to_environment_document
 
@@ -232,3 +240,43 @@ def populate_environment_document_cache(
     persistent_environment_document_cache.get.return_value = (
         map_environment_to_environment_document(environment)
     )
+
+
+@pytest.fixture()
+def set_flagsmith_client_flags(
+    mocker: MockerFixture,
+) -> typing.Callable[[list[TestFlagData]], None]:
+    class TestOfflineHandler(BaseOfflineHandler):
+        def __init__(self) -> None:
+            _organisation_model = OrganisationModel(id=1, name="flagsmith-organisation")
+            _project_model = ProjectModel(
+                id=1, name="flagsmith-project", organisation=_organisation_model
+            )
+            self.environment = EnvironmentModel(
+                id=1, api_key="test-key", project=_project_model
+            )
+
+        def set_flags(self, flags: list[TestFlagData]) -> None:
+            self.environment.feature_states = [
+                FeatureStateModel(
+                    feature=FeatureModel(
+                        id=i, name=flag_data.feature_name, type=STANDARD
+                    ),
+                    enabled=flag_data.enabled,
+                    feature_state_value=flag_data.value,
+                )
+                for i, flag_data in enumerate(flags)
+            ]
+
+        def get_environment(self) -> EnvironmentModel:
+            return self.environment
+
+    offline_handler = TestOfflineHandler()
+    mocker.patch(
+        "integrations.flagsmith.client.LocalFileHandler", return_value=offline_handler
+    )
+
+    def _setter(flags: list[TestFlagData]) -> None:
+        offline_handler.set_flags(flags)
+
+    return _setter

api/tests/unit/environments/test_unit_environments_models.py

@@ -39,6 +39,7 @@
 from organisations.models import Organisation, OrganisationRole
 from projects.models import EdgeV2MigrationStatus, Project
 from segments.models import Segment
+from tests.types import TestFlagData
 from users.models import FFAdminUser
 from util.mappers import map_environment_to_environment_document
 
@@ -1208,3 +1209,66 @@ def test_environment_metric_query_helpers_match_expected_counts(
     assert change_request_count_result == change_request_count
     assert scheduled_count_result == scheduled_change_count
     assert identity_override_count == 0
+
+
+def test_environment_create_with_use_v2_feature_versioning_true(
+    project: Project,
+    environment_v2_versioning: Environment,
+    feature: Feature,
+    set_flagsmith_client_flags: typing.Callable[[list[TestFlagData]], None],
+) -> None:
+    # Given
+    set_flagsmith_client_flags(
+        [TestFlagData("enable_feature_versioning_for_new_projects", True, "2025-02-17")]
+    )
+
+    # When
+    new_environment = Environment.objects.create(
+        name="new-environment",
+        project=project,
+    )
+
+    # Then
+    assert EnvironmentFeatureVersion.objects.filter(
+        environment=new_environment, feature=feature
+    ).exists()
+
+
+def test_environment_clone_from_versioned_environment_with_use_v2_feature_versioning_true(
+    project: Project,
+    environment_v2_versioning: Environment,
+    feature: Feature,
+    set_flagsmith_client_flags: typing.Callable[[list[TestFlagData]], None],
+) -> None:
+    # Given
+    set_flagsmith_client_flags(
+        [TestFlagData("enable_feature_versioning_for_new_projects", True, "2025-02-17")]
+    )
+
+    # When
+    new_environment = environment_v2_versioning.clone(name="new-environment")
+
+    # Then
+    assert EnvironmentFeatureVersion.objects.filter(
+        environment=new_environment, feature=feature
+    ).exists()
+
+
+def test_environment_clone_from_non_versioned_environment_with_use_v2_feature_versioning_true(
+    project: Project,
+    environment: Environment,
+    feature: Feature,
+    set_flagsmith_client_flags: typing.Callable[[list[TestFlagData]], None],
+) -> None:
+    # Given
+    set_flagsmith_client_flags(
+        [TestFlagData("enable_feature_versioning_for_new_projects", True, "2025-02-17")]
+    )
+
+    # When
+    new_environment = environment.clone(name="new-environment")
+
+    # Then
+    assert not EnvironmentFeatureVersion.objects.filter(
+        environment=new_environment, feature=feature
+    ).exists()