Merge pull request #123 from SpineEventEngine/schedule-commands

Schedule command delivering

Author: AlexanderLitus

build.gradle

@@ -15,7 +15,7 @@ allprojects {
     apply plugin: 'jacoco'
 
     group = 'org.spine3'
-    version = '0.2'
+    version = '0.3'
 }
 
 project.ext {

client/build.gradle

@@ -4,7 +4,7 @@ buildscript {
         resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
     }
     dependencies {
-        classpath group: 'org.spine3.tools', name: 'protobuf-plugin', version: '1.2', changing: true
+        classpath group: 'org.spine3.tools', name: 'protobuf-plugin', version: '1.3.1', changing: true
     }
 }
 

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

@@ -22,6 +22,7 @@
 
 import com.google.common.base.Predicate;
 import com.google.protobuf.Descriptors.FileDescriptor;
+import com.google.protobuf.Duration;
 import com.google.protobuf.Message;
 import com.google.protobuf.Timestamp;
 import org.spine3.protobuf.EntityPackagesMap;
@@ -39,6 +40,7 @@
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.protobuf.util.TimeUtil.getCurrentTime;
+import static org.spine3.validate.Validate.isNotDefault;
 
 /**
  * Client-side utilities for working with commands.
@@ -48,11 +50,12 @@
 public class Commands {
 
     /**
-     * A substring which the {@code .proto} file containing commands must have in its name.
+     * A suffix which the {@code .proto} file containing commands must have in its name.
      */
-    public static final String COMMANDS_FILE_SUBSTRING = "commands";
+    public static final String FILE_NAME_SUFFIX = "commands";
 
-    private static final char PROTO_FILE_SEPARATOR = '/';
+    private static final char FILE_PATH_SEPARATOR = '/';
+    private static final char FILE_EXTENSION_SEPARATOR = '.';
 
     private Commands() {}
 
@@ -193,13 +196,14 @@ public static String formatMessageTypeAndId(String format, Message commandMessag
      * Checks if the file is for commands.
      *
      * @param file a descriptor of a {@code .proto} file to check
-     * @return {@code true} if the file name contains {@link #COMMANDS_FILE_SUBSTRING} substring, {@code false} otherwise
+     * @return {@code true} if the file name ends with the {@link #FILE_NAME_SUFFIX}, {@code false} otherwise
      */
     public static boolean isCommandsFile(FileDescriptor file) {
         final String fqn = file.getName();
-        final int startIndexOfFileName = fqn.lastIndexOf(PROTO_FILE_SEPARATOR) + 1;
-        final String fileName = fqn.substring(startIndexOfFileName);
-        final boolean isCommandsFile = fileName.contains(COMMANDS_FILE_SUBSTRING);
+        final int startIndexOfFileName = fqn.lastIndexOf(FILE_PATH_SEPARATOR) + 1;
+        final int endIndexOfFileName = fqn.lastIndexOf(FILE_EXTENSION_SEPARATOR);
+        final String fileName = fqn.substring(startIndexOfFileName, endIndexOfFileName);
+        final boolean isCommandsFile = fileName.endsWith(FILE_NAME_SUFFIX);
         return isCommandsFile;
     }
 
@@ -216,4 +220,20 @@ public static boolean isEntityFile(FileDescriptor file) {
         final boolean isCommandForEntity = EntityPackagesMap.contains(protoPackage);
         return isCommandForEntity;
     }
+
+    /**
+     * Checks if the command is scheduled to be delivered later.
+     *
+     * @param command a command to check
+     * @return {@code true} if the command context has a scheduling option set, {@code false} otherwise
+     */
+    public static boolean isScheduled(Command command) {
+        final Schedule schedule = command.getContext().getSchedule();
+        final Duration delay = schedule.getAfter();
+        if (isNotDefault(delay)) {
+            checkArgument(delay.getSeconds() > 0, "Command delay seconds must be a positive value.");
+            return true;
+        }
+        return false;
+    }
 }

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

@@ -22,6 +22,8 @@
 
 import com.google.protobuf.Empty;
 
+import static org.spine3.protobuf.Messages.fromAny;
+
 /**
  * Utilities for working with {@link org.spine3.base.Response} objects.
  *
@@ -47,6 +49,8 @@ public static Response ok() {
     }
 
     /**
+     * Checks if the response is OK.
+     *
      * @return {@code true} if the passed response represents `ok` status,
      *         {@code false} otherwise
      */
@@ -56,13 +60,31 @@ public static boolean isOk(Response response) {
     }
 
     /**
+     * Checks if the response is `unsupported command`.
+     *
      * @return {@code true} if the passed response represents `unsupported command` error,
      *         {@code false} otherwise
      */
     public static boolean isUnsupportedCommand(Response response) {
         if (response.getStatusCase() == Response.StatusCase.ERROR) {
             final Error error = response.getError();
-            return error.getCode() == CommandValidationError.UNSUPPORTED_COMMAND.getNumber();
+            final boolean isUnsupported = error.getCode() == CommandValidationError.UNSUPPORTED_COMMAND.getNumber();
+            return isUnsupported;
+        }
+        return false;
+    }
+
+    /**
+     * Checks if the response is `invalid command`.
+     *
+     * @return {@code true} if the passed response represents `invalid command` error,
+     *         {@code false} otherwise
+     */
+    public static boolean isInvalidCommand(Response response) {
+        if (response.getStatusCase() == Response.StatusCase.FAILURE) {
+            final ValidationFailure failure = fromAny(response.getFailure().getInstance());
+            final boolean isInvalid = !failure.getConstraintViolationList().isEmpty();
+            return isInvalid;
         }
         return false;
     }