prepare release v0.8.0

Author: fupelaqu

build.sbt

@@ -2,7 +2,7 @@ ThisBuild / organization := "app.softnetwork"
 
 name := "resource"
 
-ThisBuild / version := "0.7.0"
+ThisBuild / version := "0.8.0"
 
 ThisBuild / scalaVersion := "2.12.18"
 
@@ -34,6 +34,13 @@ lazy val common = project.in(file("common"))
   .settings(Defaults.itSettings)
   .enablePlugins(AkkaGrpcPlugin)
 
+lazy val local = project.in(file("local"))
+  .configs(IntegrationTest)
+  .settings(Defaults.itSettings)
+  .dependsOn(
+    common % "compile->compile;test->test;it->it"
+  )
+
 lazy val core = project.in(file("core"))
   .configs(IntegrationTest)
   .settings(Defaults.itSettings, app.softnetwork.Info.infoSettings)
@@ -46,7 +53,8 @@ lazy val testkit = project.in(file("testkit"))
   .configs(IntegrationTest)
   .settings(Defaults.itSettings)
   .dependsOn(
-    core % "compile->compile;test->test;it->it"
+    core % "compile->compile;test->test;it->it",
+    local % "compile->compile;test->test;it->it"
   )
 
 lazy val api = project.in(file("api"))

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

@@ -24,34 +24,27 @@ message ResourceCreatedEvent {
     required app.softnetwork.resource.model.Resource document = 1;
 }
 
-message SessionResourceCreatedEvent {
-    option (scalapb.message).extends = "ProtobufEvent";
-    option (scalapb.message).extends = "SessionResourceEvent";
-    required string uuid = 1;
-    required string sessionId = 2;
-    optional string uri = 3;
-}
-
 message ResourceUpdatedEvent {
     option (scalapb.message).extends = "ProtobufEvent";
     option (scalapb.message).extends = "Updated[Resource]";
     option (scalapb.message).extends = "ResourceEvent";
     required app.softnetwork.resource.model.Resource document = 1;
 }
 
-message SessionResourceUpdatedEvent {
+message ResourceDeletedEvent {
     option (scalapb.message).extends = "ProtobufEvent";
-    option (scalapb.message).extends = "SessionResourceEvent";
+    option (scalapb.message).extends = "Deleted";
+    option (scalapb.message).extends = "ResourceEvent";
     required string uuid = 1;
-    required string sessionId = 2;
-    optional string uri = 3;
 }
 
-message ResourceDeletedEvent {
+message SessionResourceUpsertedEvent {
     option (scalapb.message).extends = "ProtobufEvent";
-    option (scalapb.message).extends = "Deleted";
-    option (scalapb.message).extends = "ResourceEvent";
+    option (scalapb.message).extends = "SessionResourceEvent";
     required string uuid = 1;
+    required string sessionId = 2;
+    required string content = 3;
+    optional string uri = 4;
 }
 
 message SessionResourceDeletedEvent {

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

@@ -23,6 +23,16 @@ option (scalapb.options) = {
  * @param md5 - resource md5
  */
 message Resource {
+
+    enum ProviderType {
+        LOCAL = 0;
+        AWS = 1;
+        GCP = 2;
+        AZURE = 3;
+        MINIO = 4;
+        DB = 5;
+    }
+
     option (scalapb.message).extends = "ProtobufDomainObject";
     option (scalapb.message).extends = "GenericResource";
     required string uuid = 1;
@@ -32,4 +42,5 @@ message Resource {
     required string md5 = 5;
     optional string mimetype = 6;
     optional string uri = 7;
+    optional ProviderType providerType = 8 [default = LOCAL];
 }

common/src/main/scala/app/softnetwork/resource/serialization/package.scala

@@ -0,0 +1,15 @@
+package app.softnetwork.resource
+
+import app.softnetwork.protobuf.ScalaPBSerializers.GeneratedEnumSerializer
+import app.softnetwork.resource.model.Resource
+import app.softnetwork.serialization.commonFormats
+import org.json4s.Formats
+
+package object serialization {
+
+  val resourceFormats: Formats = commonFormats ++
+    Seq(
+      GeneratedEnumSerializer(Resource.ProviderType.enumCompanion)
+    )
+
+}

common/src/main/scala/app/softnetwork/resource/spi/ResourceProvider.scala

@@ -1,11 +1,16 @@
 package app.softnetwork.resource.spi
 
 import app.softnetwork.utils.ImageTools.ImageSize
+import org.slf4j.Logger
 
 import java.nio.file.Path
 
 protected[resource] trait ResourceProvider {
 
+  def log: Logger
+
+  def rootDir: String
+
   /** Upsert the underlying resource referenced by its uuid to the resource provider
     *
     * @param uuid

common/src/main/scala/app/softnetwork/resource/spi/ResourceProviderSpi.scala

@@ -0,0 +1,10 @@
+package app.softnetwork.resource.spi
+
+import app.softnetwork.resource.model.Resource.ProviderType
+
+trait ResourceProviderSpi {
+
+  def providerType: ProviderType
+
+  def provider: ResourceProvider
+}

common/src/main/scala/app/softnetwork/resource/spi/ResourceProviders.scala

@@ -0,0 +1,35 @@
+package app.softnetwork.resource.spi
+
+import app.softnetwork.resource.model.Resource.ProviderType
+
+import java.util.ServiceLoader
+import scala.collection.JavaConverters._
+
+object ResourceProviders {
+
+  private[this] lazy val resourceProviderFactories: ServiceLoader[ResourceProviderSpi] =
+    java.util.ServiceLoader.load(classOf[ResourceProviderSpi])
+
+  private[this] var resourceProviders: Map[String, ResourceProvider] = Map.empty
+
+  private[this] def registerProvider(providerType: String, provider: ResourceProvider): Unit = {
+    resourceProviders += (providerType -> provider)
+  }
+
+  def provider(providerType: ProviderType): ResourceProvider = {
+    resourceProviders.get(providerType.name) match {
+      case Some(provider) => provider
+      case None =>
+        resourceProviderFactories
+          .iterator()
+          .asScala
+          .find(_.providerType == providerType)
+          .map { factory =>
+            val provider = factory.provider
+            registerProvider(providerType.name, provider)
+            provider
+          }
+          .getOrElse(throw new Exception(s"No provider found for type ${providerType.name}"))
+    }
+  }
+}

core/src/main/scala/app/softnetwork/resource/persistence/query/ExternalGenericResourceProvider.scala

@@ -2,14 +2,19 @@ package app.softnetwork.resource.persistence.query
 
 import app.softnetwork.persistence.ManifestWrapper
 import app.softnetwork.persistence.query.ExternalPersistenceProvider
+import app.softnetwork.resource.model.Resource.ProviderType
 import app.softnetwork.resource.model.GenericResource
-import app.softnetwork.resource.spi.{LocalFileSystemProvider, ResourceProvider}
+import app.softnetwork.resource.spi.{ResourceProvider, ResourceProviders}
 
 import scala.reflect.ClassTag
 
 protected[resource] trait ExternalGenericResourceProvider[Resource <: GenericResource]
     extends ExternalPersistenceProvider[Resource] {
-  _: ResourceProvider with ManifestWrapper[Resource] =>
+  _: ManifestWrapper[Resource] =>
+
+  def providerType: ProviderType
+
+  def provider: ResourceProvider = ResourceProviders.provider(providerType)
 
   /** Creates the underlying document to the external system
     *
@@ -22,7 +27,7 @@ protected[resource] trait ExternalGenericResourceProvider[Resource <: GenericRes
     */
   override def createDocument(document: Resource)(implicit t: ClassTag[Resource]): Boolean = {
     import document._
-    upsertResource(uuid, content, uri)
+    provider.upsertResource(uuid, content, uri)
   }
 
   /** Updates the underlying document to the external system
@@ -41,7 +46,7 @@ protected[resource] trait ExternalGenericResourceProvider[Resource <: GenericRes
     t: ClassTag[Resource]
   ): Boolean = {
     import document._
-    upsertResource(uuid, content, uri)
+    provider.upsertResource(uuid, content, uri)
   }
 
   /** Upsert the underlying document referenced by its uuid to the external system
@@ -61,7 +66,7 @@ protected[resource] trait ExternalGenericResourceProvider[Resource <: GenericRes
       else
         None
     }
-    upsertResource(segments.last, data, uri)
+    provider.upsertResource(segments.last, data, uri)
   }
 
   /** Deletes the underlying document referenced by its uuid to the external system
@@ -79,7 +84,7 @@ protected[resource] trait ExternalGenericResourceProvider[Resource <: GenericRes
       else
         None
     }
-    deleteResource(segments.last, uri)
+    provider.deleteResource(segments.last, uri)
   }
 
 }

core/src/main/scala/app/softnetwork/resource/persistence/query/LocalFileSystemGenericResourceProvider.scala

@@ -1,9 +1,10 @@
 package app.softnetwork.resource.persistence.query
 
 import app.softnetwork.persistence.ManifestWrapper
+import app.softnetwork.resource.model.Resource.ProviderType
 import app.softnetwork.resource.model.GenericResource
-import app.softnetwork.resource.spi.LocalFileSystemProvider
 
 trait LocalFileSystemGenericResourceProvider[Resource <: GenericResource]
-    extends ExternalGenericResourceProvider[Resource]
-    with LocalFileSystemProvider { _: ManifestWrapper[Resource] => }
+    extends ExternalGenericResourceProvider[Resource] { _: ManifestWrapper[Resource] =>
+  override def providerType: ProviderType = ProviderType.LOCAL
+}

core/src/main/scala/app/softnetwork/resource/persistence/query/LocalFileSystemResourceProvider.scala

@@ -29,7 +29,7 @@ protected[resource] trait LocalFileSystemResourceProvider
     uuid: String
   )(implicit m: Manifest[Resource], formats: Formats): Option[Resource] = {
     Try {
-      val path = Paths.get(rootDir, uuid)
+      val path = Paths.get(provider.rootDir, uuid)
       if (Files.exists(path)) {
         val fileAttributes =
           Files.readAttributes(path, classOf[BasicFileAttributes], LinkOption.NOFOLLOW_LINKS)
@@ -57,7 +57,7 @@ protected[resource] trait LocalFileSystemResourceProvider
     } match {
       case Success(s) => s
       case Failure(f) =>
-        log.error(f.getMessage, f)
+        provider.log.error(f.getMessage, f)
         None
     }
   }