feat(sdk): Game runner handles FAIL command and crashes cleanly

Author: chickentuna

runner/src/main/java/com/codingame/gameengine/runner/Command.java

@@ -15,7 +15,7 @@ static enum OutputCommand implements CommandKey {
     }
 
     static enum InputCommand implements CommandKey {
-        VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA;
+        VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL;
     }
 
     private List<String> lines;

runner/src/main/java/com/codingame/gameengine/runner/GameRunner.java

@@ -127,6 +127,8 @@ private void runAgents() {
             GameTurnInfo turnInfo = readGameInfo(round);
             boolean validTurn = turnInfo.isComplete();
 
+            gameResult.failCause = turnInfo.get(InputCommand.FAIL).orElse(null);
+
             if (validTurn) {
                 gameResult.outputs.get("referee").add(refereeStdout.toString());
                 refereeStdout.reset();
@@ -283,7 +285,7 @@ private GameTurnInfo readGameInfo(int round) {
 
         referee.sendInput(new Command(OutputCommand.GET_GAME_INFO).toString());
 
-        while (!turnInfo.isComplete()) {
+        while (!turnInfo.isComplete() && !turnInfo.refereeHasFailed()) {
             Command command = readCommand(referee, round);
             if (command == null) {
                 return turnInfo;
@@ -294,34 +296,39 @@ private GameTurnInfo readGameInfo(int round) {
     }
 
     private Command readCommand(Agent agent, int round) {
-        String output = agent.getOutput(1, 150_000);
-        if (output != null) {
-            output = output.replace('\r', '\n');
-        }
-        if (checkOutput(output, 1) != OutputResult.OK) {
-            throw new RuntimeException("Invalid Referee command: " + output);
-        }
+        try {
+            String output = agent.getOutput(1, 150_000);
+            if (output != null) {
+                output = output.replace('\r', '\n');
+            }
+            if (checkOutput(output, 1) != OutputResult.OK) {
+                throw new RuntimeException("Invalid Referee command: " + output);
+            }
 
-        Matcher m = COMMAND_HEADER_PATTERN.matcher(output.trim());
-        if (m.matches()) {
-            String command = m.group("cmd");
-            int nbLinesToRead = Integer.parseInt(m.group("lineCount"));
+            Matcher m = COMMAND_HEADER_PATTERN.matcher(output.trim());
+            if (m.matches()) {
+                String command = m.group("cmd");
+                int nbLinesToRead = Integer.parseInt(m.group("lineCount"));
 
-            if (nbLinesToRead >= 0) {
-                output = agent.getOutput(nbLinesToRead, 150_000, round == 0);
-                output = output.replace('\r', '\n');
+                if (nbLinesToRead >= 0) {
+                    output = agent.getOutput(nbLinesToRead, 150_000, round == 0);
+                    output = output.replace('\r', '\n');
+                } else {
+                    throw new RuntimeException("Invalid Referee command line count: " + output);
+                }
+                if (checkOutput(output, nbLinesToRead) != OutputResult.OK) {
+                    throw new RuntimeException(
+                        "Error reading Referee command. Buffer capacity: " + output.length() + " / "
+                            + (round == 0 ? RefereeAgent.REFEREE_MAX_BUFFER_SIZE_EXTRA : RefereeAgent.REFEREE_MAX_BUFFER_SIZE)
+                    );
+                }
+                return new Command(InputCommand.valueOf(command), output);
             } else {
-                throw new RuntimeException("Invalid Referee command line count: " + output);
+                throw new RuntimeException("Invalid referee command: " + output);
             }
-            if (checkOutput(output, nbLinesToRead) != OutputResult.OK) {
-                throw new RuntimeException(
-                    "Error reading Referee command. Buffer capacity: " + output.length() + " / "
-                        + (round == 0 ? RefereeAgent.REFEREE_MAX_BUFFER_SIZE_EXTRA : RefereeAgent.REFEREE_MAX_BUFFER_SIZE)
-                );
-            }
-            return new Command(InputCommand.valueOf(command), output);
-        } else {
-            throw new RuntimeException("Invalid referee command: " + output);
+        } catch (RuntimeException err) {
+            err.printStackTrace();
+            return new Command(InputCommand.FAIL, err.toString());
         }
     }
 
@@ -408,12 +415,15 @@ public void write(int b) throws IOException {
             public void write(int b) throws IOException {
                 err.write(b);
                 refereeStderr.write(b);
-            }       
+            }
         }));
         requireGameNotEnded();
         Properties conf = new Properties();
         initialize(conf);
+        
         runAgents();
+        
+        referee.destroy();
         destroyPlayers();
         gameEnded = true;
         System.setOut(out);

runner/src/main/java/com/codingame/gameengine/runner/GameTurnInfo.java

@@ -26,6 +26,10 @@ boolean isComplete() {
     boolean isEndTurn() {
         return isCompleteEndTurn();
     }
+    
+    boolean refereeHasFailed() {
+        return received.containsKey(InputCommand.FAIL);
+    }
 
     private boolean isCompleteEndTurn() {
         return received.containsKey(InputCommand.SCORES)

runner/src/main/java/com/codingame/gameengine/runner/JavaPlayerAgent.java

@@ -87,7 +87,6 @@ protected void runInputOutput() throws Exception {
 
     @Override
     public void destroy() {
-        // Does nothing
         if (javaRunnerThread != null) {
             javaRunnerThread.setStopping(true);
             javaRunnerThread.interrupt();

runner/src/main/java/com/codingame/gameengine/runner/RefereeAgent.java

@@ -22,6 +22,8 @@ class RefereeAgent extends Agent {
     private OutputStream processStdin = null;
     private InputStream processStdout = null;
     private InputStream processStderr = null;
+    
+    private Thread thread;
 
     public RefereeAgent() {
         super();
@@ -34,6 +36,14 @@ public RefereeAgent() {
             throw new RuntimeException("Cannot initialize Referee Agent");
         }
     }
+    
+    @Override
+    public void destroy() {
+        if (thread != null) {
+            thread.interrupt();
+        }
+    }
+
 
     @Override
     protected OutputStream getInputStream() {
@@ -53,13 +63,12 @@ protected InputStream getErrorStream() {
     @Override
     protected void runInputOutput() throws Exception {
 
-        Thread t = new Thread() {
+        thread = new Thread() {
             public void run() {
                 RefereeMain.start(agentStdin, new PrintStream(agentStdout));
             }
         };
-
-        t.start();
+        thread.start();
     }
 
     @Override

runner/src/main/java/com/codingame/gameengine/runner/dto/GameResult.java

@@ -16,4 +16,5 @@ public class GameResult {
     public List<Tooltip> tooltips = new ArrayList<>();
     public Map<Integer, Integer> ids = new HashMap<>();
     public List<AgentDto> agents = new ArrayList<>();
+    public String failCause = null;
 }

runner/src/main/resources/view/app.js

@@ -62,6 +62,11 @@ function PlayerCtrl ($scope, $timeout, $interval, $filter, drawerFactory, gameMa
     if ($scope.gameLoaded || !ctrl.data) {
       return
     }
+    if (ctrl.data.failCause) {
+      $scope.errors = ctrl.data.failCause
+      return;
+    }
+    
     $scope.gameLoaded = true
     $scope.uinput = ctrl.data.uinput
     ctrl.gameInfo = convertFrameFormat(ctrl.data)