sourcery-ai[bot]
commented
1 month ago Reviewer's Guide by Sourcery
This pull request fixes an issue where async fields could return non-awaitable values, potentially breaking functionality that expects awaitables. The change ensures that async fields always return an awaitable, addressing issue #639.
Class diagram for AsyncPermission and Query classes
classDiagram
class AsyncPermission {
+async has_permission(source: Any, info: Info, **kwargs: Any) Union[bool, Awaitable[bool]]
}
class Query {
+list[Color] colors
}
class Color {
+strawberry.auto name
+list[Fruit] fruits
}
class Fruit {
+strawberry.auto name
}
Query --> Color : has
Color --> Fruit : has
Color --> AsyncPermission : uses
Fruit --> AsyncPermission : usesFile-Level Changes
| Change | Details | Files |
|---|---|---|
| Modify the get_result function to always return an awaitable for async fields |
|
strawberry_django/fields/field.py |
| Add comprehensive test cases for field permissions with async and sync scenarios |
|
tests/test_field_permissions.py |
Assessment against linked issues
| Issue | Objective | Addressed | Explanation |
|---|---|---|---|
| #639 | Fix the 'object list can't be used in 'await' expression' error when using async has_permission with optimizer's enable_prefetch_related_optimization set to True |
✅ | |
| #639 | Ensure async fields always return Awaitables | ✅ |
Possibly linked issues
- #639: PR fixes the async 'await' error reported in the issue by ensuring fields return Awaitables.
codecov-commenter
Async fields sometimes can return non-awaitable values, like when the optimizer is enabled and already prefetched the nested field.
This can break some places that expect an awaitable, like strawberry's base field permissions.
This change ensures that async fields always return an awaitable.
Fix #639
Summary by Sourcery
Fix async fields to consistently return awaitables, addressing issues with components expecting awaitable results, and add tests to validate this behavior.
Bug Fixes:
Tests: