UserScreen Test migration from jest to vitest

[PurnenduMIshra129th]

What kind of change does this PR introduce?
It is a feture request of changing the test case migration of jest to vitest.

Issue Number:
Fixes issue no . #2580

Did you add tests for your changes?
Yes after changing the code to vitest i ran the command npm run vitest and it is successfully completed. I will provide screenshots.

Snapshots/Videos:

Summary
In this Pr the screen is now tested with vitest . which is more faster than jest which is previously used. And one by one all the screens are migrating to vitest so this is one of them.

Does this PR introduce a breaking change?
No this does not affect the existing code flow.

Have you read the contributing guide?

Yes

Summary by CodeRabbit

• Bug Fixes

  • Enhanced the test suite for the UserScreen component, improving routing behavior during tests.

• New Features

  • Introduced vite-plugin-svgr to handle SVG files as React components.

• Documentation

  • Updated test descriptions and comments for clarity and organization.
  • Modified the prepare script in package.json for conditional execution based on environment.

[coderabbitai]

Walkthrough

The pull request introduces significant changes to the testing framework for the UserScreen component, transitioning from Jest to Vitest. This includes updating mocking methods for react-router-dom, restructuring test cases for clarity, and enhancing overall test organization. Additionally, a new Vite plugin, vite-plugin-svgr, is added to handle SVG files as React components. The modifications aim to improve the readability and maintainability of the test suite while ensuring all tests pass under the new framework.

Changes

File Path	Change Summary
src/screens/UserPortal/UserScreen/UserScreen.spec.tsx	Updated tests to use vitest instead of jest, restructured test cases, added beforeEach for setup, and improved comments.
vitest.config.ts	Added vite-plugin-svgr to handle SVG files as React components.
package.json	Modified prepare script for conditional execution and added vite-plugin-svgr to devDependencies.

Possibly related issues

• Refactor: src/screens/UserPortal/UserScreen from Jest to Vitest #2580: This issue requests the refactor of UserScreen tests from Jest to Vitest, which aligns with the changes made in this PR.
• Refactor: src/screens/UserPortal/People from Jest to Vitest #2576: This issue involves refactoring tests for People, which may benefit from the same migration approach as seen in this PR.
• Refactor: src/screens/Users from Jest to Vitest #2585: Similar to the main PR, this issue focuses on refactoring Users tests to Vitest, indicating a broader migration effort.

Possibly related PRs

• feat!: Migrate Testing Framework from Jest to Vitest #2457: This PR focuses on migrating the testing framework from Jest to Vitest, which is directly related to the main PR's changes that also involve transitioning from Jest to Vitest for the UserScreen component tests.
• Refactored src/components/AddOn/support/components/Action/Action.test.tsx from Jest to Vitest #2482: This PR involves refactoring tests from Jest to Vitest for the Action component, aligning with the main PR's objective of updating test files to use Vitest.
• Refactored src/components/AddOn/core/AddOnEntry/AddOnEntry.test.tsx from Jest to Vitest #2501: Similar to the main PR, this PR refactors the AddOnEntry component's tests from Jest to Vitest, indicating a broader effort to standardize testing across the codebase.
• Refactor: Adding vitest to Avatar component #2622: This PR also involves migrating the Avatar component's tests to Vitest, reinforcing the trend of updating testing frameworks in the project, which is a key aspect of the main PR.

Suggested labels

refactor, test

Suggested reviewers

• palisadoes
• varshith257
• AVtheking

Poem

In the land of code where rabbits play,
We hopped to Vitest without delay.
Tests now clearer, structure bright,
Mocking routes with all our might.
With SVGs dancing, our joy is grand,
Hopping forward, hand in hand! 🐇✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c00f7b9 and c1deb22.

📒 Files selected for processing (2)

• package.json (2 hunks)
• vitest.config.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• vitest.config.ts

🔇 Additional comments (3)

package.json (3)

89-89: LGTM: Improved production deployment handling.

The modified prepare script now correctly handles production environments by skipping husky installation.

---

159-160: LGTM: Required dependencies for Vitest migration.

The addition of vite-plugin-svgr is necessary for handling SVG files as React components in the Vitest environment.

---

Line range hint 73-78: Consider consolidating test scripts during migration.

Currently, both Jest and Vitest test scripts coexist:

"test:vitest": "vitest run",
"test:vitest:watch": "vitest",
"test:vitest:coverage": "vitest run --coverage",
"test": "cross-env NODE_ENV=test jest --env=./scripts/custom-test-env.js --watchAll --coverage",

While this is acceptable during the migration phase, consider:

1. Adding a comment in the package.json indicating this is temporary during migration
2. Creating a tracking issue for removing Jest scripts once all tests are migrated
3. Updating documentation to clarify which test command developers should use

Let's check the test coverage to ensure we're maintaining it during migration:

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Experiment)
• @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.

[github-actions]

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

[github-actions]

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (5)

vitest.config.ts (1)

5-5: LGTM! Consider adding SVG type declarations.

The addition of vite-plugin-svgr is appropriate for handling SVG files as React components. The plugin is correctly configured in the plugins array.

Consider adding a type declaration file for SVG imports to improve TypeScript integration:

// src/types/svg.d.ts
declare module '*.svg' {
  import React from 'react'
  const SVG: React.FC<React.SVGProps<SVGSVGElement>>
  export default SVG
}

Also applies to: 14-14

src/screens/UserPortal/UserScreen/UserScreen.spec.tsx (4)

18-30: Consider improving the mock implementation.

The migration to Vitest mocking is correct, but there are a few improvements we can make:

 vi.mock('react-router-dom', async () => {
-  const actual =
-    // eslint-disable-next-line @typescript-eslint/consistent-type-imports
-    await vi.importActual<typeof import('react-router-dom')>(
-      'react-router-dom',
-    );
+  const actual = await vi.importActual<typeof import('react-router-dom')>('react-router-dom');
   return {
     ...actual,
     useParams: () => ({ orgId: mockID }),
     useLocation: () => ({ pathname: mockLocation }),
-    useNavigate: vi.fn(), // Mock only the necessary parts
+    useNavigate: vi.fn(),
   };
 });

---

84-88: Consider adding afterEach cleanup.

While the beforeEach setup is good, consider adding cleanup to ensure tests don't affect each other:

 describe('UserScreen tests with LeftDrawer functionality', () => {
   beforeEach(() => {
     mockID = '123';
     mockLocation = '/user/organization/123';
   });
+  afterEach(() => {
+    vi.clearAllMocks();
+  });

---

142-152: Enhance window resize test assertions.

The window resize tests could be more robust with additional assertions:

   // Resize to small screen and check toggle state
   resizeWindow(800);
   clickToggleMenuBtn(toggleButton);
   expect(icon).toHaveClass('fa fa-angle-double-left');
+  expect(window.innerWidth).toBe(800);
+  const drawer = screen.getByTestId('leftDrawer');
+  expect(drawer).toHaveStyle({ width: '0px' });

   // Resize to large screen and check toggle state
   resizeWindow(1000);
   clickToggleMenuBtn(toggleButton);
   expect(icon).toHaveClass('fa fa-angle-double-right');
+  expect(window.innerWidth).toBe(1000);
+  expect(drawer).toHaveStyle({ width: '250px' });

---

Line range hint 157-175: Enhance navigation test coverage.

The navigation test could be more comprehensive:

   it('redirects to root when orgId is undefined', () => {
     mockID = undefined;
     const navigate = vi.fn();
     vi.spyOn({ useNavigate }, 'useNavigate').mockReturnValue(navigate);
 
     render(
       <MockedProvider addTypename={false} link={link}>
         <BrowserRouter>
           <Provider store={store}>
             <I18nextProvider i18n={i18nForTest}>
               <UserScreen />
             </I18nextProvider>
           </Provider>
         </BrowserRouter>
       </MockedProvider>,
     );
 
-    expect(window.location.pathname).toEqual('/');
+    expect(navigate).toHaveBeenCalledWith('/');
+    expect(navigate).toHaveBeenCalledTimes(1);
   });
+
+  it('handles invalid orgId', () => {
+    mockID = 'invalid-id';
+    const navigate = vi.fn();
+    vi.spyOn({ useNavigate }, 'useNavigate').mockReturnValue(navigate);
+
+    render(
+      <MockedProvider addTypename={false} link={link}>
+        <BrowserRouter>
+          <Provider store={store}>
+            <I18nextProvider i18n={i18nForTest}>
+              <UserScreen />
+            </I18nextProvider>
+          </Provider>
+        </BrowserRouter>
+      </MockedProvider>,
+    );
+
+    expect(navigate).toHaveBeenCalledWith('/');
+  });

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4bef093 and 2b43022.

📒 Files selected for processing (2)

• src/screens/UserPortal/UserScreen/UserScreen.spec.tsx (6 hunks)
• vitest.config.ts (2 hunks)

🔇 Additional comments (1)

src/screens/UserPortal/UserScreen/UserScreen.spec.tsx (1)

2-3: LGTM! Import organization looks good.

The migration from Jest to Vitest is correctly reflected in the imports. The addition of @testing-library/jest-dom is appropriate for DOM-specific assertions.

Also applies to: 13-13

[PurnenduMIshra129th]

will i have to again make a pr for the failed cases?

[Cioppolo14]

@PurnenduMIshra129th No, please don't make a new PR, just address the issues here. Please fix the failed tests.

[PurnenduMIshra129th]

@Cioppolo14 as per your suggestion i am addressing the failed test cases

1. Run echo "Error: Pull request target branch must be 'develop-postgres'. Please refer PR_GUIDELINES.md"
   Error: Pull request target branch must be 'develop-postgres'. Please refer PR_GUIDELINES.md

2. Run npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
   File /home/runner/work/talawa-admin/talawa-admin/src/screens/UserPortal/UserScreen/UserScreen.spec.tsx contains eslint-disable statement.
   ESLint-disable check failed. Exiting with error.

and i fixed the issues but i have to make a new pr against develop-postgress or what ? I don't know the process of modifing existing pr.So guide me

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.78%. Comparing base (2e6ea0b) to head (c00f7b9).
Report is 27 commits behind head on develop-postgres.

Additional details and impacted files

@@                  Coverage Diff                  @@
##           develop-postgres    #2628       +/-   ##
=====================================================
- Coverage             98.26%   83.78%   -14.48%     
=====================================================
  Files                   297      312       +15     
  Lines                  8638     8117      -521     
  Branches               2486     1776      -710     
=====================================================
- Hits                   8488     6801     -1687     
- Misses                  139     1177     +1038     
- Partials                 11      139      +128     

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

The base branch was changed.

[PurnenduMIshra129th]

i am now very doubt with this branch develop and develop-postgress. When choose the develop-postgress and take changes to adjust for userScreen page then more test are failing . So for now i will keep at as develop until further instruction.

[varshith257]

Please open a new PR by pulling upstream with develop-postgres