Vitest chat #2648

NishantSinghhhhh · 2024-12-12T19:34:07Z

PR Title: Refactor Chat Component Tests: Migrate from Jest to Vitest
Issue Number:
Fixes: #2572

Did you add tests for your changes?
Yes

Snapshots/Videos:

Screencast.from.2024-12-13.00-58-58.webm

Summary:

This PR refactors the test suite for the Chat.tsx component by migrating from Jest to Vitest, in alignment with the project's updated testing framework. The following changes were made:

Updated the testing configuration to be compatible with Vitest.
Refactored all test files related to Chat.tsx to use Vitest's syntax and features.
Consolidated mock definitions to reduce redundancy across test cases for better maintainability.
Does this PR introduce a breaking change?
No

Summary by CodeRabbit

New Features
- Updated the vite-plugin-svgr dependency to the latest version.
- Introduced a new test suite for the Avatar component, validating its rendering behavior.
Bug Fixes
- Enhanced test logic for the Requests screen to streamline redirection checks.
- Improved test structure and checks for the Chat component.
Tests
- Transitioned multiple test files from Jest to Vitest, updating mocking and asynchronous handling.
- Consolidated mock data and refined test cases for better readability and maintainability.
Chores
- Added the vite-plugin-svgr to the Vitest configuration.

Signed-off-by: NishantSinghhhhh <[email protected]>

coderabbitai · 2024-12-12T19:34:14Z

Walkthrough

The pull request introduces updates to the package.json file, specifically upgrading the vite-plugin-svgr dependency from version ^4.2.0 to ^4.3.0. Additionally, it adds a new test suite for the Avatar component using Vitest, replaces Jest with Vitest in several existing test files, and modifies tests for the Requests, Chat, and Donate components to align with the new testing framework. Overall, the changes focus on dependency management and enhancing testing practices.

Changes

File Path	Change Summary
`package.json`	Updated `vite-plugin-svgr` from `^4.2.0` to `^4.3.0` in `devDependencies`.
`src/components/Avatar/Avatar.spec.tsx`	Added a new test suite for the `Avatar` component with unit tests for rendering behavior.
`src/components/Avatar/Avatar.test.tsx`	Deleted existing Jest test file for `Avatar` component.
`src/screens/EventVolunteers/Requests/Requests.spec.tsx`	Refactored tests from Jest to Vitest, updated mocking, and simplified redirection test.
`src/screens/UserPortal/Chat/Chat.spec.tsx`	Refactored tests from Jest to Vitest, improved structure, and enhanced test cases for rendering.
`src/screens/UserPortal/Donate/Donate.spec.tsx`	Refactored tests from Jest to Vitest, maintained structure and functionality of tests.
`vitest.config.ts`	Added `vite-plugin-svgr` to the plugins array in Vitest configuration.

Assessment against linked issues

Objective	Addressed	Explanation
Replace Jest-specific functions and mocks with Vitest equivalents (#[2572])	✅
Ensure all tests in `src/screens/UserPortal/Chat` pass after migration using `npm run test:vitest` (#[2572])	✅
Maintain the test coverage for the file as 100% after migration (#[2572])	✅

Possibly related issues

Refactor: src/screens/CommunityProfile from Jest to Vitest #2545: The migration of tests for the Requests component to Vitest aligns with the changes made in this PR.
Refactor : src/components/Avatar/Avatar.test.tsx from Jest to Vitest #2492: Refactoring the Avatar component tests to Vitest is directly related to the changes made here.
Refactor: src/screens/UserPortal/Donate from Jest to Vitest #2573: The updates to the Donate component tests reflect a similar effort to standardize testing practices across the project.

Possibly related PRs

Refactor: Adding vitest to Avatar component #2622: Updates to the Avatar component's tests to use Vitest align with the dependency update in this PR.
Migrate src/screens/UserPortal/Donate/Donate.test.tsx Tests from Jest to Vitest #2636: Migration of the Donate component tests from Jest to Vitest is relevant as it reflects a broader effort to standardize testing.
Refactor: jest to vitest : Fixes #2547 #2641: Refactor of the Requests component tests from Jest to Vitest continues the trend of updating tests to the new framework.

Suggested labels

refactor, test

Suggested reviewers

AVtheking
varshith257
pranshugupta54

🐰 In the code, we hop and play,
With tests and plugins, we pave the way.
From Jest to Vitest, we make the switch,
Ensuring our components are without a hitch!
So let’s cheer for updates, both big and small,
In our rabbit hole, we’re having a ball! 🐇✨

📜 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 316c3cb and 27d21c2.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (7)

package.json (1 hunks)
src/components/Avatar/Avatar.spec.tsx (1 hunks)
src/components/Avatar/Avatar.test.tsx (0 hunks)
src/screens/EventVolunteers/Requests/Requests.spec.tsx (4 hunks)
src/screens/UserPortal/Chat/Chat.spec.tsx (7 hunks)
src/screens/UserPortal/Donate/Donate.spec.tsx (2 hunks)
vitest.config.ts (1 hunks)

💤 Files with no reviewable changes (1)

src/components/Avatar/Avatar.test.tsx

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

package.json

🧰 Additional context used

📓 Learnings (2)

src/screens/UserPortal/Donate/Donate.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.

src/screens/EventVolunteers/Requests/Requests.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 (15)

vitest.config.ts (1)

5-5: LGTM: SVG plugin integration looks good

The addition of the vite-plugin-svgr plugin is appropriate for handling SVG imports in the test environment.

Also applies to: 10-10

src/components/Avatar/Avatar.spec.tsx (1)

1-92: LGTM: Well-structured test migration to Vitest

The test suite is well-organized with:

Proper use of Vitest's mocking functionality
Clear test case documentation
Good coverage of component functionality

src/screens/EventVolunteers/Requests/Requests.spec.tsx (4)

32-37: LGTM: Toast mock properly migrated to Vitest

The toast mock has been correctly migrated from Jest to Vitest syntax.

85-88: LGTM: Router mock properly migrated to Vitest

The react-router-dom mock has been correctly migrated using Vitest's async import actual functionality.

92-92: LGTM: Clear mocks properly migrated

The clearAllMocks call has been correctly updated to use Vitest's API.

113-113: LGTM: Simplified redirection test

The redirection test has been simplified to directly check window.location.pathname, which is more straightforward than waiting for element visibility.

src/screens/UserPortal/Donate/Donate.spec.tsx (4)

11-11: LGTM: Import changes for Vitest migration

The addition of the vi import from 'vitest' is correct for the migration.

141-149: LGTM: Mock implementations updated for Vitest

The migration from Jest's mocking API to Vitest's API is correct:

jest.mock → vi.mock
jest.fn() → vi.fn()

156-164: LGTM: Window matchMedia mock updated for Vitest

The mock implementation has been correctly updated to use vi.fn().

169-169: LGTM: BeforeEach hook updated for Vitest

The migration from jest.clearAllMocks() to vi.clearAllMocks() is correct.

src/screens/UserPortal/Chat/Chat.spec.tsx (5)

12-12: LGTM: Import changes for Vitest migration

The addition of Vitest-specific imports is correct.

1489-1499: LGTM: Mock data consolidation

Good practice to consolidate mock data outside tests for better maintainability.

1473-1473: LGTM: ScrollIntoView mock updated for Vitest

The migration to vi.fn() is correct.

1477-1485: LGTM: Window matchMedia mock updated for Vitest

The mock implementation has been correctly updated to use vi.fn().

Line range hint 1629-1654: LGTM: Mobile view test implementation with Vitest

The test correctly uses Vitest's assertion patterns and async utilities.

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. (Experiment)
@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-12T19:34:34Z

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

NishantSinghhhhh and others added 3 commits December 8, 2024 00:48

added vitest to avatar component

56bb908

Signed-off-by: NishantSinghhhhh <[email protected]>

Merge branch 'develop-postgres' into develop-postgres

386c604

added vitest to the chat.tsx component

27d21c2

Signed-off-by: NishantSinghhhhh <[email protected]>

coderabbitai bot approved these changes Dec 12, 2024

View reviewed changes

Merge branch 'develop-postgres' into vitest-chat

8406774

NishantSinghhhhh closed this Dec 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vitest chat #2648

Vitest chat #2648

NishantSinghhhhh commented Dec 12, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 12, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Dec 12, 2024

Vitest chat #2648

Vitest chat #2648

Conversation

NishantSinghhhhh commented Dec 12, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 12, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

github-actions bot commented Dec 12, 2024

Our Pull Request Approval Process

Testing Your Code

Reviewers

Reviewing Your Code

CONTRIBUTING.md

Other

NishantSinghhhhh commented Dec 12, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 12, 2024 •

edited

Loading