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

Include "private" fields when serializing objects for change logging #9741

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

Originally created by @jeremystretch on GitHub (May 24, 2024).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v4.0.3

Feature type

Change to existing functionality

Proposed functionality

When logging the creation, change, or deletion of an object, NetBox serializes the Python instance using the serialize_object() utility function. This wraps Django's internal serialization function, with some caveats. First, we ignore MPTT internal fields:

103c08c2d2/netbox/utilities/serialization.py (L33-L36)

Second, we omit any "private" fields; those which begin with an underscore. (This is done purely as a means of noise reduction, and not in the interest of privacy or security.)

103c08c2d2/netbox/utilities/serialization.py (L48-L51)

This issue proposes that we stop omitting these fields from the serialized data. Where it makes sense to omit these fields from display (e.g. when rendering a diff in the change log), the fields can be omitted from the output.

Use case

The exclusion of MPTT internal fields poses an issue for the staged changes API, which has been captured in #13422.

The omission of certain private fields can pose similar problems. For instance, omitting the _name field when serializing a site fails to capture the naturalized form of the site's name. When attempting to restore a site from serialized data using deserialize_object(), the resulting instance will be saved to the database with an empty value for _name, leading to issues with query ordering.

Database changes

None

External dependencies

None

Originally created by @jeremystretch on GitHub (May 24, 2024). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v4.0.3 ### Feature type Change to existing functionality ### Proposed functionality When logging the creation, change, or deletion of an object, NetBox serializes the Python instance using the [`serialize_object()`](https://github.com/netbox-community/netbox/blob/103c08c2d2bc3e32d8274b8d8ec8dd2380857388/netbox/utilities/serialization.py#L15) utility function. This wraps Django's internal serialization function, with some caveats. First, we ignore MPTT internal fields: https://github.com/netbox-community/netbox/blob/103c08c2d2bc3e32d8274b8d8ec8dd2380857388/netbox/utilities/serialization.py#L33-L36 Second, we omit any "private" fields; those which begin with an underscore. (This is done purely as a means of noise reduction, and not in the interest of privacy or security.) https://github.com/netbox-community/netbox/blob/103c08c2d2bc3e32d8274b8d8ec8dd2380857388/netbox/utilities/serialization.py#L48-L51 This issue proposes that we stop omitting these fields from the serialized data. Where it makes sense to omit these fields from display (e.g. when rendering a diff in the change log), the fields can be omitted from the output. ### Use case The exclusion of MPTT internal fields poses an issue for the [staged changes API](https://netboxlabs.com/docs/netbox/en/stable/plugins/development/staged-changes/), which has been captured in #13422. The omission of certain private fields can pose similar problems. For instance, omitting the `_name` field when serializing a site fails to capture the naturalized form of the site's name. When attempting to restore a site from serialized data using [`deserialize_object()`](https://github.com/netbox-community/netbox/blob/103c08c2d2bc3e32d8274b8d8ec8dd2380857388/netbox/utilities/serialization.py#L48), the resulting instance will be saved to the database with an empty value for `_name`, leading to issues with query ordering. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: featurecomplexity: low labels 2025-12-29 21:21:56 +01:00
adam closed this issue 2025-12-29 21:21:56 +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 complexity: low status: accepted type: feature
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#9741
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?