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

Refactored src/screens/UserPortal/Campaigns/PledgeModal.test.tsx from jest to vitest #3355

Merged

Conversation

syedali237
Copy link
Contributor

@syedali237 syedali237 commented Jan 19, 2025

What kind of change does this PR introduce?

Refactoring

Issue Number:

Fixes #3347

Snapshots/Videos:

N/A

If relevant, did you update the documentation?

No

Summary

Migrated src/screens/UserPortal/Campaigns/PledgeModal.test.tsx from jest to vitest.

Does this PR introduce a breaking change?

No

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Other information

N/A

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Chores
    • Updated testing framework from Jest to Vitest
    • Migrated mocking strategies for test dependencies
    • Replaced mock function calls to align with new testing framework

Copy link
Contributor

coderabbitai bot commented Jan 19, 2025

Walkthrough

This pull request focuses on refactoring the PledgeModal.spec.tsx test file from Jest to Vitest. The changes involve replacing Jest-specific mocking functions with Vitest equivalents, such as switching from jest.mock to vi.mock, and updating mock implementations for libraries like react-toastify and @mui/x-date-pickers/DateTimePicker. The modifications ensure compatibility with the Vitest testing framework while maintaining the existing test structure and coverage.

Changes

File Change Summary
src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx - Replaced jest.mock with vi.mock
- Updated mocks for react-toastify and DateTimePicker
- Replaced jest.fn() with vi.fn()
- Updated cleanup function to use vi.clearAllMocks()

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents [#3347]
Rename test file to .spec.* suffix [#3347]
Ensure tests pass with npm run test:vitest [#3347] Requires actual test run verification
Maintain 100% test coverage [#3347] Requires coverage report confirmation

Possibly related issues

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes
  • disha1202

Poem

🐰 Hop, hop, testing we go,
From Jest to Vitest, watch our code flow!
Mocks dancing, functions bright,
Refactoring tests with all our might!
Vitest magic, tests now gleam! 🧪✨


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
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 (1)
src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx (1)

27-32: Consider using type-safe mock implementation for react-toastify.

The mock implementation is functionally correct for Vitest, but could benefit from type safety.

-vi.mock('react-toastify', () => ({
+vi.mock('react-toastify', () => ({
+  __esModule: true,
   toast: {
     success: vi.fn(),
     error: vi.fn(),
   },
 }));
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c52f54e and 7044182.

📒 Files selected for processing (1)
  • src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx (4 hunks)
🧰 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/UserPortal/Campaigns/PledgeModal.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.
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test Application
🔇 Additional comments (3)
src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx (3)

46-46: LGTM! Correct migration of mock functions.

The jest.fn() calls have been properly replaced with vi.fn() while maintaining the existing mock data structure.

Also applies to: 62-62, 70-70, 86-86


215-226: LGTM! Correct implementation of Vitest mocking patterns.

The test suite setup correctly implements:

  • Async mock implementation with vi.importActual
  • Proper mock cleanup with vi.clearAllMocks

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

Let's ensure no Jest-specific references remain in the codebase.

✅ Verification successful

Migration to Vitest is complete and correct

The codebase has been successfully migrated from Jest to Vitest:

  • All assertions use Vitest-compatible matchers
  • Test lifecycle methods are framework-agnostic
  • No Jest-specific APIs or patterns remain
  • Mocking is properly implemented using vi namespace
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining Jest references in the test file
# Expected: No occurrences of jest. except in comments

# Search for jest references excluding comments and package.json
rg 'jest\.' --type tsx --type ts --type jsx --type js \
  --glob '!package.json' \
  --glob '!**/jest.config.*' \
  src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx

Length of output: 187


Script:

#!/bin/bash
# Search for various Jest-specific patterns
echo "=== Searching for Jest references ==="
rg -i "jest\." src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx || true

echo -e "\n=== Searching for Jest-specific expect matchers ==="
rg "expect\((.*?)\)\.to(Be|Have|Match|Contain)" src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx || true

echo -e "\n=== Searching for Jest lifecycle methods ==="
rg "\b(beforeAll|afterAll|beforeEach|afterEach|describe|it|test)\b" src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx || true

echo -e "\n=== Searching for Jest mock functions ==="
rg "jest\.fn\(\)" src/screens/UserPortal/Campaigns/PledgeModal.spec.tsx || true

Length of output: 2636

Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.75%. Comparing base (0c0fc8e) to head (84d4b58).
Report is 5 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3355       +/-   ##
=====================================================
+ Coverage              8.40%   89.75%   +81.35%     
=====================================================
  Files                   312      335       +23     
  Lines                  8105     8612      +507     
  Branches               1801     1898       +97     
=====================================================
+ Hits                    681     7730     +7049     
+ Misses                 7347      627     -6720     
- Partials                 77      255      +178     
Flag Coverage Δ
combined 89.75% <ø> (?)
vitest 89.75% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@syedali237
Copy link
Contributor Author

on my local, all the test cases passes successfully, even this failing test.

Screenshot 2025-01-20 at 2 02 10 AM Screenshot 2025-01-20 at 2 04 19 AM

@palisadoes
Copy link
Contributor

@syedali237
Copy link
Contributor Author

the failed test does not fail on my local system , and it was not altered during this PR.

@palisadoes
Copy link
Contributor

The PR that introduced the error has been reverted. Please merge with the latest upstream

@palisadoes palisadoes merged commit 0185646 into PalisadoesFoundation:develop-postgres Jan 20, 2025
19 checks passed
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