NetBoxModelFilterSet causes GraphQL queries on custom-fields even if not referenced #7745

New Issue

adam · 2025-12-29T20:27:45+01:00

adam commented

2025-12-29 20:27:45 +01:00

Originally created by @arthanson on GitHub (Mar 10, 2023).

NetBox version

v3.4.5

Python version

3.8

Steps to Reproduce

This only appears in GraphQL as you can specify which fields to return, where REST API returns all the fields and has prefetch_related for the custom-fields. Make a graphql call to any model that uses NetBoxModelFilterSet, in the debug toolbar look at the queries and see that queries are made to custom-field even though they aren't referenced in the query. Example query below:

query vlan {
	vlan_list {
                id
	}
}

Traced down the issue: https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/filtersets.py#L249 This code is causing custom-fields to be queried even if they aren't in GraphQL request.

Found while working on issue #11291 so opening a separate bug to track.

Expected Behavior

If custom-fields are not referenced in the filter then then queries shouldn't be done for them.

Observed Behavior

Queries are always added for the custom fields.

Originally created by @arthanson on GitHub (Mar 10, 2023). ### NetBox version v3.4.5 ### Python version 3.8 ### Steps to Reproduce This only appears in GraphQL as you can specify which fields to return, where REST API returns all the fields and has prefetch_related for the custom-fields. Make a graphql call to any model that uses NetBoxModelFilterSet, in the debug toolbar look at the queries and see that queries are made to custom-field even though they aren't referenced in the query. Example query below: ``` query vlan { vlan_list { id } } ``` Traced down the issue: https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/filtersets.py#L249 This code is causing custom-fields to be queried even if they aren't in GraphQL request. Found while working on issue #11291 so opening a separate bug to track. ### Expected Behavior If custom-fields are not referenced in the filter then then queries shouldn't be done for them. ### Observed Behavior Queries are always added for the custom fields.

adam added the type: bug netbox topic: GraphQL severity: low labels 2025-12-29 20:27:45 +01:00

adam closed this issue

2025-12-29 20:27:45 +01:00

adam commented

2025-12-29 20:27:46 +01:00

@arthanson commented on GitHub (Apr 21, 2023):

Adding blocked till: #9856

@arthanson commented on GitHub (Apr 21, 2023): Adding blocked till: #9856

adam commented

2025-12-29 20:27:46 +01:00

@jeremypng commented on GitHub (Jan 23, 2025):

This is fixed in my branch here:
https://github.com/jeremypng/netbox/tree/refs/heads/graphql-filter-redesign

If you'll assign this to me I'll tag this issue in my PR request.

@jeremypng commented on GitHub (Jan 23, 2025): This is fixed in my branch here: https://github.com/jeremypng/netbox/tree/refs/heads/graphql-filter-redesign If you'll assign this to me I'll tag this issue in my PR request.

adam commented

2025-12-29 20:27:46 +01:00

@jeremystretch commented on GitHub (Feb 7, 2025):

Make a graphql call to any model that uses NetBoxModelFilterSet, in the debug toolbar look at the queries and see that queries are made to custom-field even though they aren't referenced in the query.

I'm not able to reproduce this on NetBox v4.2.3. When issuing a query for any model with a custom field to retrieve the list of IDs, only one SQL query is produced. This issue was probably addressed by a more recent Strawberry release or some other change made since it was opened.

@jeremystretch commented on GitHub (Feb 7, 2025): > Make a graphql call to any model that uses NetBoxModelFilterSet, in the debug toolbar look at the queries and see that queries are made to custom-field even though they aren't referenced in the query. I'm not able to reproduce this on NetBox v4.2.3. When issuing a query for any model with a custom field to retrieve the list of IDs, only one SQL query is produced. This issue was probably addressed by a more recent Strawberry release or some other change made since it was opened.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#7745