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

Refactored: src/screens/UserPortal/Campaigns from Jest to Vitest #2640

Merged

Conversation

rafidoth
Copy link

@rafidoth rafidoth commented Dec 11, 2024

What kind of change does this PR introduce?
Refactoring

Issue Number:
#2571
Fixes #

Snapshots/Videos:
test_passed.webm

Summary

  • added "vitest/globals" in tsconfig.json to use typescript working with vitest globally
  • Renamed Campaigns.test.tsx to Campaigns.spec.tsx
  • Refactored Campaigns test files from Jest to Vitest Syntax

Does this PR introduce a breaking change?
No

Other information

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Tests
    • Updated testing framework from Jest to Vitest for improved functionality.
    • Adjusted mocking methods for dependencies and modified test cases for better accuracy.
    • Enhanced error messaging in the fallback route for clarity.
    • Added comments throughout the test suite for better understanding of the code.

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request involve updating the test file Campaigns.spec.tsx to transition from Jest to Vitest. This includes replacing Jest-specific mocking functions with their Vitest equivalents, such as changing jest.mock to vi.mock. Additionally, the useParams function is mocked with vi.fn() to return a specific orgId. Minor adjustments are made to the test cases, including changes to the initial entries in MemoryRouter and updating error messages.

Changes

File Path Change Summary
src/screens/UserPortal/Campaigns/Campaigns.spec.tsx Updated to use Vitest instead of Jest for testing, including changes to mocking and test case adjustments.

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • pranshugupta54
  • varshith257

Poem

🐇 In the land of tests, we hop and play,
From Jest to Vitest, we find our way.
Mocking with vi, our code shines bright,
Campaigns are ready, all tests take flight!
With errors now clear, and paths all set,
A new dawn for testing, we won't forget! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e57155e and dddcaab.

📒 Files selected for processing (1)
  • src/screens/UserPortal/Campaigns/Campaigns.spec.tsx (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/screens/UserPortal/Campaigns/Campaigns.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. (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.

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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

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

🧹 Outside diff range and nitpick comments (1)
src/screens/UserPortal/Campaigns/Campaigns.spec.tsx (1)

36-43: Consider simplifying the DateTimePicker mock

The async mock implementation could be simplified since you're only using the DesktopDateTimePicker.

-vi.mock('@mui/x-date-pickers/DateTimePicker', async () => {
-  const actual = await vi.importActual(
-    '@mui/x-date-pickers/DesktopDateTimePicker',
-  );
-  return {
-    DateTimePicker: actual.DesktopDateTimePicker,
-  };
-});
+vi.mock('@mui/x-date-pickers/DateTimePicker', () => ({
+  DateTimePicker: vi.importActual('@mui/x-date-pickers/DesktopDateTimePicker').DesktopDateTimePicker,
+}));
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0630cff and c9b2ead.

📒 Files selected for processing (2)
  • src/screens/UserPortal/Campaigns/Campaigns.spec.tsx (3 hunks)
  • tsconfig.json (1 hunks)
🔇 Additional comments (5)
tsconfig.json (1)

3-8: LGTM: Vitest types correctly configured

The addition of "vitest/globals" to the types array is correct and necessary for TypeScript to recognize Vitest's global types.

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

29-34: LGTM: Toast mock correctly migrated to Vitest

The toast mock has been properly converted from Jest to Vitest syntax.


93-99: LGTM: Router mock properly implemented

The react-router-dom mock is correctly implemented using Vitest's async mocking capabilities while preserving the actual router functionality.


103-103: LGTM: Cleanup properly migrated

The cleanup function has been correctly updated to use Vitest's clearAllMocks.


Line range hint 1-324: LGTM: Comprehensive test coverage maintained

The migration to Vitest has been completed while maintaining thorough test coverage across all key functionality:

  • Component rendering
  • User interactions
  • Error handling
  • Sorting and filtering
  • Search functionality
  • Modal operations
  • Navigation

The test structure and assertions remain robust after the migration.

src/screens/UserPortal/Campaigns/Campaigns.spec.tsx Outdated Show resolved Hide resolved
@palisadoes
Copy link
Contributor

  1. Please make sure coderabbit.ai approves your PR
  2. Make sure all tests pass (except introspection)
  3. Please make sure that the code coverage for your patch reaches at least 95%

@rafidoth
Copy link
Author

  1. no code coverage changed due to my patch
  2. there is 11.95% of reduction in code coverage of the project (indirect change in code coverage).
    image

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