starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #16395] [CLOSED] 16293 fix form data handler deleting checkbox data #14843

New Issue
Closed
opened 2025-12-29 23:27:03 +01:00 by adam · 0 comments
adam commented 2025-12-29 23:27:03 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/16395
Author: @ibuclaw
Created: 6/4/2024
Status: ❌ Closed

Base: develop ← Head: fix_16293

📝 Commits (1)

  • 3ec84e3 16293 fix form data handler deleting checkbox data

📊 Changes

1 file changed (+9 additions, -3 deletions)

View changed files

📝 netbox/project-static/src/netbox.ts (+9 -3)

📄 Description

In NetBox, formData may have multiple values associated with a given key (see netbox/templates/django/forms/widgets/checkbox.html), however a handler that prunes empty form data before posting doesn't take this into account.

So instead of a for loop over all formData.entries(), retrieve all values using formData.getAll(), delete all keys from formData, then append all non-empty values back in.

Fixes: #16293

What is happening here?

  1. Netbox uses checkboxes in Edit forms (reference)
  2. NetBox uses HTMX in Edit forms (reference)
  3. HTMX breaks NetBox by filtering unchecked checkboxes from submit form data (reference) (bug report)
  4. NetBox worked around this by adding in a hidden input with the same name, and an empty string value (reference)
  5. NetBox deletes all form data from Filter forms if any value is an empty string (reference)
  6. Some downstream NetBox plugins - looking specifically at Topology View - use checkboxes in Filter forms (reference)
  7. NetBox broke these plugins by filtering checked checkboxes - because of the introduced hidden input - from Filter submit form data (bug report)
  8. Downstream plugins worked around this by overriding/subverting NetBox's renderer to remove/revert this hidden input field within their plugin (reference)

Honestly, there are so many wrongs here it's difficult to know at which level it should be "righted" (except that downstreams obviously override NetBox's django templates at their own peril).

  • Should someone ask HTMX whether there's an alternative way to preserve checkbox values across page refreshes?
  • Should downstream plugins stop using BooleanField in Filter forms?
  • Should NetBox fix its logic bugs?

This change sits somewhere in the middle that keeps NetBox's workarounds for HTMX whilst at the same time not breaking downstreams.

Aside: This particular function looks suspiciously like it was copy-pasted from (StackOverflow) - ouch!. The fact that it doesn't work when form data has multiple values associated to the same key is also pointed out there.

I don't know idiomatic TypeScript, so someone more knowledgeable may have a cleaner way of doing this.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/16395 **Author:** [@ibuclaw](https://github.com/ibuclaw) **Created:** 6/4/2024 **Status:** ❌ Closed **Base:** `develop` ← **Head:** `fix_16293` --- ### 📝 Commits (1) - [`3ec84e3`](https://github.com/netbox-community/netbox/commit/3ec84e36d5d664da46804575c89d0836cc975a81) 16293 fix form data handler deleting checkbox data ### 📊 Changes **1 file changed** (+9 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `netbox/project-static/src/netbox.ts` (+9 -3) </details> ### 📄 Description In NetBox, formData may have multiple values associated with a given key (see [netbox/templates/django/forms/widgets/checkbox.html](https://github.com/netbox-community/netbox/blob/8e48e939aab3b75a50c73cb46b2cc4c30f801ae8/netbox/templates/django/forms/widgets/checkbox.html)), however a handler that prunes empty form data before posting doesn't take this into account. So instead of a for loop over all `formData.entries()`, retrieve all values using `formData.getAll()`, delete all keys from `formData`, then append all non-empty values back in. <!-- Thank you for your interest in contributing to NetBox! Please note that our contribution policy requires that a feature request or bug report be approved and assigned prior to opening a pull request. This helps avoid waste time and effort on a proposed change that we might not be able to accept. IF YOUR PULL REQUEST DOES NOT REFERENCE AN ISSUE WHICH HAS BEEN ASSIGNED TO YOU, IT WILL BE CLOSED AUTOMATICALLY. Please specify your assigned issue number on the line below. --> ### Fixes: #16293 <!-- Please include a summary of the proposed changes below. --> What is happening here? 1. Netbox uses checkboxes in Edit forms ([reference](https://github.com/netbox-community/netbox/blob/8e48e939aab3b75a50c73cb46b2cc4c30f801ae8/netbox/dcim/models/device_components.py#L512-L515)) 2. NetBox uses HTMX in Edit forms ([reference](https://github.com/netbox-community/netbox/blob/8e48e939aab3b75a50c73cb46b2cc4c30f801ae8/netbox/templates/generic/object_edit.html#L64-L68)) 3. HTMX breaks NetBox by filtering unchecked checkboxes from submit form data ([reference](https://github.com/bigskysoftware/htmx/blob/4eadc8f492bd90694455414d06f99801d950e94f/src/htmx.js#L2512C18-L2524)) ([bug report](https://github.com/netbox-community/netbox/issues/13064)) 4. NetBox worked around this by adding in a hidden input with the same name, and an empty string value ([reference](https://github.com/netbox-community/netbox/blob/8e48e939aab3b75a50c73cb46b2cc4c30f801ae8/netbox/templates/django/forms/widgets/checkbox.html#L1-L6)) 5. NetBox deletes all form data from Filter forms if any value is an empty string ([reference](https://github.com/netbox-community/netbox/blob/8e48e939aab3b75a50c73cb46b2cc4c30f801ae8/netbox/project-static/src/netbox.ts#L43-L48)) 6. Some downstream NetBox plugins - looking specifically at Topology View - use checkboxes in Filter forms ([reference](https://github.com/netbox-community/netbox-topology-views/blob/8368ffa2fdc13b258be3c42ddc275054853fde85/netbox_topology_views/forms.py#L231-L270)) 7. NetBox broke these plugins by filtering checked checkboxes - because of the introduced hidden input - from Filter submit form data ([bug report](https://github.com/netbox-community/netbox-topology-views/issues/407)) 8. Downstream plugins worked around this by overriding/subverting NetBox's renderer to remove/revert this hidden input field within their plugin ([reference](https://github.com/netbox-community/netbox-topology-views/blob/develop/netbox_topology_views/forms.py#L32)) --- Honestly, there are so many wrongs here it's difficult to know at which level it should be "righted" (except that downstreams obviously override NetBox's django templates at their own peril). - Should someone ask HTMX whether there's an alternative way to preserve checkbox values across page refreshes? - Should downstream plugins stop using BooleanField in Filter forms? - Should NetBox fix its logic bugs? This change sits somewhere in the middle that keeps NetBox's workarounds for HTMX whilst at the same time not breaking downstreams. Aside: This particular function looks suspiciously like it was copy-pasted from ([StackOverflow](https://stackoverflow.com/questions/8029532/how-to-prevent-submitting-the-html-forms-input-field-value-if-it-empty/64029534#64029534)) - ouch!. The fact that it doesn't work when form data has multiple values associated to the same key is also pointed out there. I don't know idiomatic TypeScript, so someone more knowledgeable may have a cleaner way of doing this. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 23:27:03 +01:00
adam closed this issue 2025-12-29 23:27:04 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#14843
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?