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

fixed :#2750 Refactor: src/setup/askForTalawaApiUrl/setupTalawaWebSocketUrl.test.ts from Jest to Vitest #2779

Conversation

gurramkarthiknetha
Copy link
Contributor

@gurramkarthiknetha gurramkarthiknetha commented Dec 24, 2024

What kind of change does this PR introduce?

Issue Number: #2750

Fixes :

Refactored the testing framework from Jest to Vitest in src/setup/checkConnection/checkConnection.test.ts.
Updated import statements, mocking methods, and assertions to align with Vitest conventions.
Verified compatibility with the existing codebase using Vitest.

Renamed the test file:
From checkConnection.test.ts → checkConnection.spec.ts to follow the naming convention for Vitest.
Ran all tests successfully under the Vitest environment.

Did you add tests for your changes?

Snapshots/Videos:
image

If relevant, did you update the documentation?

Summary

The test file was initially using Jest, but as part of the migration to Vitest, the following updates were made:

  • Replaced Jest-specific functions and mocks with their Vitest equivalents.
  • Renamed the test file to follow the .spec.* suffix.
  • Ensured all tests pass with npm run test:vitest.
  • Maintained 100% test coverage for the file.

Does this PR introduce a breaking change?
No

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • Chores
    • Migrated testing framework from Jest to Vitest for improved testing capabilities.

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Walkthrough

This pull request involves migrating the test file setupTalawaWebSocketUrl.spec.ts from Jest to Vitest. The changes include replacing Jest-specific mocking and testing functions with their Vitest equivalents. The migration involves updating import statements, mocking methods, and test setup functions to align with Vitest's syntax and functionality.

Changes

File Change Summary
src/setup/askForTalawaApiUrl/setupTalawaWebSocketUrl.spec.ts Migrated from Jest to Vitest, replacing jest.mock with vi.mock, jest.resetAllMocks() with vi.clearAllMocks(), and jest.spyOn with vi.spyOn

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 Hopping through test lines with glee,
From Jest to Vitest, we're setting tests free!
Mocks and spies dance a new refrain,
Cleaner code is our joyful gain.
Vitest hops, testing made light! 🧪✨

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 7755890 and 6b81117.

📒 Files selected for processing (1)
  • src/setup/askForTalawaApiUrl/setupTalawaWebSocketUrl.spec.ts (2 hunks)
🔇 Additional comments (6)
src/setup/askForTalawaApiUrl/setupTalawaWebSocketUrl.spec.ts (6)

2-2: Successful migration to Vitest import.

Replacing jest-specific imports with vitest is consistent with the PR objective to migrate from Jest to Vitest. Looks good!


6-6: Correct use of vi.mock for module mocking.

Mocking the fs module with vi.mock('fs') correctly transitions away from the Jest equivalent and should behave as expected under Vitest.


7-13: Appropriate async mocking strategy for inquirer.

Using an async import combined with spread of the actual module ensures that only the prompt method is overridden and the rest of inquirer remains intact. This aligns well with Vitest’s mocking approach.


17-17: Replacing jest.resetAllMocks() with vi.clearAllMocks().

This is the correct Vitest equivalent for resetting mocks between tests.


35-37: Properly spying on inquirer.prompt under Vitest.

Switching from jest.spyOn to vi.spyOn is the straightforward and correct approach. Ensure that any subsequent calls to prompt are also stubs or restored appropriately.


40-40: Ensuring consistency with Vitest spy.

Using vi.spyOn for fs.writeFileSync is consistent with the rest of the migration to Vitest. Implementation looks correct.


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.27%. Comparing base (9b5bd3e) to head (6b81117).
Report is 69 commits behind head on develop-postgres.

Additional details and impacted files
@@                 Coverage Diff                  @@
##           develop-postgres    #2779      +/-   ##
====================================================
- Coverage             95.82%   87.27%   -8.55%     
====================================================
  Files                   295      313      +18     
  Lines                  7037     8204    +1167     
  Branches               1520     1848     +328     
====================================================
+ Hits                   6743     7160     +417     
- Misses                   98      859     +761     
+ Partials                196      185      -11     

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

@palisadoes palisadoes merged commit dbe3387 into PalisadoesFoundation:develop-postgres Dec 24, 2024
12 of 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