feat: Create change requests for segments

api/app/urls.py

@@ -52,7 +52,7 @@
 if settings.SAML_INSTALLED:
     urlpatterns.append(path("api/v1/auth/saml/", include("saml.urls")))
 
-if settings.WORKFLOWS_LOGIC_INSTALLED:
+if settings.WORKFLOWS_LOGIC_INSTALLED:  # pragma: no cover
     workflow_views = importlib.import_module("workflows_logic.views")
     urlpatterns.extend(
         [

api/conftest.py

@@ -18,6 +18,7 @@
 from rest_framework.authtoken.models import Token
 from rest_framework.test import APIClient
 from task_processor.task_run_method import TaskRunMethod
+from urllib3 import HTTPResponse
 from urllib3.connectionpool import HTTPConnectionPool
 from xdist import get_xdist_worker_id
 
@@ -163,7 +164,7 @@ def urlopen_mock(
         url: str,
         *args,
         **kwargs,
-    ) -> HTTPConnectionPool.ResponseCls:
+    ) -> HTTPResponse:
         if self.host in allowed_hosts:
             return original_urlopen(self, method, url, *args, **kwargs)
 
@@ -513,12 +514,19 @@ def feature(project: Project, environment: Environment) -> Feature:
 
 
 @pytest.fixture()
-def change_request(environment, admin_user):
+def change_request(environment: Environment, admin_user: FFAdminUser) -> ChangeRequest:
     return ChangeRequest.objects.create(
         environment=environment, title="Test CR", user_id=admin_user.id
     )
 
 
+@pytest.fixture()
+def project_change_request(project: Project, admin_user: FFAdminUser) -> ChangeRequest:
+    return ChangeRequest.objects.create(
+        project=project, title="Test Project CR", user_id=admin_user.id
+    )
+
+
 @pytest.fixture()
 def feature_state(feature: Feature, environment: Environment) -> FeatureState:
     return FeatureState.objects.get(environment=environment, feature=feature)

api/environments/managers.py

@@ -3,6 +3,7 @@
 
 from features.models import FeatureSegment, FeatureState
 from features.multivariate.models import MultivariateFeatureStateValue
+from segments.models import Segment
 
 
 class EnvironmentManager(SoftDeleteManager):
@@ -21,7 +22,10 @@ def filter_for_document_builder(
                 *extra_select_related or (),
             )
             .prefetch_related(
-                "project__segments",
+                Prefetch(
+                    "project__segments",
+                    queryset=Segment.live_objects.all(),
+                ),
                 "project__segments__rules",
                 "project__segments__rules__rules",
                 "project__segments__rules__conditions",

api/environments/models.py

@@ -347,7 +347,7 @@ def get_segments_from_cache(self) -> typing.List[Segment]:
         segments = environment_segments_cache.get(self.id)
         if not segments:
             segments = list(
-                Segment.objects.filter(
+                Segment.live_objects.filter(
                     feature_segments__feature_states__environment=self
                 ).prefetch_related(
                     "rules",

api/features/workflows/core/migrations/0011_add_project_to_change_requests.py

@@ -0,0 +1,72 @@
+# Generated by Django 4.2.15 on 2024-09-17 15:34
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def set_project_for_existing_change_requests(apps, schema_model):
+    ChangeRequest = apps.get_model("workflows_core", "ChangeRequest")
+
+    for change_request in ChangeRequest.objects.filter(
+        environment_id__isnull=False
+    ).select_related("environment"):
+        change_request.project = change_request.environment.project
+        change_request.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("environments", "0035_add_use_identity_overrides_in_local_eval"),
+        ("projects", "0025_add_change_request_project_permissions"),
+        ("workflows_core", "0010_add_ignore_conflicts_option"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="changerequest",
+            name="project",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="change_requests",
+                to="projects.project",
+            ),
+        ),
+        migrations.AddField(
+            model_name="historicalchangerequest",
+            name="project",
+            field=models.ForeignKey(
+                blank=True,
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.DO_NOTHING,
+                related_name="+",
+                to="projects.project",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="changerequest",
+            name="environment",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="change_requests",
+                to="environments.environment",
+            ),
+        ),
+        migrations.RunPython(
+            set_project_for_existing_change_requests,
+            reverse_code=migrations.RunPython.noop,
+        ),
+        migrations.AlterField(
+            model_name="changerequest",
+            name="project",
+            field=models.ForeignKey(
+                null=False,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="change_requests",
+                to="projects.project",
+            ),
+        ),
+    ]

api/features/workflows/core/models.py

@@ -18,6 +18,7 @@
     AFTER_CREATE,
     AFTER_SAVE,
     AFTER_UPDATE,
+    BEFORE_CREATE,
     BEFORE_DELETE,
     LifecycleModel,
     LifecycleModelMixin,
@@ -77,10 +78,19 @@ class ChangeRequest(
         null=True,
     )
 
+    # Change requests get deleted in a delegated task when a project is deleted.
+    project = models.ForeignKey(
+        "projects.Project",
+        on_delete=models.CASCADE,
+        related_name="change_requests",
+        null=False,
+    )
+
     environment = models.ForeignKey(
         "environments.Environment",
         on_delete=models.CASCADE,
         related_name="change_requests",
+        null=True,
     )
 
     committed_at = models.DateTimeField(null=True)
@@ -114,6 +124,7 @@ def commit(self, committed_by: "FFAdminUser"):
         self._publish_feature_states()
         self._publish_environment_feature_versions(committed_by)
         self._publish_change_sets(committed_by)
+        self._publish_segments()
 
         self.committed_at = timezone.now()
         self.committed_by = committed_by
@@ -181,6 +192,30 @@ def _publish_change_sets(self, published_by: "FFAdminUser") -> None:
         for change_set in self.change_sets.all():
             change_set.publish(user=published_by)
 
+    def _publish_segments(self) -> None:
+        for segment in self.segments.all():
+            target_segment = segment.version_of
+            assert target_segment != segment
+
+            # Deep clone the segment to establish historical version this is required
+            # because the target segment will be altered when the segment is published.
+            # Think of it like a regular update to a segment where we create the clone
+            # to create the version, then modifying the new 'draft' version with the
+            # data from the change request.
+            target_segment.deep_clone()
+
+            # Set the properties of the change request's segment to the properties
+            # of the target (i.e., canonical) segment.
+            target_segment.name = segment.name
+            target_segment.description = segment.description
+            target_segment.feature = segment.feature
+            target_segment.save()
+
+            # Delete the rules in order to replace them with copies of the segment.
+            target_segment.rules.all().delete()
+            for rule in segment.rules.all():
+                rule.deep_clone(target_segment)
+
     def get_create_log_message(self, history_instance) -> typing.Optional[str]:
         return CHANGE_REQUEST_CREATED_MESSAGE % self.title
 
@@ -208,10 +243,21 @@ def get_audit_log_author(self, history_instance) -> typing.Optional["FFAdminUser
     def _get_environment(self) -> typing.Optional["Environment"]:
         return self.environment
 
-    def _get_project(self) -> typing.Optional["Project"]:
-        return self.environment.project
+    def _get_project(self) -> "Project":
+        return self.project
 
     def is_approved(self):
+        if self.environment:
+            return self.is_approved_via_environment()
+        return self.is_approved_via_project()
+
+    def is_approved_via_project(self):
+        return self.project.minimum_change_request_approvals is None or (
+            self.approvals.filter(approved_at__isnull=False).count()
+            >= self.project.minimum_change_request_approvals
+        )
+
+    def is_approved_via_environment(self):
         return self.environment.minimum_change_request_approvals is None or (
             self.approvals.filter(approved_at__isnull=False).count()
             >= self.environment.minimum_change_request_approvals
@@ -228,15 +274,22 @@ def url(self):
                 "Change request must be saved before it has a url attribute."
             )
         url = get_current_site_url()
-        url += f"/project/{self.environment.project_id}"
-        url += f"/environment/{self.environment.api_key}"
+        if self.environment:
+            url += f"/project/{self.environment.project_id}"
+            url += f"/environment/{self.environment.api_key}"
+        else:
+            url += f"/projects/{self.project_id}"
         url += f"/change-requests/{self.id}"
         return url
 
     @property
     def email_subject(self):
         return f"Flagsmith Change Request: {self.title} (#{self.id})"
 
+    @hook(BEFORE_CREATE, when="project", is_now=None)
+    def set_project_from_environment(self):
+        self.project_id = self.environment.project_id
+
     @hook(AFTER_CREATE, when="committed_at", is_not=None)
     @hook(AFTER_SAVE, when="committed_at", was=None, is_not=None)
     def create_audit_log_for_related_feature_state(self):
@@ -368,6 +421,9 @@ def get_audit_log_author(self, history_instance) -> "FFAdminUser":
     def _get_environment(self):
         return self.change_request.environment
 
+    def _get_project(self):
+        return self.change_request._get_project()
+
 
 class ChangeRequestGroupAssignment(AbstractBaseExportableModel, LifecycleModel):
     change_request = models.ForeignKey(