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

refactor:vitest to MemberDetailScreen #2662

Merged

Conversation

shivasankaran18
Copy link
Contributor

@shivasankaran18 shivasankaran18 commented Dec 14, 2024

What kind of change does this PR introduce?

Added Vitest to MemberDetail Screen

Issue Number: 2556

Fixes #2556

Did you add tests for your changes?
Yes

Snapshots/Videos:
Screenshot 2024-12-14 210712

If relevant, did you update the documentation?

Summary

Migrated the testing framework to Vitest.
Updated all test files and configurations to be compatible with Vitest's syntax and features.

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Tests
    • Transitioned testing framework from Jest to Vitest for improved functionality.
    • Updated mock implementations for various components and functions.
    • Enhanced clarity in mock declarations with additional comments.
    • Streamlined assertions in the OrganizationScreen tests to utilize CSS module references for improved maintainability.
    • Improved handling of CSS modules in test configurations.

Copy link
Contributor

coderabbitai bot commented Dec 14, 2024

Walkthrough

This pull request focuses on refactoring the MemberDetail.spec.tsx and OrganizationScreen.test.tsx test files from Jest to Vitest. The changes involve replacing Jest-specific mocking and testing functions with their Vitest equivalents, such as replacing jest.mock() with vi.mock(), jest.fn() with vi.fn(), and jest.clearAllMocks() with vi.clearAllMocks(). Additionally, assertions in the OrganizationScreen tests have been updated to use CSS module styles instead of hardcoded class names. The overall structure and logic of the tests remain consistent, ensuring that the test coverage and functionality are maintained during the migration.

Changes

File Change Summary
src/screens/MemberDetail/MemberDetail.spec.tsx Migrated from Jest to Vitest, updated mocking functions and cleanup hooks.
src/components/OrganizationScreen/OrganizationScreen.test.tsx Updated class name assertions to use CSS module styles instead of hardcoded class names.
jest.config.js Updated configuration for Vitest compatibility, including module name mappings.

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents [#2556]
Ensure tests pass using npm run test:vitest [#2556] Requires full test suite verification.
Maintain 100% test coverage [#2556] Requires comprehensive coverage check.

Possibly related issues

Possibly related PRs

Suggested labels

refactor, test

Suggested reviewers

  • palisadoes
  • varshith257

Poem

🐰 Hopping through code with glee,
Jest to Vitest, a testing spree!
Mocks transformed, functions bright,
Our test suite now shines with might!
Refactoring rabbit, coding with care 🧪

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.


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

coderabbitai[bot]
coderabbitai bot previously approved these changes Dec 14, 2024
@Cioppolo14
Copy link
Contributor

@shivasankaran18 Please fix the failed tests.

@shivasankaran18
Copy link
Contributor Author

shivasankaran18 commented Dec 15, 2024

@palisadoes @Cioppolo14 the tests are failing due to pre-existing issues in the codebase and are unrelated to the changes in the PR...These are even failing after cloning the repo and running the command without making any code change..

@palisadoes
Copy link
Contributor

@palisadoes @Cioppolo14 the tests are failing due to pre-existing issues in the codebase and are unrelated to the changes in the PR...These are even failing after cloning the repo and running the command without making any code change..

Please try to fix the cause of the issue. A past contributor may not have tested for all possible outcomes. We cannot merge code into the code base that is failing tests.

@shivasankaran18
Copy link
Contributor Author

@CodeRabbit review

Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

✅ 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.

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)
jest.config.js (1)

Line range hint 1-83: Clean up configuration file

Consider the following maintenance tasks:

  1. Remove or uncomment the commented sections (e.g., watchPlugins)
  2. Document the transition status from Jest to Vitest
  3. Review coverage thresholds (currently at 20%) as they seem quite low for a mature project
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c745815 and 4fc9fd4.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • jest.config.js (2 hunks)
🧰 Additional context used
📓 Learnings (1)
jest.config.js (1)
Learnt from: MayankJha014
PR: PalisadoesFoundation/talawa-admin#2619
File: vitest.config.ts:0-0
Timestamp: 2024-12-09T15:54:04.872Z
Learning: The files `scripts/custom-test-env.js`, `src/utils/i18nForTest.ts`, and `vitest.setup.ts` are not test files and should not be included in the test pattern.
🔇 Additional comments (2)
jest.config.js (2)

46-46: Verify identity-obj-proxy dependency

The CSS module mapping is correctly configured, but let's ensure the required dependency is properly installed.

Let's verify the dependency and its version:

✅ Verification successful

CSS module configuration is properly set up with required dependency

The verification confirms that:

  1. identity-obj-proxy is properly installed as a dev dependency in package.json
  2. The codebase extensively uses CSS modules (found numerous .module.css files and imports)
  3. The jest configuration correctly maps CSS modules to the proxy
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if identity-obj-proxy is properly installed
# Check package.json for the dependency
rg "identity-obj-proxy" -A 5 -B 5 package.json

# Check if there are any other test files using CSS modules that might need updating
rg "\.module\.(css|scss|sass|less)" --type ts --type tsx

Length of output: 504


Script:

#!/bin/bash
# Check for CSS module imports in JavaScript/TypeScript files
rg "\.module\.(css|scss|sass|less)" --type js --type ts

# Check if there are any CSS module files in the codebase
fd -e module.css -e module.scss -e module.sass -e module.less

# Verify if identity-obj-proxy is also listed in devDependencies (for more thorough check)
rg '"devDependencies"' -A 20 package.json

Length of output: 25117


13-14: Consider separating Jest and Vitest configurations

While excluding vitest.config.ts is correct, maintaining both Jest and Vitest configurations simultaneously might lead to confusion. Consider creating a migration plan to fully transition to Vitest.

Let's check if there are any other Jest-specific files that should be excluded or migrated:

✅ Verification successful

Let me gather more information about the testing setup to provide a more accurate verification.


The exclusion of vitest.config.ts is appropriate during this transition phase

The codebase is actively maintaining both Jest and Vitest setups as evidenced by:

  • Parallel test scripts for both frameworks in package.json
  • Presence of both jest.config.js and vitest.config.ts
  • Active dependencies for both testing frameworks

The exclusion of vitest.config.ts from Jest's coverage is correct and necessary to avoid confusion between the two testing setups during this transition period.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find Jest-specific configuration and test files
# Look for Jest-specific files and configurations
fd -e config.js -e setup.js -e spec.js -e spec.tsx -e test.js -e test.tsx . | grep -i jest

Length of output: 107


Script:

#!/bin/bash
# Check for Vitest-related files and configurations
fd -e config.ts -e setup.ts . | grep -i 'vitest\|test'

# Check content of package.json for test-related scripts and dependencies
cat package.json | jq '.scripts + .dependencies + .devDependencies' | grep -i 'jest\|vitest'

Length of output: 715

@shivasankaran18
Copy link
Contributor Author

@palisadoes @Cioppolo14 fixed the failing tests..

This was referenced Dec 24, 2024
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.

4 participants