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(citizenship): small fix for file uploads #16270

Merged
merged 3 commits into from
Oct 4, 2024
Merged

Conversation

berglindoma13
Copy link
Member

@berglindoma13 berglindoma13 commented Oct 4, 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
    • Enhanced management of multiple child entries in the citizenship form by ensuring unique IDs for each document field.
  • Bug Fixes
    • Improved clarity and specificity in validation error messages for supporting documents.
    • Streamlined validation logic in existing schemas for better error handling.

@berglindoma13 berglindoma13 requested a review from a team as a code owner October 4, 2024 12:42
Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

Walkthrough

The changes in this pull request involve modifications to the ChildrenOtherDocumentsSubSection component and Zod schemas in the dataSchema.ts file. The ChildrenOtherDocumentsSubSection.ts file sees updates to the IDs of various input fields to ensure uniqueness based on an index for handling multiple children. The dataSchema.ts file undergoes refinements in validation paths and the removal of parameters in certain schemas, enhancing the clarity of validation logic without altering overall functionality.

Changes

File Change Summary
libs/application/templates/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/ChildrenSupportingDocuments/ChildrenOtherDocumentsSubSection.ts Updated IDs for hidden inputs and file upload fields to include an index for uniqueness.
libs/application/templates/directorate-of-immigration/citizenship/src/lib/dataSchema.ts Refined validation paths in schemas, removed parameters from refinements, and maintained schema structure.

Possibly related PRs

  • fix(citizenship): adding validation to file uploads #16239: This PR adds validation for file uploads, which is directly related to the changes in the ChildrenOtherDocumentsSubSection.ts file that involve handling file upload fields for written consent and custody documents.
  • fix(citizenship): wrong path error fix #16251: This PR updates the IDs of hidden input fields in the ChildrenOtherDocumentsSubSection.ts file to reflect a new routing structure, which is closely related to the modifications made in the main PR regarding the same component.

Suggested reviewers

  • sigruntg
  • oskarjs

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.

@berglindoma13 berglindoma13 added the automerge Merge this PR as soon as all checks pass label Oct 4, 2024
Copy link

codecov bot commented Oct 4, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 36.92%. Comparing base (ead8e77) to head (e37d346).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...e-of-immigration/citizenship/src/lib/dataSchema.ts 0.00% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16270   +/-   ##
=======================================
  Coverage   36.92%   36.92%           
=======================================
  Files        6781     6781           
  Lines      140031   140025    -6     
  Branches    39816    39815    -1     
=======================================
  Hits        51705    51705           
+ Misses      88326    88320    -6     
Flag Coverage Δ
api 3.37% <ø> (ø)
application-system-api 41.62% <0.00%> (-0.01%) ⬇️
application-template-api-modules 24.38% <ø> (ø)
application-ui-shell 21.29% <ø> (ø)

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

Files with missing lines Coverage Δ
...e-of-immigration/citizenship/src/lib/dataSchema.ts 21.64% <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 4c37af4...e37d346. Read the comment docs.

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/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/ChildrenSupportingDocuments/ChildrenOtherDocumentsSubSection.ts (1)

Line range hint 78-174: Overall improvement in component reusability and robustness

The changes made to this file consistently improve the handling of multiple children in the form by ensuring unique identifiers for hidden inputs. These modifications enhance the component's reusability across different NextJS apps, which aligns with the coding guidelines for libs/**/* files. The use of TypeScript for props and exported types is maintained, and the changes should not negatively impact tree-shaking or bundling practices.

Consider adding a comment explaining the purpose of the index parameter in the IDs to improve code readability and maintainability for future developers.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ead8e77 and 0bc628e.

📒 Files selected for processing (2)
  • libs/application/templates/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/ChildrenSupportingDocuments/ChildrenOtherDocumentsSubSection.ts (3 hunks)
  • libs/application/templates/directorate-of-immigration/citizenship/src/lib/dataSchema.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
libs/application/templates/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/ChildrenSupportingDocuments/ChildrenOtherDocumentsSubSection.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."
libs/application/templates/directorate-of-immigration/citizenship/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 (5)
libs/application/templates/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/ChildrenSupportingDocuments/ChildrenOtherDocumentsSubSection.ts (3)

78-78: Improved uniqueness and reusability of hidden input ID

The change to include the index parameter in the hidden input ID is a good improvement. It ensures unique identifiers for each instance when handling multiple children, enhancing the component's reusability across different NextJS apps.


113-113: Consistent improvement in hidden input ID uniqueness

This change follows the same pattern as the previous one, ensuring unique identifiers for hidden inputs related to written consent from other parents. It maintains consistency in the approach to handling multiple children and improves the overall robustness of the form.


174-174: Completed update of hidden input IDs for improved uniqueness

This change completes the update of hidden input IDs to include the index parameter. All hidden inputs in this section now have unique identifiers, which is crucial for correctly handling multiple children in the form. These changes collectively improve the component's reusability and robustness.

libs/application/templates/directorate-of-immigration/citizenship/src/lib/dataSchema.ts (2)

269-279: Improved error reporting in ChildrenSupportingDocumentsSchema

The changes to the ChildrenSupportingDocumentsSchema refinement for the writtenConsentFromChild field enhance the error reporting by explicitly defining the error path. This improvement aligns with TypeScript best practices and maintains the schema's reusability across different NextJS apps.


Line range hint 1-379: Overall assessment: File adheres to coding guidelines

The changes made to this file are minimal and focused, improving the existing schema without introducing new issues. The file continues to adhere to the coding guidelines for the libs directory:

  1. It maintains reusability of components and hooks across different NextJS apps.
  2. TypeScript is effectively used for defining props and exporting types.
  3. The changes do not affect tree-shaking and bundling practices.

The improvement in error reporting enhances the overall quality of the schema while maintaining its reusability and type safety.

@datadog-island-is
Copy link

Datadog Report

All test runs 2f18a2a 🔗

6 Total Test Services: 0 Failed, 6 Passed
➡️ Test Sessions change in coverage: 9 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 3.1s 1 no change Link
application-system-api 0 0 0 120 2 3m 14.2s 1 no change Link
application-template-api-modules 0 0 0 135 0 1m 55.6s 1 no change Link
application-ui-shell 0 0 0 74 0 32.51s 1 no change Link
judicial-system-backend 0 0 0 21199 0 0s N/A Link
judicial-system-xrd-api 0 0 0 6 0 4.94s 1 no change Link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants