Add unavailable status (TS-2276) #1085
Open
Conversation
This file contains 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
|
Unreviewed packages will be unavailable if their Community's require_package_listing_approval field is set to true, so logic for that should probably be added to the is_unavailable function. (we don't currently use require_package_listing_approval in production but we've been keeping it functional through updates so might as well continue) |
Roffenlund
force-pushed
the
add-is-unavailable-status
branch
2 times, most recently
from
0b9ea35 to
b9a9465
Compare
Add new functions to the Package and PackageVersion models to determine whether a package or package version is unavailable. A package is considered unavailable if: - It is not active (is_effectively_active is False), or - It does not have a related listing in a specific community, or - It has a listing, but the listing is marked as rejected. A package version is considered unavailable if: - The related package is unavailable, or - The package version itself is not active. - (If both conditions apply, the package's status takes precedence.) Additionally, implement unit tests to validate these new functions for both the Package and PackageVersion models. Refs. TS-2776
Add the is_unavailable status to the DependencySerializer. Use SerializerMethodField and implement a function to fetch the is_unavailable value from the PackageVersion model. Implement tests for the endpoint using the serializer. The tests should verify that the field is present and correctly reflects the result of the is_unavailable function. Refs. TS-2276
Refs. TS-2276
Roffenlund
force-pushed
the
add-is-unavailable-status
branch
from
c7f1af3 to
53d0e55
Compare
Comment on lines
61
to
66
| def get_is_unavailable(self, obj: PackageVersion) -> bool: | ||
| community = Community.objects.filter( | ||
| identifier=obj.community_identifier | ||
| ).first() | ||
|
|
||
| return obj.is_unavailable(community) |
There was a problem hiding this comment.
Only noticed this on a second look, but the implementation of this seems hazardous for performance when sets of items are being rendered. I'd try to find a way to e.g. annotate this information to the queryset as a batch operation instead.
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
django/thunderstore/api/cyberstorm/tests/test_package_listing.py
Outdated
Show resolved
Hide resolved
Refactor availability checks to reduce queries: - Annotate availability in get_custom_package_listing. - Modify DependencySerializer to use annotations instead of fetching the community model. - Move availability check to PackageListing and update Package's is_unavailable. - Add tests ensuring queries remain under 20 for small datasets; larger sets see a drop from 100+ to ~60. Refs. TS-2276
Roffenlund
force-pushed
the
add-is-unavailable-status
branch
from
2d09ba1 to
84e320b
Compare
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.
Add a new is_unavailable status to the Package and PackageVersion
models to determine whether a package or package version is unavailable.
A package is considered unavailable if there is no PackageListing
object linking the package to the currently viewed community.
Even if a PackageListing object exists linking the package to the
community, its status might be "rejected," which would render the
package unavailable.