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

Refactor: src/screens/OrganizationFunds from Jest to Vitest #2685

Merged
merged 10 commits into from
Dec 23, 2024

Conversation

prathmesh703
Copy link
Contributor

@prathmesh703 prathmesh703 commented Dec 19, 2024

What kind of change does this PR introduce?

refactoring

Issue Number:

Fixes #2561

Did you add tests for your changes?

no

Snapshots/Videos:

Screenshot 2024-12-19 144016
Screenshot 2024-12-19 191914

Summary
refactored two files from jest to vitest framework
1.OrganizationFunds
2.FundModal

Does this PR introduce a breaking change?

NO

Have you read the contributing guide?

YES

Summary by CodeRabbit

  • Tests
    • Updated testing framework from Jest to Vitest for FundModal and OrganizationFunds components.
    • Enhanced mocking of URL parameters using useParams in OrganizationFunds tests.
    • Improved clarity and functionality of tests for both components, ensuring accurate behavior verification.
    • Added a new test case in FundModal to verify no updates occur when no fields are changed.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

This pull request focuses on migrating the test files FundModal.spec.tsx and OrganizationFunds.spec.tsx from Jest to Vitest. The changes involve replacing Jest-specific mocking functions with Vitest equivalents, updating mock implementations, and adjusting test configurations to align with Vitest's syntax and features. The core functionality and test coverage of the components remain unchanged during this migration.

Changes

File Change Summary
src/screens/OrganizationFunds/FundModal.spec.tsx Migrated from Jest to Vitest mocking, replacing jest.mock() with vi.mock(), and updating mock function implementations. Added a new test case for unchanged fields.
src/screens/OrganizationFunds/OrganizationFunds.spec.tsx Updated mocking for useParams and routing, migrated to Vitest mocking methods, added explicit parameter mocking, and adjusted lifecycle hooks.

Assessment against linked issues

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

Possibly related issues

Possibly related PRs

Suggested reviewers

  • varshith257

Poem

🐰 Hopping through the test terrain,
Jest to Vitest, a coding refrain,
Mocks dancing with vi.fn() glee,
Refactoring tests, setting them free!
Rabbit's testing magic, smooth and bright 🧪


📜 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 22b1204 and 9d3eb9e.

📒 Files selected for processing (2)
  • src/screens/OrganizationFunds/FundModal.spec.tsx (6 hunks)
  • src/screens/OrganizationFunds/FundModal.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/screens/OrganizationFunds/FundModal.spec.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/OrganizationFunds/FundModal.tsx (1)
Learnt from: GlenDsza
PR: PalisadoesFoundation/talawa-admin#2064
File: src/screens/OrganizationFunds/OrganizationFunds.tsx:66-72
Timestamp: 2024-11-12T10:40:58.654Z
Learning: Renaming the Enum `Modal` to `ModalState` in the `organizationFunds` component is unnecessary and does not change the functionality.
🔇 Additional comments (2)
src/screens/OrganizationFunds/FundModal.tsx (2)

162-162: LGTM! Error handling improvement.

The simplified error casting is a safe improvement that maintains type safety.


142-144: LGTM! Verify test coverage for the early return optimization.

The optimization to prevent unnecessary API calls when no fields have changed is a good improvement.

Let's verify the test coverage for this optimization:

✅ Verification successful

Let me gather more context about the test implementation to verify if it properly checks the API call prevention.


Let me check for the API mock setup and assertions in the test file to ensure it properly verifies that no API call is made.


Test coverage for the early return optimization is complete and accurate

The test case "should not update the fund when no fields are changed" properly verifies the optimization by:

  • Setting all form fields to their original values
  • Verifying no API calls were made by checking that:
    • Success toast wasn't shown
    • Fund refetch wasn't triggered
    • Modal wasn't closed
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if there are tests covering the early return case
# Expected: Find test cases that verify no API calls are made when fields haven't changed

rg -A 5 "when no fields (are )?changed" "src/screens/OrganizationFunds/FundModal.spec.tsx"

Length of output: 391


Script:

#!/bin/bash
# Get more context around the test case including assertions
rg -B 2 -A 15 "should not update the fund when no fields are changed" "src/screens/OrganizationFunds/FundModal.spec.tsx"

# Also check the mock setup for API calls
rg "mock\(" "src/screens/OrganizationFunds/FundModal.spec.tsx"

Length of output: 927


Script:

#!/bin/bash
# Get the full test file content to check API mock setup and assertions
cat "src/screens/OrganizationFunds/FundModal.spec.tsx"

Length of output: 9835


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

@varshith257 varshith257 marked this pull request as ready for review December 19, 2024 14:01
@varshith257
Copy link
Member

Note: This organisation doesn't accept draft PRs

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 19, 2024
@prathmesh703
Copy link
Contributor Author

sorry, should i make a new PR

@Cioppolo14
Copy link
Contributor

@prathmesh703 If it is not ready for review, you can close it. If you want to leave it open, please fix the failed tests.

@shivasankaran18
Copy link
Contributor

shivasankaran18 commented Dec 19, 2024

@Cioppolo14 @palisadoes fixed these failing tests in my PRs #2663 #2662 ..Merging them should fix these ..could you please look into it?

Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.08%. Comparing base (92ce58d) to head (a1ad1cc).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2685       +/-   ##
=====================================================
+ Coverage             77.00%   87.08%   +10.08%     
=====================================================
  Files                   295      312       +17     
  Lines                  7289     8148      +859     
  Branches               1593     1784      +191     
=====================================================
+ Hits                   5613     7096     +1483     
+ Misses                 1412      875      -537     
+ Partials                264      177       -87     

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

@prathmesh703
Copy link
Contributor Author

Thanks @shivasankaran18 after merging it fixed the failing test . @Cioppolo14 @palisadoes fixed the failing test

package-lock.json Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 20, 2024
@varshith257
Copy link
Member

@prathmesh703 Can you increase test coverage so that the remaining lines get cover for FundModal.tsx

  FundModal.tsx    |     100 |    85.71 |     100 |     100 | 127-160           

@prathmesh703
Copy link
Contributor Author

ok

@prathmesh703
Copy link
Contributor Author

Screenshot 2024-12-21 221542

@varshith257 increased the test coverage

@prathmesh703
Copy link
Contributor Author

@Cioppolo14 @palisadoes can you review the PR ?

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.

5 participants