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(health-insurance): Fixing zod schema #16778

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Conversation

HjorturJ
Copy link
Member

@HjorturJ HjorturJ commented Nov 8, 2024

...

Attach a link to issue if relevant

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
    • Updated the residency document field to allow multiple files for confirmation of residency, enhancing user flexibility in document submission.

@HjorturJ HjorturJ requested a review from a team as a code owner November 8, 2024 12:09
Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Walkthrough

The changes in this pull request involve an update to the formerInsurance schema within the dataSchema file located in the health insurance module. Specifically, the confirmationOfResidencyDocument field has been modified from an optional single FileSchema object to an optional array of FileSchema objects, allowing for multiple residency documents to be included.

Changes

File Path Change Summary
libs/application/templates/health-insurance/src/lib/dataSchema.ts Updated confirmationOfResidencyDocument from optional single FileSchema to optional array of FileSchema.

Possibly related PRs

  • feat(health-insurance): zod for health insurance #16379: This PR modifies the dataSchema.ts file in the health insurance module, which is directly related to the changes made to the confirmationOfResidencyDocument field in the main PR's dataSchema.ts. Both PRs involve schema updates within the same file, focusing on the structure and validation of data.

Suggested labels

automerge

Suggested reviewers

  • jonnigs
  • rafnarnason

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

🧹 Outside diff range and nitpick comments (1)
libs/application/templates/health-insurance/src/lib/dataSchema.ts (1)

16-16: LGTM! Type-safe array implementation.

The change from single file to array of files is implemented correctly using Zod's type-safe array validation.

Consider adding min/max constraints to the array to prevent potential abuse:

-  confirmationOfResidencyDocument: z.array(FileSchema).optional(),
+  confirmationOfResidencyDocument: z.array(FileSchema).min(1).max(5).optional(),
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4cc1e8b and e002a33.

📒 Files selected for processing (1)
  • libs/application/templates/health-insurance/src/lib/dataSchema.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/application/templates/health-insurance/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 (1)
libs/application/templates/health-insurance/src/lib/dataSchema.ts (1)

16-16: Verify the impact of this breaking change.

The schema change from single file to array of files is a breaking change that might affect existing implementations.

✅ Verification successful

Let me gather more information about the historical changes and usage patterns.


Breaking change confirmed but already properly handled

The git history shows this was changed from FileSchema.optional() to z.array(FileSchema).optional(). However, the codebase appears to have been properly updated to handle this change:

  • The interface FormerInsurance in types.ts already expects FileType[] (array)
  • The form field definition in formerInsuranceSection.ts is properly configured
  • The review component in FormerInsurance.tsx is using the correct field ID

Since all related code has been updated to handle the array type, this change is not breaking existing implementations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for usages of confirmationOfResidencyDocument to identify affected code

# Search for direct property access
rg -A 3 "confirmationOfResidencyDocument"

# Search for form submissions or API calls related to health insurance
rg -A 5 "formerInsurance.*submit|health-insurance.*api"

Length of output: 3402


Script:

#!/bin/bash
# Check git history for this field
git log -p libs/application/templates/health-insurance/src/lib/dataSchema.ts | grep -A 5 -B 5 "confirmationOfResidencyDocument"

# Check for any API type definitions or interfaces
ast-grep --pattern 'interface $_ {
  $$$
  confirmationOfResidencyDocument
  $$$
}'

# Check for form submission handlers
rg -A 10 "onSubmit.*formerInsurance|handleSubmit.*formerInsurance"

Length of output: 1971

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.54%. Comparing base (369a35b) to head (3527901).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16778      +/-   ##
==========================================
- Coverage   36.55%   36.54%   -0.01%     
==========================================
  Files        6890     6890              
  Lines      143839   143839              
  Branches    41005    41005              
==========================================
- Hits        52574    52569       -5     
- Misses      91265    91270       +5     
Flag Coverage Δ
air-discount-scheme-backend 54.04% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.35% <ø> (ø)
api-catalogue-services 77.85% <ø> (ø)
api-domains-air-discount-scheme 36.99% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.48% <ø> (ø)
api-domains-communications 39.59% <ø> (ø)
api-domains-criminal-record 47.44% <ø> (ø)
api-domains-driving-license 44.46% <ø> (ø)
api-domains-education 30.52% <ø> (ø)
api-domains-health-insurance 34.28% <ø> (ø)
api-domains-mortgage-certificate 34.65% <ø> (ø)
api-domains-payment-schedule 41.22% <ø> (ø)
application-api-files 56.25% <ø> (ø)
application-core 70.75% <ø> (-0.32%) ⬇️
application-system-api 41.11% <ø> (ø)
application-template-api-modules 27.63% <ø> (ø)
application-templates-accident-notification 28.98% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.87% <ø> (ø)
application-templates-driving-license 18.26% <ø> (ø)
application-templates-estate 12.17% <ø> (ø)
application-templates-example-payment 24.80% <ø> (ø)
application-templates-financial-aid 15.48% <ø> (ø)
application-templates-general-petition 23.07% <ø> (ø)
application-templates-inheritance-report 6.52% <ø> (ø)
application-templates-marriage-conditions 15.04% <ø> (ø)
application-templates-mortgage-certificate 43.22% <ø> (ø)
application-templates-parental-leave 29.83% <ø> (ø)
application-types 6.60% <ø> (ø)
application-ui-components 1.27% <ø> (ø)
application-ui-shell 20.80% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 30.20% <ø> (ø)
auth-react 21.92% <ø> (ø)
auth-shared 75.00% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
clients-driving-license 40.16% <ø> (ø)
clients-driving-license-book 43.41% <ø> (ø)
clients-financial-statements-inao 48.94% <ø> (ø)
clients-license-client 1.26% <ø> (ø)
clients-middlewares 73.22% <ø> (ø)
clients-regulations 42.23% <ø> (ø)
clients-rsk-company-registry 29.76% <ø> (ø)
clients-rsk-personal-tax-return 38.00% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.17% <ø> (ø)
clients-zendesk 50.24% <ø> (ø)
cms 0.42% <ø> (ø)
cms-translations 38.89% <ø> (ø)
content-search-index-manager 95.65% <ø> (ø)
content-search-toolkit 8.14% <ø> (ø)
contentful-apps 4.69% <ø> (ø)
dokobit-signing 62.50% <ø> (ø)
download-service 44.24% <ø> (ø)
email-service 60.33% <ø> (ø)
feature-flags 90.40% <ø> (ø)
file-storage 45.75% <ø> (ø)
financial-aid-backend 51.25% <ø> (ø)
financial-aid-shared 17.81% <ø> (ø)
icelandic-names-registry-backend 54.34% <ø> (ø)
infra-nest-server 48.37% <ø> (ø)
infra-tracing 43.24% <ø> (ø)
island-ui-core 28.94% <ø> (ø)
judicial-system-api 19.62% <ø> (ø)
judicial-system-audit-trail 68.61% <ø> (ø)
judicial-system-backend 55.18% <ø> (ø)
judicial-system-formatters 79.97% <ø> (ø)
judicial-system-message 66.79% <ø> (ø)
judicial-system-message-handler 47.71% <ø> (ø)
judicial-system-scheduler 70.45% <ø> (ø)
judicial-system-types 43.99% <ø> (ø)
judicial-system-web 27.55% <ø> (ø)
license-api 42.64% <ø> (+0.07%) ⬆️
localization 10.15% <ø> (ø)
logging 48.43% <ø> (ø)
message-queue 67.80% <ø> (-0.79%) ⬇️
nest-audit 68.20% <ø> (ø)
nest-aws 54.03% <ø> (ø)
nest-config 77.81% <ø> (ø)
nest-core 43.54% <ø> (ø)
nest-feature-flags 50.90% <ø> (ø)
nest-problem 45.82% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.71% <ø> (ø)
nova-sms 61.80% <ø> (ø)
portals-admin-regulations-admin 1.85% <ø> (ø)
portals-core 15.95% <ø> (ø)
reference-backend 49.74% <ø> (ø)
regulations 16.78% <ø> (ø)
residence-history 85.00% <ø> (ø)
services-auth-admin-api 52.46% <ø> (ø)
services-auth-delegation-api 58.19% <ø> (ø)
services-auth-ids-api 52.05% <ø> (-0.02%) ⬇️
services-auth-personal-representative 45.56% <ø> (-0.03%) ⬇️
services-auth-personal-representative-public 41.75% <ø> (ø)
services-auth-public-api 49.56% <ø> (ø)
services-documents 60.81% <ø> (ø)
services-endorsements-api 53.33% <ø> (ø)
services-sessions 65.38% <ø> (ø)
services-university-gateway 49.32% <ø> (+0.02%) ⬆️
services-user-notification 46.84% <ø> (ø)
services-user-profile 61.83% <ø> (ø)
shared-components 26.95% <ø> (ø)
shared-form-fields 31.35% <ø> (ø)
shared-mocking 60.89% <ø> (ø)
shared-pii 92.85% <ø> (ø)
shared-problem 87.50% <ø> (ø)
shared-utils 27.69% <ø> (ø)
skilavottord-ws 24.14% <ø> (ø)
testing-e2e 66.66% <ø> (ø)
web 1.80% <ø> (ø)

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

Files with missing lines Coverage Δ
...n/templates/health-insurance/src/lib/dataSchema.ts 0.00% <ø> (ø)

... and 2 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 369a35b...3527901. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Nov 8, 2024

Datadog Report

All test runs 3a2500d 🔗

99 Total Test Services: 0 Failed, 96 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.9%), 1 increased (+0.02%), 198 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-backend 0 0 0 82 0 31.58s N/A Link
air-discount-scheme-web 0 0 0 2 0 7.04s N/A Link
api 0 0 0 4 0 2.33s N/A Link
api-catalogue-services 0 0 0 23 0 8.88s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 16.34s N/A Link
api-domains-assets 0 0 0 3 0 9.41s N/A Link
api-domains-auth-admin 0 0 0 18 0 10.1s N/A Link
api-domains-communications 0 0 0 5 0 31.08s N/A Link
api-domains-criminal-record 0 0 0 5 0 8.17s N/A Link
api-domains-driving-license 0 0 0 23 0 28.04s N/A Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • message-queue - jest 68.26% (-0.9%) - Details

@HjorturJ HjorturJ added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Nov 8, 2024
@kodiakhq kodiakhq bot merged commit b68eea7 into main Nov 8, 2024
261 checks passed
@kodiakhq kodiakhq bot deleted the fix/insurance-zod-fix branch November 8, 2024 17:20
jonnigs pushed a commit that referenced this pull request Nov 12, 2024
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
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