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 #2684

Closed

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 143519
Screenshot 2024-12-19 144016

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

  • New Features

    • Updated project dependencies for improved performance and compatibility.
    • Enhanced test coverage for the FundModal and OrganizationFunds components, ensuring accurate functionality and user interactions.
  • Bug Fixes

    • Improved handling of URL parameters in tests for the OrganizationFunds component.
  • Tests

    • Transitioned testing framework from Jest to Vitest for better alignment with project standards.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

This pull request involves updating the package.json file for the talawa-admin project and refactoring test files for the OrganizationFunds screen from Jest to Vitest. The changes include updating dependency versions, specifying Node.js engine requirements, and migrating test mocking and assertion methods to align with the Vitest testing framework.

Changes

File Change Summary
package.json - Updated vitest to version ^2.1.8
- Modified resolutions for graphql, @apollo/client, and @types/react
- Added engines to specify Node.js version >=20.x
src/screens/OrganizationFunds/FundModal.spec.tsx - Replaced jest.mock with vi.mock
- Updated mock implementations for toast.success and toast.error
- Replaced jest.fn() with vi.fn()
src/screens/OrganizationFunds/OrganizationFunds.spec.tsx - Added useParams import from react-router-dom
- Migrated from Jest to Vitest mocking
- Updated test cases to use vi.mocked(useParams)

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 coverage report verification

Possibly related issues

Possibly related PRs

Suggested labels

test, ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes

Poem

🐰 Hop, hop, testing we go!
From Jest to Vitest, watch our code flow
Mocks and functions, now crystal clear
Refactoring tests without a fear
CodeRabbit's magic makes testing a breeze! 🧪✨


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 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: 1

🔭 Outside diff range comments (1)
package.json (1)

Version incompatibility detected between dependencies

  • The project uses React 18.3.1, but @types/react is pinned to 17.0.2, which may cause type mismatches
  • GraphQL 16.9.0 is used, but @apollo/client 3.4.0-beta.19 requires GraphQL ^14.0.0 || ^15.0.0
  • Required peer dependency 'subscriptions-transport-ws' is missing
🔗 Analysis chain

Line range hint 164-167: Verify dependency resolution compatibility

The resolutions for @apollo/client and React types are pinned to specific versions. While this helps avoid conflicts, we should verify these versions are compatible with the rest of the ecosystem.

Consider documenting the reason for these specific version pins in the package.json comments or README to help future maintenance.


Let me gather more information about the graphql version being used and other related dependencies.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for potential compatibility issues with specified versions
npm info @apollo/[email protected] peerDependencies
npm info @types/[email protected] peerDependencies

Length of output: 213


Script:

#!/bin/bash
# Check the actual graphql version and other related dependencies
cat package.json | jq '.dependencies.graphql, .dependencies["@apollo/client"], .dependencies.react, .dependencies["react-dom"]'

# Check if subscriptions-transport-ws is present
cat package.json | jq '.dependencies["subscriptions-transport-ws"], .devDependencies["subscriptions-transport-ws"]'

Length of output: 297

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9723078 and 342dbc0.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • package.json (1 hunks)
  • src/screens/OrganizationFunds/FundModal.spec.tsx (4 hunks)
  • src/screens/OrganizationFunds/OrganizationFunds.spec.tsx (9 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
src/screens/OrganizationFunds/OrganizationFunds.spec.tsx

[error] 84-86: Disallow duplicate setup and teardown hooks.

Disallow afterEach duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)

🔇 Additional comments (3)
package.json (1)

159-159: LGTM: Vitest version update

The update to Vitest v2.1.8 aligns with the migration objective.

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

71-77: LGTM: Proper async mock implementation

The async mock implementation for react-router-dom correctly preserves the actual module's functionality while mocking useParams.

src/screens/OrganizationFunds/FundModal.spec.tsx (1)

26-31: LGTM: Consistent mock migration

The migration from Jest to Vitest mocks is implemented correctly and consistently throughout the file, including:

  • Mock implementation for react-toastify
  • Mock functions for hide and refetchFunds in fundProps

Also applies to: 42-42, 58-58, 64-64, 80-80

Comment on lines +81 to 86
vi.clearAllMocks();
});

afterEach(() => {
cleanup();
});
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Merge duplicate afterEach blocks

There are two consecutive afterEach blocks that should be combined for better maintainability.

  afterEach(() => {
    vi.clearAllMocks();
-  });
-
-  afterEach(() => {
    cleanup();
  });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
vi.clearAllMocks();
});
afterEach(() => {
cleanup();
});
afterEach(() => {
vi.clearAllMocks();
cleanup();
});
🧰 Tools
🪛 Biome (1.9.4)

[error] 84-86: Disallow duplicate setup and teardown hooks.

Disallow afterEach duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)

@Niyatijain-9
Copy link

I am encountering this check ( PR Workflow / Runs Introspection on the GitHub talawa-api repo on the schema.graphql file) unsuccessful too in one of my pull request, how are you planning to fix it? Also the file for which this check fails is in Graphql, which I havent changed in my issue. How does it then link to my file checks?

@varshith257
Copy link
Member

@palisadoes https://github.com/PalisadoesFoundation/talawa-admin/actions/runs/12409861519/job/34644307629?pr=2684

Prettier not found error in the workflow. Have any recent changes done to this workflow?

@prathmesh703
Copy link
Contributor Author

I have made changes to the file so that it passes the formating check now . I will make a new PR .

@palisadoes
Copy link
Contributor

We have a policy of unassigning contributors who close PRs without getting validation from our reviewer team. This is because:

  1. We start looking for people to review PRs when you submit them.
  2. We often contact them and link to the PR. If the PR is closed the whole effort is wasted.
  3. The historical thread of reviewer comments is broken when the work is spread across multiple PRs. The quality of our code is affected negatively.

Please be considerate of our volunteers' limited time and our desire to improve our code base.

This policy is stated as a pinned post in all our Talawa repositories. Our YouTube videos explain why this practice is not acceptable to our Community.

In most cases you don’t have to close the PR to trigger the GitHub workflow to run again. Making a new commit and pushing it to your GitHub account will normally be sufficient.

Unfortunately, if this continues we will have to close the offending PR and unassign you from the issue.

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