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

Migrated src/screens/ManageTag from Jest to Vitest #2742

Conversation

PratapRathi
Copy link
Contributor

@PratapRathi PratapRathi commented Dec 23, 2024

What kind of change does this PR introduce?

This PR migrates the test cases in src/screens/ManageTag from Jest to Vitest, ensuring compatibility with Vitest and maintaining 100% test coverage.

Issue Number:
Fixes #2555

Did you add tests for your changes?

Yes

Snapshots/Videos:

Screenshot 2024-12-24 at 00 30 53

If relevant, did you update the documentation?

N/A

Summary

Does this PR introduce a breaking change?

No

Other information

N/A

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Tests

    • Transitioned testing framework from Jest to Vitest for the ManageTag component.
    • Updated test cases to utilize Vitest's mocking and assertion methods.
  • Chores

    • Enhanced code comments related to error handling for better clarity and maintainability in the ManageTag component.

Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Walkthrough

The pull request focuses on refactoring the test file ManageTag.spec.tsx from Jest to Vitest, updating the testing framework and mocking mechanisms. The changes involve replacing Jest-specific functions and mocks with their Vitest equivalents, maintaining the same test logic and coverage. Additionally, the ManageTag.tsx file receives minor comment modifications to preserve code coverage directives.

Changes

File Change Summary
src/screens/ManageTag/ManageTag.spec.tsx Migrated from Jest to Vitest, replacing jest.mock() with vi.mock(), updating import statements, and reformatting test cases.
src/screens/ManageTag/ManageTag.tsx Added -- @preserve comments for error handling and code coverage preservation.

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents [#2555]
Ensure tests pass using npm run test:vitest [#2555] Requires actual test run verification.
Maintain 100% test coverage [#2555] Requires coverage report confirmation.

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Hopping through code with glee,
Jest to Vitest, a testing spree!
Mocks transformed, imports anew,
Coverage preserved, our tests ring true.
Refactoring rabbit's merry dance! 🧪


📜 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 4baf40b and 763a1ab.

📒 Files selected for processing (1)
  • src/screens/ManageTag/ManageTag.spec.tsx (20 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/screens/ManageTag/ManageTag.spec.tsx

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 23, 2024
Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.04%. Comparing base (df2dd67) to head (763a1ab).
Report is 2 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2742       +/-   ##
=====================================================
+ Coverage             75.01%   87.04%   +12.03%     
=====================================================
  Files                   296      313       +17     
  Lines                  7359     8211      +852     
  Branches               1608     1851      +243     
=====================================================
+ Hits                   5520     7147     +1627     
+ Misses                 1572      882      -690     
+ Partials                267      182       -85     

☔ 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.

See comment

@@ -22,6 +21,8 @@ import i18n from 'utils/i18nForTest';
import ManageTag from './ManageTag';
import { MOCKS, MOCKS_ERROR_ASSIGNED_MEMBERS } from './ManageTagMocks';
import { type ApolloLink } from '@apollo/client';
import { vi, beforeEach, afterEach, expect, it } from 'vitest';
import '@testing-library/jest-dom/vitest';
Copy link
Contributor

Choose a reason for hiding this comment

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

Why was this added? It doesn't appear to be used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@palisadoes Please review, imports for Jest are removed.

@palisadoes palisadoes merged commit 47c0e3b into PalisadoesFoundation:develop-postgres Dec 23, 2024
13 checks passed
@PratapRathi PratapRathi deleted the Migrate-src/screens/ManageTag-from-Jest-to-Vitest branch December 23, 2024 20:12
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