Update version to 1.5.4.dev1 and enhance query parameter handling#185
Open
julietteceb16 wants to merge 4 commits into
Open
Update version to 1.5.4.dev1 and enhance query parameter handling#185julietteceb16 wants to merge 4 commits into
julietteceb16 wants to merge 4 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughAdds validate_query_params and EmptyQueryMapping for mapping HTTP query params into Pydantic models, uses them in Chalice and FastAPI GET handlers (falling back to EmptyQueryMapping), changes pagination encoding to urlencode(..., doseq=True), excludes ids from filter construction, adds an optional ids field to an example query model, expands unit tests for list-detection and mapping behavior (including a UnionType reload regression), adds integration tests for repeated ids and pagination preservation, and bumps version to 1.5.4.dev2. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #185 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 20 +1
Lines 716 751 +35
Branches 75 79 +4
=========================================
+ Hits 716 751 +35
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
tests/core/test_query_params.py (2)
75-79: ⚡ Quick winAdd a regression test for the empty-query mapping path.
Please add a test that calls
validate_query_params(EmptyQueryMapping(), SampleQuery)and asserts it does not raise and keeps all optional fields asNone.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/core/test_query_params.py` around lines 75 - 79, Add a new regression test that calls validate_query_params with an EmptyQueryMapping and SampleQuery and asserts it does not raise and returns a mapping where all optional SampleQuery fields are None; specifically, create a test function (e.g., test_validate_query_params_accepts_empty_mapping) that does: result = validate_query_params(EmptyQueryMapping(), SampleQuery) and then asserts no exception and that for each optional field defined on SampleQuery the result mapping has a key with value None (use the same field names as in SampleQuery to locate them).
48-53: ⚡ Quick winRename this test to match its behavior.
The current name says “rejects invalid list”, but it verifies successful normalization to
['a', 'b']. This is misleading during failure triage.Suggested rename
-def test_validate_query_params_rejects_invalid_list() -> None: +def test_validate_query_params_normalizes_list_fields() -> None:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/core/test_query_params.py` around lines 48 - 53, Rename the test function test_validate_query_params_rejects_invalid_list to a name that reflects its behavior (it verifies normalization rather than rejection), e.g. test_validate_query_params_normalizes_list_field or test_validate_query_params_returns_list_for_multiple_values; update the function definition and any references accordingly so the test still calls QueryParams('ids=a&ids=b'), invokes validate_query_params(query, SampleQuery), and asserts validated.ids == ['a', 'b'].
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@agave/core/query_params.py`:
- Around line 64-72: EmptyQueryMapping is missing iteration support required by
build_query_dict and the QueryParamMapping protocol; implement __iter__ to yield
no keys and __len__ to return 0 (and keep existing __contains__, get, getlist)
so EmptyQueryMapping behaves like an empty mapping when iterated by
build_query_dict, e.g., add an __iter__(self) -> Iterator[str] that yields
nothing and a __len__(self) -> int that returns 0 to satisfy consumers expecting
an iterable mapping.
In `@tests/blueprint/test_blueprint.py`:
- Around line 289-297: The test test_query_with_repeated_ids_param currently
only checks status and presence of 'items' but doesn't assert filtering; modify
it to parse resp.json(), extract the list under 'items', and assert that every
returned item's id is one of the requested ids ('US1' or 'US2') and that no
other ids are present (optionally assert the set of returned ids equals
{'US1','US2'} or that length matches expected). Use the existing
client.get('/accounts?ids=US1&ids=US2') response object (resp) and its
resp.json() to perform these assertions so the test fails if ids filtering is
ignored.
---
Nitpick comments:
In `@tests/core/test_query_params.py`:
- Around line 75-79: Add a new regression test that calls validate_query_params
with an EmptyQueryMapping and SampleQuery and asserts it does not raise and
returns a mapping where all optional SampleQuery fields are None; specifically,
create a test function (e.g., test_validate_query_params_accepts_empty_mapping)
that does: result = validate_query_params(EmptyQueryMapping(), SampleQuery) and
then asserts no exception and that for each optional field defined on
SampleQuery the result mapping has a key with value None (use the same field
names as in SampleQuery to locate them).
- Around line 48-53: Rename the test function
test_validate_query_params_rejects_invalid_list to a name that reflects its
behavior (it verifies normalization rather than rejection), e.g.
test_validate_query_params_normalizes_list_field or
test_validate_query_params_returns_list_for_multiple_values; update the function
definition and any references accordingly so the test still calls
QueryParams('ids=a&ids=b'), invokes validate_query_params(query, SampleQuery),
and asserts validated.ids == ['a', 'b'].
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4f0f809e-0417-47be-b8f1-e535d2006294
📒 Files selected for processing (8)
agave/chalice/rest_api.pyagave/core/filters.pyagave/core/query_params.pyagave/fastapi/rest_api.pyagave/version.pyexamples/validators.pytests/blueprint/test_blueprint.pytests/core/test_query_params.py
Comment on lines
+289
to
+297
| def test_query_with_repeated_ids_param( | ||
| client_fixture: str, | ||
| request: pytest.FixtureRequest, | ||
| ) -> None: | ||
| client = request.getfixturevalue(client_fixture) | ||
| resp = client.get('/accounts?ids=US1&ids=US2') | ||
| assert resp.status_code == 200 | ||
| assert 'items' in resp.json() | ||
|
|
There was a problem hiding this comment.
Test does not verify that ids filtering actually works.
At Line 294, this test sends repeated ids, but current assertions only check status and key existence, so it still passes if ids is ignored.
✅ Suggested test hardening
`@pytest.mark.parametrize`(
"client_fixture", ["fastapi_client", "chalice_client"]
)
`@pytest.mark.usefixtures`('accounts')
def test_query_with_repeated_ids_param(
client_fixture: str,
request: pytest.FixtureRequest,
+ accounts: list[Account],
) -> None:
client = request.getfixturevalue(client_fixture)
- resp = client.get('/accounts?ids=US1&ids=US2')
+ account_ids = [accounts[0].id, accounts[1].id]
+ query = '&'.join(f'ids={account_id}' for account_id in account_ids)
+ resp = client.get(f'/accounts?{query}')
assert resp.status_code == 200
- assert 'items' in resp.json()
+ json_body = resp.json()
+ assert 'items' in json_body
+ returned_ids = {item['id'] for item in json_body['items']}
+ assert returned_ids == set(account_ids)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@tests/blueprint/test_blueprint.py` around lines 289 - 297, The test
test_query_with_repeated_ids_param currently only checks status and presence of
'items' but doesn't assert filtering; modify it to parse resp.json(), extract
the list under 'items', and assert that every returned item's id is one of the
requested ids ('US1' or 'US2') and that no other ids are present (optionally
assert the set of returned ids equals {'US1','US2'} or that length matches
expected). Use the existing client.get('/accounts?ids=US1&ids=US2') response
object (resp) and its resp.json() to perform these assertions so the test fails
if ids filtering is ignored.
rogelioLpz
reviewed
Jun 1, 2026
Comment on lines
+7
to
+14
| try: | ||
| from types import UnionType | ||
| except ImportError: # Python < 3.10 | ||
| UnionType = None # type: ignore[misc, assignment] | ||
|
|
||
| _UNION_ORIGINS: Tuple[Any, ...] = ( | ||
| (Union, UnionType) if UnionType is not None else (Union,) | ||
| ) |
Member
There was a problem hiding this comment.
Quitar soporte para <3.10 y dejar más simple el import
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
2 participants
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 by CodeRabbit
Bug Fixes
Refactor
Tests
Examples
Chores