add support for email notification attachment as an array of bytes

Author: fupelaqu

build.sbt

@@ -31,7 +31,7 @@ ThisBuild / organization := "app.softnetwork"
 
 name := "notification"
 
-ThisBuild / version := "0.2.5"
+ThisBuild / version := "0.2.6"
 
 ThisBuild / scalaVersion := "2.12.15"
 

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

@@ -56,9 +56,12 @@ message BasicDevice{
 
 message Attachment{
     option (scalapb.message).extends = "ProtobufDomainObject";
+    option (scalapb.message).extends = "AttachmentDecorator";
+    option (scalapb.message).companion_extends = "AttachmentCompanion";
     required string name = 1;
     required string path = 2;
     optional string description = 3;
+    optional bytes bytes = 4;
 }
 
 enum MailType{

common/src/main/scala/app/softnetwork/notification/model/AttachmentCompanion.scala

@@ -0,0 +1,7 @@
+package app.softnetwork.notification.model
+
+trait AttachmentCompanion {
+  def apply(name: String, path: String, bytes: Array[Byte]): Attachment = {
+    Attachment.defaultInstance.withName(name).withPath(path).copyFrom(bytes)
+  }
+}

common/src/main/scala/app/softnetwork/notification/model/AttachmentDecorator.scala

@@ -0,0 +1,25 @@
+package app.softnetwork.notification.model
+
+import app.softnetwork.utils.MimeTypeTools
+import com.google.protobuf.ByteString
+
+import javax.activation.{DataSource, FileDataSource}
+import javax.mail.util.ByteArrayDataSource
+
+trait AttachmentDecorator { _: Attachment =>
+
+  def copyFrom(bytes: Array[Byte]): Attachment = this.withBytes(ByteString.copyFrom(bytes))
+
+  lazy val arrayOfBytes: Option[Array[Byte]] = bytes.map(_.toByteArray)
+
+  lazy val `type`: Option[String] = arrayOfBytes.flatMap(MimeTypeTools.detectMimeType)
+
+  lazy val dataSource: DataSource = arrayOfBytes
+    .map { b =>
+      val ds = new ByteArrayDataSource(b, `type`.getOrElse("application/octet-stream"))
+      ds.setName(name)
+      ds
+    }
+    .getOrElse(new FileDataSource(path))
+
+}

common/src/test/resources/avatar.png

@@ -0,0 +1,37 @@
+package app.softnetwork.notification.model
+
+import app.softnetwork.utils.HashTools
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+
+import java.io.ByteArrayInputStream
+import java.nio.file.{Files, Paths}
+import javax.mail.util.ByteArrayDataSource
+
+class AttachmentSpec extends AnyFlatSpec with Matchers {
+
+  "png attachment" should "work" in {
+    val name = "avatar.png"
+    val path =
+      Paths.get(Thread.currentThread().getContextClassLoader.getResource(name).getPath)
+    val bytes = Files.readAllBytes(path)
+    val attachment = Attachment(name, path.toString, bytes)
+    assert(attachment.name == name)
+    assert(attachment.dataSource.isInstanceOf[ByteArrayDataSource])
+    assert(attachment.`type`.isDefined)
+    assert(attachment.`type`.getOrElse("") == "image/png")
+    val md5 = HashTools
+      .hashStream(
+        new ByteArrayInputStream(bytes)
+      )
+      .getOrElse("")
+    assert(
+      HashTools
+        .hashStream(
+          new ByteArrayInputStream(attachment.bytes.map(_.toByteArray).getOrElse(Array.empty))
+        )
+        .getOrElse("") == md5
+    )
+  }
+
+}

common/src/test/scala/app/softnetwork/notification/model/AttachmentSpec.scala

@@ -11,7 +11,6 @@ import app.softnetwork.notification.model.MailType._
 import app.softnetwork.notification.model._
 
 import java.util.Date
-import javax.activation.FileDataSource
 import scala.util.{Failure, Success, Try}
 
 /** From https://gist.github.com/mariussoutier/3436111
@@ -43,7 +42,7 @@ trait SimpleMailProvider extends MailProvider with MailSettings with StrictLoggi
         }
         attachments.foreach(attachment => {
           multipart.attach(
-            new FileDataSource(attachment.path),
+            attachment.dataSource,
             attachment.name,
             attachment.description.orNull,
             EmailAttachment.ATTACHMENT

core/src/main/scala/app/softnetwork/notification/spi/SimpleMailProvider.scala

@@ -8,15 +8,15 @@ import app.softnetwork.notification.config.MailSettings
 import app.softnetwork.notification.config.NotificationSettings.NotificationConfig
 import app.softnetwork.notification.launch.NotificationGuardian
 import app.softnetwork.notification.message.Schedule4NotificationTriggered
-import app.softnetwork.notification.model.Notification
+import app.softnetwork.notification.model.{Attachment, BasicDevice, From, Mail, Notification, Platform, Push, SMS}
 import app.softnetwork.scheduler.scalatest.SchedulerTestKit
 import com.typesafe.config.Config
 import org.scalatest.Suite
-import app.softnetwork.notification.model.{BasicDevice, From, Mail, Platform, Push, SMS}
 import app.softnetwork.persistence.launch.PersistentEntity
 import app.softnetwork.persistence.query.EventProcessorStream
 
 import java.net.ServerSocket
+import java.nio.file.{Files, Path}
 
 trait NotificationTestKit[T <: Notification]
     extends SchedulerTestKit
@@ -43,13 +43,19 @@ trait NotificationTestKit[T <: Notification]
   val subject = "test"
   val message = "message"
 
-  protected def generateMail(uuid: String): Mail =
+  protected def generateAttachment(name: String, path: Path): Attachment = {
+    val bytes = Files.readAllBytes(path)
+    Attachment(name, path.toString, bytes)
+  }
+
+  protected def generateMail(uuid: String, attachments: Seq[Attachment] = Seq.empty): Mail =
     Mail.defaultInstance
       .withUuid(uuid)
       .withFrom(From(MailSettings.MailConfig.username, None))
       .withTo(Seq("nobody@gmail.com"))
       .withSubject(subject)
       .withMessage(message)
+      .withAttachments(attachments)
 
   protected def generateSMS(uuid: String): SMS =
     SMS.defaultInstance

testkit/src/main/resources/avatar.png

@@ -1,16 +1,29 @@
 package app.softnetwork.notification.handlers
 
 import app.softnetwork.notification.message._
+import app.softnetwork.notification.model.Attachment
 import app.softnetwork.notification.scalatest.SimpleMailNotificationsTestKit
 import org.scalatest.wordspec.AnyWordSpecLike
 
+import java.nio.file.Paths
+
 /** Created by smanciot on 14/04/2020.
   */
 class SimpleMailNotificationsHandlerSpec
     extends SimpleMailNotificationsHandler
     with AnyWordSpecLike
     with SimpleMailNotificationsTestKit {
 
+  var attachment: Attachment = _
+
+  override def beforeAll(): Unit = {
+    super.beforeAll()
+    attachment = generateAttachment(
+      "avatar.png",
+      Paths.get(Thread.currentThread().getContextClassLoader.getResource("avatar.png").getPath)
+    )
+  }
+
   "Simple Mail Notification handler" must {
 
     "add notification" in {
@@ -25,6 +38,18 @@ class SimpleMailNotificationsHandlerSpec
       }
     }
 
+    "add notification with attachment(s)" in {
+      val uuid = "addWithAttachments"
+      this ? (uuid, AddNotification(generateMail(uuid, Seq(attachment)))) await {
+        case n: NotificationAdded =>
+          n.uuid shouldBe uuid
+          assert(
+            probe.receiveMessage().schedule.uuid == s"MailNotification#$uuid#NotificationTimerKey"
+          )
+        case _ => fail()
+      }
+    }
+
     "remove notification" in {
       val uuid = "remove"
       this ? (uuid, AddNotification(generateMail(uuid))) await {
@@ -50,6 +75,15 @@ class SimpleMailNotificationsHandlerSpec
       }
     }
 
+    "send notification with attachment(s)" in {
+      val uuid = "sendWithAttachments"
+      this ? (uuid, SendNotification(generateMail(uuid, Seq(attachment)))) await {
+        case n: NotificationSent =>
+          n.uuid shouldBe uuid
+        case _ => fail()
+      }
+    }
+
     "resend notification" in {
       val uuid = "resend"
       this ? (uuid, SendNotification(generateMail(uuid))) await {