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(income-plan): Don't allow negative numbers or 0 in income plan #15982

Merged
merged 3 commits into from
Sep 13, 2024

Conversation

veronikasif
Copy link
Member

@veronikasif veronikasif commented Sep 12, 2024

[TS-911] Don't allow negative numbers or 0 in income plan

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced validation for income-related fields to ensure they contain positive numeric values.
    • Introduced a new validation method to check monthly income entries for each month, ensuring data integrity.
  • Bug Fixes

    • Improved error handling for invalid income entries, providing clearer feedback on validation failures.

@veronikasif veronikasif requested a review from a team as a code owner September 12, 2024 16:21
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

The changes made to the dataSchema.ts file focus on enhancing validation logic for income-related fields. The updates ensure that specific fields, such as incomePerYear, equalIncomePerMonth, and equalForeignIncomePerMonth, must contain positive numeric values under certain conditions. Additionally, a new superRefine method has been introduced to validate monthly income entries, ensuring that if the income type is MONTHLY and other criteria are met, each month's income must also be positive.

Changes

File Path Change Summary
libs/application/templates/social-insurance-administration/income-plan/src/lib/dataSchema.ts Added validation logic to enforce positive numeric values for income fields and introduced superRefine method for monthly income validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Application
    participant Validator

    User->>Application: Submit income data
    Application->>Validator: Validate income fields
    alt Income Type is YEARLY
        Validator->>Validator: Check incomePerYear > 0
    else Income Type is MONTHLY
        Validator->>Validator: Check each month's income > 0
    end
    Validator-->>Application: Return validation results
    Application-->>User: Display validation feedback
Loading

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 128e557 and ff76ef6.

Files selected for processing (1)
  • libs/application/templates/social-insurance-administration/income-plan/src/lib/dataSchema.ts (5 hunks)
Additional context used
Path-based instructions (1)
libs/application/templates/social-insurance-administration/income-plan/src/lib/dataSchema.ts (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
Additional comments not posted (3)
libs/application/templates/social-insurance-administration/income-plan/src/lib/dataSchema.ts (3)

35-37: LGTM!

The refinement logic correctly ensures that incomePerYear is a positive value when the income is YEARLY.


57-58: LGTM!

The refinement logic correctly ensures that equalIncomePerMonth is a positive value under the specified conditions.


79-80: LGTM!

The refinement logic correctly ensures that equalForeignIncomePerMonth is a positive value under the specified conditions.

Copy link

codecov bot commented Sep 12, 2024

Codecov Report

Attention: Patch coverage is 6.25000% with 15 lines in your changes missing coverage. Please review.

Project coverage is 36.89%. Comparing base (2a36e0a) to head (ac4e9d2).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...e-administration/income-plan/src/lib/dataSchema.ts 6.25% 15 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15982      +/-   ##
==========================================
+ Coverage   36.84%   36.89%   +0.04%     
==========================================
  Files        6718     6715       -3     
  Lines      137708   137538     -170     
  Branches    39148    39087      -61     
==========================================
- Hits        50745    50738       -7     
+ Misses      86963    86800     -163     
Flag Coverage Δ
api 3.39% <ø> (ø)
application-system-api 41.66% <6.25%> (-0.02%) ⬇️
application-template-api-modules 23.43% <6.25%> (-0.01%) ⬇️
application-ui-shell 21.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...e-administration/income-plan/src/lib/dataSchema.ts 11.62% <6.25%> (-1.71%) ⬇️

... and 15 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a36e0a...ac4e9d2. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 12, 2024

Datadog Report

All test runs d0e50f3 🔗

4 Total Test Services: 0 Failed, 4 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.63%), 7 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.73s 1 no change Link
application-system-api 0 0 0 111 2 2m 57.57s 1 no change Link
application-template-api-modules 0 0 0 109 0 1m 44.16s 1 no change Link
application-ui-shell 0 0 0 74 0 33.03s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-templates-social-insurance-administration-income-plan - jest 29.62% (-0.63%) - Details

Copy link
Member

@ylfahfa ylfahfa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 👍

@veronikasif veronikasif added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Sep 13, 2024
@kodiakhq kodiakhq bot merged commit 76faccd into main Sep 13, 2024
36 checks passed
@kodiakhq kodiakhq bot deleted the feat/income-plan-dont-allow-negative-or-zero branch September 13, 2024 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants