fix(fa): direct payments making code more readable

[MargretFinnboga]

...

Attach a link to issue if relevant

What

• Trying to fix direct payments

Why

• Direct payments is just appearing for spouse or applicant

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

• Bug Fixes
  • Improved error handling during application creation for clearer error messages.
• Refactor
  • Enhanced readability of the direct tax payments logic by using a spread operator for array combination.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the FinancialAidService class within the financial-aid.service.ts file. Key changes include a refactoring of the directTaxPayments method to utilize the spread operator for combining arrays, enhancing code readability. Additionally, the error handling in the createApplication method has been improved to throw specific TemplateApiError messages during application creation errors. Other methods remain largely unchanged but benefit from the updated error handling. The overall functionality of the service is preserved.

Changes

File	Change Summary
libs/application/template-api-modules/src/lib/modules/templates/financial-aid/financial-aid.service.ts	Refactored directTaxPayments method to use spread operator for array concatenation; improved error handling in createApplication method while keeping overall logic intact.

Possibly related PRs

• fix(fa): fixing direct payments and imports #15332: This PR modifies the directTaxPayments function in the financial-aid.service.ts file, which is directly related to the changes made in the main PR regarding the logic for combining direct tax payments.
• fix(financial-adi): use account number and ledger when sending bank info #16599: This PR also makes changes to the financial-aid.service.ts file, specifically updating the directTaxPayments function to ensure it concatenates direct tax payments from both the applicant and spouse, which aligns with the refactoring done in the main PR.

Suggested labels

automerge, high priority

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

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

Project coverage is 36.71%. Comparing base (0947e07) to head (a6f2eff).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
...s/templates/financial-aid/financial-aid.service.ts	0.00%	10 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #16657   +/-   ##
=======================================
  Coverage   36.71%   36.71%           
=======================================
  Files        6858     6858           
  Lines      142638   142638           
  Branches    40639    40638    -1     
=======================================
  Hits        52365    52365           
  Misses      90273    90273           

Flag	Coverage Δ
api	3.37% <ø> (ø)
application-system-api	41.31% <0.00%> (ø)
application-template-api-modules	27.77% <0.00%> (-0.02%)	⬇️

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

Files with missing lines	Coverage Δ
...s/templates/financial-aid/financial-aid.service.ts	12.00% <0.00%> (ø)

---

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 0947e07...a6f2eff. Read the comment docs.

[datadog-island-is]

Datadog Report

All test runs f334978 🔗

✅ 3 Total Test Services: 0 Failed, 3 Passed
➡️ Test Sessions change in coverage: 5 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.36s	1 no change	Link
application-system-api	0	0	0	120	2	3m 22.44s	1 no change	Link
application-template-api-modules	0	0	0	123	0	2m 7.47s	1 no change	Link

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

libs/application/template-api-modules/src/lib/modules/templates/financial-aid/financial-aid.service.ts (1)

152-164: LGTM! Consider enhancing type safety.

The refactoring to use the spread operator improves code readability while maintaining functionality. The null checks with optional chaining are properly implemented.

Consider adding explicit type annotations for better type safety:

-      const combinedTaxPayments = [
+      const combinedTaxPayments: DirectTaxPayment[] = [
         ...(externalDataSchema?.taxData?.data?.municipalitiesDirectTaxPayments
           ?.directTaxPayments || []),
         ...(externalDataSchema?.taxDataSpouse?.data
           ?.municipalitiesDirectTaxPayments?.directTaxPayments || []),
       ]

-      return combinedTaxPayments.map((d) => {
+      return combinedTaxPayments.map((d: DirectTaxPayment) => {
         d.userType = application.assignees.includes(auth.nationalId)
           ? UserType.SPOUSE
           : UserType.APPLICANT
         return d
       })

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a40250f and a6f2eff.

📒 Files selected for processing (1)

• libs/application/template-api-modules/src/lib/modules/templates/financial-aid/financial-aid.service.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

libs/application/template-api-modules/src/lib/modules/templates/financial-aid/financial-aid.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."