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

feat!: Migrate Testing Framework from Jest to Vitest of src/components/TableLoader/TableLoader.test.tsx #3126

Conversation

swastikCommits
Copy link

@swastikCommits swastikCommits commented Jan 3, 2025

What kind of change does this PR introduce?

Migration of testing framework from Jest to Vitest of src/components/TableLoader/TableLoader.test.tsx

Issue Number:

Fixes #2822

Did you add tests for your changes?

Yes

Snapshots/Videos:

Screenshot 2025-01-02 083642

If relevant, did you update the documentation?

No

Summary

Added vitest.config.js file and changed the required functions from jest to vitest syntax.
Contributing to talawa-admin grows my technical skills alot.

Does this PR introduce a breaking change?

No

Other information

No

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Dependency Updates

    • Removed the package.json file, impacting project configurations and dependencies.
  • Testing Improvements

    • Enhanced test configuration for DOM-based testing with the introduction of a new Vitest configuration file.
    • Improved test syntax and error assertions by transitioning from Jest to Vitest in the TableLoader component tests.

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Walkthrough

This pull request involves the removal of the package.json file, which contained essential project configurations and dependencies for the "talawa-admin" project. Additionally, it refactors the test suite for the TableLoader component, transitioning from Jest to Vitest. A new Vitest configuration file is introduced, establishing the testing environment and enabling global APIs.

Changes

File Change Summary
package.json - Entire file removed, including all project metadata and dependencies.
src/components/TableLoader/TableLoader.spec.tsx - Updated from Jest to Vitest: replaced jest.fn() with vi.fn(), changed test to it, and refined error assertion from toThrow() to toThrowError().
vitest.config.js - New file added with Vitest configuration, setting the environment to 'jsdom' and enabling global APIs.

Assessment against linked issues

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

Possibly related issues

Possibly related PRs

Suggested labels

refactor

Suggested reviewers

  • GlenDsza
  • pranshugupta54
  • varshith257

Poem

🐰 Hop, skip, and a test we'll write,
Vitest sparkles, Jest takes flight!
From .test to .spec we leap,
Code coverage we'll surely keep.
A testing rabbit's joyful might! 🧪


📜 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 32f51ea and 3555361.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • package.json (0 hunks)
  • src/components/TableLoader/TableLoader.spec.tsx (4 hunks)
  • vitest.config.js (1 hunks)
💤 Files with no reviewable changes (1)
  • package.json
🧰 Additional context used
📓 Learnings (1)
src/components/TableLoader/TableLoader.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 (3)
vitest.config.js (1)

1-8: LGTM! Configuration looks good.

The Vitest configuration is properly set up with:

  • jsdom environment for DOM simulation
  • globals enabled for vi API access
src/components/TableLoader/TableLoader.spec.tsx (2)

5-5: Combine imports to comply with import/no-duplicates rule.

This issue has already been reported in a previous review.


11-11: LGTM! Testing framework migration looks complete.

The migration from Jest to Vitest has been properly implemented:

  • Replaced jest.fn() with vi.fn()
  • Updated test() to it()
  • Changed toThrow() to toThrowError()

Also applies to: 15-78


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

github-actions bot commented Jan 3, 2025

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: 1

🧹 Nitpick comments (3)
package.json (1)

141-141: Added @vitest/coverage-v8 for coverage instrumentation.

Consider configuring your coverage thresholds in vitest.config.js to ensure robust coverage checks.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.

vitest.config.js (2)

6-6: Clean up trailing spaces to resolve Prettier warnings.

Remove the unwanted whitespace on this line to maintain formatting consistency.

-    globals: true,        // Use global APIs like `vi`
+    globals: true, // Use global APIs like `vi`
🧰 Tools
🪛 eslint

[error] 6-6: Delete ·······

(prettier/prettier)


8-8: Add a new line at the end of the file to satisfy Prettier format.

Insert an extra newline after the closing bracket to maintain consistent file endings.

  },
});
+ 
🧰 Tools
🪛 eslint

[error] 8-8: Insert

(prettier/prettier)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 32f51ea and 58becbd.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • package.json (3 hunks)
  • src/components/TableLoader/TableLoader.spec.tsx (4 hunks)
  • vitest.config.js (1 hunks)
🧰 Additional context used
🪛 eslint
src/components/TableLoader/TableLoader.spec.tsx

[error] 5-5: '/home/jailuser/git/node_modules/vitest/dist/index.js' imported multiple times.

(import/no-duplicates)


[error] 6-6: '/home/jailuser/git/node_modules/vitest/dist/index.js' imported multiple times.

(import/no-duplicates)

vitest.config.js

[error] 6-6: Delete ·······

(prettier/prettier)


[error] 8-8: Insert

(prettier/prettier)

🪛 GitHub Actions: PR Workflow
package.json

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.

🔇 Additional comments (5)
src/components/TableLoader/TableLoader.spec.tsx (3)

12-12: Mocking console.error is correct.

This ensures that error messages are scannable or suppressible during tests without polluting the console. Good job!


16-16: Updating test blocks to 'it' from 'test'.

This aligns with Vitest's recommended style. The usage here is correct.


Line range hint 69-79: Refined error assertion with toThrowError.

Using toThrowError is clearer than toThrow for verifying error conditions in Vitest. Excellent change.

package.json (2)

120-120: Reinstating @testing-library/dom is consistent with test usage.

Please verify if all test references to this library are valid and add any missing test coverage if needed.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.


162-162: Upgraded Vitest to ^2.1.8.

Upgrading to a newer version can bring performance benefits and bug fixes. Confirm that all references to Vitest's new features are documented.

🧰 Tools
🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file. Apply 'ignore-sensitive-files-pr' label to override.

src/components/TableLoader/TableLoader.spec.tsx Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 3, 2025
@swastikCommits
Copy link
Author

@coderabbitai full review

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

✅ Actions performed

Full review triggered.

@swastikCommits
Copy link
Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@palisadoes
Copy link
Contributor

  1. I have to close this issue.
  2. You have edited sensitive files that are not related to fixing src/components/TableLoader/TableLoader.test.tsx
  3. Please reopen, submitting only one file.

@palisadoes palisadoes closed this Jan 3, 2025
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