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

Cleared localstorage to solve flickering #2937

Merged

Conversation

Aad1tya27
Copy link
Contributor

@Aad1tya27 Aad1tya27 commented Dec 26, 2024

What kind of change does this PR introduce?
I changed src/screens/OrgList/OrgList.tsx to solve the flickering issue. Clearing the local storage was the solution to it.

Issue Number:

Fixes #2936

Did you add tests for your changes?
No

If relevant, did you update the documentation?
No

Does this PR introduce a breaking change?
No

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling by clearing local storage upon encountering specific errors, enhancing user experience during error scenarios.
    • Enhanced conditional rendering in the Organization Modal to prevent potential runtime errors.
  • Tests

    • Streamlined test suite for the OrgList component, improving clarity and maintainability.
    • Enhanced error handling tests to check for specific error messages under invalid conditions.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request modifies the OrgList.tsx file to enhance error handling by adding a mechanism to clear local storage when encountering errors related to errorList or errorUser. This change ensures that upon encountering an error, the application will clear all data stored in local storage before redirecting the user to the home page. Additionally, it refines the test suite for the OrgList component and adjusts the conditional rendering logic in the OrganizationModal component.

Changes

File Change Summary
src/screens/OrgList/OrgList.tsx Added localStorage.clear(); when encountering errors in the orgList function.
src/screens/OrgList/OrgList.test.tsx Enhanced cleanup process, refined test logic, removed redundant local storage calls, and improved error handling tests.
src/screens/OrgList/OrganizationModal.tsx Modified conditional rendering for the create sample organization button to prevent accessing properties of undefined values.

Assessment against linked issues

Objective Addressed Explanation
Prevent screen flickering when GraphQL endpoint is unreachable [#2936] Clearing localStorage might help, but doesn't directly address the root cause of flickering.
Display clear error message for inaccessible API endpoint [#2936] No explicit error message implementation added.

Possibly related PRs

Suggested reviewers

  • varshith257
  • palisadoes

Poem

🐰 In the land of code where errors play,
A rabbit hops to clear the way.
With local storage wiped so clean,
We chase away the flickering scene!
Hooray for fixes, let joy abound,
In a world where bugs can't be found! 🚀


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.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 26, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/screens/OrgList/OrgList.test.tsx (1)

503-543: Enhance test coverage by verifying the actual sorting outcome.
Although the toggle between latest and oldest is tested, the test does not validate whether the fetched or rendered data is actually sorted. You may consider adding assertions to confirm that the UI reflects the expected ordering of the organizations after toggling the sort option.

src/screens/OrgList/OrganizationModal.tsx (1)

304-304: Optional chaining for safer array length checks.
This condition is a good fix to avoid errors if adminFor is null or undefined. For even more safety and code brevity, consider optional chaining:

- {((adminFor && adminFor.length > 0) || superAdmin) && (
+ {(adminFor?.length > 0 || superAdmin) && (
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e3bda8 and d31b034.

📒 Files selected for processing (3)
  • src/screens/OrgList/OrgList.test.tsx (2 hunks)
  • src/screens/OrgList/OrgList.tsx (1 hunks)
  • src/screens/OrgList/OrganizationModal.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/screens/OrgList/OrgList.tsx
🔇 Additional comments (1)
src/screens/OrgList/OrgList.test.tsx (1)

47-47: Good practice to clear mocks after each test.
Using jest.clearAllMocks() helps ensure isolation and prevents test pollution from inadvertently shared mocks.

Copy link

codecov bot commented Dec 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.39%. Comparing base (6997a04) to head (d31b034).
Report is 2 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2937       +/-   ##
=====================================================
+ Coverage             43.57%   88.39%   +44.82%     
=====================================================
  Files                   299      316       +17     
  Lines                  7420     8273      +853     
  Branches               1623     1869      +246     
=====================================================
+ Hits                   3233     7313     +4080     
+ Misses                 3958      742     -3216     
+ Partials                229      218       -11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Aad1tya27
Copy link
Contributor Author

@palisadoes Can you please review the pr? This is linked to the same issue which was raised in talawa-api repo, but the fix had to be done in talawa-admin.

@palisadoes palisadoes merged commit 167a846 into PalisadoesFoundation:develop-postgres Dec 26, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants