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/OrganizationTags/OrganizationTags.test.tsx from Jest to Vitest #3078

Conversation

arpit-chakraborty
Copy link
Contributor

@arpit-chakraborty arpit-chakraborty commented Dec 29, 2024

What kind of change does this PR introduce?

Refactor: src/screens/OrganizationTags/OrganizationTags.test.tsx from Jest to Vitest

Issue Number:

Fixes #3071

Did you add tests for your changes?

yes

Snapshot

image

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Testing

    • Migrated test suite from Jest to Vitest
    • Updated mocking strategies for react-toastify and react-router-dom
  • Refactor

    • Updated mock constants to use dynamic organization ID references

Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

Walkthrough

This pull request focuses on refactoring the OrganizationTags test suite from Jest to Vitest. The changes involve updating the test file OrganizationTags.spec.tsx to use Vitest's syntax and mocking mechanisms, replacing Jest-specific functions with their Vitest equivalents. Additionally, the OrganizationTagsMocks.ts file was updated to use a dynamic organization ID variable instead of hardcoded values.

Changes

File Change Summary
src/screens/OrganizationTags/OrganizationTags.spec.tsx Migrated from Jest to Vitest, replacing jest.fn() with vi.fn(), updating mock imports, and modifying test setup and teardown methods
src/screens/OrganizationTags/OrganizationTagsMocks.ts Replaced hardcoded organization ID with a dynamic 'orgId' variable in mock GraphQL requests

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents [#3071]
Rename test file to .spec.* suffix [#3071]
Ensure tests pass with npm run test:vitest [#3071] Requires actual test run verification
Maintain 100% test coverage [#3071] Requires coverage report verification

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Hopping through the test terrain,
Jest to Vitest, a coding refrain!
Mocks dance, functions gleam bright,
Code migration takes flight!
Refactoring with rabbit delight! 🧪✨


📜 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 c777abe and 4341660.

📒 Files selected for processing (2)
  • src/screens/OrganizationTags/OrganizationTags.spec.tsx (3 hunks)
  • src/screens/OrganizationTags/OrganizationTagsMocks.ts (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/screens/OrganizationTags/OrganizationTags.spec.tsx
  • src/screens/OrganizationTags/OrganizationTagsMocks.ts

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

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 (2)
src/screens/UserPortal/Settings/Settings.tsx (1)

129-139: Provide user feedback on invalid birth date selection.

While logging an error to the console prevents state updates for future birth dates, the user receives no direct UI feedback. Consider rendering a localized error message or a subtle UI prompt to guide users toward a valid date selection.

src/components/UsersTableItem/UserTableItem.test.tsx (1)

18-18: Remove unused it import.
According to the static analysis hint, it is never referenced in the tests. Eliminating unused imports will keep the code clean.

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

[error] 18-18: 'it' is defined but never used.

(@typescript-eslint/no-unused-vars)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2e18c32 and 6ea0c70.

📒 Files selected for processing (4)
  • src/components/UsersTableItem/UserTableItem.test.tsx (3 hunks)
  • src/screens/OrganizationTags/OrganizationTags.test.tsx (3 hunks)
  • src/screens/UserPortal/Settings/Settings.spec.tsx (1 hunks)
  • src/screens/UserPortal/Settings/Settings.tsx (2 hunks)
🧰 Additional context used
📓 Learnings (1)
src/components/UsersTableItem/UserTableItem.test.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.
🪛 eslint
src/components/UsersTableItem/UserTableItem.test.tsx

[error] 18-18: 'it' is defined but never used.

(@typescript-eslint/no-unused-vars)

🔇 Additional comments (11)
src/screens/UserPortal/Settings/Settings.spec.tsx (1)

414-445: Well-structured birth date future-date test.

The newly added test effectively verifies that future dates are disallowed and ensures the birth date input field remains unchanged when a future date is set. As a further enhancement, consider adding edge-case tests (e.g., partial/invalid date input) to reinforce date validation coverage.

src/screens/UserPortal/Settings/Settings.tsx (1)

465-465: Check local time zones with the 'max' attribute.

Using new Date().toISOString().split('T')[0] places a strict UTC-based bound on the date picker, which may lead to slight off-by-one issues in other time zones. If relevant for the user base, consider adjusting the logic or clarifying time zone expectations in the UI.

src/screens/OrganizationTags/OrganizationTags.test.tsx (4)

14-14: Migrated import to Vitest successfully.
This import of vi aligns with the transition away from Jest to Vitest.


47-50: Switched mocking of react-toastify to use vi.mock.
This change correctly follows Vitest’s mocking API.


80-86: Updated react-router-dom mock to Vitest.
Using vi.mock and importActual is a valid approach for seamlessly mocking useParams.


90-90: Replaced jest.clearAllMocks() with vi.clearAllMocks().
This ensures that all mocks are cleared between test runs under Vitest.

src/components/UsersTableItem/UserTableItem.test.tsx (5)

31-31: Use of vi.fn() is correct.
The transition from jest.fn() to vi.fn() for resetAndRefetchMock is properly executed.


33-37: Mocking react-toastify with Vitest.
These lines correctly switch from jest.mock() to vi.mock(), and from jest.fn() to vi.fn().


49-51: Mocking react-router-dom with Vitest.
Replacing jest.mock('react-router-dom') with vi.mock('react-router-dom') is consistent with the migration.


62-62: Replaced jest.clearAllMocks() with vi.clearAllMocks().
This ensures no stale mocks persist between tests under Vitest.


66-66: Redirecting console.error to vi.fn().
Use of Vitest for stubbing out console errors is correct and helps in controlling test output.

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 29, 2024
@palisadoes
Copy link
Contributor

Please fix the conflicting file

@palisadoes
Copy link
Contributor

  1. You don't have to close the PR
  2. Just fix the file in your local repo, commit and push to your origin
  3. The PR will automatically update

Reopening

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 30, 2024
@arpit-chakraborty
Copy link
Contributor Author

i found the reason of conflict i will change the issue with a new commit

@palisadoes
Copy link
Contributor

Please fix the new conflicting file

Copy link

codecov bot commented Dec 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.09%. Comparing base (6349f3f) to head (4341660).
Report is 3 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3078       +/-   ##
=====================================================
+ Coverage             26.39%   89.09%   +62.70%     
=====================================================
  Files                   301      322       +21     
  Lines                  7588     8421      +833     
  Branches               1657     1897      +240     
=====================================================
+ Hits                   2003     7503     +5500     
+ Misses                 5454      676     -4778     
- Partials                131      242      +111     

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

@palisadoes palisadoes merged commit ff5663e into PalisadoesFoundation:develop-postgres Dec 31, 2024
15 checks passed
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