Merge branch 'jpn/feat-sdk-execution-time' into 'master'

[FEAT][SDK] enable access to Player bot execution time

See merge request codingame/game-engine!330

Author: CGjupoulton

engine/core/src/main/java/com/codingame/gameengine/core/AbstractPlayer.java

@@ -31,6 +31,7 @@ public static class TimeoutException extends Exception {
     private int score;
     private boolean hasBeenExecuted;
     private boolean hasNeverBeenExecuted = true;
+    private long lastExecutionTimeMs = -1;
 
     /**
      * Returns a string that will be converted into the real nickname by the viewer.
@@ -174,4 +175,12 @@ final void setHasBeenExecuted(boolean hasBeenExecuted) {
     final boolean hasNeverBeenExecuted() {
         return hasNeverBeenExecuted;
     }
+
+    final public void setLastExecutionTimeMs(long ms) {
+        this.lastExecutionTimeMs = ms;
+    }
+    
+    public long getLastExectionTimeMs() {
+        return lastExecutionTimeMs;
+    }
 }

engine/core/src/main/java/com/codingame/gameengine/core/GameManager.java

@@ -75,6 +75,7 @@ abstract public class GameManager<T extends AbstractPlayer> {
     private int totalTurnTime = 0;
 
     private boolean viewWarning, summaryWarning;
+    private boolean monitoringRequested;
 
     /**
      * GameManager main loop.
@@ -110,6 +111,7 @@ void start(InputStream is, PrintStream out) {
 
             referee.init();
             registeredModules.forEach(Module::onGameInit);
+            monitoringRequested = false;
             initDone = true;
 
             // Game Loop ----------------------------------------------------------
@@ -186,6 +188,9 @@ protected void execute(T player, int nbrOutputLines) {
             }
 
             dumpView();
+            if (!monitoringRequested) {
+                requestMonitoring();
+            }
             dumpInfos();
             dumpNextPlayerInput(player.getInputs().toArray(new String[0]));
             if (nbrOutputLines > 0) {
@@ -196,8 +201,16 @@ protected void execute(T player, int nbrOutputLines) {
             // READ PLAYER OUTPUTS
             iCmd = InputCommand.parse(s.nextLine());
             if (iCmd.cmd == InputCommand.Command.SET_PLAYER_OUTPUT) {
-                List<String> output = new ArrayList<>(iCmd.lineCount);
-                for (int i = 0; i < iCmd.lineCount; i++) {
+                int lineCount = iCmd.lineCount;
+                List<String> output = new ArrayList<>(lineCount);
+
+                if (monitoringRequested) {
+                    String exectionTime = s.nextLine();
+                    long ms = Long.valueOf(exectionTime);
+                    player.setLastExecutionTimeMs(ms);
+                    lineCount--;
+                }
+                for (int i = 0; i < lineCount; i++) {
                     output.add(s.nextLine());
                 }
                 player.setOutputs(output);
@@ -216,6 +229,13 @@ protected void execute(T player, int nbrOutputLines) {
         }
     }
 
+    private void requestMonitoring() {
+        OutputData data = new OutputData(OutputCommand.MONITORING);
+        out.println(data);
+        log.info(data);
+        monitoringRequested = true;
+    }
+
     /**
      * Executes a player for a maximum of turnMaxTime milliseconds and store the output. Used by player.execute().
      * 
@@ -363,7 +383,7 @@ boolean getOuputsRead() {
     /**
      * Puts a new metadata that will be included in the game's <code>GameResult</code>.
      * <p>
-     * Can be used for: 
+     * Can be used for:
      * </p>
      * <ul>
      * <li>Setting the value of an optimization criteria for OPTI games, used by the CodinGame IDE</li>
@@ -461,7 +481,7 @@ public void setTurnMaxTime(int turnMaxTime) throws IllegalArgumentException {
         }
         this.turnMaxTime = turnMaxTime;
     }
-    
+
     /**
      * Set the timeout delay of the first turn for every player. Default is 1000ms.
      * 
@@ -487,7 +507,7 @@ public void setFirstTurnMaxTime(int firstTurnMaxTime) throws IllegalArgumentExce
     public int getTurnMaxTime() {
         return turnMaxTime;
     }
-    
+
     /**
      * Get the timeout delay of the first turn for every player.
      * 

engine/core/src/main/java/com/codingame/gameengine/core/OutputCommand.java

@@ -1,6 +1,6 @@
 package com.codingame.gameengine.core;
 enum OutputCommand {
-    VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL;
+    VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL, MONITORING;
     public String format(int lineCount) {
         return String.format("[[%s] %d]", this.name(), lineCount);
     }

playground/misc/misc-3-release-notes.md

@@ -2,6 +2,12 @@
 
 The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases.
 
+## Next Release
+
+### 🎁 Features
+
+- Added a method to Player to get execution time for current frame.
+
 ## 4.5.0
 
 ### 🎁 Features

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

@@ -28,6 +28,7 @@ abstract class Agent {
     private String nickname;
     private String avatar;
 
+    public long lastExecutionTimeMs;
     public Agent() {
     }
 
@@ -44,6 +45,7 @@ public Agent() {
      *            Global configuration
      */
     public void initialize(Properties conf) {
+        this.lastExecutionTimeMs = 0;
     }
 
     /**

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, FAIL;
+        VIEW, INFOS, NEXT_PLAYER_INPUT, NEXT_PLAYER_INFO, SCORES, UINPUT, TOOLTIP, SUMMARY, METADATA, FAIL, MONITORING;
     }
 
     private List<String> lines;

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

@@ -46,6 +46,7 @@ abstract class GameRunner {
 
     private String[] avatars = new String[] { "16085734516701", "16085846089817", "16085713250612", "16085756802960", "16085746254929",
         "16085763837151", "16085720641630", "16085834521247" };
+    private boolean monitoringRequested;
 
     private static enum OutputResult {
         OK, TIMEOUT, TOOLONG, TOOSHORT
@@ -86,6 +87,7 @@ private void initialize(Properties conf) {
             agent.name = player.getNickname() != null ? player.getNickname() : "Player " + i;
             gameResult.agents.add(agent);
         }
+        monitoringRequested = false;
     }
 
     private void bootstrapPlayers() {
@@ -127,6 +129,10 @@ private void runAgents() {
             GameTurnInfo turnInfo = readGameInfo(round);
             boolean validTurn = turnInfo.isComplete();
 
+            if (turnInfo.requestedMonitoring()) {
+                monitoringRequested = true;
+            }
+
             gameResult.failCause = turnInfo.get(InputCommand.FAIL).orElse(null);
 
             if (validTurn) {
@@ -139,6 +145,7 @@ private void runAgents() {
                 NextPlayerInfo nextPlayerInfo = new NextPlayerInfo(
                     turnInfo.get(InputCommand.NEXT_PLAYER_INFO).orElse(null)
                 );
+
                 String nextPlayerOutput = getNextPlayerOutput(
                     nextPlayerInfo,
                     turnInfo.get(InputCommand.NEXT_PLAYER_INPUT).orElse(null)
@@ -152,7 +159,8 @@ private void runAgents() {
                     log.info("\t=== Read from player");
                     log.info(nextPlayerOutput);
                     log.info("\t=== End Player");
-                    sendPlayerOutput(nextPlayerOutput, nextPlayerInfo.nbLinesNextOutput);
+                    Agent player = players.get(nextPlayerInfo.nextPlayer);
+                    sendPlayerOutput(nextPlayerOutput, nextPlayerInfo.nbLinesNextOutput, player);
                 } else {
                     sendTimeOut();
                 }
@@ -244,10 +252,25 @@ private void readError(Agent agent) {
         }
     }
 
-    private void sendPlayerOutput(String output, int nbLines) {
+    private void sendPlayerOutput(String output, int nbLines, Agent player) {
         String[] lines = output.split("(\\n|\\r\\n)", -1);
+
+        if (monitoringRequested) {
+            long time = player.lastExecutionTimeMs;
+            lines = unshiftIntoArray(String.valueOf(time), lines, nbLines);
+            nbLines++;
+        }
+
         Command command = new Command(OutputCommand.SET_PLAYER_OUTPUT, Arrays.copyOfRange(lines, 0, nbLines));
         referee.sendInput(command.toString());
+        log.info(command.toString());
+    }
+
+    private String[] unshiftIntoArray(String string, String[] lines, int length) {
+        String[] newLines = new String[length + 1];
+        newLines[0] = string;
+        System.arraycopy(lines, 0, newLines, 1, length);
+        return newLines;
     }
 
     private void sendTimeOut() {
@@ -260,9 +283,13 @@ private String getNextPlayerOutput(NextPlayerInfo nextPlayerInfo, String nextPla
 
         // Send player input to input queue
         queues.get(nextPlayerInfo.nextPlayer).offer(nextPlayerInput);
-
+        long start = System.nanoTime();
         // Wait for player output then read error
         String playerOutput = player.getOutput(nextPlayerInfo.nbLinesNextOutput, nextPlayerInfo.timeout);
+        long end = System.nanoTime();
+
+        player.lastExecutionTimeMs = (end - start) / 1_000_000;
+
         if (playerOutput != null)
             playerOutput = playerOutput.replace('\r', '\n');
 

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

@@ -60,4 +60,8 @@ public Optional<String> get(CommandKey key) {
         }
         return Optional.of(lines.get(0));
     }
+
+    public boolean requestedMonitoring() {
+        return received.containsKey(InputCommand.MONITORING);
+    }
 }