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\utils\useLocalstorage.test.ts from Jest to Vitest #2844

Merged

Conversation

AceHunterr
Copy link
Contributor

@AceHunterr AceHunterr commented Dec 24, 2024

What kind of change does this PR introduce?
Refractoring

Issue Number:

Fixes #2755

Did you add tests for your changes?
No

Snapshots/Videos:
Modified the file and ran the test command to check and it was cleared:

CoverageScore
performanceStats

Also ensure the linting and formatting:
lint-and-format

If relevant, did you update the documentation?
Not yet

Summary

Does this PR introduce a breaking change?
No... it simply converts one test suite framework to other.

Other information
Have checked all the points in the Acceptance Criteria that was asked in the Issue:

  1. Replaced Jest-specific functions and mocks with Vitest equivalents
  2. Renamed the test file from src/utils/useLocalstorage.test.ts to src/utils/useLocalstorage.spec.ts
    3.Ensured all tests in the file pass after migration using npm run test:vitest
    4.Maintained the test coverage for the file as 100% after migration as shown in the uploaded snapshot.
    5.Upload snapshots for this specific file coverage is 100% in the PR description.

There was one thing I was dealing with that when I made changes in the src/utils/useLocalstorage.test.ts file... I got this error due to pre commit hook in scripts/githooks/check-localstorage-usage.js
precommit-error

I read that code and then added the comment // SKIP_LOCALSTORAGE_CHECK... the error went away but I am not very sure whether to add this or not

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Tests
    • Updated test file to use the vitest framework for mocking functions.
    • Introduced a line to skip local storage checks in the test cases.

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Walkthrough

This pull request focuses on refactoring the src/utils/useLocalstorage.spec.ts test file from Jest to Vitest. The changes involve updating import statements to use vi from Vitest, replacing jest.spyOn with vi.spyOn for mocking functions, and renaming the test file from .test.ts to .spec.ts. The overall test logic and structure remain unchanged, with the primary goal of migrating the testing framework.

Changes

File Change Summary
src/utils/useLocalstorage.spec.ts - Added // SKIP_LOCALSTORAGE_CHECK comment
- Updated import to include vi from Vitest
- Replaced jest.spyOn with vi.spyOn for mocking functions

Assessment against linked issues

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

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 A Rabbit's Ode to Vitest Migration 🧪

From Jest to Vitest, tests take flight,
Mocking methods now shine so bright
spyOn transforms with gentle grace
Code coverage finds its rightful place
Refactoring dance, a testing delight! 🎉

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.


📜 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 45d18b6 and 61be6a5.

📒 Files selected for processing (1)
  • src/utils/useLocalstorage.spec.ts (5 hunks)
🧰 Additional context used
📓 Learnings (1)
📓 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.
🔇 Additional comments (6)
src/utils/useLocalstorage.spec.ts (6)

1-1: Question the necessity of skipping local storage checks
Adding // SKIP_LOCALSTORAGE_CHECK might bypass important validations from the pre-commit hook. Confirm whether it’s truly required or if the hook can be updated to accommodate these tests.

Would you like me to open an issue to discuss updating the pre-commit hook logic instead of skipping the check?


10-10: Proper Vitest import
Good job migrating to Vitest. This import shows you’ve replaced Jest with Vitest in your test suite.


101-101: Correct mocking approach
Using vi.spyOn instead of jest.spyOn is appropriate for Vitest.


112-112: Consistent mocking usage
This replacement follows the Vitest syntax and ensures consistency across tests.


124-124: Good job on the setItem spy migration
Likewise, vi.spyOn for setItem is correct and aligns with Vitest.


135-135: removeItem spy updates completed
The usage of vi.spyOn here confirms a full replacement of Jest. All references appear updated.


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

codecov bot commented Dec 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.55%. Comparing base (45d18b6) to head (61be6a5).
Report is 3 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2844       +/-   ##
=====================================================
+ Coverage             68.60%   87.55%   +18.94%     
=====================================================
  Files                   296      313       +17     
  Lines                  7358     8204      +846     
  Branches               1606     1848      +242     
=====================================================
+ Hits                   5048     7183     +2135     
+ Misses                 2069      827     -1242     
+ Partials                241      194       -47     

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

@palisadoes palisadoes merged commit 9fbb202 into PalisadoesFoundation:develop-postgres Dec 24, 2024
13 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