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

Migrated src/components/AgendaItems/* from Jest to Vitest #2850

Conversation

mandeepnh5
Copy link

@mandeepnh5 mandeepnh5 commented Dec 25, 2024

What kind of change does this PR introduce?
This PR will migrate the src/components/AgendaItems/* from Jest to Vitest.

Issue Number:
Fixes #2792

Did you add tests for your changes?
Yes

Snapshots/Videos:
image

If relevant, did you update the documentation?
No

Does this PR introduce a breaking change?
No

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Tests
    • Transitioned testing framework from Jest to Vitest across multiple test files.
    • Updated mock functions to utilize Vitest's mocking utilities.
    • Adjusted import statements to reflect the new testing framework.

Copy link

coderabbitai bot commented Dec 25, 2024

Walkthrough

This pull request focuses on refactoring test files in the src/components/AgendaItems/ directory from Jest to Vitest. The changes involve updating import statements, mocking methods, and test utilities to align with Vitest's syntax and features. The core functionality of the tests remains unchanged, with only the testing framework being migrated.

Changes

File Change Summary
src/components/AgendaItems/AgendaItemsContainer.spec.tsx Replaced Jest imports with Vitest imports, updated mocking methods from jest.mock to vi.mock, and changed jest.spyOn to vi.spyOn
src/components/AgendaItems/AgendaItemsContainerProps.ts Updated mock function creation from jest.fn() to vi.fn()
src/components/AgendaItems/AgendaItemsPreviewModal.spec.tsx Added Vitest imports, replaced jest.fn() with vi.fn() for component props

Assessment against linked issues

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

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • pranshugupta54
  • varshith257
  • palisadoes

Poem

🐰 Hopping through the test terrain,
Jest's old paths we now disdain,
Vitest springs with fresh delight,
Our code now tests with quantum might!
Refactoring with bunny glee 🧪

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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

@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

🧹 Nitpick comments (1)
src/components/AgendaItems/AgendaItemsContainer.spec.tsx (1)

38-38: Spying on console with vi.spyOn
This approach maintains the existing behavior but within the Vitest ecosystem. Make sure this spy is restored or cleaned up if necessary.

- vi.spyOn(console, 'error').mockImplementation((message) => {
+ const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation((message) => {
    if (message.includes('Support for defaultProps will be removed')) {
      return;
    }
    console.error(message);
  });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f60d17d and 5a13410.

📒 Files selected for processing (3)
  • src/components/AgendaItems/AgendaItemsContainer.spec.tsx (1 hunks)
  • src/components/AgendaItems/AgendaItemsContainerProps.ts (3 hunks)
  • src/components/AgendaItems/AgendaItemsPreviewModal.spec.tsx (2 hunks)
🔇 Additional comments (9)
src/components/AgendaItems/AgendaItemsContainerProps.ts (2)

2-2: Vitest import statement aligns with the PR objective.
Good job replacing the Jest import with Vitest. This approach cleanly removes the old dependency.


100-100: Consistent mocking across all props
This update maintains consistency with the rest of the code that now uses Vitest’s vi.fn(). Looks good.

src/components/AgendaItems/AgendaItemsPreviewModal.spec.tsx (4)

14-14: Correct switch to Vitest imports
Importing vi from Vitest ensures your test suite is aligned with the new framework.


48-48: Mock function replaced with vi.fn()
Well done migrating from Jest’s mock function to Vitest’s counterpart for hidePreviewModal.


50-50: Maintain consistency in the test suite
Swapping to vi.fn() for showUpdateModal aligns with the rest of your Vitest mocks.


51-51: Use vi.fn() for all mocks
This consistent usage ensures smooth integration with Vitest’s mocking APIs.

src/components/AgendaItems/AgendaItemsContainer.spec.tsx (3)

25-25: Replacing Jest with Vitest import
Excellent job transitioning to Vitest’s describe, test, and expect.


29-29: Update mock calls to Vitest
Using vi.mock for react-toastify ensures the new framework’s patches apply consistently.


31-32: Use Vitest’s vi.fn() for toast mocking
These changes keep everything in sync with Vitest’s mocking methods.

Copy link

codecov bot commented Dec 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.80%. Comparing base (aff65c9) to head (5a13410).
Report is 11 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2850       +/-   ##
=====================================================
+ Coverage             68.61%   87.80%   +19.18%     
=====================================================
  Files                   296      313       +17     
  Lines                  7358     8222      +864     
  Branches               1606     1854      +248     
=====================================================
+ Hits                   5049     7219     +2170     
+ Misses                 2068      804     -1264     
+ Partials                241      199       -42     

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

Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Please convert src/components/AgendaItems/AgendaItemsPreviewModal.test.tsx

@mandeepnh5
Copy link
Author

Please convert src/components/AgendaItems/AgendaItemsPreviewModal.test.tsx

@palisadoes
image
its done right?

@palisadoes
Copy link
Contributor

My mistake. This file is missing from the PR

  • src/components/AgendaItems/AgendaItemsUpdateModal.test.tsx

@mandeepnh5
Copy link
Author

My mistake. This file is missing from the PR

  • src/components/AgendaItems/AgendaItemsUpdateModal.test.tsx

@palisadoes there is a separate issue for that (#2491) which is assigned to me only I have created a separate pr for that

@palisadoes palisadoes self-requested a review December 25, 2024 07:31
@palisadoes palisadoes merged commit f8da9d5 into PalisadoesFoundation:develop-postgres Dec 25, 2024
13 checks passed
@palisadoes
Copy link
Contributor

Thanks

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