Merge pull request #362 from code-dot-org/molly-ignore-unused-messages

Ignore unused output messages in basic output adapters

Author: molly-moen

org-code-javabuilder/lib/src/main/java/dev/javabuilder/WebSocketOutputAdapter.java

@@ -20,22 +20,26 @@ public WebSocketOutputAdapter(Session session) {
 
   @Override
   public void sendMessage(ClientMessage message) {
-    try {
-      endpoint.sendText(message.getFormattedMessage());
-    } catch (IOException e) {
-      e.printStackTrace();
-    } catch (IllegalStateException e) {
-      throw new InternalServerRuntimeException(InternalExceptionKey.CONNECTION_TERMINATED, e);
+    if (message.shouldAlwaysSend()) {
+      try {
+        endpoint.sendText(message.getFormattedMessage());
+      } catch (IOException e) {
+        e.printStackTrace();
+      } catch (IllegalStateException e) {
+        throw new InternalServerRuntimeException(InternalExceptionKey.CONNECTION_TERMINATED, e);
+      }
     }
   }
 
   public void sendDebuggingMessage(ClientMessage message) {
-    try {
-      endpoint.sendText(message.getFormattedMessage());
-    } catch (IOException e) {
-      e.printStackTrace();
-    } catch (IllegalStateException e) {
-      throw new InternalServerRuntimeException(InternalExceptionKey.CONNECTION_TERMINATED, e);
+    if (message.shouldAlwaysSend()) {
+      try {
+        endpoint.sendText(message.getFormattedMessage());
+      } catch (IOException e) {
+        e.printStackTrace();
+      } catch (IllegalStateException e) {
+        throw new InternalServerRuntimeException(InternalExceptionKey.CONNECTION_TERMINATED, e);
+      }
     }
   }
 }

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/AWSOutputAdapter.java

@@ -25,18 +25,22 @@ public AWSOutputAdapter(String connectionId, AmazonApiGatewayManagementApi api)
    */
   @Override
   public void sendMessage(ClientMessage message) {
-    PostToConnectionRequest post = new PostToConnectionRequest();
-    post.setConnectionId(connectionId);
-    post.setData(ByteBuffer.wrap((message.getFormattedMessage()).getBytes()));
-    this.sendMessageHelper(post);
+    if (message.shouldAlwaysSend()) {
+      PostToConnectionRequest post = new PostToConnectionRequest();
+      post.setConnectionId(connectionId);
+      post.setData(ByteBuffer.wrap((message.getFormattedMessage()).getBytes()));
+      this.sendMessageHelper(post);
+    }
   }
 
   public void sendDebuggingMessage(ClientMessage message) {
-    String time = String.valueOf(java.time.Clock.systemUTC().instant());
-    PostToConnectionRequest post = new PostToConnectionRequest();
-    post.setConnectionId(connectionId);
-    post.setData(ByteBuffer.wrap((message + " " + time).getBytes()));
-    this.sendMessageHelper(post);
+    if (message.shouldAlwaysSend()) {
+      String time = String.valueOf(java.time.Clock.systemUTC().instant());
+      PostToConnectionRequest post = new PostToConnectionRequest();
+      post.setConnectionId(connectionId);
+      post.setData(ByteBuffer.wrap((message + " " + time).getBytes()));
+      this.sendMessageHelper(post);
+    }
   }
 
   private void sendMessageHelper(PostToConnectionRequest post) {

org-code-javabuilder/neighborhood/src/main/java/org/code/neighborhood/support/NeighborhoodSignalMessage.java

@@ -1,11 +1,27 @@
 package org.code.neighborhood.support;
 
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Set;
 import org.code.protocol.ClientMessage;
 import org.code.protocol.ClientMessageType;
 
 public class NeighborhoodSignalMessage extends ClientMessage {
   public NeighborhoodSignalMessage(NeighborhoodSignalKey key, HashMap<String, String> detail) {
     super(ClientMessageType.NEIGHBORHOOD, key.toString(), detail);
   }
+
+  @Override
+  public boolean shouldAlwaysSend() {
+    String signalKey = this.getValue();
+    Set<String> ignoredSignalKeys = new HashSet<>();
+    // These keys are only used for validation testing, by default don't send them.
+    ignoredSignalKeys.add(NeighborhoodSignalKey.CAN_MOVE.toString());
+    ignoredSignalKeys.add(NeighborhoodSignalKey.IS_ON_BUCKET.toString());
+    ignoredSignalKeys.add(NeighborhoodSignalKey.IS_ON_PAINT.toString());
+    if (ignoredSignalKeys.contains(signalKey)) {
+      return false;
+    }
+    return true;
+  }
 }

org-code-javabuilder/protocol/src/main/java/org/code/protocol/ClientMessage.java

@@ -67,4 +67,12 @@ public String getFormattedMessage() {
     }
     return formattedMessage.toString();
   }
+
+  /**
+   * @return whether or not this message should always be sent by any output adapter. Some messages
+   *     are only relevant for the test output adapter
+   */
+  public boolean shouldAlwaysSend() {
+    return true;
+  }
 }