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

Refactor src/components/CollapsibleDropdown/CollapsibleDropdown.test.tsx from Jest to Vitest #2809 #2868

Merged

Conversation

Ramneet04
Copy link
Contributor

@Ramneet04 Ramneet04 commented Dec 25, 2024

Refactored src/components/CollapsibleDropdown/CollapsibleDropdown.test.tsx to
src/components/CollapsibleDropdown/CollapsibleDropdown.spec.tsx

Issue: #2809: #2809

Changes Implemented:

Refactored the testing framework from Jest to Vitest in src/components/CollapsibleDropdown/CollapsibleDropdown.test.tsx.
Altered the Mock logic as it was not suitable for the Vitest.
Updated import statements, mocking methods, and assertions to align with Vitest conventions.
Verified compatibility with the existing codebase using Vitest.

issue4 1

Other information
I have read the previous refactor PR and tried to keep things as uniform as possible.
Please suggest any other changes if required.

Summary by CodeRabbit

  • Tests
    • Updated the test suite for the CollapsibleDropdown component to utilize Vitest's mocking capabilities.
    • Added an afterEach hook to ensure a clean state after each test.
    • Introduced a new constant to simulate the location object for testing.

Copy link
Contributor

coderabbitai bot commented Dec 25, 2024

Walkthrough

This pull request focuses on migrating the test suite for the CollapsibleDropdown component from Jest to Vitest. The changes involve updating the testing framework's mocking mechanisms, replacing Jest-specific functions with Vitest equivalents, and ensuring the test suite maintains its original structure and functionality while aligning with Vitest's syntax.

Changes

File Change Summary
src/components/CollapsibleDropdown/CollapsibleDropdown.spec.tsx - Replaced Jest mocking with Vitest mocking
- Added afterEach hook to reset modules
- Updated setShowDropdown mock from jest.fn() to vi.fn()

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Hopping through code with glee,
Jest to Vitest, a testing spree!
Mocks and functions, now reborn,
A testing framework freshly sworn.
CodeRabbit's leap of testing might! 🧪


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 471f113 and 34522d8.

📒 Files selected for processing (1)
  • src/components/CollapsibleDropdown/CollapsibleDropdown.spec.tsx (1 hunks)
🧰 Additional context used
📓 Learnings (2)
📓 Common learnings
Learnt from: bitbard3
PR: PalisadoesFoundation/talawa-admin#2588
File: src/components/ChangeLanguageDropdown/ChangeLanguageDropdown.spec.tsx:145-155
Timestamp: 2024-12-02T04:20:11.745Z
Learning: In PRs focused solely on refactoring test cases from Jest to Vitest, avoid suggesting optimizations or changes outside the migration scope.
src/components/CollapsibleDropdown/CollapsibleDropdown.spec.tsx (1)
Learnt from: bitbard3
PR: PalisadoesFoundation/talawa-admin#2588
File: src/components/ChangeLanguageDropdown/ChangeLanguageDropdown.spec.tsx:145-155
Timestamp: 2024-12-02T04:20:11.745Z
Learning: In PRs focused solely on refactoring test cases from Jest to Vitest, avoid suggesting optimizations or changes outside the migration scope.
🔇 Additional comments (5)
src/components/CollapsibleDropdown/CollapsibleDropdown.spec.tsx (5)

11-12: Good switch to Vitest imports
Switching to describe, expect, test, and vi from Vitest is appropriate. This aligns with the PR's objective to migrate from Jest to Vitest without introducing additional dependencies or changes outside the migration scope.


14-16: Verify necessity of vi.resetModules()
vi.resetModules() can sometimes be overkill if no modules are conditionally imported. However, if the tests benefit from re-importing modules for a clean slate each time, it's valid. Just be mindful of potential performance impacts if unneeded.


18-24: No issues with custom location object
Defining a mock currentLocation object aligns well with Vitest’s mocking strategy and ensures the tested component receives the same location info that it would in production code.


26-33: Appropriate approach for mocking React Router
Using vi.mock for 'react-router-dom' is consistent with Vitest. This ensures your tests remain isolated from the real library implementation and can still validate component behavior.


37-37: Successful migration from jest.fn() to vi.fn()
This direct replacement meets the PR objective, maintaining the existing test logic while adhering to Vitest’s syntax.


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

@Ramneet04
Copy link
Contributor Author

hi @palisadoes actually while working on this when I run this after I did the changes from jest to vi, all the test fails, there is one segment of code where we use ( useLocation ) hook and it is not working in Vitest. While searching about this issue on the internet I found others have also faced that so I have altered that logic and now it works completely fine. Please review it once if any change require do let me know.
PS: Figuring out that logic took the whole time.

Copy link

codecov bot commented Dec 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.82%. Comparing base (471f113) to head (34522d8).
Report is 6 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2868       +/-   ##
=====================================================
+ Coverage             63.58%   87.82%   +24.24%     
=====================================================
  Files                   296      313       +17     
  Lines                  7371     8224      +853     
  Branches               1610     1799      +189     
=====================================================
+ Hits                   4687     7223     +2536     
+ Misses                 2451      802     -1649     
+ Partials                233      199       -34     

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

@palisadoes palisadoes merged commit 5feefcd into PalisadoesFoundation:develop-postgres Dec 25, 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