-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(nextjs): fix createRouteManifest with basePath #17838
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
seoyeon9888
wants to merge
2
commits into
getsentry:develop
from
seoyeon9888:fix/next-sentry-create-route-manifest-basepath-bug
+61
−2
Open
Changes from all commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,10 @@ export type CreateRouteManifestOptions = { | |
| * By default, route groups are stripped from paths following Next.js convention. | ||
| */ | ||
| includeRouteGroups?: boolean; | ||
| /** | ||
| * Base path for the application, if any. This will be prefixed to all routes. | ||
| */ | ||
| basePath?: string; | ||
| }; | ||
|
|
||
| let manifestCache: RouteManifest | null = null; | ||
|
|
@@ -192,7 +196,7 @@ export function createRouteManifest(options?: CreateRouteManifestOptions): Route | |
| return manifestCache; | ||
| } | ||
|
|
||
| const { dynamicRoutes, staticRoutes } = scanAppDirectory(targetDir, '', options?.includeRouteGroups); | ||
| const { dynamicRoutes, staticRoutes } = scanAppDirectory(targetDir, options?.basePath, options?.includeRouteGroups); | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bug: Route Manifest Cache and Base Path HandlingThe |
||
|
|
||
| const manifest: RouteManifest = { | ||
| dynamicRoutes, | ||
|
|
||
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
1 change: 1 addition & 0 deletions
packages/nextjs/test/config/manifest/suites/base-path/app/about/page.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // about page |
1 change: 1 addition & 0 deletions
packages/nextjs/test/config/manifest/suites/base-path/app/api/test/page.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // API test page |
1 change: 1 addition & 0 deletions
packages/nextjs/test/config/manifest/suites/base-path/app/page.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // root page |
1 change: 1 addition & 0 deletions
packages/nextjs/test/config/manifest/suites/base-path/app/users/[id]/page.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // users id dynamic page |
49 changes: 49 additions & 0 deletions
packages/nextjs/test/config/manifest/suites/base-path/base-path.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import path from 'path'; | ||
| import { describe, expect, test } from 'vitest'; | ||
| import { createRouteManifest } from '../../../../../src/config/manifest/createRouteManifest'; | ||
|
|
||
| describe('basePath', () => { | ||
| test('should generate routes with base path prefix', () => { | ||
| const manifest = createRouteManifest({ | ||
| basePath: '/my-app', | ||
| appDirPath: path.join(__dirname, 'app') | ||
| }); | ||
|
|
||
| expect(manifest).toEqual({ | ||
| staticRoutes: [ | ||
| { path: '/my-app' }, | ||
| { path: '/my-app/about' }, | ||
| { path: '/my-app/api/test' } | ||
| ], | ||
| dynamicRoutes: [ | ||
| { | ||
| path: '/my-app/users/:id', | ||
| regex: '^/my-app/users/([^/]+)$', | ||
| paramNames: ['id'], | ||
| } | ||
| ], | ||
| }); | ||
| }); | ||
|
|
||
| test('should validate dynamic route regex with base path', () => { | ||
| const manifest = createRouteManifest({ | ||
| basePath: '/my-app', | ||
| appDirPath: path.join(__dirname, 'app') | ||
| }); | ||
|
|
||
| const dynamicRoute = manifest.dynamicRoutes.find(route => route.path === '/my-app/users/:id'); | ||
| const regex = new RegExp(dynamicRoute?.regex ?? ''); | ||
|
|
||
| // Should match valid paths with base path | ||
| expect(regex.test('/my-app/users/123')).toBe(true); | ||
| expect(regex.test('/my-app/users/john-doe')).toBe(true); | ||
|
|
||
| // Should not match paths without base path | ||
| expect(regex.test('/users/123')).toBe(false); | ||
|
|
||
| // Should not match invalid paths | ||
| expect(regex.test('/my-app/users/')).toBe(false); | ||
| expect(regex.test('/my-app/users/123/extra')).toBe(false); | ||
| expect(regex.test('/my-app/user/123')).toBe(false); | ||
| }); | ||
| }); |
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.