Migrated src/screens/manage tag from jest to vitest #2736

PratapRathi · 2024-12-23T16:52:03Z

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:

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, updating mock functions and test cases accordingly.
Chores
- Added preservation comments to error handling sections for better clarity during code minification.

…d to ManageTag.spec.tsx

coderabbitai · 2024-12-23T16:52:10Z

Walkthrough

This pull request focuses on refactoring the ManageTag component and its test file from Jest to Vitest. The changes involve updating the test suite's syntax, mocking mechanisms, and import statements to align with Vitest's testing framework. Additionally, minor comments were added to preserve error handling sections in the ManageTag.tsx file during code transformations.

Changes

File	Change Summary
`src/screens/ManageTag/ManageTag.spec.tsx`	Migrated from Jest to Vitest, updated import statements, replaced Jest mocking with `vi.mock()`, changed `test()` to `it()`, and updated mock clearing mechanism
`src/screens/ManageTag/ManageTag.tsx`	Added `-- @preserve` comments in error handling sections to maintain code integrity during transformations

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 verification

Possibly related issues

Refactor: src/screens/SubTags from Jest to Vitest #2570: Refactoring src/screens/SubTags from Jest to Vitest, similar migration approach
Refactor: src/screens/UserPortal/UserScreen from Jest to Vitest #2580: Refactoring src/screens/UserPortal/UserScreen from Jest to Vitest
Refactor : src/components/AddPeopleToTag/AddPeopleToTag.test.tsx from Jest to Vitest #2483: Refactoring AddPeopleToTag component tests from Jest to Vitest

Possibly related PRs

Refactor: src/screens/UserPortal/Volunteer/Actions from Jest to Vitest #2619: Migration of tests from Jest to Vitest
refactored: src/screens/OrgSettings from Jest to Vitest(fixes: #2567) #2625: Refactoring OrgSettings component tests
Refactor Tests: Migrate src/screens/UserPortal/UserScreen/UserScreen.tsx from Jest to Vitest #2632: Transitioning UserScreen tests to Vitest

Suggested reviewers

palisadoes

Poem

🐰 Hopping through code with glee,
Jest to Vitest, setting tests free!
Mocks and imports dance anew,
Preserving logic, tried and true.
Refactoring rabbit's merry spree! 🧪

📜 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 ec91a82 and cabed76.

📒 Files selected for processing (2)

src/screens/ManageTag/ManageTag.spec.tsx (20 hunks)
src/screens/ManageTag/ManageTag.tsx (8 hunks)

✅ Files skipped from review due to trivial changes (1)

src/screens/ManageTag/ManageTag.tsx

🧰 Additional context used

📓 Learnings (2)

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

src/screens/ManageTag/ManageTag.spec.tsx (1)

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 (7)

src/screens/ManageTag/ManageTag.spec.tsx (7)

24-25: Nice use of Vitest imports.
These updated imports correctly replace Jest with Vitest components (vi, beforeEach, afterEach, expect, it).

46-50: Mocking react-toastify with vi.mock looks correct.
Switching from Jest to Vitest mocking is smooth here. No issues found.

55-56: Successful mock for AddPeopleToTag with vi.mock.
Nicely aligns with Vitest best practices.

59-60: Successful mock for TagActions with vi.mock.
Well done porting from Jest to Vitest.

97-98: react-router-dom mock.
Using vi.importActual ensures you maintain original functionalities while still mocking. This is great.

103-103: vi.clearAllMocks works as expected.
This retains the clearing-behavior previously achieved with Jest.

107-107: All updated test blocks run as expected under Vitest.
Each one preserves the original test logic while replacing “test” with “it.” Great job staying within the migration scope without unintended changes.

Also applies to: 117-117, 127-127, 149-149, 171-171, 196-196, 221-221, 243-243, 265-265, 280-280, 295-295, 312-312, 327-327, 348-348, 405-405, 436-436, 455-455, 485-485

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.

github-actions · 2024-12-23T16:52:27Z

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

We don't merge PRs with poor code quality.
1. Follow coding best practices such that CodeRabbit.ai approves your PR.
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.
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:

comments in this PR or
our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

arbitrators of future discussions with other contributors about the validity of your changes
point of contact for evaluating the validity of your work
person who verifies matching issues by others that should be closed.
person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

PRs with issues not assigned to you will be closed by the reviewer
Fix the first comment in the PR so that each issue listed automatically closes

Other

🎯 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.
Read the CONTRIBUTING.md file make

codecov · 2024-12-23T17:00:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.13%. Comparing base (ec91a82) to head (cabed76).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2736      +/-   ##
===========================================
- Coverage    90.52%   85.13%   -5.40%     
===========================================
  Files          295      312      +17     
  Lines         7249     8125     +876     
  Branches      1591     1837     +246     
===========================================
+ Hits          6562     6917     +355     
- Misses         455     1050     +595     
+ Partials       232      158      -74

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

PratapRathi · 2024-12-23T17:14:26Z

@palisadoes This is my 2nd pull request first one is #2733
Here Codecov still showing me the test coverage data of my previous 1st PR.

Current Code Coverage in Vitest

Old Code Coverage in Jest

palisadoes · 2024-12-23T17:27:10Z

Please ensure the following:

Fetch the latest upstream/develop-postgres files
Make your PR modifications based on the local copy of this develop-postgres branch
Submit your PRs against our develop-postgres branch.
Your source branch in your local repository must not be the same as the target branch

Refactor: Migrated ManageTag.test.tsx from Jest to Vitest also rename…

cabed76

…d to ManageTag.spec.tsx

coderabbitai bot approved these changes Dec 23, 2024

View reviewed changes

PratapRathi closed this Dec 23, 2024

PratapRathi deleted the Migrate-src/screens/manageTag-from-Jest-to-Vitest branch December 23, 2024 17:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrated src/screens/manage tag from jest to vitest #2736

Migrated src/screens/manage tag from jest to vitest #2736

PratapRathi commented Dec 23, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 23, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Dec 23, 2024

codecov bot commented Dec 23, 2024

PratapRathi commented Dec 23, 2024

palisadoes commented Dec 23, 2024

Migrated src/screens/manage tag from jest to vitest #2736

Migrated src/screens/manage tag from jest to vitest #2736

Conversation

PratapRathi commented Dec 23, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 23, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related issues

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Dec 23, 2024

Our Pull Request Approval Process

Testing Your Code

Reviewers

Reviewing Your Code

CONTRIBUTING.md

Other

codecov bot commented Dec 23, 2024

Codecov Report

PratapRathi commented Dec 23, 2024

palisadoes commented Dec 23, 2024

PratapRathi commented Dec 23, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 23, 2024 •

edited

Loading