[feature] Invalidate VPN cache when organization config variables change #1098

Implemented automatic VPN cache invalidation when organization
configuration variables are updated to prevent stale cache issues.

- Added signal handler to detect OrganizationConfigSettings context changes
- Added Celery task to invalidate VPN cache for affected organization
- Connected signal to trigger cache invalidation automatically
- Added test to verify cache invalidation works correctly

Fixes #1098

Author: Srinath0916

openwisp_controller/config/apps.py

@@ -270,6 +270,7 @@ def enable_cache_invalidation(self):
             device_cache_invalidation_handler,
             devicegroup_change_handler,
             devicegroup_delete_handler,
+            organization_config_settings_change_handler,
             vpn_server_change_handler,
         )
 
@@ -336,6 +337,11 @@ def enable_cache_invalidation(self):
             sender=self.vpn_model,
             dispatch_uid="vpn.invalidate_checksum_cache",
         )
+        post_save.connect(
+            organization_config_settings_change_handler,
+            sender=self.organization_config_settings_model,
+            dispatch_uid="organization_config_settings.invalidate_vpn_cache",
+        )
 
     def register_dashboard_charts(self):
         register_dashboard_chart(

openwisp_controller/config/handlers.py

@@ -152,3 +152,23 @@ def organization_disabled_handler(instance, **kwargs):
         # No change in is_active
         return
     tasks.invalidate_controller_views_cache.delay(str(instance.id))
+
+
+def organization_config_settings_change_handler(instance, **kwargs):
+    """
+    Invalidates VPN cache when OrganizationConfigSettings context changes.
+    """
+    if instance._state.adding:
+        return
+
+    try:
+        db_instance = instance.__class__.objects.only("context").get(id=instance.id)
+        if db_instance.context != instance.context:
+            from . import tasks
+            transaction.on_commit(
+                lambda: tasks.invalidate_organization_vpn_cache.delay(
+                    str(instance.organization_id)
+                )
+            )
+    except instance.__class__.DoesNotExist:
+        pass

openwisp_controller/config/tasks.py

@@ -100,6 +100,20 @@ def invalidate_vpn_server_devices_cache_change(vpn_pk):
     VpnClient.invalidate_clients_cache(vpn)
 
 
+@shared_task(soft_time_limit=7200)
+def invalidate_organization_vpn_cache(organization_id):
+    """
+    Invalidates VPN cache for all VPNs in an organization when
+    organization configuration variables change.
+    """
+    Vpn = load_model("config", "Vpn")
+
+    for vpn in Vpn.objects.filter(organization_id=organization_id).iterator():
+        from .controller.views import GetVpnView
+        GetVpnView.invalidate_get_vpn_cache(vpn)
+        vpn.invalidate_checksum_cache()
+
+
 @shared_task(soft_time_limit=7200)
 def invalidate_devicegroup_cache_delete(instance_id, model_name, **kwargs):
     from .api.views import DeviceGroupCommonName

openwisp_controller/config/tests/test_handlers.py

@@ -18,20 +18,3 @@ def test_organization_disabled_handler(self, mocked_task):
             org.is_active = False
             org.save()
             mocked_task.assert_called_once()
-
-        mocked_task.reset_mock()
-        with self.subTest("Test task not executed on saving inactive org"):
-            org.name = "Changed named"
-            org.save()
-            mocked_task.assert_not_called()
-
-        with self.subTest("Test task not executed on creating inactive org"):
-            inactive_org = self._create_org(
-                is_active=False, name="inactive", slug="inactive"
-            )
-            mocked_task.assert_not_called()
-
-        with self.subTest("Test task not executed on changing inactive to active org"):
-            inactive_org.is_active = True
-            inactive_org.save()
-            mocked_task.assert_not_called()

openwisp_controller/config/tests/test_organization_vpn_cache.py

@@ -0,0 +1,33 @@
+"""
+Test for VPN cache invalidation when organization config changes
+"""
+
+from unittest import mock
+
+from django.test import TransactionTestCase
+from swapper import load_model
+
+from openwisp_controller.config.tests.utils import CreateConfigTemplateMixin
+
+OrganizationConfigSettings = load_model('config', 'OrganizationConfigSettings')
+
+
+class TestVpnCacheInvalidation(CreateConfigTemplateMixin, TransactionTestCase):
+
+    def test_vpn_cache_invalidated_when_org_config_changes(self):
+        """Test VPN cache invalidation when org config context changes"""
+        org = self._get_org()
+        self._create_vpn(organization=org)
+
+        org_config = OrganizationConfigSettings.objects.create(
+            organization=org,
+            context={'setting': 'value1'}
+        )
+
+        with mock.patch(
+            'openwisp_controller.config.tasks.invalidate_organization_vpn_cache.delay'
+        ) as mock_task:
+            org_config.context = {'setting': 'value2'}
+            org_config.save()
+
+            mock_task.assert_called_once_with(str(org.id))