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

Refactored src/screens/OrgList from jest to vitest #3200

Merged

Conversation

syedali237
Copy link
Contributor

@syedali237 syedali237 commented Jan 7, 2025

What kind of change does this PR introduce?

Refactoring

Issue Number:

Fixes #2565

Did you add tests for your changes?

Yes

Snapshots/Videos:

N/A

If relevant, did you update the documentation?

N/A

Summary

Refactored src/screens/OrgList/OrgList.test.tsx to src/screens/OrgList/OrgList.spec.tsx

Does this PR introduce a breaking change?

No

Other information

N/A

Have you read the contributing guide?

Summary by CodeRabbit

  • Testing Framework

    • Migrated test suite from Jest to Vitest
    • Updated mocking and testing configurations
    • Adjusted timeout and spy methods for new testing environment
  • Mock Data

    • Added explicit adminUser variable
    • Refined user mock data structure

Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

Walkthrough

This pull request focuses on refactoring the OrgList test suite from Jest to Vitest, a modern testing framework. The changes involve updating the test file OrgList.spec.tsx and the associated mock file OrgListMocks.ts. The migration includes replacing Jest-specific imports, mocking methods, and configuration with Vitest equivalents, while maintaining the overall test structure and functionality.

Changes

File Change Summary
src/screens/OrgList/OrgList.spec.tsx - Replaced Jest imports with Vitest imports
- Updated timeout configuration from jest.setTimeout() to vi.setConfig()
- Modified mocking methods to use Vitest syntax
- Updated cleanup method to vi.clearAllMocks()
src/screens/OrgList/OrgListMocks.ts - Removed jest-location-mock import
- Added adminUser variable as a copy of superAdminUser
- Updated MOCKS_ADMIN to use adminUser

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions and mocks with Vitest equivalents [#2565]
Ensure all tests pass using npm run test:vitest [#2565] Requires full test suite verification
Maintain 100% test coverage [#2565] Requires coverage report verification

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • palisadoes
  • disha1202

Poem

🐰 Hop, hop, testing we go!
From Jest to Vitest, watch our code flow
Mocks and spies, a new dance we'll try
Refactoring tests with a rabbit's sigh
Cleaner, faster, our tests now shine bright! 🌟


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

github-actions bot commented Jan 7, 2025

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

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 (4)
src/screens/OrgList/OrgList.spec.tsx (4)

43-50: Consider enhancing test cleanup

While the migration to Vitest's mocking system is correct, consider adding vi.restoreAllMocks() in the afterEach block to ensure all spies are properly restored to their original state. This prevents any potential leakage between tests.

 afterEach(() => {
   localStorage.clear();
   cleanup();
   vi.clearAllMocks();
+  vi.restoreAllMocks();
 });

Line range hint 34-41: Optimize wait helper function

The custom wait helper function could be improved by using Vitest's built-in timer utilities.

-async function wait(ms = 100): Promise<void> {
-  await act(() => {
-    return new Promise((resolve) => {
-      setTimeout(resolve, ms);
-    });
-  });
+async function wait(ms = 100): Promise<void> {
+  await act(async () => {
+    vi.advanceTimersByTime(ms);
+  });
}

Line range hint 367-369: Remove commented code

Remove the commented out code as it's no longer needed and may cause confusion.

-    // await act(async () => {
-    //   await new Promise((resolve) => setTimeout(resolve, 1000));
-    // });

Line range hint 1-1: Consider adding Vitest configuration file

Since this is a migration to Vitest, consider adding a vitest.config.ts file to centralize test configuration, including timeout settings and other Vitest-specific options.

Would you like me to generate a sample vitest.config.ts file with recommended settings?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 495e976 and 4b5bdce.

📒 Files selected for processing (2)
  • src/screens/OrgList/OrgList.spec.tsx (3 hunks)
  • src/screens/OrgList/OrgListMocks.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • src/screens/OrgList/OrgListMocks.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (3)
src/screens/OrgList/OrgList.spec.tsx (3)

29-31: LGTM: Proper Vitest configuration setup

The migration from Jest to Vitest includes the correct import and timeout configuration. The timeout value of 30000ms is maintained from the previous Jest configuration.


456-456: LGTM: Proper migration of toast spy

The toast spy has been correctly migrated from Jest to Vitest.


Line range hint 1-558: Verify complete migration from Jest

Let's ensure no Jest-specific code remains in the codebase.

@syedali237
Copy link
Contributor Author

the check that is failing is when previous jest cases are run, as migrating this one reduces the threshold coverage below 20%.

@palisadoes
Copy link
Contributor

How can that threshold be lowered?

@syedali237
Copy link
Contributor Author

How can that threshold be lowered?

@palisadoes I think we can make changes in the jest.config.js file:

Screenshot 2025-01-08 at 1 24 19 AM

@palisadoes
Copy link
Contributor

I updated it. Please merge with the latest upstream

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.81%. Comparing base (ef5a206) to head (55e1afc).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3200       +/-   ##
=====================================================
+ Coverage             18.70%   89.81%   +71.10%     
=====================================================
  Files                   308      329       +21     
  Lines                  7798     8526      +728     
  Branches               1697     1854      +157     
=====================================================
+ Hits                   1459     7658     +6199     
+ Misses                 6241      636     -5605     
- Partials                 98      232      +134     

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

@palisadoes palisadoes merged commit de5330b into PalisadoesFoundation:develop-postgres Jan 7, 2025
18 checks passed
Dhiren-Mhatre pushed a commit to Dhiren-Mhatre/talawa-admin that referenced this pull request Jan 9, 2025
rishav-jha-mech pushed a commit that referenced this pull request Jan 9, 2025
* prevented unnecessary page reload with complementary test

* Update jest.config.js

* Fixes #2986 - Multiple UI Updates (#3165)

* UI fixes on organisation pages

* Added TSDoc for Truncated Text

* Added Debouncer

* Update src/components/OrgListCard/OrgListCard.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Added code rabbit suggestions

* Fixed test error

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* refactore src/screens/OrgList from jest to vitest (#3200)

* Improved Code Coverage in src/components/Venues/VenueModal.tsx (#3203)

* Improved Code Coverage in src/components/Venues/VenueModal.tsx

* removed the ignore statements from VenueModal.tsx

* Removed istanbul ignore lines. Code coverage remians 100% (#3207)

* refactored src/screens/FundCampaignPledge from jest to vitest (#3208)

* prettier formatting and disabled ts-specific rules for js in eslint (#3186)

* Improve Code Coverage in src/screens/UserPortal/Settings/Settings.tsx (#3189)

* Preventing Overflow of images in Advertisement and Venue Post modals (#3204)

* improve code coverage of src/screens/EventManagement (#3149)

* code coverage

* jest global coverage decreased

* global jest coverage

* rename file problem solved

* changes requested resolved

* fix: update Chat section title to 'Chats' (#3216)

* removed stale comment line

* Revert "removed stale comment line"

This reverts commit e0fa894.

* removed stale comment line

---------

Co-authored-by: Peter Harrison <[email protected]>
Co-authored-by: Mehul Aggarwal <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Syed Ali Ul Hasan <[email protected]>
Co-authored-by: harshk-89 <[email protected]>
Co-authored-by: Amaan ali <[email protected]>
Co-authored-by: Yugal Sadhwani <[email protected]>
Co-authored-by: Pranav Nathe <[email protected]>
Co-authored-by: prathmesh703 <[email protected]>
Co-authored-by: Nivedita <[email protected]>
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