Added max retries / waiting for retry (#438)

Author: mfriesen

actions/src/main/java/com/formkiq/module/actions/Action.java

@@ -91,6 +91,12 @@ public class Action implements DynamodbRecord<Action>, DbKeys {
   /** Workflow Step Id. */
   @Reflectable
   private String workflowStepId;
+  /** Retry Count. */
+  @Reflectable
+  private Integer retryCount;
+  /** Max Retries. */
+  @Reflectable
+  private Integer maxRetries;
 
   /**
    * constructor.
@@ -180,6 +186,8 @@ public Map<String, AttributeValue> getAttributes(final String siteId) {
       attrs.put("startDate", AttributeValue.fromS(df.format(this.startDate)));
     }
 
+    addN(attrs, "retryCount", this.retryCount);
+    addN(attrs, "maxRetries", this.maxRetries);
     addS(attrs, "message", this.message);
     addS(attrs, "queueId", this.queueId);
     addS(attrs, "workflowId", this.workflowId);
@@ -216,7 +224,8 @@ public Action getFromAttributes(final String siteId, final Map<String, Attribute
     Action record = new Action().documentId(ss(attrs, "documentId")).userId(ss(attrs, "userId"))
         .message(ss(attrs, "message")).queueId(ss(attrs, "queueId"))
         .workflowId(ss(attrs, "workflowId")).workflowLastStep(ss(attrs, "workflowLastStep"))
-        .workflowStepId(ss(attrs, "workflowStepId"));
+        .workflowStepId(ss(attrs, "workflowStepId")).retryCount(toInt(attrs, "retryCount"))
+        .maxRetries(toInt(attrs, "maxRetries"));
 
     if (attrs.containsKey("status")) {
       record.status(ActionStatus.valueOf(ss(attrs, "status")));
@@ -300,6 +309,26 @@ public Action insertedDate(final Date date) {
     return this;
   }
 
+  /**
+   * Get Max Retries.
+   * 
+   * @return {@link Integer}
+   */
+  public Integer maxRetries() {
+    return maxRetries;
+  }
+
+  /**
+   * Set Max Retries.
+   * 
+   * @param count {@link Integer}
+   * @return {@link Action}
+   */
+  public Action maxRetries(final Integer count) {
+    this.maxRetries = count;
+    return this;
+  }
+
   /**
    * Get Action Message.
    * 
@@ -410,6 +439,26 @@ public Action queueId(final String id) {
     return this;
   }
 
+  /**
+   * Get Retry Count.
+   * 
+   * @return {@link Integer}
+   */
+  public Integer retryCount() {
+    return retryCount;
+  }
+
+  /**
+   * Set retry Count.
+   * 
+   * @param count {@link Integer}
+   * @return {@link Action}
+   */
+  public Action retryCount(final Integer count) {
+    this.retryCount = count;
+    return this;
+  }
+
   @Override
   public String sk() {
     if (isEmpty(this.index)) {

actions/src/main/java/com/formkiq/module/actions/ActionStatus.java

@@ -42,5 +42,9 @@ public enum ActionStatus {
   /** Running. */
   RUNNING,
   /** Skipped. */
-  SKIPPED;
+  SKIPPED,
+  /** Max Retry Reachd. */
+  MAX_RETRIES_REACHED,
+  /** Waiting for Retry. */
+  WAITING_FOR_RETRY
 }

actions/src/main/java/com/formkiq/module/actions/services/ActionStatusPredicate.java

@@ -23,6 +23,7 @@
  */
 package com.formkiq.module.actions.services;
 
+import java.util.List;
 import java.util.function.Predicate;
 import com.formkiq.module.actions.Action;
 import com.formkiq.module.actions.ActionStatus;
@@ -35,19 +36,19 @@
 public class ActionStatusPredicate implements Predicate<Action> {
 
   /** {@link ActionStatus}. */
-  private ActionStatus status;
+  private List<ActionStatus> status;
 
   /**
    * constructor.
    * 
    * @param actionStatus {@link ActionStatus}
    */
-  public ActionStatusPredicate(final ActionStatus actionStatus) {
-    this.status = actionStatus;
+  public ActionStatusPredicate(final ActionStatus... actionStatus) {
+    this.status = List.of(actionStatus);
   }
 
   @Override
   public boolean test(final Action a) {
-    return this.status.equals(a.status());
+    return this.status.contains(a.status());
   }
 }

actions/src/main/java/com/formkiq/module/actions/services/ActionsServiceDynamoDb.java

@@ -98,6 +98,13 @@ public ActionsServiceDynamoDb(final DynamoDbConnectionBuilder connection,
     this.db = new DynamoDbServiceImpl(this.dbClient, documentsTable);
   }
 
+  private void addKeyIfNotNull(final Map<String, AttributeValueUpdate> updates,
+      final Map<String, AttributeValue> attrs, final String key) {
+    if (attrs.get(key) != null) {
+      updates.put(key, AttributeValueUpdate.builder().value(attrs.get(key)).build());
+    }
+  }
+
   private void deleteAction(final String siteId, final Action action) {
     String pk = action.pk(siteId);
     String sk = action.sk();
@@ -364,14 +371,10 @@ public void updateActionStatus(final String siteId, final String documentId,
           AttributeValueUpdate.builder().value(fromS(df.format(new Date()))).build());
     }
 
-    if (action.message() != null) {
-      updates.put("message", AttributeValueUpdate.builder().value(attrs.get("message")).build());
-    }
-
-    if (action.completedDate() != null) {
-      updates.put("completedDate",
-          AttributeValueUpdate.builder().value(attrs.get("completedDate")).build());
-    }
+    addKeyIfNotNull(updates, attrs, "message");
+    addKeyIfNotNull(updates, attrs, "retryCount");
+    addKeyIfNotNull(updates, attrs, "maxRetries");
+    addKeyIfNotNull(updates, attrs, "completedDate");
 
     for (String index : Arrays.asList(GSI1, GSI2)) {
 

aws-dynamodb/src/main/java/com/formkiq/aws/dynamodb/DbKeys.java

@@ -165,6 +165,19 @@ default void addMobject(final Map<String, AttributeValue> map, final String key,
     }
   }
 
+  /**
+   * Add Number to {@link Map} {@link AttributeValue}.
+   *
+   * @param map {@link Map} {@link AttributeValue}
+   * @param key {@link String}
+   * @param value {@link Number}
+   */
+  default void addN(final Map<String, AttributeValue> map, final String key, final Number value) {
+    if (value != null) {
+      map.put(key, AttributeValue.builder().n(String.valueOf(value)).build());
+    }
+  }
+
   /**
    * Add Number to {@link Map} {@link AttributeValue}.
    * 

build.gradle

@@ -226,7 +226,7 @@ openApiGenerate {
   modelPackage.set("com.formkiq.springboot.model")
 }
 
-tasks.register("cleanOpenApi") {
+tasks.register("buildOpenApi") {
   def fileMappings = [
     (file("build/ytt/api/api.yaml"))        : "openapi-jwt.yaml",
     (file("build/ytt/api/api-iam.yaml"))    : "openapi-iam.yaml",
@@ -271,4 +271,4 @@ tasks.register("cleanOpenApi") {
   }
 }
 
-cleanOpenApi.dependsOn 'yttRenderAll'
+buildOpenApi.dependsOn 'yttRenderAll'

docs/openapi/openapi-iam.yaml

@@ -11215,6 +11215,8 @@
               - RUNNING
               - SKIPPED
               - FAILED_RETRY
+              - MAX_RETRIES_REACHED
+              - WAITING_FOR_RETRY
             DocumentActionType:
               type: string
               description: Type of the Document Action
@@ -11240,6 +11242,12 @@
                   $ref: '#/components/schemas/DocumentActionStatus'
                 type:
                   $ref: '#/components/schemas/DocumentActionType'
+                retryCount:
+                  type: number
+                  description: The number of times this action has already been attempted
+                maxRetries:
+                  type: number
+                  description: The maximum number of retry attempts allowed for this action
                 queueId:
                   type: string
                   description: Queue Id

docs/openapi/openapi-jwt.yaml

@@ -11215,6 +11215,8 @@
               - RUNNING
               - SKIPPED
               - FAILED_RETRY
+              - MAX_RETRIES_REACHED
+              - WAITING_FOR_RETRY
             DocumentActionType:
               type: string
               description: Type of the Document Action
@@ -11240,6 +11242,12 @@
                   $ref: '#/components/schemas/DocumentActionStatus'
                 type:
                   $ref: '#/components/schemas/DocumentActionType'
+                retryCount:
+                  type: number
+                  description: The number of times this action has already been attempted
+                maxRetries:
+                  type: number
+                  description: The maximum number of retry attempts allowed for this action
                 queueId:
                   type: string
                   description: Queue Id

docs/openapi/openapi-key.yaml

@@ -11215,6 +11215,8 @@
               - RUNNING
               - SKIPPED
               - FAILED_RETRY
+              - MAX_RETRIES_REACHED
+              - WAITING_FOR_RETRY
             DocumentActionType:
               type: string
               description: Type of the Document Action
@@ -11240,6 +11242,12 @@
                   $ref: '#/components/schemas/DocumentActionStatus'
                 type:
                   $ref: '#/components/schemas/DocumentActionType'
+                retryCount:
+                  type: number
+                  description: The number of times this action has already been attempted
+                maxRetries:
+                  type: number
+                  description: The maximum number of retry attempts allowed for this action
                 queueId:
                   type: string
                   description: Queue Id

fkq-test-utils/src/main/java/com/formkiq/testutils/api/ApiHttpResponseOkPredicate.java

@@ -0,0 +1,38 @@
+/**
+ * MIT License
+ * 
+ * Copyright (c) 2018 - 2020 FormKiQ
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.formkiq.testutils.api;
+
+import java.util.function.Predicate;
+
+/**
+ * {@link Predicate} for {@link ApiHttpResponse} for no error.
+ * 
+ * @param <T> Type of {@link ApiHttpResponse}
+ */
+public class ApiHttpResponseOkPredicate<T> implements Predicate<ApiHttpResponse<T>> {
+  @Override
+  public boolean test(final ApiHttpResponse<T> apiHttpResponse) {
+    return !apiHttpResponse.isError();
+  }
+}