feat(user-notifications): Send notificationId in push notifications

[eirikurn]

What

Add notificationId (database id) to push message data.

Why

So the notification can be easily marked as read/seen when the user taps on the push notification.

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

  • Introduced an optional notificationId parameter for more granular control in notification dispatching.
  • Enhanced notification handling to improve traceability by linking notifications to their respective IDs.

• Bug Fixes

  • Improved test coverage to ensure correct message storage and notification sending behavior.

• Documentation

  • Updated service specifications to reflect the new notification handling capabilities and parameters.

[coderabbitai]

Walkthrough

The changes involve the enhancement of the notification dispatching process within the NotificationDispatchService and NotificationsWorkerService. An optional notificationId parameter has been added to key methods, allowing for improved identification and management of notifications. Additionally, the test coverage for the NotificationsWorkerService has been expanded to verify database interactions and the correct handling of notifications, including the new identifier.

Changes

Files	Change Summary
apps/services/user-notification/src/app/modules/notifications/notificationDispatch.service.ts	Added an optional notificationId parameter to dispatchNotification and sendNotificationToToken methods for improved notification management.
apps/services/user-notification/src/app/modules/notifications/notificationsWorker/notificationsWorker.service.ts	Introduced an optional notificationId property in the HandleNotification type and updated the handleDocumentNotification method accordingly.
apps/services/user-notification/src/app/modules/notifications/notificationsWorker/notificationsWorker.service.spec.ts	Enhanced test coverage to verify database message storage and push notification sending, including checks for notificationId.

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.

[datadog-island-is]

Datadog Report

All test runs f133ddf 🔗

✅ 101 Total Test Services: 0 Failed, 99 Passed
🔻 Test Sessions change in coverage: 3 decreased, 3 increased, 194 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	81	0	31.34s	N/A	Link
air-discount-scheme-web	0	0	0	2	0	9.04s	1 no change	Link
api	0	0	0	4	0	2.66s	N/A	Link
api-catalogue-services	0	0	0	23	0	10.97s	N/A	Link
api-domains-air-discount-scheme	0	0	0	6	0	18.08s	N/A	Link
api-domains-assets	0	0	0	3	0	11.42s	1 no change	Link
api-domains-auth-admin	0	0	0	18	0	12.2s	1 no change	Link
api-domains-communications	0	0	0	5	0	31.89s	N/A	Link
api-domains-criminal-record	0	0	0	5	0	9.2s	1 no change	Link
api-domains-driving-license	0	0	0	23	0	34.73s	N/A	Link

🔻 Code Coverage Decreases vs Default Branch (3)

• application-core - jest 79.15% (-0.41%) - Details
• services-auth-delegation-api - jest 60.03% (-0.26%) - Details
• services-auth-admin-api - jest 52.85% (-0.02%) - Details

[codecov]

Codecov Report

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

Project coverage is 36.81%. Comparing base (46a5b69) to head (ffc6751).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ules/notifications/notificationDispatch.service.ts	0.00%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #15962   +/-   ##
=======================================
  Coverage   36.81%   36.81%           
=======================================
  Files        6721     6721           
  Lines      137868   137870    +2     
  Branches    39195    39198    +3     
=======================================
+ Hits        50753    50756    +3     
+ Misses      87115    87114    -1     

Flag	Coverage Δ
air-discount-scheme-backend	54.07% <ø> (ø)
air-discount-scheme-web	0.00% <ø> (ø)
api	3.39% <ø> (ø)
api-catalogue-services	77.85% <ø> (ø)
api-domains-air-discount-scheme	36.85% <ø> (ø)
api-domains-assets	26.71% <ø> (ø)
api-domains-auth-admin	49.89% <ø> (ø)
api-domains-communications	40.42% <ø> (ø)
api-domains-criminal-record	47.77% <ø> (ø)
api-domains-driving-license	44.27% <ø> (ø)
api-domains-education	31.22% <ø> (ø)
api-domains-health-insurance	34.58% <ø> (ø)
api-domains-mortgage-certificate	35.73% <ø> (ø)
api-domains-payment-schedule	41.14% <ø> (ø)
application-api-files	57.46% <ø> (ø)
application-core	71.58% <ø> (-0.67%)	⬇️
application-system-api	41.67% <ø> (ø)
application-template-api-modules	23.46% <ø> (ø)
application-templates-accident-notification	22.26% <ø> (ø)
application-templates-car-recycling	3.12% <ø> (ø)
application-templates-criminal-record	26.96% <ø> (ø)
application-templates-driving-license	18.75% <ø> (ø)
application-templates-estate	12.55% <ø> (ø)
application-templates-example-payment	25.72% <ø> (ø)
application-templates-financial-aid	14.39% <ø> (ø)
application-templates-general-petition	23.95% <ø> (ø)
application-templates-health-insurance	26.88% <ø> (ø)
application-templates-inheritance-report	6.45% <ø> (ø)
application-templates-marriage-conditions	15.35% <ø> (ø)
application-templates-mortgage-certificate	44.15% <ø> (ø)
application-templates-parental-leave	29.31% <ø> (ø)
application-types	6.74% <ø> (ø)
application-ui-components	1.52% <ø> (ø)
application-ui-shell	21.74% <ø> (ø)
auth-admin-web	2.43% <ø> (ø)
auth-nest-tools	30.83% <ø> (ø)
auth-react	22.82% <ø> (ø)
auth-shared	75.00% <ø> (ø)
clients-charge-fjs-v2	24.11% <ø> (ø)
clients-driving-license	40.56% <ø> (ø)
clients-driving-license-book	43.85% <ø> (ø)
clients-financial-statements-inao	49.10% <ø> (ø)
clients-license-client	1.83% <ø> (ø)
clients-middlewares	72.83% <ø> (+0.34%)	⬆️
clients-regulations	42.54% <ø> (ø)
clients-rsk-company-registry	29.76% <ø> (ø)
clients-rsk-personal-tax-return	38.00% <ø> (ø)
clients-smartsolutions	12.77% <ø> (ø)
clients-syslumenn	49.75% <ø> (ø)
clients-zendesk	55.65% <ø> (ø)
cms	0.42% <ø> (ø)
cms-translations	39.57% <ø> (ø)
content-search-index-manager	95.65% <ø> (ø)
content-search-toolkit	8.50% <ø> (ø)
contentful-apps	5.76% <ø> (ø)
dokobit-signing	62.85% <ø> (ø)
download-service	44.55% <ø> (ø)
email-service	60.65% <ø> (ø)
feature-flags	90.69% <ø> (ø)
file-storage	53.01% <ø> (ø)
financial-aid-backend	56.52% <ø> (ø)
financial-aid-shared	19.03% <ø> (ø)
icelandic-names-registry-backend	54.64% <ø> (ø)
infra-nest-server	48.95% <ø> (ø)
infra-tracing	43.24% <ø> (ø)
island-ui-core	28.59% <ø> (ø)
judicial-system-api	19.35% <ø> (ø)
judicial-system-audit-trail	68.53% <ø> (ø)
judicial-system-backend	55.72% <ø> (ø)
judicial-system-formatters	79.83% <ø> (ø)
judicial-system-message	66.79% <ø> (ø)
judicial-system-message-handler	47.61% <ø> (ø)
judicial-system-scheduler	68.98% <ø> (ø)
judicial-system-types	48.34% <ø> (ø)
judicial-system-web	28.71% <ø> (ø)
license-api	42.84% <ø> (+0.07%)	⬆️
localization	10.15% <ø> (ø)
logging	48.43% <ø> (ø)
message-queue	68.50% <ø> (+0.78%)	⬆️
nest-audit	68.20% <ø> (ø)
nest-config	78.07% <ø> (ø)
nest-feature-flags	51.91% <ø> (ø)
nest-problem	46.48% <ø> (ø)
nest-sequelize	94.44% <ø> (ø)
nest-swagger	51.71% <ø> (ø)
nova-sms	62.18% <ø> (ø)
portals-admin-regulations-admin	1.96% <ø> (ø)
portals-core	16.14% <ø> (ø)
reference-backend	50.57% <ø> (ø)
regulations	16.78% <ø> (ø)
residence-history	85.00% <ø> (ø)
services-auth-admin-api	52.79% <ø> (-0.04%)	⬇️
services-auth-delegation-api	61.31% <ø> (-0.08%)	⬇️
services-auth-ids-api	54.03% <ø> (ø)
services-auth-personal-representative	47.98% <ø> (ø)
services-auth-personal-representative-public	43.90% <ø> (ø)
services-auth-public-api	51.81% <ø> (ø)
services-documents	61.26% <ø> (ø)
services-endorsements-api	54.98% <ø> (ø)
services-sessions	65.79% <ø> (ø)
services-university-gateway	48.39% <ø> (ø)
services-user-notification	47.61% <62.50%> (+<0.01%)	⬆️
services-user-profile	62.26% <ø> (ø)
shared-components	27.65% <ø> (ø)
shared-form-fields	31.58% <ø> (ø)
shared-mocking	64.62% <ø> (ø)
shared-pii	92.85% <ø> (ø)
shared-problem	87.50% <ø> (ø)
shared-utils	29.26% <ø> (ø)
skilavottord-ws	24.34% <ø> (ø)
web	1.84% <ø> (ø)

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

Files with missing lines	Coverage Δ
...notificationsWorker/notificationsWorker.service.ts	94.83% <100.00%> (+0.03%)	⬆️
...ules/notifications/notificationDispatch.service.ts	12.32% <0.00%> (-0.18%)	⬇️

... 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 46a5b69...ffc6751. Read the comment docs.

[saevarma]

🚀