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 Jest to Vitest #2828 #2873

Conversation

rahulch07
Copy link
Contributor

@rahulch07 rahulch07 commented Dec 25, 2024

What kind of change does this PR introduce?

This PR will migrate the src/components/RequestsTableItem/RequestsTableItem.test.tsx from Jest to Vitest #2828

Did you add tests for your changes?

Yes

Snapshots/Videos:

Screenshot from 2024-12-25 21-01-33

If relevant, did you update the documentation?

N/A

Does this PR introduce a breaking change?

No

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features
    • Added test cases for accepting and rejecting membership requests, including error handling scenarios.
  • Bug Fixes
    • Updated mock data to reflect new identifiers for organization request mutations.
  • Tests
    • Transitioned test suite from jest to vitest, enhancing consistency and functionality in testing.

Copy link
Contributor

coderabbitai bot commented Dec 25, 2024

Walkthrough

This pull request focuses on migrating the RequestsTableItem component's test suite from Jest to Vitest. The changes involve updating the testing framework-specific functions, renaming test cases from test to it, and adding new test scenarios for handling membership request acceptance and rejection. The mock data for organization request mutations has also been updated with a new request ID.

Changes

File Change Summary
src/components/RequestsTableItem/RequestsTableItem.spec.tsx - Transitioned from Jest to Vitest
- Replaced jest.fn() with vi.fn()
- Replaced jest.mock with vi.mock
- Renamed tests from test to it
- Added new test cases for request acceptance and error handling
src/components/RequestsTableItem/RequestsTableItemMocks.ts - Updated mock data IDs from '1' to '123' for both request mutations

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Hopping through code with glee,
Jest to Vitest, we're breaking free!
Mocks and tests, now crisp and bright,
Refactoring with all our might!
Rabbit's testing dance, oh so light! 🧪

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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

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/components/RequestsTableItem/RequestsTableItemMocks.ts (1)

11-17: Consider refactoring to use a shared constant for ID.

The repeated usage of '123' in both variables and result sections might benefit from a shared constant to avoid typos and make future modifications easier.

src/components/RequestsTableItem/RequestsTableItem.spec.tsx (1)

45-45: Suggest using vi.spyOn(console, 'error') for improved clarity.

Reassigning console.error works, but vi.spyOn provides better transparency and ensures that console overrides do not leak.

- console.error = vi.fn((message) => {
+ vi.spyOn(console, 'error').mockImplementation((message) => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9eef34c and c91d7e4.

📒 Files selected for processing (2)
  • src/components/RequestsTableItem/RequestsTableItem.spec.tsx (6 hunks)
  • src/components/RequestsTableItem/RequestsTableItemMocks.ts (2 hunks)
🔇 Additional comments (10)
src/components/RequestsTableItem/RequestsTableItemMocks.ts (1)

26-32: Maintain consistency in test data.

Changing all references from '1' to '123' is consistent; ensure that test scenarios referencing _id: '1' in other files are deliberate and still valid if they expect a missing or non-matching mock.

src/components/RequestsTableItem/RequestsTableItem.spec.tsx (9)

14-14: Good move migrating to Vitest.

Importing the Vitest vi object aligns with the PR’s objective. This import looks correct.


25-25: Ensure all references to the mock function are correctly updated.

resetAndRefetchMock is correctly assigned using vi.fn(). Confirm that all calls to the former Jest-based mock have been replaced throughout the suite.


27-31: Correct usage of vi.mock() and vi.fn().

Switching from jest.mock() to vi.mock() is appropriate. The toast mocks appear comprehensive for capturing success and error notifications.


41-41: Appropriate clearing of mocks between tests.

vi.clearAllMocks() ensures a clean slate for each test, preventing state leakage between test cases.


Line range hint 51-83: Tests remain consistent.

Renaming from test to it is purely stylistic but is a recommended practice for readability. The libraries, property checks, and screen queries look correct.


Line range hint 85-115: Acceptance scenario works properly.

The test for accepting membership requests references _id: '123', matching updated mock data. This should behave correctly with the new mutation ID.


117-147: Mismatch between _id: '1' and updated mock data.

This error-handling test uses _id: '1', which may be intentional for simulating missing mock data. Verify that not having a matching mock is the expected scenario to test error flows.


Line range hint 149-179: Rejection scenario works properly.

Rejecting membership requests with _id: '123' aligns with the updated mocks, ensuring the test covers a successful scenario.


180-211: Again, _id: '1' for error scenario.

Similar to the accept error test, confirm that _id: '1' not matching the mock is desired to trigger an error.

Copy link

codecov bot commented Dec 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.90%. Comparing base (471f113) to head (c91d7e4).
Report is 8 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2873       +/-   ##
=====================================================
+ Coverage             63.58%   87.90%   +24.31%     
=====================================================
  Files                   296      313       +17     
  Lines                  7371     8224      +853     
  Branches               1610     1855      +245     
=====================================================
+ Hits                   4687     7229     +2542     
+ Misses                 2451      793     -1658     
+ Partials                233      202       -31     

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

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Thanks for adding more test cases

@palisadoes palisadoes merged commit c42135b 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