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): error with given and family names on prod #15865

Merged
merged 4 commits into from
Sep 3, 2024

Conversation

berglindoma13
Copy link
Member

@berglindoma13 berglindoma13 commented Sep 3, 2024

...

Attach a link to issue if relevant

What

Family name and given name are sometimes null from Þjóðskrá and need to do a small fix to prevent that from breaking the submit function

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 name handling in the citizenship service to ensure givenName and familyName are populated even when certain fields are missing.
    • Simplified name representation in the user information section by utilizing a single fullName property.
    • Extended the application template lifecycle from 1 day to 30 days, allowing applications to remain active longer.

These changes improve data accuracy and user experience within the citizenship application process.

@berglindoma13 berglindoma13 requested a review from a team as a code owner September 3, 2024 11:12
Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

The changes involve modifications to the CitizenshipService for deriving givenName and familyName from the individual object, enhancing name handling. Additionally, the UserInformationSubSection component now returns a single fullName property instead of concatenating names. Lastly, the lifecycle property in CitizenshipTemplate.ts has been adjusted to extend the application template's active duration from 1 day to 30 days.

Changes

Files Change Summary
libs/application/template-api-modules/src/lib/modules/templates/.../citizenship.service.ts Updated givenName and familyName derivation logic to include fallback from fullName.
libs/application/templates/directorate-of-immigration/citizenship/src/forms/.../UserInformationSubSection.ts Changed return value from concatenated givenName and familyName to a single fullName property from the individual object.
libs/application/templates/directorate-of-immigration/citizenship/src/lib/.../CitizenshipTemplate.ts Modified pruneAfterDays value from 1 to 30 in the lifecycle property of the template constant, extending the duration before pruning.

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.

@berglindoma13 berglindoma13 added the automerge Merge this PR as soon as all checks pass label Sep 3, 2024
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f1a362 and 8e3e5ff.

Files selected for processing (3)
  • libs/application/template-api-modules/src/lib/modules/templates/directorate-of-immigration/citizenship/citizenship.service.ts (1 hunks)
  • libs/application/templates/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/PersonalSection/UserInformationSubSection.ts (1 hunks)
  • libs/application/templates/directorate-of-immigration/citizenship/src/lib/CitizenshipTemplate.ts (1 hunks)
Additional context used
Path-based instructions (3)
libs/application/templates/directorate-of-immigration/citizenship/src/lib/CitizenshipTemplate.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/forms/CitizenshipForm/PersonalSection/UserInformationSubSection.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/template-api-modules/src/lib/modules/templates/directorate-of-immigration/citizenship/citizenship.service.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/directorate-of-immigration/citizenship/src/lib/CitizenshipTemplate.ts (1)

123-123: Verify the implications of extending the application's active duration.

The change significantly increases the duration for which the application remains active before being pruned, from 1 day to 30 days. This could impact:

  • Data retention
  • Lifecycle management
  • User experience
  • System resources

Please confirm that the implications of this change have been carefully considered and validated, especially in terms of:

  • Compliance with data retention policies
  • Handling of stale or outdated applications
  • User notifications and experience when returning to older applications
  • Increased storage and processing requirements

Provide evidence that these aspects have been thoroughly tested and potential risks have been mitigated.

libs/application/templates/directorate-of-immigration/citizenship/src/forms/CitizenshipForm/PersonalSection/UserInformationSubSection.ts (1)

61-61: LGTM!

The change simplifies the logic by directly utilizing the fullName property instead of constructing the name from separate fields. This enhances consistency and reduces potential errors related to name formatting.

The code adheres to the reusability and TypeScript usage guidelines.

libs/application/template-api-modules/src/lib/modules/templates/directorate-of-immigration/citizenship/citizenship.service.ts (1)

309-313: Verify the assumption for deriving givenName and familyName.

The current logic assumes that the last segment of fullName is always the family name. However, this may not hold true for all naming conventions.

Please ensure that this assumption is valid for the expected user base of the application.

Additionally, consider adding a null check before accessing individual.fullName to prevent potential errors:

- individual?.fullName.split(' ').slice(0, -1).join(' ')
+ individual?.fullName?.split(' ').slice(0, -1).join(' ')
- individual?.fullName.split(' ').pop()
+ individual?.fullName?.split(' ').pop()  

Copy link

codecov bot commented Sep 3, 2024

Codecov Report

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

Project coverage is 36.93%. Comparing base (2ff3afd) to head (f62d1dc).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...-of-immigration/citizenship/citizenship.service.ts 0.00% 3 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15865      +/-   ##
==========================================
- Coverage   36.93%   36.93%   -0.01%     
==========================================
  Files        6681     6681              
  Lines      136449   136450       +1     
  Branches    38745    38746       +1     
==========================================
  Hits        50399    50399              
- Misses      86050    86051       +1     
Flag Coverage Δ
api 3.39% <ø> (ø)
application-system-api 41.75% <0.00%> (-0.01%) ⬇️
application-template-api-modules 23.66% <0.00%> (-0.01%) ⬇️
application-ui-shell 21.17% <ø> (ø)
judicial-system-web 28.78% <ø> (ø)

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

Files with missing lines Coverage Δ
...gration/citizenship/src/lib/CitizenshipTemplate.ts 54.54% <ø> (ø)
...-of-immigration/citizenship/citizenship.service.ts 8.23% <0.00%> (-0.05%) ⬇️

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 2ff3afd...f62d1dc. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

All test runs e88d14b 🔗

4 Total Test Services: 0 Failed, 4 Passed
➡️ Test Sessions change in coverage: 8 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.58s 1 no change Link
application-system-api 0 0 0 111 2 3m 14.42s 1 no change Link
application-template-api-modules 0 0 0 109 0 1m 44.38s 1 no change Link
application-ui-shell 0 0 0 74 0 32.68s 1 no change Link

@kodiakhq kodiakhq bot merged commit 9a67d75 into main Sep 3, 2024
44 checks passed
@kodiakhq kodiakhq bot deleted the fix/citizenship-prod-error branch September 3, 2024 11:36
jonnigs pushed a commit that referenced this pull request Sep 12, 2024
* fixed name error and prune date for draft

* fixed name error and prune date for draft

---------

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