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

Filtering VLANGroup by vid_ranges.contains in GraphQL fails with “cannot cast type integer to int4range” #11687

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

Originally created by @pheus on GitHub (Oct 4, 2025).

Originally assigned to: @pheus on GitHub.

NetBox Edition

NetBox Community

NetBox Version

v4.4.2

Python Version

3.12

Steps to Reproduce

Filtering vlan_group_list by a scalar VLAN ID using the vid_ranges.contains GraphQL filter returns an error instead of matching groups whose VID ranges include the value.

  1. Ensure a VLANGroup exists with vid_ranges that include VLAN 10 (e.g., [1,11)).
  2. Run the GraphQL query below against /graphql/.
  3. The request fails with the error shown instead of returning the matching VLANGroup.
query MyQuery {
  vlan_group_list(filters: { vid_ranges: { contains: 10 } }) {
    id
    name
    vid_ranges
  }
}

Expected Behavior

The query should succeed and return all VLANGroup records whose vid_ranges include the given VLAN ID (e.g., 10), without errors.
If no groups match, the API should return an empty list. The response should include the requested fields for each matching group.

Observed Behavior

{
  "data": null,
  "errors": [
    {
      "message": "cannot cast type integer to int4range\nLINE 1: ... WHERE \"ipam_vlangroup\".\"vid_ranges\" @> (ARRAY[10])::int4...\n                                                             ^",
      "path": ["vlan_group_list"]
    }
  ]
}

Server traceback (excerpt)

django.db.utils.ProgrammingError: cannot cast type integer to int4range
LINE 1: ... "ipam_vlangroup"."vid_ranges" @> (ARRAY[10])::int4...
                                                             ^
Originally created by @pheus on GitHub (Oct 4, 2025). Originally assigned to: @pheus on GitHub. ### NetBox Edition NetBox Community ### NetBox Version v4.4.2 ### Python Version 3.12 ### Steps to Reproduce Filtering `vlan_group_list` by a scalar VLAN ID using the `vid_ranges.contains` GraphQL filter returns an error instead of matching groups whose VID ranges include the value. 1. Ensure a `VLANGroup` exists with `vid_ranges` that include VLAN 10 (e.g., `[1,11)`). 2. Run the GraphQL query below against `/graphql/`. 3. The request fails with the error shown instead of returning the matching `VLANGroup`. ```graphql query MyQuery { vlan_group_list(filters: { vid_ranges: { contains: 10 } }) { id name vid_ranges } } ``` ### Expected Behavior The query should succeed and return all `VLANGroup` records whose `vid_ranges` include the given VLAN ID (e.g., `10`), without errors. If no groups match, the API should return an empty list. The response should include the requested fields for each matching group. ### Observed Behavior ```json { "data": null, "errors": [ { "message": "cannot cast type integer to int4range\nLINE 1: ... WHERE \"ipam_vlangroup\".\"vid_ranges\" @> (ARRAY[10])::int4...\n ^", "path": ["vlan_group_list"] } ] } ``` *Server traceback* (excerpt) ```text django.db.utils.ProgrammingError: cannot cast type integer to int4range LINE 1: ... "ipam_vlangroup"."vid_ranges" @> (ARRAY[10])::int4... ^ ```
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 21:48:37 +01:00
adam closed this issue 2025-12-29 21:48:37 +01:00
adam commented 2025-12-29 21:48:38 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Oct 4, 2025):

Cause

  • VLANGroup.vid_ranges is an array of ranges (int4range[]), not an array of integers.
  • The GraphQL filter treats it as if it were an array of ints, so it generates an array‑contains check: vid_ranges @> ARRAY[10].
  • PostgreSQL then attempts to coerce 10 to an int4range (or int4range[]) to satisfy @>, which fails with:
    cannot cast type integer to int4range.
  • The intended semantics are range‑contains‑value on each element of the array (i.e., “does any stored range include 10?”), not “array contains 10”.
@pheus commented on GitHub (Oct 4, 2025): #### Cause - `VLANGroup.vid_ranges` is an **array of ranges** (`int4range[]`), not an array of integers. - The GraphQL filter treats it **as if it were an array of ints**, so it generates an **array‑contains** check: `vid_ranges @> ARRAY[10]`. - PostgreSQL then attempts to coerce `10` to an `int4range` (or `int4range[]`) to satisfy `@>`, which fails with: `cannot cast type integer to int4range`. - The intended semantics are **range‑contains‑value** on **each element** of the array (i.e., “does **any** stored range include 10?”), not “array contains 10”.
adam commented 2025-12-29 21:48:38 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Oct 4, 2025):

I think a small, reusable change can address this:

  • Add a generic ORM lookup any_range_contains for ArrayField(RangeField) that matches rows where a scalar value is contained by any range in the array.
  • Reuse it in IPAM by wiring VLANGroup’s FilterSet (contains_vid) to this lookup, removing the current raw‑SQL/custom helper.
  • For GraphQL, keep the public API friendly (vid_ranges: { contains: 10 }) and map it internally to __any_range_contains via a custom filter input/method (no schema churn).

If that sounds reasonable, I’m happy to open a draft PR with the lookup + FilterSet wiring and tests for the ORM and FilterSet.

@pheus commented on GitHub (Oct 4, 2025): I think a small, reusable change can address this: - Add a generic ORM lookup **`any_range_contains`** for `ArrayField(RangeField)` that matches rows where a scalar value is contained by **any** range in the array. - Reuse it in IPAM by wiring `VLANGroup`’s FilterSet (`contains_vid`) to this lookup, removing the current raw‑SQL/custom helper. - For GraphQL, keep the public API friendly (`vid_ranges: { contains: 10 }`) and map it internally to `__any_range_contains` via a custom filter input/method (no schema churn). If that sounds reasonable, I’m happy to open a draft PR with the lookup + FilterSet wiring and tests for the ORM and FilterSet.
adam commented 2025-12-29 21:48:39 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Oct 6, 2025):

Thanks, @pheus . Sounds like a reasonable approach.

@jnovinger commented on GitHub (Oct 6, 2025): Thanks, @pheus . Sounds like a reasonable approach.
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: low 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#11687
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?