chore: scrub stale filter argument references in comments/errors#996
Merged
pyramation merged 1 commit intomainfrom Apr 18, 2026
Merged
chore: scrub stale filter argument references in comments/errors#996pyramation merged 1 commit intomainfrom
filter argument references in comments/errors#996pyramation merged 1 commit intomainfrom
Conversation
The GraphQL connection argument was renamed from `filter` to `where` back in commit 10b4fc6 (via `connectionFilterArgumentName: 'where'` in `graphile-connection-filter`'s default preset). A number of JSDoc examples, plugin descriptions, and error strings were not updated at the time and still referenced the old `filter:` name, which was confusing when reading the code. This change: - Updates JSDoc `filter: { ... }` examples to `where: { ... }` in the forward/backward/computed-attribute relation plugins, the spatial relations plugin, and the constructive preset. - Rewords the `ConnectionFilterArgPlugin` JSDoc, description, and internal log string to reflect that the argument name is `where`. - Renames the "Empty objects are forbidden in filter argument input" and "Null literals are forbidden in filter argument input" error messages to say "where argument input". - Fixes the stale preset comments that still claimed filtering lives under the `filter` argument. - Renames one test case title to match what it actually asserts (`where` not `filter`). No behavior change beyond the text of the above two error messages.
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up cleanup to #995. The GraphQL connection argument was renamed from
filtertowherein commit 10b4fc6 (viaconnectionFilterArgumentName: 'where'defaulted ingraphile-connection-filter's preset), but a number of JSDoc examples, plugin descriptions, error strings, and preset comments were not updated at the time. This PR scrubs them.Changes are almost entirely in comments/docstrings. The only behavior-adjacent diffs are:
"Empty objects are forbidden in filter argument input."→"...in where argument input.""Null literals are forbidden in filter argument input."→"...in where argument input."wherearg, notfilter).extend(...)log string renamed (not user-visible, just debug output).Specifically updated:
graphile-connection-filter: JSDoc examples (filter:→where:) inConnectionFilter{Forward,Backward,ComputedAttributes}RelationsPlugin, theConnectionFilterArgPlugintop-level JSDoc +descriptionstring + inline comments, and the two error message strings inutils.ts,ConnectionFilterAttributesPlugin.ts, andoperatorApply.ts.graphile-postgis: JSDoc example inspatial-relations.ts.graphile-settings: corrected the misleading preset comments inconstructive-preset.ts(the ones that tripped me up in docs(graphile-postgis): deep spatial-relations docs; lead with client-side GeoJSON problem #995 and made me think the GraphQL arg was stillfilter:), updated an example comment inenable-all-filter-columns.ts, and renamed the preset-integration test case title.Review & Testing Checklist for Human
'... forbidden in filter argument input.'(equality check, not substring) would need to update their match. I grepped the repo for these strings and the only call sites are the three source files in this diff; no test snapshots reference them.graphile/graphile-settings/src/presets/constructive-preset.ts— the rewritten block about "filtering now lives under thewhereargument" should read accurately to you.Notes
graphile-connection-filterandgraphile-postgispackage builds locally; both clean. The workspace-level build fails on unrelated missing cross-package type declarations in my environment, but CI will do the full build.filter→whererename commit were deliberately left alone — they're historical and accurate.Link to Devin session: https://app.devin.ai/sessions/059b0c2e4594474aa107e3f83f83fe0f
Requested by: @pyramation