[change] Added cache for org config, refactoring

Org config settings are now cached to ensure
DeviceChecksumview is not degraded. This will
be invalidated on org settings update/delete
which are rare.
Refactored code and tests for readability.

Signed-off-by: DragnEmperor <[email protected]>

Author: DragnEmperor

docs/user/settings.rst

@@ -743,8 +743,8 @@ For more information on these settings, you can refer to the `the celery
 documentation regarding automatic retries for known errors.
 <https://docs.celeryq.dev/en/stable/userguide/tasks.html#automatic-retry-for-known-exceptions>`_
 
-``OPENWISP_CONTROLLER_WHOIS_ENABLED``
--------------------------------------
+``OPENWISP_CONTROLLER_WHO_IS_ENABLED``
+--------------------------------------
 
 ============ =========
 **type**:    ``bool``
@@ -754,7 +754,7 @@ documentation regarding automatic retries for known errors.
 Allows to enable WhoIs lookup feature.
 
 .. image:: https://github.com/user-attachments/assets/0737d39c-1fad-4fca-aca9-9b42bc321763
-    :alt: whois admin setting
+    :alt: who_is admin setting
 
 This feature is used to fetch details of a device based on its last
 reported public IP address. The fetched details include ASN, CIDR,
@@ -776,7 +776,7 @@ This feature is disabled by default and requires setting the
 
 This setting represents the Account ID of your Maxmind Account which can
 be obtained by following the steps mentioned in the :doc:`WhoIs Lookup
-<whois>`.
+<who-is>`.
 
 This setting is required for WhoIs lookup feature to work.
 
@@ -790,6 +790,6 @@ This setting is required for WhoIs lookup feature to work.
 
 This setting represents the License Key of your Maxmind Account which can
 be obtained by following the steps mentioned in the :doc:`WhoIs Lookup
-<whois>`.
+<who-is>`.
 
 This setting is required for WhoIs lookup feature to work.

docs/user/whois.rst renamed to docs/user/who-is.rst

@@ -6,17 +6,17 @@ WHOIS lookup
     The WhoIs lookup feature is disabled by default.
 
     In order to enable this feature you have to follow the `setup
-    instructions <controller_setup_whois_lookup_>`_ below and then
+    instructions <controller_setup_who_is_lookup_>`_ below and then
     activate it via :ref:`global setting or from the admin interface
-    <OPENWISP_CONTROLLER_WHOIS_ENABLED>`.
+    <OPENWISP_CONTROLLER_WHO_IS_ENABLED>`.
 
 WhoIs feature includes fetching details of the last public ip address
 reported by a device to ensure better device management.
 
 The fetched details include Organization Name, ASN, CIDR, Address,
 Timezone.
 
-.. _controller_setup_whois_lookup:
+.. _controller_setup_who_is_lookup:
 
 Setup
 -----

openwisp_controller/config/apps.py

@@ -63,6 +63,7 @@ def __setmodels__(self):
         self.org_limits = load_model("config", "OrganizationLimits")
         self.cert_model = load_model("django_x509", "Cert")
         self.org_model = load_model("openwisp_users", "Organization")
+        self.org_config_model = load_model("config", "OrganizationConfigSettings")
 
     def connect_signals(self):
         """
@@ -74,6 +75,10 @@ def connect_signals(self):
         * cache invalidation
         """
         from . import handlers  # noqa
+        from .who_is.handlers import (
+            device_who_is_info_delete_handler,
+            invalidate_org_settings_cache,
+        )
 
         m2m_changed.connect(
             self.config_model.clean_templates,
@@ -156,6 +161,21 @@ def connect_signals(self):
             sender=self.org_model,
             dispatch_uid="organization_allowed_devices_post_save_handler",
         )
+        post_delete.connect(
+            device_who_is_info_delete_handler,
+            sender=self.device_model,
+            dispatch_uid="device.delete_who_is_info",
+        )
+        post_save.connect(
+            invalidate_org_settings_cache,
+            self.org_config_model,
+            dispatch_uid="invalidate_org_config_cache_on_org_config_save",
+        )
+        post_delete.connect(
+            invalidate_org_settings_cache,
+            self.org_config_model,
+            dispatch_uid="invalidate_org_config_cache_on_org_config_delete",
+        )
 
     def register_menu_groups(self):
         register_menu_group(
@@ -312,7 +332,6 @@ def enable_cache_invalidation(self):
             devicegroup_delete_handler,
             vpn_server_change_handler,
         )
-        from .whois.handlers import device_whois_info_delete_handler
 
         post_save.connect(
             DeviceChecksumView.invalidate_get_device_cache,
@@ -370,11 +389,6 @@ def enable_cache_invalidation(self):
             sender=self.vpn_model,
             dispatch_uid="vpn.invalidate_checksum_cache",
         )
-        post_delete.connect(
-            device_whois_info_delete_handler,
-            sender=self.device_model,
-            dispatch_uid="device.delete_whois_info",
-        )
 
     def register_dashboard_charts(self):
         register_dashboard_chart(

openwisp_controller/config/base/device.py

@@ -337,7 +337,8 @@ def _get_initial_values_for_checked_fields(self):
         if not present_values:
             return
         self.refresh_from_db(fields=present_values.keys())
-        for field in present_values:
+        # TODO: check
+        for field in self._changed_checked_fields:
             setattr(self, f"_initial_{field}", field)
             setattr(self, field, present_values[field])
 
@@ -381,7 +382,7 @@ def _check_last_ip(self):
         if self._initial_last_ip == models.DEFERRED:
             return
 
-        self.whois_service.trigger_whois_lookup()
+        self.who_is_service.trigger_who_is_lookup()
 
         self._initial_last_ip = self.last_ip
 
@@ -424,12 +425,12 @@ def status(self):
         return self._get_config_attr("get_status_display")
 
     @cached_property
-    def whois_service(self):
+    def who_is_service(self):
         """
         Used as a shortcut to get WhoIsService instance
         for the device.
         """
-        from ..whois.service import WhoIsService
+        from ..who_is.service import WhoIsService
 
         return WhoIsService(self)
 

openwisp_controller/config/base/multitenancy.py

@@ -43,9 +43,9 @@ class AbstractOrganizationConfigSettings(UUIDModel):
         ),
         verbose_name=_("Configuration Variables"),
     )
-    whois_enabled = FallbackBooleanChoiceField(
+    who_is_enabled = FallbackBooleanChoiceField(
         help_text=_("Whether WhoIs details lookup is enabled"),
-        fallback=app_settings.WHOIS_ENABLED,
+        fallback=app_settings.WHO_IS_ENABLED,
         verbose_name=_("WhoIs Enabled"),
     )
 

openwisp_controller/config/base/whois.py renamed to openwisp_controller/config/base/who_is.py

@@ -78,11 +78,11 @@ class Migration(migrations.Migration):
         ),
         migrations.AddField(
             model_name="organizationconfigsettings",
-            name="whois_enabled",
+            name="who_is_enabled",
             field=openwisp_utils.fields.FallbackBooleanChoiceField(
                 blank=True,
                 default=None,
-                fallback=app_settings.WHOIS_ENABLED,
+                fallback=app_settings.WHO_IS_ENABLED,
                 help_text="Whether WhoIs details lookup is enabled",
                 null=True,
                 verbose_name="WhoIs Enabled",

openwisp_controller/config/migrations/0060_whoisinfo.py

@@ -10,7 +10,7 @@
 from .base.tag import AbstractTaggedTemplate, AbstractTemplateTag
 from .base.template import AbstractTemplate
 from .base.vpn import AbstractVpn, AbstractVpnClient
-from .base.whois import AbstractWhoIsInfo
+from .base.who_is import AbstractWhoIsInfo
 
 
 class Device(AbstractDevice):
@@ -116,7 +116,7 @@ class Meta(AbstractOrganizationLimits.Meta):
 
 class WhoIsInfo(AbstractWhoIsInfo):
     """
-    Concrete Whois model
+    Concrete WhoIs model
     """
 
     class Meta(AbstractWhoIsInfo.Meta):

openwisp_controller/config/models.py

@@ -69,4 +69,4 @@ def get_setting(option, default):
 )
 GEOIP_ACCOUNT_ID = get_setting("GEOIP_ACCOUNT_ID", None)
 GEOIP_LICENSE_KEY = get_setting("GEOIP_LICENSE_KEY", None)
-WHOIS_ENABLED = get_setting("WHOIS_ENABLED", False)
+WHO_IS_ENABLED = get_setting("WHO_IS_ENABLED", False)

openwisp_controller/config/settings.py

@@ -73,9 +73,9 @@ def update_last_ip(device, request):
     if device.last_ip != ip:
         device.last_ip = ip
         update_fields.append("last_ip")
-    # for cases of devices who do not have whois record
-    elif not device.whois_service.get_whois_info():
-        device.whois_service.trigger_whois_lookup()
+    # for cases of devices who do not have who_is record
+    elif not device.who_is_service.get_device_who_is_info():
+        device.who_is_service.trigger_who_is_lookup()
     if device.management_ip != management_ip:
         device.management_ip = management_ip
         update_fields.append("management_ip")

openwisp_controller/config/utils.py

@@ -0,0 +1,18 @@
+from django.core.cache import cache
+from django.db import transaction
+
+from .service import WhoIsService
+
+
+# Remove the related WhoIs record for that ip from db and cache
+# If other active devices are linked to it, then new lookup will
+# be triggered for them.
+def device_who_is_info_delete_handler(instance, **kwargs):
+    transaction.on_commit(
+        lambda: WhoIsService.delete_who_is_record.delay(instance.last_ip)
+    )
+
+
+def invalidate_org_settings_cache(instance, **kwargs):
+    org_pk = instance.organization_id
+    cache.delete(WhoIsService.ORG_SETTINGS_CACHE_KEY.format(org_pk=org_pk))