Support for sending of email notification to known email address

[SandGrainOne]

Notification: Send email

This epic collects all issues related to the initial development of a notification system. It should be able to take an order to send an email notification to a provided email address. Included in this work we also will need to create the base infrastructure and architecture for additional services related to notifications.

Considerations

Why don't the clients post directly to Kafka? As we know we will need authorization and authentication as well as some confirmation that the receipient is someone we can reach (at the moment of the creating the notification) we would need a library with all this logic bundled in. As we would have to provide libraries in different programming languages we believe a better approach is to provide an API with this functionality what we control and can modify as we see fit, in a single programming language.

Deployment checklist

• Create domains for communication services
• Connect domain to communication services
• Ensure alerts for notifications and notifications email are deployed

Kafka service

The Kafka service being added to platform should be accessible for any use by any platform application. In other words, not restricted to Notification.

Tasks

Beta Give feedback

1. Learn Kafka #168
   +0
2. Analysis: Determine how we would like Kafka to be hosted. (Include hardening) #167
   kind/analysis +1
   
3. Define necessary topics and access control (ACL) #177
   +0
4. Write necessary infrastructure code to setup a Kafka service #155
   +0
   
5. Improve kafka config for topics and consumers #319
   kind/chore +1
   
6. Deploy Kafka service for TT02 and production #284
   area/infrastructure kind/chore +2
   
7. Add topic to rights list for producer and consumer roles in Kafka #316
   kind/user-story +1
   

Notifications micro service

This application should be the core part and access point for the Notification system. Primary objective is to take notification orders and provide endpoints for accessing stored notifications and their statuses. The API should have endpoints for both external and internal (within notifications) systems.

Tasks

Beta Give feedback

1. Consider whether the component should follow the platform standard of daemonsets #106
   kind/user-story +1
2. Set up API management #107
   kind/user-story +1
   
3. Write necessary infrastructure code to setup required services (PostgreSQL) #156
   kind/user-story +1
   
4. Clean up the existing Notification solution #161
   kind/user-story +1
   
5. Create release pipelines for notification application in Azure DevOps. #62
   kind/user-story +1
   
6. Set up alert for increased number of 500 errors #175
   kind/chore +1
7. Define the domain models #163
   kind/user-story +1
   
8. Endpoint for Posting a notification order (publish event for immediate sending) #164
   kind/user-story +1
   
9. Implement service for picking up past due notifications and processing them #185
   kind/user-story +1
   
10. Implement trigger for internal tasks as k8s CronJob #193
    kind/user-story +1
    
11. Implement retry mechanism for failed order processing #194
    +0
    
12. Endpoints for retrieving order by id or senders reference #197
    kind/user-story +1
    
13. Set up health checks confirming Kakfa connectivity as producer #160
    kind/user-story +1
14. Make from address optional, use default noreply@altinn.cloud/no #246
    +0
    
15. Update KafkaProducer to return false instead of throwing an exception. Create alert rules to detect cases #245
    +0
    
16. Create order should return an object serialized to JSON #247
    +0
    
17. App logic to update notification status based on an event #166
    kind/user-story +1
    
18. Endpoint for retrieving a specific notification order with status etc #165
    kind/user-story +1
    
19. Hide the from address field from the email notification order endpoint #264
    +0
20. Adjust procedure for past due orders to retrieve element with sendtime in the near future as well #262
    kind/user-story up-for-grabs +2
    
21. Fine tuning of database resources and sql #253
    +0
    
22. Authorization requirements for different aspects of the notification system #8
    kind/user-story +1
23. General exceptions not in a http request context are not picked up by any alerts. E.g. logged by kafkaconsumer #268
    kind/chore +1
24. Register scopes and delegation schemes to access notifications #265
    9 of 9
    kind/chore +1
    
25. Use case testing in production. Authentication as an ORG. #266
    kind/chore +1
26. Endpoint for listing generated notifications with results #267
    kind/user-story +1
    
27. Validation of email address. Use the same regex as in Altinn 2 as a start
28. Enable use case for remaining at envs, tt, and prod
29. Ensure alert rules (AKS) are deployed to all environments

Send email notification service

Tasks

Beta Give feedback

1. Analysis: Investigate which email service the notification component should use #108
   kind/analysis +1
   
2. Write necessary infrastructure code to setup an Azure Communication Services service #150
   kind/user-story +1
   
3. Create a new code projects for the new email microservice #151
   kind/user-story +1
   
4. App logic to send an email based on an event. Publish end result as an event. #152
   kind/user-story +1
   
5. Set up health checks confirming Kakfa connectivity as producer #160
   kind/user-story +1
6. Analysis: How to handle potential duplicate reading of a notification from Kafka #158
   kind/analysis +1
7. Analysis: Monitoring of Communication services #154
   kind/analysis +1
8. Analysis: retry mechanism for the Kafka consumer #159
   +0
9. Implement support for reporting back on invalid recipient address altinn-notifications-email#25
   kind/user-story +1
10. Analysis: Can we continue with Communication Services? #261
    +0
    
11. Broker: Unknown member altinn-notifications-email#33
    kind/bug +1
12. Implement retry logic for intermittent errors in communication with Communication Services. #153
    kind/analysis +1
    

Onboarding

Issues related to onboarding of existing users of the Altinn 2 notification system over to the new service

Tasks

Beta Give feedback

1. What is persisted of notifications in Altinn 2 #276
   kind/analysis +1
   
2. Update LocalTest with the notification features introduced for sending email #239
   kind/user-story +1

Obsolete sketch

[SandGrainOne]

All related issues and tasks have been completed.