Fixes #20541: Enhance GraphQL filter methods with dynamic prefixing #1065

New Issue

MrUnknownDE · 2026-04-05T20:11:28+02:00

MrUnknownDE commented

2026-04-05 20:11:28 +02:00

Originally created by @pheus on 10/15/2025

Fixes: #20541

Refactors filter methods to enable dynamic query prefixing for greater flexibility in nested queries. Improves error handling for invalid network inputs and ensures consistency across IPAM filter implementations.

Context

This follows the discussion in Bug #20466 and builds on PR #20538 (which addressed IPAddressFilter.assigned). The goal here is to complete the prefixing/validation sweep within ipam.graphql.filters only and ensure nested filters consistently target the correct related model.

Summary of changes

Prefix-aware Q objects (nested filtering):
Standardize construction of lookups as Q(**{f"{prefix}…": …}) in custom filter methods so nested queries are resolved against the intended model path.
Input safeguards:
contains/parent-style helpers now guard network parsing with try/except, skipping invalid entries rather than failing the entire filter.
Targeted refactors for clarity/consistency:
Minor internal tidy-ups (e.g., shared helper for device-based lookups) while preserving existing behavior.

🚨 Breaking change (GraphQL): `AggregateFilter`

Aggregate.prefix is a concrete field, not a relation. To avoid double-qualifying lookups in nested contexts, this PR proposes:

Replace the nested filter with a field lookup:
```
prefix: FilterLookup[str] | None
```
Add a field-level contains(value: [CIDR]) that applies prefix__net_contains to the Aggregate field itself.

Client impact (input shape changed for Aggregates only):

Before

aggregate_list(filters: { prefix: { contains: "10.0.0.0/8" } }) { prefix }

After

containment:

aggregate_list(filters: { contains: ["10.0.0.0/8"] }) { prefix }

equality:

aggregate_list(filters: { prefix: { exact: "10.0.0.0/8" } }) { prefix }

No other GraphQL inputs are changed.

Files/areas touched (IPAM only)

ipam.graphql.filters.AggregateFilter
- prefix now a FilterLookup[str] on the field.
- New contains([...]) uses prefix__net_contains.
ipam.graphql.filters.PrefixFilter
- contains([...]) remains relation-aware; lookups are prefixed via f"{prefix}prefix__net_contains".
ipam.graphql.filters.IPRangeFilter
- parent([...]) and contains([...]) use prefixed lookups with input validation.
ipam.graphql.filters.IPAddressFilter
- parent([...]) uses prefixed lookups with input validation.
- (Note: assigned was handled in PR #20538 per Bug #20466.)

Upgrade notes

Breaking (Aggregates only): Update GraphQL clients to use:
- aggregate_list(filters: { contains: ["<cidr>"] }) for containment, and
- aggregate_list(filters: { prefix: { exact: "<cidr>" } }) for equality.
No changes required for other IPAM GraphQL filters.

Bug: #20466
Prior fix: #20538

*Originally created by @pheus on 10/15/2025*  ### Fixes: #20541 Refactors filter methods to enable dynamic query prefixing for greater flexibility in nested queries. Improves error handling for invalid network inputs and ensures consistency across IPAM filter implementations. --- ### Context This follows the discussion in **Bug #20466** and builds on **PR #20538** (which addressed `IPAddressFilter.assigned`). The goal here is to complete the prefixing/validation sweep within **`ipam.graphql.filters` only** and ensure nested filters consistently target the correct related model. ### Summary of changes - **Prefix-aware Q objects (nested filtering):** Standardize construction of lookups as `Q(**{f"{prefix}…": …})` in custom filter methods so nested queries are resolved against the intended model path. - **Input safeguards:** `contains`/`parent`-style helpers now guard network parsing with `try/except`, **skipping invalid entries** rather than failing the entire filter. - **Targeted refactors for clarity/consistency:** Minor internal tidy-ups (e.g., shared helper for device-based lookups) while preserving existing behavior. ### 🚨 Breaking change (GraphQL): `AggregateFilter` `Aggregate.prefix` is a **concrete field**, not a relation. To avoid double-qualifying lookups in nested contexts, this PR proposes: - Replace the nested filter with a field lookup: ```py prefix: FilterLookup[str] | None ``` - Add a field-level `contains(value: [CIDR])` that applies `prefix__net_contains` to the **Aggregate** field itself. **Client impact (input shape changed for Aggregates only):** - **Before** ```graphql aggregate_list(filters: { prefix: { contains: "10.0.0.0/8" } }) { prefix } ``` - **After** - containment: ```graphql aggregate_list(filters: { contains: ["10.0.0.0/8"] }) { prefix } ``` - equality: ```graphql aggregate_list(filters: { prefix: { exact: "10.0.0.0/8" } }) { prefix } ``` No other GraphQL inputs are changed. ### Files/areas touched (IPAM only) - `ipam.graphql.filters.AggregateFilter` - `prefix` now a `FilterLookup[str]` on the **field**. - New `contains([...])` uses `prefix__net_contains`. - `ipam.graphql.filters.PrefixFilter` - `contains([...])` remains relation-aware; lookups are prefixed via `f"{prefix}prefix__net_contains"`. - `ipam.graphql.filters.IPRangeFilter` - `parent([...])` and `contains([...])` use prefixed lookups with input validation. - `ipam.graphql.filters.IPAddressFilter` - `parent([...])` uses prefixed lookups with input validation. - (Note: `assigned` was handled in **PR #20538** per **Bug #20466**.) ### Upgrade notes - **Breaking (Aggregates only):** Update GraphQL clients to use: - `aggregate_list(filters: { contains: ["<cidr>"] })` for containment, and - `aggregate_list(filters: { prefix: { exact: "<cidr>" } })` for equality. - No changes required for other IPAM GraphQL filters. ### Related - Bug: #20466 - Prior fix: #20538

MrUnknownDE closed this issue

2026-04-05 20:11:28 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#1065

Fixes #20541: Enhance GraphQL filter methods with dynamic prefixing #1065