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

Refacted : src/components/LeftDrawer/LeftDrawer.test.tsx from Jest to Vitest #3134

Merged

Conversation

aryanrule
Copy link

@aryanrule aryanrule commented Jan 4, 2025

What kind of change does this PR introduce?

Refracting src/components/LeftDrawer/LeftDrawer.test.tsx from Jest to Vitest
Issue number :
Fixes : #3119

Did you add tests for your changes?
Yes

Snapshots/Videos:

Screenshot (61)

If relevant, did you update the documentation?

Does this PR introduce a breaking change?

No

Other information

No

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Chores
    • Updated test suite for LeftDrawer component from Jest to Vitest
    • Replaced Jest functions with Vitest equivalents
    • Converted test functions to it syntax

Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

Walkthrough

This pull request focuses on refactoring the LeftDrawer.spec.tsx test file from Jest to Vitest. The changes involve replacing Jest-specific testing functions and mocks with their Vitest equivalents, such as changing jest.fn() to vi.fn(), jest.mock() to vi.mock(), and test() to it(). The overall test structure and logic remain unchanged, maintaining the existing test coverage and functionality while transitioning to the Vitest testing framework.

Changes

File Change Summary
src/components/LeftDrawer/LeftDrawer.spec.tsx - Replaced Jest mocking and testing functions with Vitest equivalents
- Updated method signatures from jest.fn() to vi.fn()
- Replaced test() with it() for test definitions
- Removed jest-localstorage-mock import

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • varshith257
  • pranshugupta54

Poem

🐰 A Jest test hopped away,
Vitest came to save the day!
Mocks and functions realigned,
Testing magic now refined.
Code leaps forward with glee! 🧪


📜 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 fa414cd and 40c23e7.

📒 Files selected for processing (1)
  • src/components/LeftDrawer/LeftDrawer.spec.tsx (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/LeftDrawer/LeftDrawer.spec.tsx

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

github-actions bot commented Jan 4, 2025

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/components/LeftDrawer/LeftDrawer.spec.tsx (1)

13-13: Fix formatting to comply with Prettier requirements.

The static analysis and pipeline logs indicate a spacing mismatch. Adjust the import statement to ensure proper spacing:

-import {vi , it , describe , beforeEach , afterEach , expect } from 'vitest';
+import { vi, it, describe, beforeEach, afterEach, expect } from 'vitest';
🧰 Tools
🪛 eslint

[error] 13-13: Replace vi·,·it·,·describe·,·beforeEach·,·afterEach· with ·vi,·it,·describe,·beforeEach,·afterEach

(prettier/prettier)

🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5550711 and fa414cd.

📒 Files selected for processing (1)
  • src/components/LeftDrawer/LeftDrawer.spec.tsx (7 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/components/LeftDrawer/LeftDrawer.spec.tsx (2)
Learnt from: Doraemon012
PR: PalisadoesFoundation/talawa-admin#1988
File: src/components/LeftDrawerOrg/LeftDrawerOrg.test.tsx:282-282
Timestamp: 2024-11-12T10:40:58.654Z
Learning: In the test 'Component should be rendered properly' within 'Testing LeftDrawerOrg component for SUPERADMIN', setting 'SuperAdmin' to false is intentional.
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.
🪛 eslint
src/components/LeftDrawer/LeftDrawer.spec.tsx

[error] 13-13: Replace vi·,·it·,·describe·,·beforeEach·,·afterEach· with ·vi,·it,·describe,·beforeEach,·afterEach

(prettier/prettier)

🪛 GitHub Actions: PR Workflow
src/components/LeftDrawer/LeftDrawer.spec.tsx

[warning] Code style issues found. File needs to be formatted using Prettier.

🔇 Additional comments (8)
src/components/LeftDrawer/LeftDrawer.spec.tsx (8)

19-19: Acknowledging the use of vi.fn() as a replacement for jest.fn().

The transition appears correct for Vitest usage and meets the migration objective. Good job!

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


42-46: Mock updates for react-toastify are appropriate.

Switching from jest.mock() to vi.mock() and vi.fn() ensures proper Vitest compatibility.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


60-60: Clearing mocks with vi.clearAllMocks().

Replacing jest.clearAllMocks() is aligned with the Vitest transition. No issues found.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


65-65: Switching test() to it() for Vitest.

This maintains the same behavior while aligning with Vitest conventions.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


115-115: Refactoring test block to use it().

No logical changes noted; the move is straightforward and on target.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


134-134: Vitest-compatible test block name.

Adopting it() helps keep the project consistent under Vitest.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


153-153: Continued refactoring to Vitest syntax.

This aligns well with the overall migration plan.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.


186-186: Final test block updated to it().

The test remains functionally identical. Everything looks good here.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. File needs to be formatted using Prettier.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 4, 2025
Copy link

codecov bot commented Jan 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.51%. Comparing base (5550711) to head (40c23e7).
Report is 3 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3134       +/-   ##
=====================================================
+ Coverage             21.89%   89.51%   +67.61%     
=====================================================
  Files                   301      322       +21     
  Lines                  7685     8454      +769     
  Branches               1678     1843      +165     
=====================================================
+ Hits                   1683     7568     +5885     
+ Misses                 5896      655     -5241     
- Partials                106      231      +125     

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

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