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 UserPortal/Organizations #2783

Merged

Conversation

shivasankaran18
Copy link
Contributor

@shivasankaran18 shivasankaran18 commented Dec 24, 2024

What kind of change does this PR introduce?

Added Vitest to src/screens/UserPortal/Organizations

Issue Number: 2575

Fixes #2575

Did you add tests for your changes?
Yes

Snapshots/Videos:
Screenshot 2024-12-24 215955

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
    • Enhanced test suite for the Organizations component with new test cases.
    • Added mock data for GraphQL queries to simulate realistic API responses.
    • Verified rendering, search functionality, and toggle modes for organizations.
    • Included tests for the "Join Now" button and sidebar functionality, ensuring responsiveness.

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request focuses on enhancing the test suite for the Organizations component in the UserPortal by introducing comprehensive mock data for GraphQL queries and adding detailed test cases. The changes ensure thorough validation of the component's functionalities, including rendering, search operations, mode toggling between joined and created organizations, and sidebar interactions. The tests also assess the component's responsiveness at different screen sizes.

Changes

File Change Summary
src/screens/UserPortal/Organizations/Organizations.spec.tsx - Added mock data for GraphQL queries
- Implemented new test cases for component rendering
- Added tests for search functionality
- Verified mode toggling and sidebar interactions
- Included responsive design tests

Assessment against linked issues

Objective Addressed Explanation
Replace Jest-specific functions with Vitest equivalents [#2575]
Ensure tests pass using npm run test:vitest [#2575] Actual test run not visible in the diff
Maintain 100% test coverage [#2575] Coverage not explicitly demonstrated

Possibly related issues

Possibly related PRs

Poem

🐰 Hop, hop, testing we go!
From Jest to Vitest, watch our code flow
Organizations dancing with grace
Tests passing at a rabbit's pace
Migration magic, smooth and bright! 🧪✨


📜 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 dbe3387 and 1e09e7b.

📒 Files selected for processing (1)
  • src/screens/UserPortal/Organizations/Organizations.spec.tsx (8 hunks)

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

🧹 Nitpick comments (5)
src/screens/UserPortal/Organizations/Organizations.spec.tsx (5)

363-366: Consider verifying the outcome after clearing the search input.
The test checks that "anyOrganization2" appears, but there is no final assertion verifying that the UI reverts to the default state once the input is cleared.

 userEvent.clear(screen.getByTestId('searchInput'));
 userEvent.click(searchBtn);
 await wait();
+expect(screen.queryByText('anyOrganization2')).not.toBeInTheDocument();

392-395: Enhance assertions for joined organizations testing.
Confirming that "joinedOrganization" appears in the DOM is good, but you can also cross-check that elements belonging to "created organizations" do not show up unexpectedly, strengthening test coverage.


419-422: Ensure the created organizations test verifies actual content.
As with the joined organizations test, verifying non-appearance of conflicting content (e.g., joined organizations) can provide better test certainty.


446-449: “Join Now” button testing could be extended to assert functionality.
Right now, you’re confirming that the button renders. You could also check if it triggers any expected action (navigation, dialog, etc.).


493-496: Verify the sidebar’s final state after reopening.
After clicking close and then open, you might add an assertion verifying that the sidebar is indeed visible again to solidify coverage.

 await act(async () => {
   const openMenuBtn = screen.getByTestId('openMenu');
   openMenuBtn.click();
 });
+await waitFor(() => {
+  const closeMenuBtn = screen.getByTestId('closeMenu');
+  expect(closeMenuBtn).toBeInTheDocument();
+});
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dbe3387 and 9f2a04f.

📒 Files selected for processing (1)
  • src/screens/UserPortal/Organizations/Organizations.spec.tsx (8 hunks)
🔇 Additional comments (2)
src/screens/UserPortal/Organizations/Organizations.spec.tsx (2)

21-24: Good use of comments to document your GraphQL mocks.
Providing a clear purpose for the mock data helps maintainers and contributors understand the scope and usage quickly.


324-327: Documentation for the StaticMockLink is concise and clear.
It is helpful to explain this custom link approach for new contributors, ensuring easier maintenance and troubleshooting.

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 (7755890) to head (1e09e7b).
Report is 5 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #2783       +/-   ##
=====================================================
+ Coverage             70.01%   87.55%   +17.53%     
=====================================================
  Files                   296      313       +17     
  Lines                  7358     8204      +846     
  Branches               1606     1792      +186     
=====================================================
+ Hits                   5152     7183     +2031     
+ Misses                 1960      827     -1133     
+ Partials                246      194       -52     

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

@palisadoes
Copy link
Contributor

@coderabbitai full review

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

✅ Actions performed

Full review triggered.

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.

Minor PR

@palisadoes palisadoes merged commit aff65c9 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