fix: Rebuild environments when stop serving flags changed (#2944)

api/organisations/models.py

@@ -145,6 +145,17 @@ def clear_environment_caches(self):
             )
         )
 
+    @hook(AFTER_SAVE, when="stop_serving_flags", has_changed=True)
+    def rebuild_environments(self):
+        # Avoid circular imports.
+        from environments.models import Environment
+        from environments.tasks import rebuild_environment_document
+
+        for environment_id in Environment.objects.filter(
+            project__organisation=self
+        ).values_list("id", flat=True):
+            rebuild_environment_document.delay(args=(environment_id,))
+
 
 class UserOrganisation(models.Model):
     user = models.ForeignKey("users.FFAdminUser", on_delete=models.CASCADE)

api/organisations/tests/test_models.py

@@ -3,8 +3,10 @@
 
 import pytest
 from django.test import TestCase
+from pytest_mock import MockerFixture
 from rest_framework.test import override_settings
 
+from environments.models import Environment
 from organisations.chargebee.metadata import ChargebeeObjMetadata
 from organisations.models import (
     TRIAL_SUBSCRIPTION_ID,
@@ -83,6 +85,41 @@ def test_cancel_subscription_cancels_chargebee_subscription(
         assert subscription.cancellation_date
 
 
+def test_organisation_rebuild_environment_document_on_stop_serving_flags_changed(
+    environment: Environment, organisation: Organisation, mocker: MockerFixture
+):
+    # Given
+    mocked_rebuild_environment_document = mocker.patch(
+        "environments.tasks.rebuild_environment_document"
+    )
+    assert organisation.stop_serving_flags is False
+
+    # When
+    organisation.stop_serving_flags = True
+    organisation.save()
+
+    # Then
+    mocked_rebuild_environment_document.delay.assert_called_once_with(
+        args=(environment.id,)
+    )
+
+
+def test_organisation_rebuild_environment_document_on_stop_serving_flags_unchanged(
+    environment: Environment, organisation: Organisation, mocker: MockerFixture
+):
+    # Given
+    mocked_rebuild_environment_document = mocker.patch(
+        "environments.tasks.rebuild_environment_document"
+    )
+
+    # When saving something irrelevant
+    organisation.alerted_over_plan_limit = True
+    organisation.save()
+
+    # Then the task should not be called
+    mocked_rebuild_environment_document.delay.assert_not_called()
+
+
 def test_organisation_over_plan_seats_limit_returns_false_if_not_over_plan_seats_limit(
     organisation, chargebee_subscription, mocker
 ):