Refactored src/components/OrgPeopleListCard/OrgPeopleListCard.test.tsx #2814

[Ramneet04]

Refactored src/components/OrgPeopleListCard/OrgPeopleListCard.test.tsx to
src/components/OrgPeopleListCard/OrgPeopleListCard.spec.tsx

Issue: #2814: #2814

Changes Implemented:

Refactored the testing framework from Jest to Vitest in src/components/OrgPeopleListCard/OrgPeopleListCard.test.tsx.
Updated import statements, mocking methods, and assertions to align with Vitest conventions.
Verified compatibility with the existing codebase using Vitest.

• Renamed the test file:
  OrgPeopleListCard.test.tsx → OrgPeopleListCard.spec.tsx to follow the naming convention for Vitest.
• Ran all tests successfully under the Vitest environment.
  Refactor src/components/OrgPeopleListCard/OrgPeopleListCard.test.tsx from Jest to Vitest #2814

Other information
I have read the previous refactor PR and tried to keep things as uniform as possible.
Please suggest any other changes if required.

Summary by CodeRabbit

• Tests
  • Transitioned testing framework from Jest to Vitest for the OrgPeopleListCard component tests.
  • Updated global function mocking to align with the new testing framework.

[coderabbitai]

Walkthrough

The pull request involves migrating the test file OrgPeopleListCard.spec.tsx from Jest to Vitest, a modern testing framework. The changes primarily focus on updating the testing library imports and replacing Jest-specific mocking functions with Vitest equivalents. The modifications ensure that the test file can be run using Vitest while maintaining the original test structure and coverage.

Changes

File	Change Summary
src/components/OrgPeopleListCard/OrgPeopleListCard.spec.tsx	- Added Vitest imports: describe, test, expect, vi - Replaced global.alert = jest.fn() with global.alert = vi.fn()

Possibly related issues

• Refactor : src/components/AddPeopleToTag/AddPeopleToTag.test.tsx from Jest to Vitest #2483: Refactoring AddPeopleToTag.test.tsx from Jest to Vitest, which aligns with the current PR's migration strategy
• Refactor : src/components/AgendaItems/AgendaItemsPreviewModal.test.tsx from Jest to Vitest #2490: Migrating AgendaItemsPreviewModal.test.tsx to Vitest, part of the broader testing framework transition
• Refactor: src/screens/OrganizationPeople from Jest to Vitest #2562: Refactoring OrganizationPeople tests from Jest to Vitest, consistent with this PR's approach
• Refactor: src/screens/UserPortal/People from Jest to Vitest #2576: Migrating UserPortal/People tests to Vitest, following the same migration pattern

Possibly related PRs

• refactor:vitest to MemberDetailScreen #2662: Transitions a test file from Jest to Vitest
• Refactor:Vitest to OrgPeople Screen #2663: Migrates test files from Jest to Vitest
• Refactor: src/screens/OrganizationDashboard from Jest to Vitest #2678: Updates testing framework from Jest to Vitest
• Refactor: jest to vitest of itemDeleteModal : fixes #2557 #2713: Refactors tests to use Vitest
• refactor: jest to vitest of itemUpdateStatusModal : fixes #2557 #2714: Updates mocking framework from Jest to Vitest
• refactor: jest to vitest of OrganizationActionItems : fixes #2557 #2773: Transitions testing framework from Jest to Vitest
• Refactor src/components/OrganizationCard/OrganizationCard.test.tsx from Jest to Vitest #2852: Migrates a test file from Jest to Vitest
• Migrate src/components/MemberRequestCard/MemberRequestCard.test.tsx from Jest to Vitest #2859: Transitions a test file from Jest to Vitest
• Refactor src/components/SuperAdminScreen/SuperAdminScreen.test.tsx from Jest to Vitest #2820 #2874: Refactors a test file from Jest to Vitest
• Refactor: src/components/OrganizationCardStart/OrganizationCardStart.test.tsx from Jest to Vitest #2876: Migrates a test file from Jest to Vitest
• Refactor src/components/OrgPostCard/OrgPostCard.test.tsx from Jest to Vitest #2878: Transitions a test file from Jest to Vitest
• Migrated src/components/OrgAdminListCard from Jest to Vitest #2908: Migrates a test file from Jest to Vitest

Suggested reviewers

• palisadoes

Poem

🐰 A Rabbit's Ode to Vitest Migration 🧪

From Jest to Vitest, tests take flight,
Mocking functions shining bright,
Code transforms with gentle grace,
Leaving old frameworks without a trace,
Hopping forward with testing might! 🚀

---

📜 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 35cce16 and b4ebe2c.

📒 Files selected for processing (1)

• src/components/OrgPeopleListCard/OrgPeopleListCard.spec.tsx (2 hunks)

🧰 Additional context used

📓 Learnings (1)

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

🔇 Additional comments (2)

src/components/OrgPeopleListCard/OrgPeopleListCard.spec.tsx (2)

12-12: Good import transition for Vitest compatibility
This line correctly updates the import from Jest to Vitest primitives. It aligns well with typical Vitest usage and ensures consistency.

---

44-44: Direct mock function replacement looks correct
Switching from jest.fn() to vi.fn() is appropriate for Vitest migration. The syntax change remains straightforward, and the mock function usage remains consistent with the rest of the test file.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.99%. Comparing base (5c7fcd7) to head (b4ebe2c).
Report is 18 commits behind head on develop-postgres.

Additional details and impacted files

@@                  Coverage Diff                  @@
##           develop-postgres    #2920       +/-   ##
=====================================================
+ Coverage             60.19%   87.99%   +27.80%     
=====================================================
  Files                   296      316       +20     
  Lines                  7373     8265      +892     
  Branches               1610     1810      +200     
=====================================================
+ Hits                   4438     7273     +2835     
+ Misses                 2690      780     -1910     
+ Partials                245      212       -33     

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