Project Details Navigation Improvements + Translation Issue Fix

[mohitb35]

Changes

• Fixed locale persistence during shallow routing in project details page
• Improved query parameter management for site and plant location navigation
• Cleaned up URL appearance by hiding internal routing params (locale, slug, p)
• Added proper TypeScript types and removed type assertions
• Updates back navigation logic to preserve the locale
• Refactors back navigation logic to ensure path was localized and avoid an additional middleware run

Technical Details

1. Introduced proper parameter management in buildProjectDetailsQuery (renamed from updateUrlWithParams):

   • Safely converts Next.js router query params to string-only values
   • Preserves necessary routing parameters while cleaning up internal ones
   • Returns strongly typed Record<string, string> for URL query params

2. Enhanced updateProjectDetailsPath (renamed from pushWithShallow):

   • Maintains internal routing state while showing clean URLs
   • Uses proper URL handling for both browser display and Next.js router
   • Keeps locale consistent during navigation

3. Unified handling of both site and plant location navigation:

   • Both now use the same query parameter management flow
   • Consistent approach to shallow routing throughout the project details page
   • Proper TypeScript types for navigation parameters

4. Enhanced generateProjectLink logic (supplementary change)

   • Updates logic for backNavigationUrl to strip locale from path
   • Preserves locale on going back to an "in-app page" even if locale was changed on the project details page

5. Refactored handleBackButton logic (supplementary change)

   • Handle locale prefixing in the client-side navigation logic instead of relying on middleware
   • Properly handle relative paths without locale prefix (e.g. '/prd' -> '/en/prd')
   • Handle root path localization correctly (e.g. '/' -> '/en')
   • Move path localization logic to a separate utility function
   • These changes reduce middleware runs and avoid potential caching issues by handling locale prefixing directly in the navigation code

Understanding the Main Fix

The core issue stemmed from the interaction between shallow routing and our middleware:

1. Normal Navigation:

   • Middleware rewrites /de/prd/yucatan to /sites/planet/de/prd/yucatan
   • Next.js extracts dynamic parameters (locale, slug, p) from the rewritten path
   • These parameters are available in router.query but not in the URL query string

2. Shallow Routing:

   • Bypasses middleware (no server-side execution)
   • No URL rewrite occurs
   • We need to manually maintain these parameters in query state
   • Parameters need to be hidden from the URL to maintain consistent URL structure

The fix ensures that during shallow routing:

• Internal routing parameters (locale, slug, p) are preserved in router.query
• URL remains clean and consistent with middleware-processed URLs
• Locale context is maintained for next-intl

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
planet-webapp-multi-tenancy-setup	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 6, 2024 10:54am

2 Skipped Deployments

| Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **planet-webapp** | ⬜️ Ignored ([Inspect](https://vercel.com/planetapp/planet-webapp/Dcz1PuYRvo9anarMTmdHBos7t3q4)) | | | Nov 6, 2024 10:54am | | **planet-webapp-temp** | ⬜️ Ignored ([Inspect](https://vercel.com/planetapp/planet-webapp-temp/51HuHNACNyMHDrCtVQcFZ4FvEgRq)) | | | Nov 6, 2024 10:54am |

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.