forward-netbox 2.2.1__tar.gz → 2.2.2__tar.gz

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: forward-netbox
-Version: 2.2.1
+Version: 2.2.2
 Summary: NetBox plugin to sync Forward data into NetBox via built-in NQE queries
 License: MIT
 License-File: LICENSE
@@ -31,7 +31,8 @@ Forward 26.6 is the baseline for async NQE.
 
 | Plugin Release | NetBox Version | Status |
 | --- | --- | --- |
-| `v2.2.1` | `4.6.3` required; needs netbox-branching `1.1.0+` | Current release; Add read-only forward_apply_identity_audit diagnostic to pinpoint 1-created/1-deleted idempotency churn |
+| `v2.2.2` | `4.6.3` required; needs netbox-branching `1.1.0+` | Current release; Fix 504 gateway timeouts on large syncs: stop recomputing change-explainability on every poll during a long merge + back off poll to 15s |
+| `v2.2.1` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.2.2`; Add read-only forward_apply_identity_audit diagnostic to pinpoint 1-created/1-deleted idempotency churn |
 | `v2.2.0` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.2.1`; Fix devices mis-assigned the ACI platform; link Palo vsys / Fortinet vdom firewalls to their physical chassis |
 | `v2.1.5` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.2.0`; Fix Prune orphans erroring on empty sites that still hold a VLAN/VM/prefix (delete only truly-empty sites) |
 | `v2.1.4` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.1.5`; Tag delete-eligible global IPAM (prefixes/VLANs/VRFs) for manual review |

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/README.md

@@ -8,7 +8,8 @@ Forward 26.6 is the baseline for async NQE.
 
 | Plugin Release | NetBox Version | Status |
 | --- | --- | --- |
-| `v2.2.1` | `4.6.3` required; needs netbox-branching `1.1.0+` | Current release; Add read-only forward_apply_identity_audit diagnostic to pinpoint 1-created/1-deleted idempotency churn |
+| `v2.2.2` | `4.6.3` required; needs netbox-branching `1.1.0+` | Current release; Fix 504 gateway timeouts on large syncs: stop recomputing change-explainability on every poll during a long merge + back off poll to 15s |
+| `v2.2.1` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.2.2`; Add read-only forward_apply_identity_audit diagnostic to pinpoint 1-created/1-deleted idempotency churn |
 | `v2.2.0` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.2.1`; Fix devices mis-assigned the ACI platform; link Palo vsys / Fortinet vdom firewalls to their physical chassis |
 | `v2.1.5` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.2.0`; Fix Prune orphans erroring on empty sites that still hold a VLAN/VM/prefix (delete only truly-empty sites) |
 | `v2.1.4` | `4.6.3` required; needs netbox-branching `1.1.0+` | Superseded by `v2.1.5`; Tag delete-eligible global IPAM (prefixes/VLANs/VRFs) for manual review |

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/forward_netbox/__init__.py

@@ -8,7 +8,7 @@ class NetboxForwardConfig(PluginConfig):
     name = "forward_netbox"
     verbose_name = "Forward Field Integration"
     description = "Sync Forward data into NetBox using built-in NQE queries."
-    version = "2.2.1"
+    version = "2.2.2"
     base_url = "forward"
     min_version = "4.6.3"
 

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/forward_netbox/templates/forward_netbox/forwardingestion.html

@@ -167,7 +167,7 @@
     <div id="ingestion_poll"
          class="col col-md-12"
          hx-get="{% url 'plugins:forward_netbox:forwardingestion_logs' pk=object.pk %}?stage={{ active_stage|default:'sync' }}"
-         hx-trigger="{% if job_running %}every 5s{% else %}none{% endif %}"
+         hx-trigger="{% if job_running %}every 15s{% else %}none{% endif %}"
          hx-target="#ingestion_logs"
          hx-select="#ingestion_logs"
          hx-select-oob="#ingestion_status:innerHTML,#ingestion_progress:innerHTML,#ingestion_statistics:innerHTML,#change_explainability:innerHTML,#object_tabs:innerHTML,#ingestion_merge_button:innerHTML"

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/forward_netbox/templates/forward_netbox/partials/ingestion_all.html

@@ -22,7 +22,7 @@
      hx-swap-oob="true"
      class="col col-md-12"
      hx-get="{{ logs_url }}?stage={{ active_stage }}"
-     hx-trigger="{% if polling_done %}none{% else %}every 5s{% endif %}"
+     hx-trigger="{% if polling_done %}none{% else %}every 15s{% endif %}"
      hx-target="#ingestion_logs"
      hx-select="#ingestion_logs"
      hx-select-oob="#ingestion_status:innerHTML,#ingestion_progress:innerHTML,#ingestion_statistics:innerHTML,#change_explainability:innerHTML,#object_tabs:innerHTML,#ingestion_merge_button:innerHTML"

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/forward_netbox/tests/test_log_export.py

@@ -338,6 +338,66 @@ class ForwardIngestionLogExportViewTest(TestCase):
         self.assertContains(response, "ipam.prefix 1")
         self.assertContains(response, "vrf 1")
 
+    def test_poll_defers_change_explainability_while_running(self):
+        # Regression (504 fix): while the job is running, the 5s/15s poll must
+        # NOT recompute change_explainability — doing so on every poll piles DB
+        # load onto the web workers during a long settling merge, which is what
+        # produces the gateway 504s on large platform-reclassification syncs.
+        running_sync = ForwardSync.objects.create(
+            name="sync-running-poll",
+            source=self.source,
+            parameters={"snapshot_id": "latestProcessed"},
+        )
+        running_ing = ForwardIngestion.objects.create(
+            sync=running_sync,
+            snapshot_selector="latestProcessed",
+            snapshot_id="snap-running",
+        )
+        now = timezone.now()
+        running_job = Job.objects.create(
+            object_type=ContentType.objects.get_for_model(ForwardIngestion),
+            object_id=running_ing.pk,
+            name="running-ingestion-job",
+            user=None,
+            status=JobStatusChoices.STATUS_RUNNING,
+            job_id="333e4567-e89b-12d3-a456-426614174002",
+            created=now,
+            started=now,
+            completed=None,
+            data={},
+        )
+        running_ing.job = running_job
+        running_ing.save(update_fields=["job"])
+
+        self.client.force_login(self.user)
+        with patch("forward_netbox.views.change_explainability_summary") as mock_ce:
+            response = self.client.get(
+                reverse(
+                    "plugins:forward_netbox:forwardingestion_logs",
+                    kwargs={"pk": running_ing.pk},
+                ),
+                headers={"HX-Request": "true"},
+            )
+        self.assertEqual(response.status_code, 200)
+        mock_ce.assert_not_called()
+
+    def test_poll_computes_change_explainability_when_done(self):
+        # The completed ingestion still computes it (the deferral is only while
+        # the job runs), so the operator sees the breakdown once it finishes.
+        self.client.force_login(self.user)
+        with patch(
+            "forward_netbox.views.change_explainability_summary",
+            return_value={"available": False},
+        ) as mock_ce:
+            self.client.get(
+                reverse(
+                    "plugins:forward_netbox:forwardingestion_logs",
+                    kwargs={"pk": self.ingestion.pk},
+                ),
+                headers={"HX-Request": "true"},
+            )
+        mock_ce.assert_called_once()
+
     def test_export_logs_compacts_large_execution_plan_items(self):
         sync = ForwardSync.objects.create(
             name="sync-log-export-plan-items",

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/forward_netbox/utilities/apply_identity_audit.py

@@ -67,14 +67,12 @@ def audit_model_identity(model_string, rows, *, sample_limit=15):
 
     # Forward key sets (per lookup_set) from emitted row fields.
     forward_keys = {lookup_set: set() for lookup_set in lookup_sets}
-    forward_row_by_key = {}
     for row in rows:
         values = {field: (row.get(field) or None) for field in row_fields}
         for lookup_set in lookup_sets:
             key = lookup_key_from_values(values, lookup_set, model_string=model_string)
             if key is not None:
                 forward_keys[lookup_set].add(key)
-                forward_row_by_key.setdefault((lookup_set, key), row)
 
     netbox_keys = {lookup_set: set() for lookup_set in lookup_sets}
     netbox_count = 0

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/forward_netbox/views.py

@@ -1374,19 +1374,27 @@ class ForwardIngestionLogView(LoginRequiredMixin, View):
         data["execution_state"] = _compact_execution_state_payload(
             json_safe_value(get_execution_display_state(ingestion.sync))
         )
-        data["change_explainability"] = change_explainability_summary(ingestion)
+        sync_running = ingestion.job and not ingestion.job.completed
+        merge_running = ingestion.merge_job and not ingestion.merge_job.completed
+        job_running = bool(sync_running or merge_running)
+        # Defer the change-explainability recompute while the job is running: it
+        # is only meaningful once staging/merge completes, and recomputing it on
+        # every poll piles DB load onto the web workers during a long settling
+        # merge (a large platform reclassification can run for minutes) — that
+        # contention is what produces the 504 gateway timeouts the customer sees.
+        data["change_explainability"] = (
+            {"available": False, "reason": "deferred_while_running"}
+            if job_running
+            else change_explainability_summary(ingestion)
+        )
         data["export_logs_url"] = reverse(
             "plugins:forward_netbox:forwardingestion_export_logs",
             kwargs={"pk": ingestion.pk},
         )
 
         if request.htmx:
-            sync_running = ingestion.job and not ingestion.job.completed
-            merge_running = ingestion.merge_job and not ingestion.merge_job.completed
             anything_ever_ran = ingestion.job or ingestion.merge_job
-            data["polling_done"] = (
-                bool(anything_ever_ran) and not sync_running and not merge_running
-            )
+            data["polling_done"] = bool(anything_ever_ran) and not job_running
         return render(request, self.template_name, data)
 
 
@@ -1447,7 +1455,13 @@ class ForwardIngestionView(generic.ObjectView):
         data["execution_state"] = _compact_execution_state_payload(
             json_safe_value(get_execution_display_state(instance.sync))
         )
-        data["change_explainability"] = change_explainability_summary(instance)
+        # Defer change-explainability while the job is running (see
+        # ForwardIngestionLogView): avoids recomputing it under merge contention.
+        data["change_explainability"] = (
+            {"available": False, "reason": "deferred_while_running"}
+            if data["job_running"]
+            else change_explainability_summary(instance)
+        )
         data["export_logs_url"] = reverse(
             "plugins:forward_netbox:forwardingestion_export_logs",
             kwargs={"pk": instance.pk},

{forward_netbox-2.2.1 → forward_netbox-2.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "forward-netbox"
-version = "2.2.1"
+version = "2.2.2"
 description = "NetBox plugin to sync Forward data into NetBox via built-in NQE queries"
 authors = ["Craig Johnson <craigjohnson@forwardnetworks.com>"]
 license = "MIT"