feat(delegation-api): add legal guardian minor delegation type #15214
Conversation
… when child is under 16.
WalkthroughThe recent changes introduce functionality to handle legal guardianship delegations for minors under 16 and 18 years old. This involves new test scenarios, additional utility functions for age calculations, updated type definitions, and new database migration scripts. The modification includes both backend logic to support the new delegation type and frontend message definitions for better client communication. Changes
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (15)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index-test-cases.ts (7 hunks)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts (2 hunks)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.service.spec.ts (4 hunks)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegations-index-types.ts (3 hunks)
- apps/services/auth/delegation-api/src/app/delegations/test/delegations-controller/delegations.controller.test-cases.ts (1 hunks)
- libs/api/domains/auth/src/lib/models/delegation.model.ts (2 hunks)
- libs/auth-api-lib/migrations/20240607093733-add-legal-guardian-minor-delegation-type.js (1 hunks)
- libs/auth-api-lib/src/index.ts (1 hunks)
- libs/auth-api-lib/src/lib/delegations/delegations-incoming-ward.service.ts (3 hunks)
- libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts (5 hunks)
- libs/auth-api-lib/src/lib/delegations/utils/delegations.ts (1 hunks)
- libs/auth-api-lib/src/lib/delegations/utils/getXBirthday.ts (1 hunks)
- libs/auth-api-lib/src/lib/delegations/utils/isUnderXAge.ts (1 hunks)
- libs/portals/admin/ids-admin/src/lib/messages.ts (2 hunks)
- libs/shared/types/src/lib/delegation.ts (1 hunks)
Files skipped from review due to trivial changes (2)
- libs/auth-api-lib/src/index.ts
- libs/shared/types/src/lib/delegation.ts
Additional context used
Path-based instructions (13)
libs/auth-api-lib/src/lib/delegations/utils/isUnderXAge.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/auth-api-lib/migrations/20240607093733-add-legal-guardian-minor-delegation-type.js (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/auth-api-lib/src/lib/delegations/utils/getXBirthday.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/auth-api-lib/src/lib/delegations/utils/delegations.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/api/domains/auth/src/lib/models/delegation.model.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/auth-api-lib/src/lib/delegations/delegations-incoming-ward.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."
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegations-index-types.ts (2)
Pattern
apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern
apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index-test-cases.ts (2)
Pattern
apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern
apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
apps/services/auth/delegation-api/src/app/delegations/test/delegations-controller/delegations.controller.test-cases.ts (2)
Pattern
apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern
apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts (2)
Pattern
apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern
apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
libs/auth-api-lib/src/lib/delegations/delegations-index.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."
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.service.spec.ts (2)
Pattern
apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern
apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
libs/portals/admin/ids-admin/src/lib/messages.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."
Biome
libs/auth-api-lib/migrations/20240607093733-add-legal-guardian-minor-delegation-type.js
[error] 1-1: Redundant use strict directive. (lint/suspicious/noRedundantUseStrict)
The entire contents of JavaScript modules are automatically in strict mode, with no statement needed to initiate it.
Safe fix: Remove the redundant use strict directive.libs/auth-api-lib/src/lib/delegations/delegations-incoming-ward.service.ts
[error] 19-19: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts
[error] 128-128: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.
[error] 130-130: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.
[error] 132-132: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.
[error] 208-209: Change to an optional chain. (lint/complexity/useOptionalChain)
Unsafe fix: Change to an optional chain.
[error] 467-467: Avoid the use of spread (
...) syntax on accumulators. (lint/performance/noAccumulatingSpread)Spread syntax should be avoided on accumulators (like those in
.reduce) because it causes a time complexity ofO(n^2).
Consider methods such as .splice or .push instead.
GitHub Check: linting (services-auth-admin-api,services-auth-delegation-api,services-auth-ids-api,services-auth...
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts
[warning] 17-17:
'child2' is defined but never used. Allowed unused vars must match /^_[a-zA-Z0-9]*$/u
[warning] 447-447:
Found valid SSN: 2101188290
Additional comments not posted (21)
libs/auth-api-lib/src/lib/delegations/utils/isUnderXAge.ts (1)
4-18: The functionisUnderXAgeeffectively calculates whether a person is under a specified age based on their national ID. This function uses thekennitalalibrary to extract the birth date and then calculates if the current date is before the birthday after adding the specified number of years. The logic appears sound and well-implemented.libs/auth-api-lib/migrations/20240607093733-add-legal-guardian-minor-delegation-type.js (1)
6-7: Ensure that theidfield in theINSERTstatement is unique and correctly references the intendeddelegation_type. Also, the fieldprovidershould be verified to ensure it matches the expected values in the database schema.libs/auth-api-lib/src/lib/delegations/utils/getXBirthday.ts (1)
5-24: The functiongetXBirthdaycorrectly calculates the birthday when a person turns a specific age. The use ofstartOfDayandisBeforefromdate-fnsensures that the time component is correctly handled. The logic to returnnullif the person has already passed this age is a good safeguard.
[APROVED]libs/auth-api-lib/src/lib/delegations/utils/delegations.ts (1)
17-20: AddingAuthDelegationType.LegalGuardianMinorto thedelegationProviderTypeMapforAuthDelegationProvider.NationalRegistryis a necessary update to support the new delegation type. Ensure that all systems using this map handle the new type correctly.libs/api/domains/auth/src/lib/models/delegation.model.ts (2)
29-30: Correct implementation of theresolveTypemethod for the newLegalGuardianMinordelegation type.
64-67: Proper definition ofLegalGuardianMinorDelegationclass with correct usage of the@ObjectTypedecorator.libs/auth-api-lib/src/lib/delegations/delegations-incoming-ward.service.ts (2)
14-14: Correct import ofisUnderXAgeutility function, essential for the new delegation logic.
Line range hint
53-75: Well-implemented logic for filtering legal guardian delegations, both for minors under 18 and specifically under 16, using theisUnderXAgeutility.apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegations-index-types.ts (2)
11-11: Proper import ofAuthDelegationTypefor use in test cases.
32-32: Correctly updatedTestCaseclass to include delegation types in theexpectedFromfield, aligning with the new functionality tests.Also applies to: 46-46
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index-test-cases.ts (2)
1-3: Correct import of necessary modules and definition of constants for generating dynamic test data.Also applies to: 11-11
16-31: Well-structured test cases that correctly handle different age groups for testing various delegation types, ensuring comprehensive coverage.Also applies to: 45-63, 76-97
apps/services/auth/delegation-api/src/app/delegations/test/delegations-controller/delegations.controller.test-cases.ts (1)
17-17: Confirm the updated national ID type forchild1.libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts (2)
38-39: Confirm the addition of utility imports for handling age calculations.
263-278: Review the logic for handling legal guardian minor delegations. Ensure that the conditions and calculations forvalidTodates are correct and optimized.Verification successful
The logic for handling legal guardian minor delegations and the conditions and calculations for
validTodates are correct and optimized.
- The
getXBirthdayfunction is appropriately used to setvalidTodates based on age.- The
isUnderXAgefunction is correctly used to check if a child is under a certain age.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correct application of age-related utility functions in minor delegation handling. # Test: Search for the usage of `getXBirthday` and `isUnderXAge` in the context of minor delegations. Expect: Correct and optimized usage. rg --type typescript $'getXBirthday|isUnderXAge' ./libs/auth-api-lib/src/lib/delegations/Length of output: 125
Script:
#!/bin/bash # Description: Verify the correct application of age-related utility functions in minor delegation handling. # Test: Search for the usage of `getXBirthday` and `isUnderXAge` in the context of minor delegations. Expect: Correct and optimized usage. rg --type ts 'getXBirthday|isUnderXAge' ./libs/auth-api-lib/src/lib/delegations/Length of output: 1686
apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.service.spec.ts (4)
27-31: Ensure that the new imports and constants are properly utilized in the tests.
211-216: Verify that the delegation records match the expected outputs in the test cases.
450-455: Confirm that the custom delegation indexing logic accurately reflects the expected delegation records.
487-493: Ensure that personal representative delegations are indexed correctly, especially with the new delegation type handling.libs/portals/admin/ids-admin/src/lib/messages.ts (2)
900-907: The new message definitions for the client delegation type 'Legal Guardian Minor' are clear and align well with the application's context.
967-975: The message definitions for the API scope delegation type 'Legal Guardian Minor' are consistent and provide clear information on the scope of the delegation.
libs/auth-api-lib/migrations/20240607093733-add-legal-guardian-minor-delegation-type.js
Show resolved
Hide resolved
...delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts
Outdated
Show resolved
Hide resolved
...delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts
Outdated
Show resolved
Hide resolved
…if some delegation fail
Datadog ReportAll test runs ✅ 81 Total Test Services: 0 Failed, 79 Passed Test ServicesThis report shows up to 10 services
🔻 Code Coverage Decreases vs Default Branch (6)
|
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts (3)
38-39: ### Ensure proper encapsulation of utility functions
The utility functionsgetXBirthdayandisUnderXAgeare imported here. Given their potential reuse across various modules, consider encapsulating these functions within a more generic utility service or class, which could then be injected as needed. This would enhance modularity and maintainability.
Line range hint
326-355: ### Handle promise rejections properly in bulk operations
The use ofPromise.allSettledis appropriate for handling multiple asynchronous operations concurrently. However, the error handling in lines 351-355 only logs the error. Consider enhancing the error handling strategy by possibly retrying failed operations or alerting through an external monitoring service. This would improve the robustness of the indexing process.+ try { + // Retry logic or alerting mechanism + } catch (error) { + console.error('Failed operation:', error) + }
Line range hint
475-475: ### Optimize the use of the spread operator in accumulators
The use of the spread operator in the accumulator of the.reducemethod can lead to performance issues due to itsO(n^2)complexity. Consider using alternative methods like.pushto accumulate items.- acc.created.push(curr) + acc.created = [...acc.created, curr]
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (4)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts (1 hunks)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.service.spec.ts (6 hunks)
- libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts (8 hunks)
- libs/auth-api-lib/src/lib/delegations/utils/getXBirthday.ts (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.controller.spec.ts
- apps/services/auth/delegation-api/src/app/delegations/test/delegation-index/delegation-index.service.spec.ts
- libs/auth-api-lib/src/lib/delegations/utils/getXBirthday.ts
Additional context used
Path-based instructions (1)
libs/auth-api-lib/src/lib/delegations/delegations-index.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."
Biome
libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts
[error] 128-128: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.
[error] 130-130: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.
[error] 132-132: Decorators are not valid here. (parse)
Decorators are only valid on class declarations, class expressions, and class methods.
You can enable parameter decorators by setting theunsafeParameterDecoratorsEnabledoption totruein your configuration file.
[error] 208-209: Change to an optional chain. (lint/complexity/useOptionalChain)
Unsafe fix: Change to an optional chain.
[error] 475-475: Avoid the use of spread (
...) syntax on accumulators. (lint/performance/noAccumulatingSpread)Spread syntax should be avoided on accumulators (like those in
.reduce) because it causes a time complexity ofO(n^2).
Consider methods such as .splice or .push instead.
Additional comments not posted (1)
libs/auth-api-lib/src/lib/delegations/delegations-index.service.ts (1)
263-279: ### Review logic for handlingLegalGuardiandelegations
The conditional block handlingLegalGuardiandelegations seems to correctly implement the business logic as per the requirements. However, there's a potential improvement in how thevalidTodate is set. It's currently being recalculated every time, which could be optimized by caching the result if the calculation is expensive.Additionally, ensure that the
upsertoperation in line 273 is correctly handling edge cases, such as concurrent updates that might lead to race conditions.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- libs/portals/admin/ids-admin/src/lib/messages.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- libs/portals/admin/ids-admin/src/lib/messages.ts
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- scripts/ci/cache/__config.mjs (2 hunks)
Files skipped from review due to trivial changes (1)
- scripts/ci/cache/__config.mjs
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
apps/services/auth/ids-api/src/app/delegations/delegations.controller.spec.ts (1)
Line range hint
238-383: Eliminate duplicate setup and teardown hooks to streamline test execution.The static analysis has flagged multiple instances where
beforeAllandafterAllhooks are duplicated within thedescribefunctions. This redundancy can lead to increased setup/teardown times and can make the tests harder to maintain. Consider refactoring these to eliminate duplication, potentially by moving shared setup and teardown logic to higher-leveldescribeblocks or into helper functions.Also applies to: 385-405, 584-602, 604-623, 736-881, 883-903, 1085-1106, 1108-1127
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- apps/services/auth/ids-api/src/app/delegations/delegations.controller.spec.ts (1 hunks)
Files not summarized due to errors (1)
- apps/services/auth/ids-api/src/app/delegations/delegations.controller.spec.ts: Error: Server error. Please try again later.
Additional context used
Path-based instructions (1)
apps/services/auth/ids-api/src/app/delegations/delegations.controller.spec.ts (2)
Pattern
apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern
apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
Biome
apps/services/auth/ids-api/src/app/delegations/delegations.controller.spec.ts
[error] 238-383: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow beforeAll duplicacy inside the describe function.
[error] 385-405: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow afterAll duplicacy inside the describe function.
[error] 584-602: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow beforeAll duplicacy inside the describe function.
[error] 604-623: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow afterAll duplicacy inside the describe function.
[error] 736-881: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow beforeAll duplicacy inside the describe function.
[error] 883-903: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow afterAll duplicacy inside the describe function.
[error] 1085-1106: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow beforeAll duplicacy inside the describe function.
[error] 1108-1127: Disallow duplicate setup and teardown hooks. (lint/suspicious/noDuplicateTestHooks)
Disallow afterAll duplicacy inside the describe function.
Additional comments not posted (1)
apps/services/auth/ids-api/src/app/delegations/delegations.controller.spec.ts (1)
1260-1264: Ensure consistent delegation type claims.The test checks for delegation types
CustomandLegalGuardian, but given the PR's focus on introducing a new delegation type for legal guardians of minors, it's crucial to verify thatLegalGuardianMinoris also considered where applicable. Please confirm if this new type should be included in the test assertions here.
Datadog ReportAll test runs ✅ 81 Total Test Services: 0 Failed, 78 Passed Test ServicesThis report shows up to 10 services
🔻 Code Coverage Decreases vs Default Branch (2) |
GunnlaugurG
added
the
deprecated:automerge
kodiakhq
bot
deleted the
feature/add-legal-guardian-minor-delegation-type
branch
What
Add a new delegation type for legal guardians of minors under 16.
Why
Certain scopes like Postholf should not be accessible by parents if child has turned 16.
Checklist:
Summary by CodeRabbit
New Features
LegalGuardianMinor, for handling legal guardian delegations for minors under 16 years old.Improvements
Bug Fixes
Chores