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

Refactoring the setupTests.ts from Jest to vitest #2931

Open
wants to merge 1 commit into
base: develop-postgres
Choose a base branch
from

Conversation

AQIB-NAWAB
Copy link

@AQIB-NAWAB AQIB-NAWAB commented Dec 26, 2024

What kind of change does this PR introduce?
refactoring

Issue Number:

Fixes #2753

Did you add tests for your changes?
No

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Chores
    • Transitioned testing setup from Jest to Vitest.
    • Updated global method mocking and overriding for improved error handling.
    • Increased test timeout configuration.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Walkthrough

This pull request focuses on refactoring the src/setupTests.ts file from Jest to Vitest, a modern testing framework. The changes involve updating test configuration, mocking global methods, and adjusting timeout settings. The modifications ensure compatibility with Vitest while maintaining the core testing setup for the project.

Changes

File Change Summary
src/setupTests.ts - Replaced Jest-specific functions with Vitest equivalents
- Updated global method mocks (fetch, console.error, console.warn)
- Modified timeout configuration from Jest to Vitest

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents
Rename test file suffix No explicit renaming mentioned in the changes
Ensure tests pass with npm run test:vitest Cannot verify from the provided summary
Maintain 100% test coverage Cannot verify from the provided summary

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Hop, hop, testing we go!
From Jest to Vitest, watch our code flow
Mocks and functions, now shiny and new
Testing framework shifts with a bunny's view
Faster, cleaner, our tests now gleam bright! 🧪✨

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

@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: 0

🧹 Nitpick comments (2)
src/setupTests.ts (2)

13-14: Consider a dedicated test utility for console errors
Overriding global.console.error is a valid strategy to ensure errors inside tests fail the test suite. However, constant overrides might hide certain logging details. If needed, use a specialized logger or a test utility that mocks console methods more selectively, restoring them after tests finish.


18-18: Same caution with console warnings
Similarly, overriding console.warn to throw can be beneficial for test rigor. Just ensure it does not obscure relevant output.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9772f7d and ed8147c.

📒 Files selected for processing (1)
  • src/setupTests.ts (1 hunks)
🔇 Additional comments (8)
src/setupTests.ts (8)

1-1: Check consistency of package name in comment vs. actual import
The comment suggests "vitest-dom," yet the import is from @testing-library/jest-dom. If you're fully transitioning to Vitest, consider whether this import should be changed to match a Vitest-compatible DOM library (e.g., vitest-dom) or if the existing @testing-library/jest-dom is intended.


7-7: Correct usage of Vitest utilities
The import of vi from 'vitest' is appropriate. Good job on initiating the actual framework transition here.


10-11: Global fetch mocking looks good
Using vi.fn() is the correct approach in Vitest to mock global methods.


22-22: Fine approach to mock muted setter
Protecting the muted setter from potentially throwing or playing media is a neat way to isolate your tests from browser-related side effects.


27-29: Global imports
Importing global CSS and scripts is usually safe for integration or end-to-end tests. For unit tests, confirm whether these imports are actually necessary, as they can slow down test runs or cause unexpected side effects.


33-33: Check usage of jestPreviewConfigure
While the library name is "jest-preview," it's being used in a Vitest setup. Make sure there's no conflict or alternative configuration needed to align with Vitest’s recommended patterns.


35-35: Configuration approach
Enabling autoPreview can be helpful for debugging failing test cases. Just verify that it integrates correctly with Vitest.


41-42: Large test timeout
The new test timeout is set to 400 seconds. Confirm if this extended timeout is genuinely required. Extended timeouts might mask performance issues or unresponsive tests.

@palisadoes
Copy link
Contributor

Please fix the failing test

@duplixx
Copy link
Member

duplixx commented Dec 30, 2024

@AQIB-NAWAB Please fix the conflicting file changes

@AQIB-NAWAB
Copy link
Author

Hy, sorry for late response i was busy. All the testcases for vitest are pasing but the main issue is that jest is not parsing the vitest. Can you help me resolving the issue ??
Adding picture
image

@palisadoes
Copy link
Contributor

Please ask the Talawa Admin slack channel

Copy link
Member

@noman2002 noman2002 left a comment

Choose a reason for hiding this comment

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

Please fix the conflicting files.

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.

4 participants