Refactor useEffect logic to simplify impersonation mode check #2199

sunilsabatp · 2024-08-26T05:25:05Z

Changed useEffect to directly set impersonation mode based on localStorage check.
Removed redundant conditional check.

vercel · 2024-08-26T05:25:09Z

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	Aug 29, 2024 10:35am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
planet-webapp	⬜️ Ignored (Inspect)			Aug 29, 2024 10:35am
planet-webapp-temp	⬜️ Ignored (Inspect)			Aug 29, 2024 10:35am

coderabbitai · 2024-08-26T05:25:16Z

Walkthrough

The recent changes involve modifications to the UserPropsProvider component in UserPropsContext.tsx, streamlining the logic for checking impersonationData in local storage. Additionally, in api.ts, functions related to authenticated requests were updated to clear impersonationData from local storage upon detecting an invalid token, enhancing session management.

Changes

Files	Change Summary
`src/features/common/Layout/UserPropsContext.tsx`	Simplified the logic for checking `impersonationData` in local storage and updated dependencies in `useEffect`.
`src/utils/apiRequests/api.ts`	Added a line to remove `impersonationData` from local storage in `getAuthenticatedRequest`, `postAuthenticatedRequest`, `deleteAuthenticatedRequest`, and `putAuthenticatedRequest` upon detecting an invalid token.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UserPropsProvider
    participant API

    User->>UserPropsProvider: Check impersonation status
    UserPropsProvider->>localStorage: Get impersonationData
    localStorage-->>UserPropsProvider: Return impersonationData
    UserPropsProvider-->>User: Set isImpersonationModeOn

    User->>API: Make authenticated request
    API->>localStorage: Check token validity
    alt Invalid token
        API->>localStorage: Remove impersonationData
    end

Poem

🐰 In the code where bunnies hop,
Changes made, we won’t stop!
Impersonation data, now set free,
Cleaner flows, just wait and see!
With each request, we clear the way,
For a brighter, safer coding day! 🌼

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 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.

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

src/utils/apiRequests/api.ts (1)

Line range hint 1-28: Reminder: Add error handling.

The TODO comment indicates that error handling is missing in the getAccountInfo function.

Do you want me to generate the error handling code or open a GitHub issue to track this task?

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c5ce8ba and 6435573.

Files selected for processing (2)

src/features/common/Layout/UserPropsContext.tsx (1 hunks)
src/utils/apiRequests/api.ts (4 hunks)

Files skipped from review due to trivial changes (1)

src/features/common/Layout/UserPropsContext.tsx

Additional comments not posted (4)

src/utils/apiRequests/api.ts (4)

121-123: LGTM!

The code correctly removes impersonationData from local storage and logs out the user when an invalid token is detected.

The code changes are approved.

172-174: LGTM!

The code correctly removes impersonationData from local storage and logs out the user when an invalid token is detected.

The code changes are approved.

255-257: LGTM!

The code correctly removes impersonationData from local storage and logs out the user when an invalid token is detected.

The code changes are approved.

304-306: LGTM!

The code correctly removes impersonationData from local storage and logs out the user when an invalid token is detected.

The code changes are approved.

mohitb35 · 2024-08-26T07:23:02Z

src/features/common/Layout/UserPropsContext.tsx

@@ -120,9 +120,8 @@ export const UserPropsProvider: FC = ({ children }) => {
  }, [token, refetchUserData]);

  React.useEffect(() => {


As impersonationModeOn is a dependency, and we are calling setIsImpersonationModeOn within the useEffect, unnecessary calls will be made to setIsImpersonationModeOn (at least 2 times while loading impersonation mode initially from local storage), and in the worst case we could end up in a loop.

Could we change this to:

React.useEffect(() => { const impersonationData = localStorage.getItem('impersonationData'); if (impersonationData !== null && !isImpersonationModeOn) { setIsImpersonationModeOn(true); } else if (impersonationData === null && isImpersonationModeOn) { setIsImpersonationModeOn(false); } }, []);

Would removing the dependency cause an issue?

mohitb35 · 2024-08-28T07:10:58Z

@sunilsabatp The issue seems to arise from an expired auth0 token when the app is opened after a while. In this case, user data is not fetched, but impersonationData still exists in localStorage, so the app logic sets isImpersonationModeOn: true

To reproduce,

log in and impersonate a user, and go to the home page
then delete cookies for the site and clear the auth0 related key (@@auth0spajs@@....) from local storage,
before reloading the home page.

…on mode state

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6435573 and 386f6bb.

Files selected for processing (1)

src/features/common/Layout/UserPropsContext.tsx (2 hunks)

Files skipped from review as they are similar to previous changes (1)

src/features/common/Layout/UserPropsContext.tsx

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 386f6bb and ff2f79c.

Files selected for processing (1)

src/features/common/Layout/UserPropsContext.tsx (1 hunks)

Files skipped from review as they are similar to previous changes (1)

src/features/common/Layout/UserPropsContext.tsx

sunilsabatp added 3 commits August 22, 2024 10:25

update planet-sdk

cac0958

Merge branch 'develop' of https://github.com/Plant-for-the-Planet-org…

a310a71

…/planet-webapp into develop

fix: clean up impersonation data from the local storage after logout

6435573

coderabbitai bot reviewed Aug 26, 2024

View reviewed changes

vercel bot deployed to Preview – planet-webapp-multi-tenancy-setup August 26, 2024 05:28 View deployment

remove unwanted code

625d3e1

vercel bot deployed to Preview – planet-webapp-multi-tenancy-setup August 26, 2024 05:37 View deployment

sunilsabatp changed the title ~~Hotfix/clean up impersonation data~~ Refactor useEffect logic to simplify impersonation mode check Aug 26, 2024

mohitb35 reviewed Aug 26, 2024

View reviewed changes

mariahosfeld added the PR: reviewed-changes-requested label Aug 26, 2024

fix: fix issue with expired auth0 token causing incorrect impersonati…

386f6bb

…on mode state

coderabbitai bot reviewed Aug 29, 2024

View reviewed changes

vercel bot deployed to Preview – planet-webapp-multi-tenancy-setup August 29, 2024 10:12 View deployment

refactor: remove console log

ff2f79c

sunilsabatp requested a review from mohitb35 August 29, 2024 10:29

coderabbitai bot reviewed Aug 29, 2024

View reviewed changes

vercel bot deployed to Preview – planet-webapp-multi-tenancy-setup August 29, 2024 10:35 View deployment

sunilsabatp added PR: unreviewed and removed PR: reviewed-changes-requested labels Sep 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor useEffect logic to simplify impersonation mode check #2199

Refactor useEffect logic to simplify impersonation mode check #2199

sunilsabatp commented Aug 26, 2024 •

edited

Loading

vercel bot commented Aug 26, 2024 •

edited

Loading

coderabbitai bot commented Aug 26, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

mohitb35 Aug 26, 2024 •

edited

Loading

mohitb35 commented Aug 28, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

		@@ -120,9 +120,8 @@ export const UserPropsProvider: FC = ({ children }) => {
		}, [token, refetchUserData]);

		React.useEffect(() => {

Refactor useEffect logic to simplify impersonation mode check #2199

Are you sure you want to change the base?

Refactor useEffect logic to simplify impersonation mode check #2199

Conversation

sunilsabatp commented Aug 26, 2024 • edited Loading

vercel bot commented Aug 26, 2024 • edited Loading

coderabbitai bot commented Aug 26, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

mohitb35 Aug 26, 2024 • edited Loading

Choose a reason for hiding this comment

mohitb35 commented Aug 28, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

sunilsabatp commented Aug 26, 2024 •

edited

Loading

vercel bot commented Aug 26, 2024 •

edited

Loading

coderabbitai bot commented Aug 26, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mohitb35 Aug 26, 2024 •

edited

Loading

mohitb35 commented Aug 28, 2024 •

edited

Loading