Add better tests for GraphQL filtering and lookup

[arthanson]

Proposed Changes

The GraphQL tests currently test all model fields, but are very light on testing any filtering of objects or sub-objects. We should add tests for checking different primary filters:

{
  site_list(filters: {name: {i_contains:"DM"}}) {
    id
    name
  }
}

and sub-object filtering:

{
  site_list {
    id
    name
    tags(filters: {name: {i_starts_with: "P"}}) {
      name
    }
  }
}

Justification

The filtering logic for Strawberry is undergoing some major refactors and we could easily miss issues with filtering without tests in-place.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

[loulecrivain]

Heya, just a heads up from a Netbox-using organization regarding this proposed change.

I've seen and experienced some issues/regressions regarding GraphQL filters following latest release and refactors.
Now I know GraphQL isn't used much internally in Netbox itself. However for lots of people writing exporters, crawlers, you name it, GraphQL API is actually the go-to.

In my opinion, if we want to be on par with the level of quality of the REST API, ensuring filters are working as expected should be a priority. +1 for automated testing here

[jeremystretch]

@loulecrivain thanks for your interest. Would you be willing to volunteer to contribute this work?

[loulecrivain]

@jeremystretch I get that the Netbox team may be busy right now with latest releases too. Unfortunately I currently do not really have the time to work on this, as I'm busy with other projects (and also not sure I'm familiar enough with Netbox codebase, as I haven't contributed lots).

So I'll have to politely decline 😉

[loulecrivain]

Commenting on this issue again, since we had another regression / breaking change in a minor release update (4.1.x -> 4.2.x).

#18433 broke in-production software depending on the GraphQL API. I'm going to be honest, I get the need for making the models evolve according to users needs, but why do so in a minor release?

I urge you to consider prioritizing better end-to-end tests for the GraphQL API. IMO if it's not as stable as the REST API, then there's no point in having this feature available for the users.