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

Bulk edit of models with M2M fields can clear the M2M field #8238

New Issue
Closed
opened 2025-12-29 20:34:10 +01:00 by adam · 5 comments
adam commented 2025-12-29 20:34:10 +01:00
Owner
Copy Link

Originally created by @Urth on GitHub (Jun 23, 2023).

Originally assigned to: @netopsab on GitHub.

NetBox version

v3.5.4 and tested on develop

Python version

3.10

Steps to Reproduce

  1. Create an interface with one or more tagged_vlans.
  2. Use bulk edit on the interface to change something unrelated like the speed.
  3. Observe the changelog with the tagged_vlans being removed.

Expected Behavior

The untagged_vlans should remain unchanged if none are selected and set null is unchecked.

Observed Behavior

The untagged_vlans are removed from the interface.

Caused by https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/views/generic/bulk_views.py#L554-L555
In 41c92483a0 the truthy check on the m2m queryset was removed. Django querysets evaluate to False if the queryset is empty.

Originally created by @Urth on GitHub (Jun 23, 2023). Originally assigned to: @netopsab on GitHub. ### NetBox version v3.5.4 and tested on develop ### Python version 3.10 ### Steps to Reproduce 1. Create an interface with one or more tagged_vlans. 2. Use bulk edit on the interface to change something unrelated like the speed. 3. Observe the changelog with the tagged_vlans being removed. ### Expected Behavior The untagged_vlans should remain unchanged if none are selected and set null is unchecked. ### Observed Behavior The untagged_vlans are removed from the interface. Caused by https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/views/generic/bulk_views.py#L554-L555 In https://github.com/netbox-community/netbox/commit/41c92483a0b9b820dd0ca0c43c6c6d6e560043ed the truthy check on the m2m queryset was removed. Django querysets evaluate to False if the queryset is empty.
adam added the type: bugstatus: acceptedseverity: medium labels 2025-12-29 20:34:10 +01:00
adam closed this issue 2025-12-29 20:34:11 +01:00
adam commented 2025-12-29 20:34:11 +01:00
Author
Owner
Copy Link

@netopsab commented on GitHub (Jun 24, 2023):

Hello,

I'm facing this issue too... Also and for clarification, you mention the untagged_vlan field (excepted / observed behavior section). However, as you mentioned, this issue occurs with m2m fields, so with tagged_vlans (not untagged_vlan).

My proposal to fix this issue :

--- a/netbox/netbox/views/generic/bulk_views.py
+++ b/netbox/netbox/views/generic/bulk_views.py
@@ -551,7 +551,7 @@ class BulkEditView(GetReturnURLMixin, BaseMultiObjectView):
             for name, m2m_field in m2m_fields.items():
                 if name in form.nullable_fields and name in nullified_fields:
                     getattr(obj, name).clear()
-                else:
+                elif name in form.changed_data:
                     getattr(obj, name).set(form.cleaned_data[name])
@netopsab commented on GitHub (Jun 24, 2023): Hello, I'm facing this issue too... Also and for clarification, you mention the untagged_vlan field (excepted / observed behavior section). However, as you mentioned, this issue occurs with m2m fields, so with tagged_vlans (not untagged_vlan). My proposal to fix this issue : ```python --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -551,7 +551,7 @@ class BulkEditView(GetReturnURLMixin, BaseMultiObjectView): for name, m2m_field in m2m_fields.items(): if name in form.nullable_fields and name in nullified_fields: getattr(obj, name).clear() - else: + elif name in form.changed_data: getattr(obj, name).set(form.cleaned_data[name]) ```
adam commented 2025-12-29 20:34:11 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (Jun 24, 2023):

@netopsab Would you like to submit a pr?

@abhi1693 commented on GitHub (Jun 24, 2023): @netopsab Would you like to submit a pr?
adam commented 2025-12-29 20:34:11 +01:00
Author
Owner
Copy Link

@netopsab commented on GitHub (Jun 24, 2023):

why not ... :)

@netopsab commented on GitHub (Jun 24, 2023): why not ... :)
adam commented 2025-12-29 20:34:11 +01:00
Author
Owner
Copy Link

@Urth commented on GitHub (Jun 26, 2023):

The change proposed by @netopsab does not fix the problem. The bulk edit form always includes m2m fields in the cleaned_data. Otherwise the old code would trigger a KeyError. The problem is that the cleaned_data is an empty queryset when nothing is selected. My PR checks if the queryset is non-empty like the code before 41c92483a0 was applied.

@Urth commented on GitHub (Jun 26, 2023): The change proposed by @netopsab does not fix the problem. The bulk edit form always includes m2m fields in the cleaned_data. Otherwise the old code would trigger a `KeyError`. The problem is that the cleaned_data is an empty queryset when nothing is selected. My PR checks if the queryset is non-empty like the code before 41c92483a0b9b820dd0ca0c43c6c6d6e560043ed was applied.
adam commented 2025-12-29 20:34:12 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Jun 26, 2023):

The change proposed by @netopsab does not fix the problem. The bulk edit form always includes m2m fields in the cleaned_data. Otherwise the old code would trigger a KeyError. The problem is that the cleaned_data is an empty queryset when nothing is selected. My PR checks if the queryset is non-empty like the code before 41c9248 was applied.

@netopsab is checking against changed_data not cleaned_data.

His method is consistent with our rchecking in other areas. Both approaches are equally valid.

@DanSheps commented on GitHub (Jun 26, 2023): > The change proposed by @netopsab does not fix the problem. The bulk edit form always includes m2m fields in the cleaned_data. Otherwise the old code would trigger a `KeyError`. The problem is that the cleaned_data is an empty queryset when nothing is selected. My PR checks if the queryset is non-empty like the code before [41c9248](https://github.com/netbox-community/netbox/commit/41c92483a0b9b820dd0ca0c43c6c6d6e560043ed) was applied. @netopsab is checking against changed_data not cleaned_data. His method is consistent with our rchecking in other areas. Both approaches are equally valid.
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 severity: medium status: accepted type: bug
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#8238
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?