[fix] Prevent update_config task from matching itself in active check

_is_update_in_progress() was matching the currently executing task
against itself in Celery's inspect().active() results, causing
config pushes to be silently skipped in production deployments.

Signed-off-by: prakash-kalwaniya <kalwaniyaprakash1@gmail.com>

Author: mn-ram

openwisp_controller/connection/tasks.py

@@ -16,20 +16,24 @@
 _TASK_NAME = "openwisp_controller.connection.tasks.update_config"
 
 
-def _is_update_in_progress(device_id):
+def _is_update_in_progress(device_id, current_task_id=None):
     active = current_app.control.inspect().active()
     if not active:
         return False
     # check if there's any other running task before adding it
     for task_list in active.values():
         for task in task_list:
-            if task["name"] == _TASK_NAME and str(device_id) in task["args"]:
+            if (
+                task["name"] == _TASK_NAME
+                and str(device_id) in task["args"]
+                and task["id"] != current_task_id
+            ):
                 return True
     return False
 
 
-@shared_task
-def update_config(device_id):
+@shared_task(bind=True)
+def update_config(self, device_id):
     """
     Launches the ``update_config()`` operation
     of a specific device in the background
@@ -48,7 +52,7 @@ def update_config(device_id):
     except ObjectDoesNotExist as e:
         logger.warning(f'update_config("{device_id}") failed: {e}')
         return
-    if _is_update_in_progress(device_id):
+    if _is_update_in_progress(device_id, current_task_id=self.request.id):
         return
     try:
         device_conn = DeviceConnection.get_working_connection(device)

openwisp_controller/connection/tests/test_models.py

@@ -1032,7 +1032,13 @@ def test_device_update_config_in_progress(
 
         with mock.patch("celery.app.control.Inspect.active") as mocked_active:
             mocked_active.return_value = {
-                "task": [{"name": _TASK_NAME, "args": [str(conf.device.pk)]}]
+                "task": [
+                    {
+                        "name": _TASK_NAME,
+                        "args": [str(conf.device.pk)],
+                        "id": "other-task-id",
+                    }
+                ]
             }
             conf.config = {"general": {"timezone": "UTC"}}
             conf.full_clean()
@@ -1054,7 +1060,7 @@ def test_device_update_config_not_in_progress(
 
         with mock.patch("celery.app.control.Inspect.active") as mocked_active:
             mocked_active.return_value = {
-                "task": [{"name": _TASK_NAME, "args": ["..."]}]
+                "task": [{"name": _TASK_NAME, "args": ["..."], "id": "other-task-id"}]
             }
             conf.config = {"general": {"timezone": "UTC"}}
             conf.full_clean()