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

migration of People.test.tsx from jest to vitest #2661

Open
wants to merge 2 commits into
base: develop-postgres
Choose a base branch
from

Conversation

nadeemnagarji
Copy link

@nadeemnagarji nadeemnagarji commented Dec 14, 2024

What kind of change does this PR introduce?

Refactor
Issue Number:

Fixes #2576

Did you add tests for your changes?

Yes

Snapshots/Videos:
testcase passed

Summary

Migrating the tests of People.tsx Component from jest to vitest

Does this PR introduce a breaking change?
No

Other information

Have you read the contributing guide?

Yes

Summary by CodeRabbit

Release Notes

  • New Features

    • Implemented a new configuration for the Vitest testing framework to enhance testing capabilities.
  • Bug Fixes

    • Updated test configurations to use Vitest instead of Jest, ensuring better compatibility and performance.
  • Chores

    • Cleaned up configuration files by removing unnecessary comments and adjusting timeout settings.
  • Refactor

    • Streamlined test cases and standardized naming conventions for improved clarity and consistency.

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

coderabbitai bot commented Dec 14, 2024

Walkthrough

This pull request focuses on migrating the testing infrastructure for the People component from Jest to Vitest. The changes involve updating test files in src/screens/UserPortal/People/People.test.tsx and src/setupTests.ts, as well as modifying the vitest.config.ts to include both .spec and .test file extensions. The primary goal is to transition the testing framework while maintaining the existing test logic and coverage.

Changes

File Change Summary
src/screens/UserPortal/People/People.test.tsx Replaced Jest-specific mocking and test methods with Vitest equivalents (e.g., jest.mockvi.mock, testit)
src/setupTests.ts Updated global test configuration from Jest to Vitest, including fetch mocking and timeout settings
vitest.config.ts Expanded test file inclusion to support both .spec and .test file extensions

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents [#2576]
Ensure tests pass using npm run test:vitest [#2576] Requires full test suite verification
Maintain 100% test coverage [#2576] Requires comprehensive coverage check

Possibly related issues

Possibly related PRs

Suggested labels

refactor, test

Suggested reviewers

  • AVtheking
  • varshith257
  • pranshugupta54

Poem

🐰 Hopping through the test terrain,
Jest to Vitest, a coding refrain!
Mocks and functions, now reborn,
A testing framework freshly sworn.
Code leaps forward with playful might! 🚀

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. This feature will be included in our Pro Plan when released.


📜 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 f4aafd7 and dfe7b0b.

📒 Files selected for processing (3)
  • src/screens/UserPortal/People/People.test.tsx (5 hunks)
  • src/setupTests.ts (2 hunks)
  • vitest.config.ts (1 hunks)
🧰 Additional context used
📓 Learnings (2)
vitest.config.ts (2)
Learnt from: MayankJha014
PR: PalisadoesFoundation/talawa-admin#2619
File: vitest.config.ts:0-0
Timestamp: 2024-12-09T15:54:04.872Z
Learning: The files `scripts/custom-test-env.js`, `src/utils/i18nForTest.ts`, and `vitest.setup.ts` are not test files and should not be included in the test pattern.
Learnt from: varshith257
PR: PalisadoesFoundation/talawa-admin#2457
File: jest.config.js:9-9
Timestamp: 2024-11-26T04:34:26.475Z
Learning: In `jest.config.js`, configure `testMatch` to include only `.test.*` files, as `.spec.*` files are used for Vitest tests.
src/setupTests.ts (1)
Learnt from: MayankJha014
PR: PalisadoesFoundation/talawa-admin#2619
File: vitest.config.ts:0-0
Timestamp: 2024-12-09T15:54:04.872Z
Learning: In the Talawa-Admin project, `src/setupTests.ts` is defined for Jest, and including it in Vitest causes reference errors.
🔇 Additional comments (7)
vitest.config.ts (1)

17-17: LGTM: Test pattern inclusion is correct

The inclusion of both .spec and .test patterns is appropriate for the Jest to Vitest migration, ensuring all test files are properly recognized.

Let's verify no test files are missed:

✅ Verification successful

LGTM: Test pattern inclusion is correct and comprehensive

The verification confirms that the test pattern inclusion in vitest.config.ts correctly matches all test files in the codebase. The pattern ['src/**/*.spec.{js,jsx,ts,tsx}', 'src/**/*.test.{js,jsx,ts,tsx}'] successfully covers:

  • 156 test files across the codebase
  • Both .spec and .test file patterns
  • All supported extensions (js, jsx, ts, tsx)
  • Files in various directories under src/
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any test files that might be missed
fd -e tsx -e ts -e jsx -e js | grep -E '(\.test\.|\.spec\.)'

Length of output: 11253

src/setupTests.ts (3)

6-6: LGTM: Proper Vitest import and mock setup

The migration from Jest to Vitest imports and global fetch mock is correct.

Also applies to: 8-8


34-37: LGTM: Proper timeout configuration

The test timeout configuration has been correctly migrated to use Vitest's API.


29-32: Verify if JestPreview needs a Vitest alternative

The JestPreview configuration has been commented out. Consider investigating if there's a Vitest-compatible alternative for test previewing functionality.

src/screens/UserPortal/People/People.test.tsx (3)

16-16: LGTM: Proper Vitest imports and router mocking

The migration to Vitest imports and router mocking implementation is correct.

Also applies to: 116-122


139-139: LGTM: Test cases properly migrated

All test cases have been correctly migrated from test to it while maintaining the same functionality and assertions.

Also applies to: 157-157, 179-179, 205-205


127-135: LGTM: Proper matchMedia mock implementation

The matchMedia mock has been correctly updated to use Vitest's mocking API.

Let's verify test coverage hasn't decreased:

✅ Verification successful

Let me check the test coverage for these conditionals by examining the test file.


Test coverage is comprehensive for all conditionals

The test file shows complete coverage of all identified conditionals:

  • if (e.key === 'Enter') is tested in "Search works properly by pressing enter" test
  • if (data) for members is tested in all test cases that render members
  • if (mode == 0) and related data conditionals are covered in the base test cases
  • if (mode == 1) and if (data2) for admin mode are tested in "Mode is changed to Admins" test
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any untested code paths in People component
rg "^(\s*)(if|switch|for|while)" src/screens/UserPortal/People/People.tsx | while read -r line; do
  echo "Potential conditional that needs test coverage: $line"
done

Length of output: 854


Script:

#!/bin/bash
# Check test coverage for the identified conditionals
echo "=== People.test.tsx content ==="
cat src/screens/UserPortal/People/People.test.tsx

echo -e "\n=== People.tsx content around conditionals ==="
rg -B 2 -A 2 "^(\s*)(if|switch|for|while)" src/screens/UserPortal/People/People.tsx

Length of output: 6923


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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 14, 2024
@Cioppolo14
Copy link

@nadeemnagarji Please fix the failed tests.

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