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

convert from jest to vitest #2486 #2705

Conversation

khushipatil1523
Copy link
Contributor

@khushipatil1523 khushipatil1523 commented Dec 22, 2024

What kind of change does this PR introduce?

refactoring

Issue Number: #2484

Fixes ##2484

Did you add tests for your changes?

Vitest test passed 👍:
Screenshot 2024-12-21 162039

Summary by CodeRabbit

  • Bug Fixes

    • Adjusted test logic to correctly categorize advertisement end dates based on current date comparisons.
  • Tests

    • Transitioned to the Vitest testing framework, updating mocking methods and import paths for improved modularity and compatibility.

Copy link
Contributor

coderabbitai bot commented Dec 22, 2024

Walkthrough

This pull request focuses on refactoring the Advertisements.spec.tsx test file from Jest to Vitest. The changes primarily involve updating import paths to use relative imports and transitioning from Jest-specific mocking and testing methods to Vitest equivalents. The core testing logic remains largely unchanged, with a minor modification in the date comparison assertion. The migration aims to align the test file with Vitest's syntax and testing framework.

Changes

File Change Summary
src/components/Advertisements/Advertisements.spec.tsx - Converted from Jest to Vitest testing framework
- Updated import paths to use relative imports
- Replaced Jest mocking methods with Vitest vi equivalents
- Slightly modified date comparison logic in assertions

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • palisadoes

Poem

🐰 A Testing Tale of Transformation
From Jest to Vitest, code takes flight,
Imports now relative, mocking just right.
Specs dance with vi, assertions anew,
A rabbit's refactor, clean and true! 🧪✨


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

Line range hint 697-698: Consider removing console.log statements

These debug statements might have been left accidentally. While not critical, removing them would improve test readability.

-    console.log('before scroll', moreiconbtn);
     fireEvent.scroll(window, { target: { scrollY: 500 } });
     moreiconbtn = await screen.findAllByTestId('moreiconbtn');
-    console.log('after scroll', moreiconbtn);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a16e02e and 89b0435.

📒 Files selected for processing (1)
  • src/components/Advertisements/Advertisements.spec.tsx (4 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/Advertisements/Advertisements.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 (2)
src/components/Advertisements/Advertisements.spec.tsx (2)

2-2: LGTM: Successful migration to Vitest mocking

The migration from Jest to Vitest mocking has been implemented correctly. The vi mock implementations follow Vitest's best practices.

Also applies to: 59-74


474-489: LGTM: Date comparison logic is correct

The date comparison logic properly verifies that the advertisement's end date is in the future, which is the expected behavior for active campaigns.

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 22, 2024
Copy link

codecov bot commented Dec 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.30%. Comparing base (a16e02e) to head (9191684).
Report is 38 commits behind head on develop-postgres.

Additional details and impacted files
@@                 Coverage Diff                  @@
##           develop-postgres    #2705      +/-   ##
====================================================
+ Coverage             82.81%   87.30%   +4.48%     
====================================================
  Files                   295      313      +18     
  Lines                  7274     8583    +1309     
  Branches               1592     1933     +341     
====================================================
+ Hits                   6024     7493    +1469     
+ Misses                 1012      896     -116     
+ Partials                238      194      -44     

☔ 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 see comments

src/components/Advertisements/Advertisements.spec.tsx Outdated Show resolved Hide resolved
src/components/Advertisements/Advertisements.spec.tsx Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 22, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 22, 2024
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/Advertisements/Advertisements.spec.tsx (1)

487-487: Remove debugging console.log statement

This appears to be debugging code that was accidentally left in during the migration process.

-    console.log(dateObject);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d8a7d66 and 9191684.

📒 Files selected for processing (1)
  • src/components/Advertisements/Advertisements.spec.tsx (4 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/Advertisements/Advertisements.spec.tsx (2)
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.
Learnt from: IITI-tushar
PR: PalisadoesFoundation/talawa-admin#2680
File: src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.spec.tsx:528-712
Timestamp: 2024-12-22T07:43:26.168Z
Learning: You prefer to keep migrated tests even if they appear duplicated because they originated from the old AdvertisementEntry.test.tsx file.
🔇 Additional comments (3)
src/components/Advertisements/Advertisements.spec.tsx (3)

2-2: LGTM: Correct Vitest imports

The migration from Jest to Vitest imports is implemented correctly.


19-24: LGTM: Import paths updated correctly

The conversion from absolute to relative imports is implemented correctly.

Also applies to: 31-33


58-73: LGTM: Mock implementations migrated correctly

The migration from Jest's mocking syntax to Vitest's vi is implemented correctly, maintaining the same functionality.

@palisadoes palisadoes merged commit cda2836 into PalisadoesFoundation:develop-postgres Dec 22, 2024
13 checks passed
palisadoes added a commit that referenced this pull request Dec 22, 2024
palisadoes added a commit that referenced this pull request Dec 22, 2024
@palisadoes
Copy link
Contributor

I had to revert this PR. You were not assigned the issue.

There isn’t an issue assigned to you for this PR. Please follow the guidelines in our PR_GUIDELINES.md file. We have the procedures in place so that everyone has a fair chance of contributing. I will be closing this pull request. Please follow the procedures and resubmit when ready.

@bandhan-majumder
Copy link
Contributor

bandhan-majumder commented Dec 24, 2024

Hi @khushipatil1523. You have mistakenly referenced #2484 where it should have been #2486. Can u please correct the PR with right details so that the issue #2486 can be closed?

@palisadoes
Copy link
Contributor

palisadoes commented Dec 24, 2024

@bandhan-majumder
Copy link
Contributor

bandhan-majumder commented Dec 24, 2024

Yes @palisadoes I noticed this later. It references to a different issue. Actually seeing the status of PR merged and the status of issue as open confused me. The file is still present as test.tsx rather than spec.tsx

@palisadoes
Copy link
Contributor

As the PR was reverted, the original files were not changed so the test.tsx file would remain.

@palisadoes
Copy link
Contributor

@khushipatil1523

You made a typo in your PR template which made me think you had not been assigned the original issue. Please resubmit your PR.

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.

3 participants