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

Fix: Improve code coverage in src/screens/forgot password #3109

Conversation

PratapRathi
Copy link
Contributor

@PratapRathi PratapRathi commented Jan 1, 2025

What kind of change does this PR introduce?
This PR will migrate src/screens/ForgotPassword/ForgotPassword.tsx from Jest to Vitest also improve its code coverage to 100%.
Removed Istanbul ignore next comments.

Issue Number:

Fixes #3025
Fixes #2551

Did you add tests for your changes?
Yes

Snapshots/Videos:
Screenshot 2025-01-01 at 17 12 00

If relevant, did you update the documentation?
N/A

Summary
Does this PR introduce a breaking change?
No

Other information
At one place we are using istanbul ignore else statement because there we don't need else statement.

Have you read the contributing guide?
Yes

Summary by CodeRabbit

  • New Features

    • Enhanced password recovery test suite with comprehensive test cases
    • Improved error handling in forgot password functionality
  • Tests

    • Updated testing framework from Jest to Vitest
    • Added more robust test scenarios for password reset process
  • Chores

    • Standardized test case descriptions
    • Refined code coverage configuration

Copy link
Contributor

coderabbitai bot commented Jan 1, 2025

Walkthrough

This pull request focuses on refactoring the ForgotPassword component's test suite and implementation. The changes involve migrating the test framework from Jest to Vitest in the ForgotPassword.spec.tsx file and updating the code coverage comment in the ForgotPassword.tsx file. The modifications aim to improve test coverage and align the testing approach with the project's evolving testing infrastructure.

Changes

File Change Summary
src/screens/ForgotPassword/ForgotPassword.spec.tsx - Migrated from Jest to Vitest testing framework
- Added FORGOT_PASSWORD_MUTATION
- Updated test cases and mocking approach
- Standardized test descriptions from test to it
src/screens/ForgotPassword/ForgotPassword.tsx - Modified code coverage comment from /* istanbul ignore next */ to /* istanbul ignore else -- @preserve */

Assessment against linked issues

Objective Addressed Explanation
Improve Code Coverage [#3025]
Migrate from Jest to Vitest [#2551]

Possibly related issues

Possibly related PRs

Suggested labels

refactor, ignore-sensitive-files-pr

Suggested reviewers

  • pranshugupta54
  • varshith257
  • gautam-divyanshu

Poem

🐰 A Rabbit's Ode to Testing Delight 🧪

From Jest to Vitest, we hop and we leap,
Coverage climbing, no stone left to keep,
Mutations mocked, assertions bright,
Our code now dances with testing might!

Refactored and polished, our tests now shine ✨


📜 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 a60179f and a780007.

📒 Files selected for processing (2)
  • src/screens/ForgotPassword/ForgotPassword.spec.tsx (11 hunks)
  • src/screens/ForgotPassword/ForgotPassword.tsx (1 hunks)
🧰 Additional context used
📓 Learnings (1)
📓 Common learnings
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 (15)
src/screens/ForgotPassword/ForgotPassword.tsx (1)

138-138: Retain coverage for the else branch.

Switching from /* istanbul ignore next */ to /* istanbul ignore else -- @preserve */ helps ensure code coverage tools properly track the else branch of this conditional. This aligns with the PR goal of removing unnecessary coverage ignore directives.

src/screens/ForgotPassword/ForgotPassword.spec.tsx (14)

8-12: New imports align with Vitest migration and coverage objectives.

Importing toast and the GraphQL mutations ensures the test suite covers relevant functionalities in the ForgotPassword component.


19-19: Vitest usage looks correct.

Replacing Jest globals with Vitest (vi, it, etc.) is consistent with your migration plan. Double-check no leftover Jest-specific references remain.


23-27: Mocking approach appears valid under Vitest.

Using vi.mock for react-toastify preserves the existing line-by-line coverage while ensuring consistent test results under Vitest.


32-46: Comprehensive mock for FORGOT_PASSWORD_MUTATION.

Defining this successful response block ensures coverage of the happy path in the ForgotPassword process.


120-121: Rendering tests confirm redirection logic.

By pushing the browser history state and validating the pathname, these checks fully cover the “already logged in” scenario.

Also applies to: 141-141


144-144: Covers “logged in” scenario accurately.

Ensures behavior is tested when the user is already logged in.


162-162: ‘Get OTP’ functionality tested thoroughly.

Providing the user’s email and expecting a success toast increases coverage for OTP generation flow.


195-196: Password reset data coverage.

Validates that newPassword and confirmNewPassword inputs are processed correctly, matching the PR’s coverage goals.


233-233: Ensures handling of missing OTP in local storage.

This verifies correct fallback behavior when otpToken is unexpectedly removed, improving test completeness.


274-274: Negative test for mismatched passwords.

Assertions confirm user feedback when the new password fields differ, further increasing code coverage.


314-314: User not found scenario verified.

Covers the API error condition to ensure the correct toast message is displayed.


344-344: Validates miscellaneous error conditions.

Ensures that unexpected errors trigger the correct fallback path, maintaining robust coverage.


362-362: Confirms response to Talawa API failure.

Guarantees the user sees the correct error message when Talawa’s API is unreachable.


392-392: No otpToken test scenario.

Ensures the function gracefully handles a missing OTP token, preserving workflow integrity.


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

codecov bot commented Jan 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.32%. Comparing base (a60179f) to head (a780007).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3109       +/-   ##
=====================================================
+ Coverage             25.37%   89.32%   +63.95%     
=====================================================
  Files                   301      322       +21     
  Lines                  7623     8421      +798     
  Branches               1667     1897      +230     
=====================================================
+ Hits                   1934     7522     +5588     
+ Misses                 5562      665     -4897     
- Partials                127      234      +107     

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

@rishav-jha-mech rishav-jha-mech merged commit 9e43fa5 into PalisadoesFoundation:develop-postgres Jan 1, 2025
16 checks passed
@PratapRathi PratapRathi deleted the Fix-improve-code-coverage-in-src/screens/ForgotPassword branch January 5, 2025 16:15
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