add support for websocket notifications

Author: fupelaqu

api/src/main/scala/app/softnetwork/notification/api/AllNotificationsApi.scala

@@ -2,7 +2,7 @@ package app.softnetwork.notification.api
 
 import akka.actor.typed.ActorSystem
 import app.softnetwork.notification.handlers.AllNotificationsHandler
-import app.softnetwork.notification.launch.NotificationApplication
+import app.softnetwork.notification.launch.{NotificationApplication, NotificationRoutes}
 import app.softnetwork.notification.model.Notification
 import app.softnetwork.notification.persistence.query.{
   NotificationCommandProcessorStream,
@@ -17,7 +17,9 @@ import app.softnetwork.persistence.schema.SchemaProvider
 import app.softnetwork.scheduler.config.SchedulerSettings
 import com.typesafe.config.Config
 
-trait AllNotificationsApi extends NotificationApplication[Notification] { _: SchemaProvider =>
+trait AllNotificationsApi
+    extends NotificationApplication[Notification]
+    with NotificationRoutes[Notification] { _: SchemaProvider =>
 
   override def notificationBehaviors: ActorSystem[_] => Seq[NotificationBehavior[Notification]] =
     _ => Seq(AllNotificationsBehavior)

api/src/main/scala/app/softnetwork/notification/api/AllNotificationsPostgresLauncher.scala

@@ -12,6 +12,4 @@ object AllNotificationsPostgresLauncher extends AllNotificationsApi with JdbcSch
 
   override def schemaType: SchemaType = JdbcSchemaTypes.Postgres
 
-  override def apiRoutes: ActorSystem[_] => List[ApiRoute] = _ => List.empty
-
 }

build.sbt

@@ -2,7 +2,7 @@ ThisBuild / organization := "app.softnetwork"
 
 name := "notification"
 
-ThisBuild / version := "0.7.0"
+ThisBuild / version := "0.8.0-SNAPSHOT"
 
 ThisBuild / scalaVersion := "2.12.18"
 
@@ -24,7 +24,9 @@ val scalatest = Seq(
 
 ThisBuild / libraryDependencies ++= Seq(
   "com.thesamet.scalapb" %% "scalapb-runtime" % scalapb.compiler.Version.scalapbVersion % "protobuf",
-  "org.scala-lang.modules" %% "scala-parser-combinators" % "1.1.1"
+  "org.scala-lang.modules" %% "scala-parser-combinators" % "1.1.1",
+  "org.apache.commons" % "commons-lang3" % "3.15.0",
+  "org.slf4j" % "slf4j-api" % Versions.slf4j,
 ) ++ scalatest
 
 Test / parallelExecution := false

common/build.sbt

@@ -18,7 +18,8 @@ libraryDependencies ++= Seq(
     ExclusionRule(organization = "com.google.auth", name = "google-auth-library-oauth2-http")
     /*, ExclusionRule(organization = "org.apache.commons", name = "commons-lang3")*/,
     ExclusionRule(organization = "io.netty"),
-    ExclusionRule(organization = "io.grpc")
+    ExclusionRule(organization = "io.grpc"),
+    ExclusionRule(organization = "org.slf4j"),
   ),
   "com.eatthepath" % "pushy" % "0.15.1"
 )

common/src/main/protobuf/api/notification.proto

@@ -14,10 +14,12 @@ service NotificationServiceApi {
     rpc AddMail (AddMailRequest) returns (AddNotificationResponse) {}
     rpc AddSMS (AddSMSRequest) returns (AddNotificationResponse) {}
     rpc AddPush (AddPushRequest) returns (AddNotificationResponse) {}
+    rpc AddWs (AddWsRequest) returns (AddNotificationResponse) {}
     rpc RemoveNotification (RemoveNotificationRequest) returns (RemoveNotificationResponse) {}
     rpc SendMail (SendMailRequest) returns (SendNotificationResponse) {}
     rpc SendSMS (SendSMSRequest) returns (SendNotificationResponse) {}
     rpc SendPush (SendPushRequest) returns (SendNotificationResponse) {}
+    rpc SendWs (SendWsRequest) returns (SendNotificationResponse) {}
     rpc GetNotificationStatus (GetNotificationStatusRequest) returns (GetNotificationStatusResponse) {}
 }
 
@@ -33,6 +35,10 @@ message AddPushRequest{
     app.softnetwork.notification.model.Push push = 1;
 }
 
+message AddWsRequest{
+    app.softnetwork.notification.model.Ws ws = 1;
+}
+
 message AddNotificationResponse{
     bool succeeded = 1;
 }
@@ -57,6 +63,10 @@ message SendPushRequest{
     app.softnetwork.notification.model.Push push = 1;
 }
 
+message SendWsRequest{
+    app.softnetwork.notification.model.Ws ws = 1;
+}
+
 message SendNotificationResponse{
     repeated app.softnetwork.notification.model.NotificationStatusResult results = 1;
 }

common/src/main/protobuf/message/notification.proto

@@ -27,6 +27,7 @@ message NotificationRecordedEvent {
         app.softnetwork.notification.model.Mail mail = 1;
         app.softnetwork.notification.model.SMS sms = 2;
         app.softnetwork.notification.model.Push push = 3;
+        app.softnetwork.notification.model.Ws ws = 4;
     }
 }
 
@@ -45,6 +46,7 @@ message ExternalEntityToNotificationEvent{
         app.softnetwork.notification.message.AddSMSCommandEvent addSMS = 2;
         app.softnetwork.notification.message.AddPushCommandEvent addPush = 3;
         app.softnetwork.notification.message.RemoveNotificationCommandEvent removeNotification = 4;
+        app.softnetwork.notification.message.AddWsCommandEvent addWs = 5;
     }
 }
 
@@ -66,6 +68,12 @@ message AddPushCommandEvent{
     required app.softnetwork.notification.model.Push notification = 1;
 }
 
+message AddWsCommandEvent{
+    option (scalapb.message).extends = "ProtobufEvent";
+    option (scalapb.message).extends = "AddNotificationCommandEvent";
+    required app.softnetwork.notification.model.Ws notification = 1;
+}
+
 message RemoveNotificationCommandEvent{
     option (scalapb.message).extends = "ProtobufEvent";
     option (scalapb.message).extends = "ExternalNotificationEvent";

common/src/main/protobuf/model/notificationType.proto

@@ -14,4 +14,5 @@ enum NotificationType {
     MAIL_TYPE = 1;
     SMS_TYPE = 2;
     PUSH_TYPE = 3;
+    WS_TYPE = 4;
 }

common/src/main/protobuf/model/notifications.proto

@@ -138,6 +138,25 @@ message Push{
     optional string application = 24;
 }
 
+message Ws{
+    option (scalapb.message).extends = "ProtobufDomainObject";
+    option (scalapb.message).extends = "Notification";
+    required string uuid = 1;
+    required google.protobuf.Timestamp createdDate = 2 [(scalapb.field).type = "java.time.Instant"];
+    required google.protobuf.Timestamp lastUpdated = 3 [(scalapb.field).type = "java.time.Instant"];
+    required From from = 4;
+    repeated string to = 5;
+    required string subject = 8;
+    required string message = 9;
+    required int32 maxTries = 13 [default = 1];
+    required int32 nbTries = 14 [default = 0];
+    optional google.protobuf.Timestamp deferred = 15 [(scalapb.field).type = "java.time.Instant"];
+    optional string ackUuid = 16;
+    required NotificationStatus status = 17 [default = Pending];
+    repeated NotificationStatusResult results = 18;
+    required NotificationType type = 19 [default = WS_TYPE];
+}
+
 message PushPayload{
     option (scalapb.message).extends = "ProtobufDomainObject";
     required string application = 1;

common/src/main/resources/reference.conf

@@ -4,4 +4,6 @@ notification {
   event-streams {
     external-to-notification-tag = "external-to-notification"
   }
+
+  path = "notification"
 }

common/src/main/scala/app/softnetwork/notification/api/NotificationClient.scala

@@ -3,7 +3,7 @@ package app.softnetwork.notification.api
 import akka.actor.typed.ActorSystem
 import akka.grpc.GrpcClientSettings
 import app.softnetwork.api.server.client.{GrpcClient, GrpcClientFactory}
-import app.softnetwork.notification.model.{Mail, NotificationStatusResult, Push, SMS}
+import app.softnetwork.notification.model.{Mail, NotificationStatusResult, Push, SMS, Ws}
 
 import scala.concurrent.Future
 
@@ -26,6 +26,10 @@ trait NotificationClient extends GrpcClient {
     grpcClient.addPush(AddPushRequest(Some(push))) map (_.succeeded)
   }
 
+  def addWs(ws: Ws): Future[Boolean] = {
+    grpcClient.addWs(AddWsRequest(Some(ws))) map (_.succeeded)
+  }
+
   def removeNotification(uuid: String): Future[Boolean] = {
     grpcClient.removeNotification(RemoveNotificationRequest(uuid)) map (_.succeeded)
   }
@@ -42,6 +46,10 @@ trait NotificationClient extends GrpcClient {
     grpcClient.sendPush(SendPushRequest(Some(push))) map (_.results)
   }
 
+  def sendWs(ws: Ws): Future[Seq[NotificationStatusResult]] = {
+    grpcClient.sendWs(SendWsRequest(Some(ws))) map (_.results)
+  }
+
   def getNotificationStatus(uuid: String): Future[Seq[NotificationStatusResult]] = {
     grpcClient.getNotificationStatus(GetNotificationStatusRequest(uuid)) map (_.results)
   }