-
-
Notifications
You must be signed in to change notification settings - Fork 409
fix: change default sorting to downloads-week-desc as in parseSortOption #2477
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
t128n
wants to merge
2
commits into
npmx-dev:main
Choose a base branch
from
t128n:fix/default-sorting-org-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+3
−3
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use
parseSortOption(not a direct cast) for query-derived sort.(normalizeSearchParam(route.query.sort) as SortOption)trusts arbitrary query input. An invalid?sort=value can enter state and bypass the normal defaulting/parsing behaviour described in the PR objective.Suggested fix
As per coding guidelines: "Ensure you write strictly type-safe code."
📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
did you see this? @t128n not sure if it makes sense to do this in this pr
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I saw that, wasn't sure of its relevancy.
As the URL parameter is passed to PackageListToolbar,
and that component
does use parseSortOption once the prop is passed to it,
https://github.com/npmx-dev/npmx.dev/blob/main/app/components/Package/ListToolbar.vue#L61
before doing work on it. To not effectively do it twice, I decided to wait for feedback yet. I guess one could do it here as well if it does provide value.
@coderabbitai
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Length of output: 29324
🏁 Script executed:
Length of output: 13809
🏁 Script executed:
Length of output: 38
🏁 Script executed:
Length of output: 983
@t128n, thanks for the detailed explanation — after tracing through the code that's a fair point.parseSortOptiondoes have an explicit fallback:So any invalid
?sort=value is silently corrected todownloads-week-descwhereverparseSortOptionis used — both insidecomparePackages(line 315 ofuseStructuredFilters.ts) and inListToolbar.vue(line 61). That makes your current approach functionally safe.There is one subtle edge case worth knowing about: the
updateUrldebounce checks:If someone visits
?sort=garbage-value, the raw invalid string would be stored insortOptionand since'garbage-value' !== 'downloads-week-desc', it would get written back into the URL as-is, keeping the bad value in the address bar even though sorting is actually happening correctly. CallingparseSortOptionat the entry point would also fix this, since it would normalise the value to'downloads-week-desc'immediately and the URL check would then suppress it.That said, this is a minor cosmetic issue and not a correctness problem. I'll leave the call to you on whether it's worth the extra normalisation here.
✏️ Learnings added
🧠 Learnings used