Merge pull request #454 from SpineEventEngine/failure-ctor-less-generation

`Failure` propagation improvements.

Author: Alex Tymchenko

build.gradle

@@ -33,12 +33,12 @@ buildscript {
         guavaVersion = '20.0'
         protobufGradlePluginVerison = '0.8.0'
 
-        spineVersion = '0.8.39-SNAPSHOT'
+        spineVersion = '0.8.40-SNAPSHOT'
 
         //TODO:2016-12-12:alexander.yevsyukov: Advance the plug-in version together with all
         // the components and change the version of the dependency below to
         // `spineVersion` defined above.
-        spineToolsVersion = '0.8.13-SNAPSHOT'
+        spineToolsVersion = '0.8.15-SNAPSHOT'
 
         // Defines option for the `spine-model-compiler` plugin.
         // Indicates whether the generation of the validating builders is enabled.

client/src/main/java/org/spine3/base/FailureThrowable.java

@@ -48,9 +48,7 @@ public abstract class FailureThrowable extends Throwable {
     /** The moment of creation of this object. */
     private final Timestamp timestamp;
 
-    protected FailureThrowable(GeneratedMessageV3 unused,
-                               CommandContext ignored,
-                               GeneratedMessageV3 failureMessage) {
+    protected FailureThrowable(GeneratedMessageV3 failureMessage) {
         super();
         this.failureMessage = failureMessage;
         this.timestamp = getCurrentTime();
@@ -76,7 +74,7 @@ public Timestamp getTimestamp() {
     public Failure toFailure(Command command) {
         final Any packedMessage = pack(failureMessage);
         final FailureContext context = createContext(command);
-        final FailureId id = Failures.generateId();
+        final FailureId id = Failures.generateId(command.getId());
         return Failure.newBuilder()
                       .setId(id)
                       .setMessage(packedMessage)

client/src/main/java/org/spine3/base/Failures.java

@@ -20,6 +20,7 @@
 
 package org.spine3.base;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.protobuf.Any;
 import com.google.protobuf.Message;
 
@@ -34,15 +35,25 @@
  */
 public final class Failures {
 
+    @VisibleForTesting
+    static final String FAILURE_ID_FORMAT = "%s-fail";
+
     private Failures() {
         // Prevent instantiation of this utility class.
     }
 
-    /** Generates a new random UUID-based {@code FailureId}. */
-    public static FailureId generateId() {
-        final String value = Identifiers.newUuid();
+    /**
+     * Generates a {@code FailureId} based upon a {@linkplain CommandId command ID} in a format:
+     *
+     * <pre>{@code <commandId>-fail}</pre>
+     *
+     * @param id the identifier of the {@linkplain Command command}, which processing caused the
+     *           failure
+     **/
+    public static FailureId generateId(CommandId id) {
+        final String idValue = String.format(FAILURE_ID_FORMAT, id.getUuid());
         return FailureId.newBuilder()
-                        .setUuid(value)
+                        .setValue(idValue)
                         .build();
     }
 

client/src/main/proto/spine/base/failure.proto

@@ -38,7 +38,13 @@ import "spine/base/version.proto";
 
 // Failure identifier.
 message FailureId {
-    string uuid = 1;
+
+    // The value is based upon the ID of the command, which caused the failure.
+    // It has the following format:
+    //
+    //      `<commandId>-fail`
+    //
+    string value = 1;
 }
 
 // A business failure is a condition in business, which does not allow to

client/src/test/java/org/spine3/base/FailureThrowableShould.java

@@ -83,7 +83,7 @@ private static class TestFailure extends FailureThrowable {
         protected TestFailure(GeneratedMessageV3 commandMessage,
                               CommandContext context,
                               GeneratedMessageV3 failure) {
-            super(commandMessage, context, failure);
+            super(failure);
         }
 
         private static final long serialVersionUID = 0L;

client/src/test/java/org/spine3/base/FailuresShould.java

@@ -23,7 +23,8 @@
 import com.google.common.testing.NullPointerTester;
 import org.junit.Test;
 
-import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertEquals;
+import static org.spine3.base.Failures.FAILURE_ID_FORMAT;
 import static org.spine3.test.Tests.assertHasPrivateParameterlessCtor;
 
 /**
@@ -40,13 +41,16 @@ public void have_utility_ctor() {
     public void pass_null_tolerance_check() {
         new NullPointerTester()
                 .setDefault(Command.class, Command.getDefaultInstance())
+                .setDefault(CommandId.class, CommandId.getDefaultInstance())
                 .testAllPublicStaticMethods(Failures.class);
     }
 
     @Test
-    public void generate_failure_id() {
-        assertFalse(Failures.generateId()
-                            .getUuid()
-                            .isEmpty());
+    public void generate_failure_id_upon_command_id() {
+        final CommandId commandId = Commands.generateId();
+        final FailureId actual = Failures.generateId(commandId);
+
+        final String expected = String.format(FAILURE_ID_FORMAT, commandId.getUuid());
+        assertEquals(expected, actual.getValue());
     }
 }

server/src/main/java/org/spine3/server/commandbus/CommandBus.java

@@ -26,10 +26,12 @@
 import io.grpc.stub.StreamObserver;
 import org.spine3.annotations.Internal;
 import org.spine3.base.Command;
+import org.spine3.base.FailureThrowable;
 import org.spine3.base.Identifiers;
 import org.spine3.base.Response;
 import org.spine3.base.Responses;
 import org.spine3.envelope.CommandEnvelope;
+import org.spine3.io.StreamObservers;
 import org.spine3.server.bus.Bus;
 import org.spine3.server.commandstore.CommandStore;
 import org.spine3.server.failure.FailureBus;
@@ -242,6 +244,20 @@ void doPost(CommandEnvelope commandEnvelope) {
         } catch (RuntimeException e) {
             final Throwable cause = getRootCause(e);
             commandStore.updateCommandStatus(commandEnvelope, cause, log);
+
+            emitFailure(commandEnvelope, cause);
+        }
+    }
+
+    /**
+     * Emits the {@code Failure} and posts it to the {@code FailureBus},
+     * if the given {@code cause} is in fact a {@code FailureThrowable} instance.
+     */
+    private void emitFailure(CommandEnvelope commandEnvelope, Throwable cause) {
+        if (cause instanceof FailureThrowable) {
+            final FailureThrowable failure = (FailureThrowable) cause;
+            failureBus.post(failure.toFailure(commandEnvelope.getCommand()),
+                            StreamObservers.<Response>noOpObserver());
         }
     }
 

server/src/main/java/org/spine3/server/entity/AbstractVersionableEntity.java

@@ -22,7 +22,6 @@
 
 import com.google.protobuf.Message;
 import com.google.protobuf.Timestamp;
-import org.spine3.base.Command;
 import org.spine3.base.Version;
 import org.spine3.base.Versions;
 import org.spine3.server.entity.failure.CannotModifyArchivedEntity;
@@ -298,34 +297,28 @@ protected void setDeleted(boolean deleted) {
     /**
      * Ensures that the entity is not marked as {@code archived}.
      *
-     * @param modification the {@linkplain Command} which execution triggered this check
      * @throws CannotModifyArchivedEntity if the entity in in the archived status
      * @see #getLifecycleFlags()
      * @see LifecycleFlags#getArchived()
      */
-    protected void checkNotArchived(Command modification) throws CannotModifyArchivedEntity {
+    protected void checkNotArchived() throws CannotModifyArchivedEntity {
         if (getLifecycleFlags().getArchived()) {
             final String idStr = idToString(getId());
-            throw new CannotModifyArchivedEntity(modification.getMessage(),
-                                                 modification.getContext(),
-                                                 idStr);
+            throw new CannotModifyArchivedEntity(idStr);
         }
     }
 
     /**
      * Ensures that the entity is not marked as {@code deleted}.
      *
-     * @param modification the {@linkplain Command} which execution triggered this check
      * @throws CannotModifyDeletedEntity if the entity is marked as {@code deleted}
      * @see #getLifecycleFlags()
      * @see LifecycleFlags#getDeleted()
      */
-    protected void checkNotDeleted(Command modification) throws CannotModifyDeletedEntity {
+    protected void checkNotDeleted() throws CannotModifyDeletedEntity {
         if (getLifecycleFlags().getDeleted()) {
             final String idStr = idToString(getId());
-            throw new CannotModifyDeletedEntity(modification.getMessage(),
-                                                modification.getContext(),
-                                                idStr);
+            throw new CannotModifyDeletedEntity(idStr);
         }
     }
 

server/src/test/java/org/spine3/server/commandbus/AbstractCommandBusTestSuite.java

@@ -129,6 +129,18 @@ protected static Command newCommandWithoutTenantId() {
         return invalidCmd;
     }
 
+    protected static Command clearTenantId(Command cmd) {
+        final ActorContext.Builder withNoTenant =
+                ActorContext.newBuilder()
+                            .setTenantId(TenantId.getDefaultInstance());
+        final Command result = cmd.toBuilder()
+                                  .setContext(cmd.getContext()
+                                                 .toBuilder()
+                                                 .setActorContext(withNoTenant))
+                                  .build();
+        return result;
+    }
+
     @Before
     public void setUp() {
         final InMemoryStorageFactory storageFactory =

server/src/test/java/org/spine3/server/commandbus/CommandStoreShould.java

@@ -274,9 +274,7 @@ private static class TestFailure extends FailureThrowable {
         private static final long serialVersionUID = 1L;
 
         private TestFailure() {
-            super(Wrapper.forString("some Command message"),
-                  CommandContext.getDefaultInstance(),
-                  Wrapper.forString(TestFailure.class.getName()));
+            super(Wrapper.forString(TestFailure.class.getName()));
         }
     }