Skip to content
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

Bug: direct link to plant location does not work (first time) #2350

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

sunilsabatp
Copy link
Contributor

@sunilsabatp sunilsabatp commented Jan 6, 2025

Fix :
Previously, visiting a plant location via a direct link in an incognito tab (e.g., https://dev.pp.eco/en/yucatan?ploc=JOCK9R) redirected to the default site instead of the specified plant location. This fix ensures the correct plant location is resolved and displayed when accessing such links, even in incognito mode.

Copy link

vercel bot commented Jan 6, 2025

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 Jan 13, 2025 10:07am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
planet-webapp ⬜️ Ignored (Inspect) Jan 13, 2025 10:07am
planet-webapp-temp ⬜️ Ignored (Inspect) Jan 13, 2025 10:07am

Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn config production Use --omit=dev instead.
npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: [email protected]
npm error Found: [email protected]
npm error node_modules/eslint
npm error dev eslint@"^8.26.0" from the root project
npm error peer eslint@"6 || 7 || 8" from @emotion/[email protected]
npm error node_modules/@emotion/eslint-plugin
npm error dev @emotion/eslint-plugin@"^11.12.0" from the root project
npm error 15 more (@eslint-community/eslint-utils, ...)
npm error
npm error Could not resolve dependency:
npm error peer eslint@"^5.16.0 || ^6.8.0 || ^7.2.0" from [email protected]
npm error node_modules/eslint-config-airbnb
npm error dev eslint-config-airbnb@"^18.2.0" from the root project
npm error
npm error Conflicting peer dependency: [email protected]
npm error node_modules/eslint
npm error peer eslint@"^5.16.0 || ^6.8.0 || ^7.2.0" from [email protected]
npm error node_modules/eslint-config-airbnb
npm error dev eslint-config-airbnb@"^18.2.0" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /root/.npm/_logs/2025-01-13T10_00_55_535Z-eresolve-report.txt
npm error A complete log of this run can be found in: /root/.npm/_logs/2025-01-13T10_00_55_535Z-debug-0.log

Walkthrough

The pull request introduces subtle modifications across four files in the projectsV2 feature: ImageSection.tsx, ProjectsContext.tsx, SingleProjectView.tsx, and projectV2.ts. The primary changes involve adding null checks for plantLocations in various useEffect hooks, simplifying a conditional statement in the handleBackButton function, and modifying the path localization logic to allow more flexible path handling. These modifications aim to enhance error handling and prevent potential runtime issues when managing project locations and routing.

Changes

File Change Summary
src/features/projectsV2/ProjectSnippet/microComponents/ImageSection.tsx Simplified handleBackButton function's conditional statement by removing braces.
src/features/projectsV2/ProjectsContext.tsx Added plantLocations null checks in two useEffect hooks to improve error handling during routing and state updates.
src/features/projectsV2/ProjectsMap/SingleProjectView.tsx Updated useEffect hooks to include requestedPlantLocation and plantLocations null checks, and modified conditions for zooming functionality.
src/utils/projectV2.ts Modified getLocalizedPath function to allow paths starting with locale without requiring a trailing slash.

Possibly related PRs

  • fix: avoid returning to the map center after selecting a project from… #2309: The changes in the ProjectsMap component's logic for centering the map may relate to the overall project navigation and user experience, which could be indirectly connected to the ImageSection component's functionality in the main PR. However, the connection is weak as it does not involve direct modifications to the same functions or components.

Suggested labels

PR: unreviewed

Suggested reviewers

  • mohitb35

Poem

🐰 A rabbit's tale of code so neat,
Null checks dancing to a rhythmic beat,
Preventing errors with graceful might,
Our routing logic now shines so bright!
Safe and sound, our project's delight! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6546740 and 2040623.

📒 Files selected for processing (1)
  • src/utils/projectV2.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/utils/projectV2.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@mariahosfeld mariahosfeld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue as already remarked in PR #2352 : Loading-time is too long

@mariahosfeld mariahosfeld dismissed their stale review January 9, 2025 13:59

Currently dismissed as we need to monitor performance on actual system.

Copy link
Contributor

@mariahosfeld mariahosfeld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General functionality works as expected, performance will need to be monitored.

@@ -263,7 +263,7 @@ export const getLocalizedPath = (path: string, locale: string): string => {
}

// If path already starts with locale, return as is
if (cleanPath.startsWith(`/${locale}/`)) {
if (cleanPath.startsWith(`/${locale}`)) {
Copy link
Collaborator

@mohitb35 mohitb35 Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't this cause an issue?

What if the cleanPath starts with /france-salesforce where the first 2 letters fr match a locale?

This is currently unlikely to happen, since the number of places internally linking to the project details page are limited, but will be difficult to debug if it occurs (after adding other sources).

Copy link
Collaborator

@mohitb35 mohitb35 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sunilsabatp There are a few issues with the changes that add a null check for plantLocations before loading data

  1. Instead of checking plantLocations = null and blocking site selection (url update) / map zoom when not needed, introduce a dedicated isLoadingPlantLocations state. This way the purpose is more explicit.
  2. Check the isLoadingPlantLocations only when needed e.g. when ploc is passed as a url query param, or a selectedPlantLocation exists.
  3. The current implementation prevents site loading when the project is not a tree purpose project. e.g. conservation-aa-andes

You might want to consider separating site selection logic from plant location handling (perhaps not now, but as part of a near future update)

- Add check for single locale path (e.g., '/en') in getLocalizedPath
- Treat single locale paths same as root path, returning '/{locale}'
- Fixes API call errors caused by malformed URLs with duplicate locales
@sunilsabatp
Copy link
Contributor Author

@sunilsabatp There are a few issues with the changes that add a null check for plantLocations before loading data

  1. Instead of checking plantLocations = null and blocking site selection (url update) / map zoom when not needed, introduce a dedicated isLoadingPlantLocations state. This way the purpose is more explicit.
  2. Check the isLoadingPlantLocations only when needed e.g. when ploc is passed as a url query param, or a selectedPlantLocation exists.
  3. The current implementation prevents site loading when the project is not a tree purpose project. e.g. conservation-aa-andes

You might want to consider separating site selection logic from plant location handling (perhaps not now, but as part of a near future update)

Instead of introducing a new state, I have followed a different approach. Please review it and provide your feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants