feat: support npmjs versions redirect#2800
Open
johnnyreilly wants to merge 2 commits into
Open
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughMiddleware now canonicalises package URLs with ChangesactiveTab=versions URL canonicalisation
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
test/e2e/url-compatibility.spec.ts (1)
123-140: ⚡ Quick winConsider adding a test case for query parameter preservation.
The middleware preserves non-
activeTabquery parameters when redirecting (e.g.,/package/vue?activeTab=versions&foo=bar→/package/vue/versions?foo=bar). Adding a test case for this behaviour would improve coverage and catch potential regressions.✅ Example test case for query param preservation
test('/package/vue?activeTab=versions&utm_source=test → preserves other params', async ({ page, goto, }) => { await goto('/package/vue?activeTab=versions&utm_source=test', { waitUntil: 'domcontentloaded', }) await expect(page).toHaveURL(/\/package\/vue\/versions\?utm_source=test$/) await expect(page.locator('h1')).toContainText('vue') })🤖 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 `@test/e2e/url-compatibility.spec.ts` around lines 123 - 140, Add a new E2E test in the existing describe block that verifies the middleware preserves non-activeTab query params when redirecting: create a test similar to the existing tests (e.g., titled "/package/vue?activeTab=versions&utm_source=test → preserves other params") that uses the same helpers (test, goto, page, expect) to navigate with goto('/package/vue?activeTab=versions&utm_source=test', { waitUntil: 'domcontentloaded' }), assert the final URL matches /\/package\/vue\/versions\?utm_source=test$/ with expect(page).toHaveURL(...), and confirm the page renders correctly with expect(page.locator('h1')).toContainText('vue'); place it alongside the other tests in the "npmjs.com activeTab=versions Compatibility" describe block so it runs with the existing suite.
🤖 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.
Nitpick comments:
In `@test/e2e/url-compatibility.spec.ts`:
- Around line 123-140: Add a new E2E test in the existing describe block that
verifies the middleware preserves non-activeTab query params when redirecting:
create a test similar to the existing tests (e.g., titled
"/package/vue?activeTab=versions&utm_source=test → preserves other params") that
uses the same helpers (test, goto, page, expect) to navigate with
goto('/package/vue?activeTab=versions&utm_source=test', { waitUntil:
'domcontentloaded' }), assert the final URL matches
/\/package\/vue\/versions\?utm_source=test$/ with expect(page).toHaveURL(...),
and confirm the page renders correctly with
expect(page.locator('h1')).toContainText('vue'); place it alongside the other
tests in the "npmjs.com activeTab=versions Compatibility" describe block so it
runs with the existing suite.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 1dd00a97-a700-4535-aaa0-1f0b93134bcd
📒 Files selected for processing (2)
server/middleware/canonical-redirects.global.tstest/e2e/url-compatibility.spec.ts
gameroman
added
the
needs review
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.
🔗 Linked issue
Resolves #2781
🧭 Context
There's a good level of intentional URL compatibility between npmjs.com and npmx.dev. The idea being that if you swapped out the prefix you'd see the same feature on npmx.dev that you see on npmjs.com
This doesn't apply for versions. So if you go to:
https://www.npmjs.com/package/webpack?activeTab=versions
Then go to
https://www.npmx.dev/package/webpack?activeTab=versions
You do not see a versions view. However, a versions view does exist:
https://npmx.dev/package/webpack/versions
📚 Description
This PR changes npmx.dev such that https://www.npmx.dev/package/webpack?activeTab=versions would be 301'd to https://npmx.dev/package/webpack/versions
This means that users swapping the prefix will see the versions view. The URL is a redirect, but that seems appropriate given there isn't a "tab" for versions in npmx
cc @gameroman