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/screens/UserPortal/Volunteer/Groups from Jest to Vitest #2584 #2638

Closed

Conversation

DevyanshuNegi
Copy link
Contributor

@DevyanshuNegi DevyanshuNegi commented Dec 11, 2024

Refactored src/screens/UserPortal/Volunteer/Groups.test.tsx to src/screens/UserPortal/Volunteer/Groups.spec.tsx

Issue: #2584 : #2584

Changes Implemented:

  • Refactored the testing framework from Jest to Vitest in Groups.test.tsx.
    • Updated import statements, mocking methods, and assertions to align with Vitest conventions.
    • Verified compatibility with the existing codebase using Vitest.
      - Renamed the test file:
    • From Groups.test.tsx → Groups.spec.tsx to follow the naming convention for Vitest.
      - Ran all tests successfully under the Vitest environment.
      Refactor: src/screens/UserPortal/Volunteer/Groups from Jest to Vitest #2584

Screenshot from 2024-12-11 17-27-28
Screenshot from 2024-12-11 17-29-15

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 testing framework from Jest to Vitest.
    • Enhanced mocking and testing capabilities for the Groups component.
    • Introduced new utility functions for improved testing.
    • Maintained existing test cases for rendering, sorting, searching, and state handling.

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request involve migrating the testing framework for the Groups.spec.tsx file from Jest to Vitest. This includes updating mocking syntax, import statements, and clearing mocks accordingly. New utility functions for debounce behavior and rendering the Groups component are introduced. The overall structure of the tests remains intact, ensuring that existing tests for the Groups component continue to validate its functionality effectively.

Changes

File Path Change Summary
src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx Updated from Jest to Vitest: changed jest.mock to vi.mock, jest.clearAllMocks() to vi.clearAllMocks(), modified import statements, and added utility functions debounceWait and renderGroups.

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • AVtheking
  • varshith257
  • palisadoes

Poem

🐰 In the land of code where tests do play,
We swapped out Jest for Vitest today.
With mocks and imports all in their place,
Our tests now run with a faster pace!
Hopping through changes, we cheer and we sing,
For the joy of refactoring, oh what joy it brings! 🎉


📜 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 05e2152 and 8313f4e.

📒 Files selected for processing (1)
  • src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx (11 hunks)
🧰 Additional context used
📓 Learnings (1)
📓 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.
🔇 Additional comments (6)
src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx (6)

18-19: LGTM: Vitest imports are correctly added

The necessary imports for Vitest have been properly added.


Line range hint 36-76: LGTM: Well-documented utility functions

The new utility functions debounceWait and renderGroups are well-structured and properly documented with JSDoc comments, making the test code more maintainable.


83-89: LGTM: Router mock correctly implemented with Vitest

The router mock has been properly migrated to use Vitest's mocking syntax and correctly uses 'useParams'.


97-97: LGTM: Test cleanup properly migrated to Vitest

The test cleanup has been correctly updated to use Vitest's vi.clearAllMocks().


100-103: LGTM: Comprehensive test documentation added

Each test case has been enhanced with clear JSDoc comments that describe its purpose, improving code maintainability.

Also applies to: 129-131, 138-140, 170-172, 193-195, 217-219, 229-231, 240-242, 253-255


Line range hint 1-266: Verify complete removal of Jest references

The migration to Vitest looks complete, but let's verify there are no remaining Jest references in the codebase.

✅ Verification successful

The search results show only one remaining Jest reference, which is the import of @testing-library/jest-dom. This is actually correct and expected, as jest-dom is a DOM testing utility that's compatible with both Jest and Vitest. It provides custom DOM element matchers and is commonly used with Vitest as well.

Migration to Vitest is complete and correct

The only Jest reference found is the jest-dom package which is intentionally kept as it's compatible with and recommended for use with Vitest for DOM testing assertions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining Jest references in the file
rg -i "jest" "src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx"

# Search for any jest.* calls that might have been missed
ast-grep --pattern "jest.$_($_)" "src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx"

Length of output: 301


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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

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: 1

🧹 Outside diff range and nitpick comments (1)
src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx (1)

Line range hint 86-214: Consider modernizing test implementation

While the tests are functional, consider these improvements for better maintainability:

  1. Consistently use userEvent instead of mixing fireEvent and userEvent
  2. Consider using test.each for similar test cases (e.g., sorting tests)
  3. Group related tests using describe blocks for better organization

Example of using test.each for sorting tests:

interface SortTest {
  sortType: string;
  expectedFirstGroup: string;
}

const sortTests: SortTest[] = [
  { sortType: 'volunteers_DESC', expectedFirstGroup: 'Group 1' },
  { sortType: 'volunteers_ASC', expectedFirstGroup: 'Group 2' }
];

test.each(sortTests)('sorts by $sortType', async ({ sortType, expectedFirstGroup }) => {
  renderGroups(link1);
  const sortBtn = await screen.findByTestId('sort');
  
  await userEvent.click(sortBtn);
  const sortOption = await screen.findByTestId(sortType);
  await userEvent.click(sortOption);

  const groupName = await screen.findAllByTestId('groupName');
  expect(groupName[0]).toHaveTextContent(expectedFirstGroup);
});
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4bef093 and bfb4245.

📒 Files selected for processing (1)
  • src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx (2 hunks)
🔇 Additional comments (2)
src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx (2)

18-19: LGTM: Correct imports for Vitest migration

The necessary imports for Vitest have been correctly added, including the test runner and DOM testing utilities.


82-82: LGTM: Correct cleanup implementation

The mock cleanup has been properly migrated from Jest to Vitest.

src/screens/UserPortal/Volunteer/Groups/Groups.spec.tsx Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 11, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 11, 2024
@palisadoes
Copy link
Contributor

  1. Please make sure coderabbit.ai approves your PR
  2. Make sure all tests pass (except introspection)
  3. Please make sure that the code coverage for your patch reaches at least 95%

@DevyanshuNegi
Copy link
Contributor Author

@palisadoes , Please look at the PR and see if I have made some errors .
coderabbit 2 checks are failling.
I am open to guidance / suggestion.

@varshith257
Copy link
Member

@DevyanshuNegi You need to make changes in develop-postgres branch and submit a new PR aginst it

You can follow this

> git remote add upstream https://github.com/PalisadoesFoundation/talawa-admin.git

> git fetch upstream

> git checkout -b refactor/test-jest-to-vitest upstream/develop-postgres

@palisadoes
Copy link
Contributor

This PR needs to be closed.

The source and target PR branches are the same. This means that our reviewers will not be able to checkout the changes and test on their systems using this methodology which will cause a rejection error:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Please follow these steps:

  1. Create a new branch with a different name in your local repository
    1. Make sure the branch name is named differently from the required target branch in the PR
    2. Use the git checkout -b command to do this.
  2. Resubmit your PR

You should be only using the develop-postgres branch for changes to talawa-admin at this time.

Closing

@palisadoes palisadoes closed this Dec 20, 2024
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.

3 participants