Merge pull request #229 from JLLeitschuh/feat/exceptionWitnessResponderButton

Add a button to respond to the ExceptionWitness

Author: JLLeitschuh

core/src/main/java/edu/wpi/grip/core/Step.java

@@ -6,8 +6,8 @@
 import com.google.inject.Singleton;
 import com.thoughtworks.xstream.annotations.XStreamAlias;
 import edu.wpi.grip.core.events.SocketChangedEvent;
+import edu.wpi.grip.core.util.ExceptionWitness;
 
-import java.util.NoSuchElementException;
 import java.util.Optional;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -20,21 +20,26 @@
  */
 @XStreamAlias(value = "grip:Step")
 public class Step {
+    private static final Logger logger = Logger.getLogger(Step.class.getName());
+    private static final String MISSING_SOCKET_MESSAGE_END = " must have a value to run this step.";
 
-    private final Logger logger =  Logger.getLogger(Step.class.getName());
+    private final ExceptionWitness witness;
 
     private final Operation operation;
     private final InputSocket<?>[] inputSockets;
     private final OutputSocket<?>[] outputSockets;
     private final Optional<?> data;
 
+
     @Singleton
     public static class Factory {
         private final EventBus eventBus;
+        private final ExceptionWitness.Factory exceptionWitnessFactory;
 
         @Inject
-        public Factory(EventBus eventBus) {
+        public Factory(EventBus eventBus, ExceptionWitness.Factory exceptionWitnessFactory) {
             this.eventBus = eventBus;
+            this.exceptionWitnessFactory = exceptionWitnessFactory;
         }
 
         public Step create(Operation operation) {
@@ -51,7 +56,13 @@ public Step create(Operation operation) {
                 eventBus.register(socket);
             }
 
-            final Step step = new Step(operation, inputSockets, outputSockets, operation.createData());
+            final Step step = new Step(
+                    operation,
+                    inputSockets,
+                    outputSockets,
+                    operation.createData(),
+                    exceptionWitnessFactory
+            );
             eventBus.register(step);
             for (Socket<?> socket : inputSockets) {
                 socket.setStep(Optional.of(step));
@@ -66,16 +77,22 @@ public Step create(Operation operation) {
     }
 
     /**
-     * @param operation     The operation that is performed at this step.
-     * @param inputSockets  The input sockets from the operation.
-     * @param outputSockets The output sockets provided by the operation.
-     * @param data          The data provided by the operation.
+     * @param operation               The operation that is performed at this step.
+     * @param inputSockets            The input sockets from the operation.
+     * @param outputSockets           The output sockets provided by the operation.
+     * @param data                    The data provided by the operation.
+     * @param exceptionWitnessFactory A factory used to create an {@link ExceptionWitness}
      */
-    Step(Operation operation, InputSocket<?>[] inputSockets, OutputSocket<?>[] outputSockets, Optional<?> data) {
+    Step(Operation operation,
+         InputSocket<?>[] inputSockets,
+         OutputSocket<?>[] outputSockets,
+         Optional<?> data,
+         ExceptionWitness.Factory exceptionWitnessFactory) {
         this.operation = operation;
         this.inputSockets = inputSockets;
         this.outputSockets = outputSockets;
         this.data = data;
+        this.witness = exceptionWitnessFactory.create(this);
     }
 
     /**
@@ -115,25 +132,25 @@ private void resetOutputSockets() {
      * default values.
      */
     private synchronized void runPerformIfPossible() {
-        try {
-            for (InputSocket<?> inputSocket : inputSockets) {
-                inputSocket.getValue()
-                        .orElseThrow(() -> new NoSuchElementException(
-                                inputSocket.getSocketHint().getIdentifier() + " must have a value to run this step."
-                        ));
+        for (InputSocket<?> inputSocket : inputSockets) {
+            // If there is a socket that isn't present then we have a problem.
+            if (!inputSocket.getValue().isPresent()) {
+                witness.flagWarning(inputSocket.getSocketHint().getIdentifier() + MISSING_SOCKET_MESSAGE_END);
+                resetOutputSockets();
+                return;  /* Only run the perform method if all of the input sockets are present. */
             }
-        } catch (NoSuchElementException e) {
-            //TODO: show warning icon
-            resetOutputSockets();
-            return; /* Only run the perform method if all of the input sockets are present. */
         }
 
         try {
             this.operation.perform(inputSockets, outputSockets, data);
         } catch (Exception e) {
-            logger.log(Level.WARNING, e.getMessage(), e);
+            final String operationFailedMessage = "The " + operation.getName() + " operation did not perform correctly.";
+            logger.log(Level.WARNING, operationFailedMessage, e);
+            witness.flagException(e, operationFailedMessage);
             resetOutputSockets();
+            return;
         }
+        witness.clearException();
     }
 
     @Subscribe

core/src/main/java/edu/wpi/grip/core/events/ExceptionEvent.java

@@ -12,28 +12,51 @@
  */
 public final class ExceptionEvent {
     private final Object origin;
-    private final Exception exception;
-    private final Optional<String> message;
+    private final Optional<Exception> exception;
+    private final String message;
 
-    public ExceptionEvent(Object origin, Exception exception) {
-        this(origin, exception, null);
-    }
 
+    /**
+     * @param origin    The object that triggered this exception.
+     * @param exception The exception this is handling.
+     * @param message   The message associated with this event.
+     *                  If <tt>null</tt> will use {@link Exception#getMessage()}
+     */
     public ExceptionEvent(Object origin, Exception exception, String message) {
-        this.exception = checkNotNull(exception, "The exception can not be null");
+        this.exception = Optional.of(exception);
+        this.origin = checkNotNull(origin, "The origin can not be null");
+        this.message = message != null ? message : exception.getMessage();
+    }
+
+    /**
+     * @param origin  The object that triggered this exception.
+     * @param message The message associated with this event.
+     */
+    public ExceptionEvent(Object origin, String message) {
         this.origin = checkNotNull(origin, "The origin can not be null");
-        this.message = Optional.ofNullable(message);
+        this.exception = Optional.empty();
+        this.message = message;
     }
 
-    public Optional<String> getMessage() {
+    /**
+     * @param origin    The object that triggered this exception.
+     * @param exception The exception this is handling.
+     *                  This will use {@link Exception#getMessage()} for the message.
+     */
+    public ExceptionEvent(Object origin, Exception exception) {
+        this(origin, exception, null);
+    }
+
+
+    public String getMessage() {
         return message;
     }
 
     public Object getOrigin() {
         return origin;
     }
 
-    public Exception getException() {
+    public Optional<Exception> getException() {
         return exception;
     }
 }

core/src/main/java/edu/wpi/grip/core/util/ExceptionWitness.java

@@ -30,7 +30,7 @@
  * </pre>
  * <blockquote/>
  */
-public final class ExceptionWitness {
+public class ExceptionWitness {
     private final EventBus eventBus;
     private final Object origin;
     private final AtomicBoolean isExceptionState = new AtomicBoolean(false);
@@ -63,6 +63,17 @@ public final void flagException(Exception exception) {
         flagException(exception, null);
     }
 
+    /**
+     * Allows a warning to be flagged without an exception. This should never be done when there is an exception
+     * involved.
+     *
+     * @param warningMessage The message to flag.
+     */
+    public final void flagWarning(final String warningMessage) {
+        isExceptionState.set(true);
+        this.eventBus.post(new ExceptionEvent(origin, warningMessage));
+    }
+
     /**
      * Indicate that there isn't currently an exception.
      * <p>

core/src/test/java/edu/wpi/grip/core/MockStep.java

@@ -1,16 +1,18 @@
 package edu.wpi.grip.core;
 
 import com.google.common.eventbus.EventBus;
+import edu.wpi.grip.core.util.MockExceptionWitness;
 
 import java.util.Optional;
 
 public class MockStep extends Step {
 
     public MockStep() {
-        super(null, new InputSocket[0], new OutputSocket[0], Optional.empty());
+        super(null, new InputSocket[0], new OutputSocket[0], Optional.empty(), origin -> null);
     }
 
     public static Step createMockStepWithOperation() {
-        return new Step.Factory(new EventBus()).create(new MockOperation());
+        final EventBus eventBus = new EventBus();
+        return new Step.Factory(eventBus, origin -> new MockExceptionWitness(eventBus, origin)).create(new MockOperation());
     }
 }

core/src/test/java/edu/wpi/grip/core/PythonTest.java

@@ -2,6 +2,7 @@
 
 import com.google.common.eventbus.EventBus;
 import edu.wpi.grip.core.operations.PythonScriptOperation;
+import edu.wpi.grip.core.util.MockExceptionWitness;
 import org.junit.Test;
 
 import static org.junit.Assert.assertEquals;
@@ -14,7 +15,7 @@ public class PythonTest {
     @Test
     public void testPython() throws Exception {
         Operation addition = new PythonScriptOperation(PythonTest.class.getResource("/edu/wpi/grip/scripts/addition.py"));
-        Step step = new Step.Factory(eventBus).create(addition);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(addition);
         Socket aSocket = step.getInputSockets()[0];
         Socket bSocket = step.getInputSockets()[1];
         Socket sumSocket = step.getOutputSockets()[0];
@@ -31,7 +32,7 @@ public void testPythonAdditionFromString() throws Exception {
                 ".lang.Integer\n\ninputs = [\n    grip.SocketHints.createNumberSocketHint(\"a\", 0.0),\n    grip.SocketHints.createNumberSocketHint(" +
                 "\"b\", 0.0),\n]\n\noutputs = [\n    grip.SocketHints.Outputs.createNumberSocketHint(\"sum\", 0.0)," +
                 "\n]\n\ndef perform(a, b):\n    return a + b\n");
-        Step step = new Step.Factory(eventBus).create(additionFromString);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(additionFromString);
         Socket aSocket = step.getInputSockets()[0];
         Socket bSocket = step.getInputSockets()[1];
         Socket sumSocket = step.getOutputSockets()[0];
@@ -45,7 +46,7 @@ public void testPythonAdditionFromString() throws Exception {
     @Test
     public void testPythonMultipleOutputs() throws Exception {
         Operation additionSubtraction = new PythonScriptOperation(PythonTest.class.getResource("/edu/wpi/grip/scripts/addition-subtraction.py"));
-        Step step = new Step.Factory(eventBus).create(additionSubtraction);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(additionSubtraction);
         Socket aSocket = step.getInputSockets()[0];
         Socket bSocket = step.getInputSockets()[1];
         Socket sumSocket = step.getOutputSockets()[0];
@@ -61,7 +62,7 @@ public void testPythonMultipleOutputs() throws Exception {
     @Test
     public void testPythonWrongOutputCount() throws Exception {
         Operation additionWrongOutputCount = new PythonScriptOperation(PythonTest.class.getResource("/edu/wpi/grip/scripts/addition-wrong-output-count.py"));
-        Step step = new Step.Factory(eventBus).create(additionWrongOutputCount);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(additionWrongOutputCount);
         Socket aSocket = step.getInputSockets()[0];
         Socket bSocket = step.getInputSockets()[1];
         Socket sumSocket = step.getOutputSockets()[0];
@@ -75,7 +76,7 @@ public void testPythonWrongOutputCount() throws Exception {
     @Test
     public void testPythonWrongOutputType() throws Exception {
         Operation additionWrongOutputType = new PythonScriptOperation(PythonTest.class.getResource("/edu/wpi/grip/scripts/addition-wrong-output-type.py"));
-        Step step = new Step.Factory(eventBus).create(additionWrongOutputType);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(additionWrongOutputType);
         Socket aSocket = step.getInputSockets()[0];
         Socket bSocket = step.getInputSockets()[1];
         Socket sumSocket = step.getOutputSockets()[0];

core/src/test/java/edu/wpi/grip/core/StepTest.java

@@ -1,6 +1,7 @@
 package edu.wpi.grip.core;
 
 import com.google.common.eventbus.EventBus;
+import edu.wpi.grip.core.util.MockExceptionWitness;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -18,12 +19,12 @@ public void setUp() {
 
     @Test(expected = NullPointerException.class)
     public void testOperationNotNull() {
-        new Step.Factory(eventBus).create(null);
+        new Step.Factory(eventBus, (origin) -> null).create(null);
     }
 
     @Test
     public void testStep() {
-        Step step = new Step.Factory(eventBus).create(addition);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(addition);
         Socket<Double> a = (Socket<Double>) step.getInputSockets()[0];
         Socket<Double> b = (Socket<Double>) step.getInputSockets()[1];
         Socket<Double> c = (Socket<Double>) step.getOutputSockets()[0];
@@ -37,7 +38,7 @@ public void testStep() {
 
     @Test
     public void testSocketDirection() {
-        Step step = new Step.Factory(eventBus).create(addition);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(addition);
         Socket<Double> a = (Socket<Double>) step.getInputSockets()[0];
         Socket<Double> b = (Socket<Double>) step.getInputSockets()[1];
         Socket<Double> c = (Socket<Double>) step.getOutputSockets()[0];
@@ -49,7 +50,7 @@ public void testSocketDirection() {
 
     @Test
     public void testGetOperation() {
-        Step step = new Step.Factory(eventBus).create(addition);
+        Step step = new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(addition);
 
         assertEquals(addition, step.getOperation());
     }

core/src/test/java/edu/wpi/grip/core/operations/OperationsTest.java

@@ -6,6 +6,7 @@
 import edu.wpi.grip.core.Operation;
 import edu.wpi.grip.core.Step;
 import edu.wpi.grip.core.events.OperationAddedEvent;
+import edu.wpi.grip.core.util.MockExceptionWitness;
 import edu.wpi.grip.generated.CVOperations;
 import org.junit.After;
 import org.junit.Before;
@@ -48,15 +49,15 @@ public void afterTest() {
     public void testCreateAllCVSteps() {
         CVOperations.addOperations(eventBus);
         for (Operation operation : operationList) {
-            new Step.Factory(eventBus).create(operation);
+            new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(operation);
         }
     }
 
     @Test
     public void testCreateAllCoreSteps() {
         Operations.addOperations(eventBus);
         for (Operation operation : operationList) {
-            new Step.Factory(eventBus).create(operation);
+            new Step.Factory(eventBus, (origin) -> new MockExceptionWitness(eventBus, origin)).create(operation);
         }
     }
 }

core/src/test/java/edu/wpi/grip/core/util/MockExceptionWitness.java

@@ -0,0 +1,12 @@
+package edu.wpi.grip.core.util;
+
+import com.google.common.eventbus.EventBus;
+import com.google.inject.assistedinject.Assisted;
+
+
+public class MockExceptionWitness extends ExceptionWitness {
+
+    public MockExceptionWitness(EventBus eventBus, @Assisted Object origin) {
+        super(eventBus, origin);
+    }
+}

ui/src/main/java/edu/wpi/grip/ui/GRIPUIModule.java

@@ -9,6 +9,7 @@
 import com.google.inject.spi.TypeListener;
 import edu.wpi.grip.core.Source;
 import edu.wpi.grip.ui.annotations.ParametrizedController;
+import edu.wpi.grip.ui.components.ExceptionWitnessResponderButton;
 import edu.wpi.grip.ui.components.StartStoppableButton;
 import edu.wpi.grip.ui.pipeline.OutputSocketController;
 import edu.wpi.grip.ui.pipeline.SocketHandleView;
@@ -62,6 +63,7 @@ public <I> void hear(final TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEnco
 
         // Components
         install(new FactoryModuleBuilder().build(StartStoppableButton.Factory.class));
+        install(new FactoryModuleBuilder().build(ExceptionWitnessResponderButton.Factory.class));
         // End Components
 
         // Controllers