Merge pull request #108 from bcgov/feature/enumCheck

Small fix for event catches

Author: arcshiftsolutions

api/src/main/java/ca/bc/gov/educ/api/pen/replication/constants/EventOutcome.java

@@ -93,5 +93,17 @@ public enum EventOutcome {
 
   GRAD_STUDENT_CITIZENSHIP_UPDATED,
 
-  STUDENT_ADDRESS_UPDATED
+  STUDENT_ADDRESS_UPDATED;
+
+  public static boolean isValid(String value) {
+    if (value == null) {
+      return false;
+    }
+    try {
+      EventOutcome.valueOf(value);
+      return true;
+    } catch (IllegalArgumentException e) {
+      return false;
+    }
+  }
 }

api/src/main/java/ca/bc/gov/educ/api/pen/replication/constants/EventType.java

@@ -86,5 +86,17 @@ public enum EventType {
 
   ADOPT_GRAD_STUDENT,
 
-  UPDATE_GRAD_STUDENT_CITIZENSHIP
+  UPDATE_GRAD_STUDENT_CITIZENSHIP;
+
+  public static boolean isValid(String value) {
+    if (value == null) {
+      return false;
+    }
+    try {
+      EventOutcome.valueOf(value);
+      return true;
+    } catch (IllegalArgumentException e) {
+      return false;
+    }
+  }
 }

api/src/main/java/ca/bc/gov/educ/api/pen/replication/exception/IgnoreEventException.java

@@ -0,0 +1,25 @@
+package ca.bc.gov.educ.api.pen.replication.exception;
+
+import lombok.Data;
+
+@Data
+public class IgnoreEventException extends Exception {
+
+  private final String eventType;
+  private final String eventOutcome;
+  /**
+   * The constant serialVersionUID.
+   */
+  private static final long serialVersionUID = 5241655513745148898L;
+
+  /**
+   * Instantiates a new Pen reg api runtime exception.
+   *
+   * @param message the message
+   */
+  public IgnoreEventException(final String message, String eventType, String eventOutcome) {
+    super(message);
+    this.eventType = eventType;
+    this.eventOutcome = eventOutcome;
+  }
+}

api/src/main/java/ca/bc/gov/educ/api/pen/replication/messaging/jetstream/Subscriber.java

@@ -1,10 +1,11 @@
 package ca.bc.gov.educ.api.pen.replication.messaging.jetstream;
 
+import ca.bc.gov.educ.api.pen.replication.exception.IgnoreEventException;
 import ca.bc.gov.educ.api.pen.replication.helpers.LogHelper;
 import ca.bc.gov.educ.api.pen.replication.properties.ApplicationProperties;
 import ca.bc.gov.educ.api.pen.replication.service.EventHandlerDelegatorService;
 import ca.bc.gov.educ.api.pen.replication.struct.ChoreographedEvent;
-import ca.bc.gov.educ.api.pen.replication.util.JsonUtil;
+import ca.bc.gov.educ.api.pen.replication.util.EventUtils;
 import com.google.common.util.concurrent.ThreadFactoryBuilder;
 import io.nats.client.Connection;
 import io.nats.client.JetStreamApiException;
@@ -115,7 +116,7 @@ public void onMessage(final Message message) {
       try {
         val eventString = new String(message.getData());
         LogHelper.logMessagingEventDetails(eventString);
-        final ChoreographedEvent event = JsonUtil.getJsonObjectFromString(ChoreographedEvent.class, eventString);
+        final ChoreographedEvent event = EventUtils.getChoreographedEventIfValid(eventString);
         if (event.getEventPayload() == null) {
           message.ack();
           log.warn("payload is null, ignoring event :: {}", event);
@@ -129,10 +130,14 @@ public void onMessage(final Message message) {
           }
         });
         log.info("received event :: {} ", event);
-      } catch (final Exception ex) {
+      } catch (final IgnoreEventException ex) {
+        log.warn("Ignoring event with type :: {} :: and event outcome :: {}", ex.getEventType(), ex.getEventOutcome());
+        message.ack();
+      }catch (final Exception ex) {
         log.error("Exception ", ex);
       }
     }
   }
+  
 
 }

api/src/main/java/ca/bc/gov/educ/api/pen/replication/struct/ChoreographedEventValidation.java

@@ -0,0 +1,45 @@
+package ca.bc.gov.educ.api.pen.replication.struct;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.UUID;
+
+/**
+ * The type Choreographed event.
+ */
+@Data
+@Builder
+@AllArgsConstructor
+@NoArgsConstructor
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ChoreographedEventValidation {
+  /**
+   * The Event id.
+   */
+  UUID eventID;
+  /**
+   * The Event type.
+   */
+  String eventType;
+  /**
+   * The Event outcome.
+   */
+  String eventOutcome;
+  /**
+   * The Event payload.
+   */
+  String eventPayload; // json string
+
+  /**
+   * The Create user.
+   */
+  String createUser;
+  /**
+   * The Update user.
+   */
+  String updateUser;
+}

api/src/main/java/ca/bc/gov/educ/api/pen/replication/util/EventUtils.java

@@ -0,0 +1,25 @@
+package ca.bc.gov.educ.api.pen.replication.util;
+
+import ca.bc.gov.educ.api.pen.replication.constants.EventOutcome;
+import ca.bc.gov.educ.api.pen.replication.constants.EventType;
+import ca.bc.gov.educ.api.pen.replication.exception.IgnoreEventException;
+import ca.bc.gov.educ.api.pen.replication.struct.ChoreographedEvent;
+import ca.bc.gov.educ.api.pen.replication.struct.ChoreographedEventValidation;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import org.apache.commons.lang3.StringUtils;
+
+
+public final class EventUtils {
+  private EventUtils() {
+  }
+
+  public static ChoreographedEvent getChoreographedEventIfValid(String eventString) throws JsonProcessingException, IgnoreEventException {
+    final ChoreographedEventValidation event = JsonUtil.getJsonObjectFromString(ChoreographedEventValidation.class, eventString);
+    if(StringUtils.isNotBlank(event.getEventOutcome()) && !EventOutcome.isValid(event.getEventOutcome())) {
+      throw new IgnoreEventException("Invalid event outcome", event.getEventType(), event.getEventOutcome());
+    }else if(StringUtils.isNotBlank(event.getEventType()) && !EventType.isValid(event.getEventType())) {
+      throw new IgnoreEventException("Invalid event type", event.getEventType(), event.getEventOutcome());
+    }
+    return JsonUtil.getJsonObjectFromString(ChoreographedEvent.class, eventString);
+  }
+}