WIP-CRUD on top of Event Sourcing

build.sbt

@@ -54,6 +54,8 @@ val Slf4jSimpleVersion = "1.7.30"
 val GraalVersion = "20.1.0"
 val DockerBaseImageVersion = "adoptopenjdk/openjdk11:debianslim-jre"
 val DockerBaseImageJavaLibraryPath = "${JAVA_HOME}/lib"
+val SlickVersion = "3.3.2"
+val SlickHikariVersion = "3.3.2"
 
 val excludeTheseDependencies: Seq[ExclusionRule] = Seq(
   ExclusionRule("io.netty", "netty"), // grpc-java is using grpc-netty-shaded
@@ -107,15 +109,16 @@ headerSources in Compile ++= {
 
 lazy val root = (project in file("."))
   .enablePlugins(NoPublish)
-// Don't forget to add your sbt module here!
-// A missing module here can lead to failing Travis test results
+  // Don't forget to add your sbt module here!
+  // A missing module here can lead to failing Travis test results
   .aggregate(
     `protocols`,
     `proxy`,
     `java-support`,
     `java-support-docs`,
     `java-support-tck`,
     `java-shopping-cart`,
+    `java-valueentity-shopping-cart`,
     `java-pingpong`,
     `akka-client`,
     operator,
@@ -396,8 +399,10 @@ lazy val `proxy-core` = (project in file("proxy/core"))
         "com.thesamet.scalapb" %% "scalapb-runtime" % scalapb.compiler.Version.scalapbVersion % "protobuf",
         "io.prometheus" % "simpleclient" % PrometheusClientVersion,
         "io.prometheus" % "simpleclient_common" % PrometheusClientVersion,
-        "org.slf4j" % "slf4j-simple" % Slf4jSimpleVersion
+        "org.slf4j" % "slf4j-simple" % Slf4jSimpleVersion,
         //"ch.qos.logback"                 % "logback-classic"                   % "1.2.3", // Doesn't work well with SubstrateVM: https://github.com/vmencik/akka-graal-native/blob/master/README.md#logging
+        "com.typesafe.slick" %% "slick" % SlickVersion,
+        "com.typesafe.slick" %% "slick-hikaricp" % SlickHikariVersion
       ),
     PB.protoSources in Compile ++= {
       val baseDir = (baseDirectory in ThisBuild).value / "protocols"
@@ -468,6 +473,8 @@ lazy val `proxy-jdbc` = (project in file("proxy/jdbc"))
     name := "cloudstate-proxy-jdbc",
     dependencyOverrides += "io.grpc" % "grpc-netty-shaded" % GrpcNettyShadedVersion,
     libraryDependencies ++= Seq(
+        //"com.typesafe.slick" %% "slick" % SlickVersion, // should be here for CRUD native support!!
+        //"com.typesafe.slick" %% "slick-hikaricp" % SlickHikariVersion, // should be here for CRUD native support!!
         "com.github.dnvriend" %% "akka-persistence-jdbc" % "3.5.2"
       ),
     fork in run := true,
@@ -631,7 +638,7 @@ lazy val `java-support-docs` = (project in file("java-support/docs"))
   )
 
 lazy val `java-support-tck` = (project in file("java-support/tck"))
-  .dependsOn(`java-support`, `java-shopping-cart`)
+  .dependsOn(`java-support`, `java-shopping-cart`, `java-valueentity-shopping-cart`)
   .enablePlugins(AkkaGrpcPlugin, AssemblyPlugin, JavaAppPackaging, DockerPlugin, AutomateHeaderPlugin, NoPublish)
   .settings(
     name := "cloudstate-java-tck",
@@ -665,6 +672,26 @@ lazy val `java-shopping-cart` = (project in file("samples/java-shopping-cart"))
     assemblySettings("java-shopping-cart.jar")
   )
 
+lazy val `java-valueentity-shopping-cart` = (project in file("samples/java-valueentity-shopping-cart"))
+  .dependsOn(`java-support`)
+  .enablePlugins(AkkaGrpcPlugin, AssemblyPlugin, JavaAppPackaging, DockerPlugin, AutomateHeaderPlugin, NoPublish)
+  .settings(
+    name := "java-valueentity-shopping-cart",
+    dockerSettings,
+    mainClass in Compile := Some("io.cloudstate.samples.valueentity.shoppingcart.Main"),
+    PB.generate in Compile := (PB.generate in Compile).dependsOn(PB.generate in (`java-support`, Compile)).value,
+    akkaGrpcGeneratedLanguages := Seq(AkkaGrpc.Java),
+    PB.protoSources in Compile ++= {
+      val baseDir = (baseDirectory in ThisBuild).value / "protocols"
+      Seq(baseDir / "frontend", baseDir / "example")
+    },
+    PB.targets in Compile := Seq(
+        PB.gens.java -> (sourceManaged in Compile).value
+      ),
+    javacOptions in Compile ++= Seq("-encoding", "UTF-8", "-source", "11", "-target", "11"),
+    assemblySettings("java-valueentity-shopping-cart.jar")
+  )
+
 lazy val `java-pingpong` = (project in file("samples/java-pingpong"))
   .dependsOn(`java-support`)
   .enablePlugins(AkkaGrpcPlugin, AssemblyPlugin, JavaAppPackaging, DockerPlugin, AutomateHeaderPlugin, NoPublish)

java-support/src/main/java/io/cloudstate/javasupport/CloudState.java

@@ -20,17 +20,21 @@
 import akka.stream.Materializer;
 import com.typesafe.config.Config;
 import com.google.protobuf.Descriptors;
+import io.cloudstate.javasupport.valueentity.ValueEntity;
 import io.cloudstate.javasupport.action.Action;
 import io.cloudstate.javasupport.action.ActionHandler;
 import io.cloudstate.javasupport.crdt.CrdtEntity;
 import io.cloudstate.javasupport.crdt.CrdtEntityFactory;
+import io.cloudstate.javasupport.valueentity.ValueEntityFactory;
 import io.cloudstate.javasupport.eventsourced.EventSourcedEntity;
 import io.cloudstate.javasupport.eventsourced.EventSourcedEntityFactory;
 import io.cloudstate.javasupport.impl.AnySupport;
 import io.cloudstate.javasupport.impl.action.AnnotationBasedActionSupport;
 import io.cloudstate.javasupport.impl.action.ActionService;
 import io.cloudstate.javasupport.impl.crdt.AnnotationBasedCrdtSupport;
 import io.cloudstate.javasupport.impl.crdt.CrdtStatefulService;
+import io.cloudstate.javasupport.impl.valueentity.AnnotationBasedValueEntitySupport;
+import io.cloudstate.javasupport.impl.valueentity.ValueEntityStatefulService;
 import io.cloudstate.javasupport.impl.eventsourced.AnnotationBasedEventSourcedSupport;
 import io.cloudstate.javasupport.impl.eventsourced.EventSourcedStatefulService;
 
@@ -145,7 +149,7 @@ public CloudState registerEventSourcedEntity(
   }
 
   /**
-   * Register an event sourced entity factor.
+   * Register an event sourced entity factory.
    *
    * <p>This is a low level API intended for custom (eg, non reflection based) mechanisms for
    * implementing the entity.
@@ -300,6 +304,75 @@ public CloudState registerAction(
     return this;
   }
 
+  /**
+   * Register a annotated value entity.
+   *
+   * <p>The entity class must be annotated with {@link ValueEntity}.
+   *
+   * @param entityClass The entity class.
+   * @param descriptor The descriptor for the service that this entity implements.
+   * @param additionalDescriptors Any additional descriptors that should be used to look up protobuf
+   *     types when needed.
+   * @return This stateful service builder.
+   */
+  public CloudState registerValueEntity(
+      Class<?> entityClass,
+      Descriptors.ServiceDescriptor descriptor,
+      Descriptors.FileDescriptor... additionalDescriptors) {
+
+    ValueEntity entity = entityClass.getAnnotation(ValueEntity.class);
+    if (entity == null) {
+      throw new IllegalArgumentException(
+          entityClass + " does not declare an " + ValueEntity.class + " annotation!");
+    }
+
+    final String persistenceId;
+    if (entity.persistenceId().isEmpty()) {
+      persistenceId = entityClass.getSimpleName();
+    } else {
+      persistenceId = entity.persistenceId();
+    }
+
+    final AnySupport anySupport = newAnySupport(additionalDescriptors);
+    ValueEntityStatefulService service =
+        new ValueEntityStatefulService(
+            new AnnotationBasedValueEntitySupport(entityClass, anySupport, descriptor),
+            descriptor,
+            anySupport,
+            persistenceId);
+
+    services.put(descriptor.getFullName(), system -> service);
+
+    return this;
+  }
+
+  /**
+   * Register a value entity factory.
+   *
+   * <p>This is a low level API intended for custom (eg, non reflection based) mechanisms for
+   * implementing the entity.
+   *
+   * @param factory The value entity factory.
+   * @param descriptor The descriptor for the service that this entity implements.
+   * @param persistenceId The persistence id for this entity.
+   * @param additionalDescriptors Any additional descriptors that should be used to look up protobuf
+   *     types when needed.
+   * @return This stateful service builder.
+   */
+  public CloudState registerValueEntity(
+      ValueEntityFactory factory,
+      Descriptors.ServiceDescriptor descriptor,
+      String persistenceId,
+      Descriptors.FileDescriptor... additionalDescriptors) {
+    services.put(
+        descriptor.getFullName(),
+        system ->
+            new ValueEntityStatefulService(
+                factory, descriptor, newAnySupport(additionalDescriptors), persistenceId));
+
+    return this;
+  }
+
   /**
    * Starts a server with the configured entities.
    *

java-support/src/main/java/io/cloudstate/javasupport/valueentity/CommandContext.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2019 Lightbend Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.cloudstate.javasupport.valueentity;
+
+import io.cloudstate.javasupport.ClientActionContext;
+import io.cloudstate.javasupport.EffectContext;
+import io.cloudstate.javasupport.MetadataContext;
+
+import java.util.Optional;
+
+/**
+ * A value entity command context.
+ *
+ * <p>Methods annotated with {@link CommandHandler} may take this is a parameter. It allows updating
+ * or deleting the entity state in response to a command, along with forwarding the result to other
+ * entities, and performing side effects on other entities.
+ */
+public interface CommandContext<T>
+    extends ValueEntityContext, ClientActionContext, EffectContext, MetadataContext {
+
+  /**
+   * The name of the command being executed.
+   *
+   * @return The name of the command.
+   */
+  String commandName();
+
+  /**
+   * The id of the command being executed.
+   *
+   * @return The id of the command.
+   */
+  long commandId();
+
+  /**
+   * Retrieve the state.
+   *
+   * @return the current state or empty if none have been created.
+   * @throws IllegalStateException If the current entity state have been deleted in the command
+   *     invocation.
+   */
+  Optional<T> getState();
+
+  /**
+   * Update the entity with the new state. The state will be persisted.
+   *
+   * @param state The state to persist.
+   */
+  void updateState(T state);
+
+  /** Delete the entity state. */
+  void deleteState();
+}

java-support/src/main/java/io/cloudstate/javasupport/valueentity/CommandHandler.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2019 Lightbend Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.cloudstate.javasupport.valueentity;
+
+import io.cloudstate.javasupport.impl.CloudStateAnnotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks a method on a value entity as a command handler.
+ *
+ * <p>This method will be invoked whenever the service call with name that matches this command
+ * handlers name is invoked.
+ *
+ * <p>The method may take the command object as a parameter, its type must match the gRPC service
+ * input type.
+ *
+ * <p>The return type of the method must match the gRPC services output type.
+ *
+ * <p>The method may also take a {@link CommandContext}, and/or a {@link
+ * io.cloudstate.javasupport.EntityId} annotated {@link String} parameter.
+ */
+@CloudStateAnnotation
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface CommandHandler {
+
+  /**
+   * The name of the command to handle.
+   *
+   * <p>If not specified, the name of the method will be used as the command name, with the first
+   * letter capitalized to match the gRPC convention of capitalizing rpc method names.
+   *
+   * @return The command name.
+   */
+  String name() default "";
+}

java-support/src/main/java/io/cloudstate/javasupport/valueentity/ValueEntity.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 Lightbend Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.cloudstate.javasupport.valueentity;
+
+import io.cloudstate.javasupport.impl.CloudStateAnnotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/** A value entity. */
+@CloudStateAnnotation
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ValueEntity {
+  /**
+   * The name of the persistence id.
+   *
+   * <p>If not specified, defaults to the entities unqualified classname. It's strongly recommended
+   * that you specify it explicitly.
+   */
+  String persistenceId() default "";
+}

java-support/src/main/java/io/cloudstate/javasupport/valueentity/ValueEntityContext.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 Lightbend Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.cloudstate.javasupport.valueentity;
+
+import io.cloudstate.javasupport.EntityContext;
+
+/** Root context for all value entity contexts. */
+public interface ValueEntityContext extends EntityContext {}