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

Don't use DynamicChoiceField for custom field choices #11208

New Issue
Closed
opened 2025-12-29 21:41:57 +01:00 by adam · 1 comment
adam commented 2025-12-29 21:41:57 +01:00
Owner
Copy Link

Originally created by @alehaa on GitHub (May 21, 2025).

NetBox version

v4.3.1

Feature type

Change to existing functionality

Proposed functionality

The current implementation of model forms uses an API call to retrieve available choices. I propose replacing this lookup with a static approach by replacing DynamicChoiceField with ChoiceField.

Use case

Using a DynamicChoiceField requires users to have privileges for the specific CustomFieldChoices instance, as the API endpoint needs to be reached. This complicates permission restrictions. Since the choices contain a static list, I don't believe this change will impact performance, but designing permissions will be easier.

Database changes

None.

External dependencies

None.

Originally created by @alehaa on GitHub (May 21, 2025). ### NetBox version v4.3.1 ### Feature type Change to existing functionality ### Proposed functionality The [current implementation](https://github.com/netbox-community/netbox/blob/main/netbox/extras/models/customfields.py#L518-L523) of model forms uses an API call to retrieve available choices. I propose replacing this lookup with a static approach by replacing `DynamicChoiceField` with `ChoiceField`. ### Use case Using a `DynamicChoiceField` requires users to have privileges for the specific `CustomFieldChoices` instance, as the API endpoint needs to be reached. This complicates permission restrictions. Since the choices contain a static list, I don't believe this change will impact performance, but designing permissions will be easier. ### Database changes None. ### External dependencies None.
adam added the type: feature label 2025-12-29 21:41:57 +01:00
adam closed this issue 2025-12-29 21:41:57 +01:00
adam commented 2025-12-29 21:41:58 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 22, 2025):

It's necessary to use DynamicChoiceField here because a choice set can potentially have many thousands of choices (UN/LOCODE, for example). Prepopulating these all in a static form field is suboptimal and can impose significant performance issues.

Using a DynamicChoiceField requires users to have privileges for the specific CustomFieldChoices instance, as the API endpoint needs to be reached. This complicates permission restrictions.

If this is a concern, you can add extras.CustomFieldChoiceSet to EXEMPT_VIEW_PERMISSIONS to obviate the need for manual permission assignment.

@jeremystretch commented on GitHub (May 22, 2025): It's necessary to use DynamicChoiceField here because a choice set can potentially have many thousands of choices (UN/LOCODE, for example). Prepopulating these all in a static form field is suboptimal and can impose significant performance issues. > Using a DynamicChoiceField requires users to have privileges for the specific CustomFieldChoices instance, as the API endpoint needs to be reached. This complicates permission restrictions. If this is a concern, you can add `extras.CustomFieldChoiceSet` to [`EXEMPT_VIEW_PERMISSIONS`](https://netboxlabs.com/docs/netbox/configuration/security/#exempt_view_permissions) to obviate the need for manual permission assignment.
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 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#11208
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?