Fixed bug in which BotWrapper was looking at bot data to determine the live frame

Author: dgant

src/main/java/bwapi/BotWrapper.java

@@ -52,13 +52,14 @@ class BotWrapper {
     /**
      * Resets the BotWrapper for a new game.
      */
-    void startNewGame(ByteBuffer dataSource, PerformanceMetrics performanceMetrics) {
+    void startNewGame(ByteBuffer liveData, PerformanceMetrics performanceMetrics) {
         if (configuration.async) {
-            frameBuffer.initialize(dataSource, performanceMetrics);
+            frameBuffer.initialize(liveData, performanceMetrics);
         }
         this.performanceMetrics = performanceMetrics;
-        game = new Game(liveClientData);
-        liveClientData.setBuffer(dataSource);
+        game = new Game();
+        game.clientData().setBuffer(liveData);
+        liveClientData.setBuffer(liveData);
         botThread = null;
         gameOver = false;
     }
@@ -90,8 +91,8 @@ void onFrame() {
             If buffer is full, it will wait until it has capacity
             Wait for empty buffer OR termination condition
              */
-            configuration.log("Main: Enqueuing frame");
-            boolean isFrameZero = liveClientData.gameData().getFrameCount() == 0;
+            int frame = liveClientData.gameData().getFrameCount();
+            configuration.log("Main: Enqueuing frame #" + frame);
             frameBuffer.enqueueFrame();
             performanceMetrics.bwapiResponse.startTiming();
             frameBuffer.lockSize.lock();
@@ -106,8 +107,8 @@ void onFrame() {
                         throw new RuntimeException(lastThrow);
                     }
 
-                    if (configuration.unlimitedFrameZero && isFrameZero) {
-                        configuration.log("Main: Waiting indefinitely on frame 0");
+                    if (configuration.unlimitedFrameZero && frame == 0) {
+                        configuration.log("Main: Waiting indefinitely on frame " + frame);
                         frameBuffer.conditionSize.await();
                     } else {
                         long remainingNanos = endNanos - System.nanoTime();

src/main/java/bwapi/ClientData.java

@@ -4,6 +4,7 @@ class ClientData {
     private WrappedBuffer buffer;
     private GameData gameData;
     ClientData() {
+        System.out.println("new ClientData()"); // TODO: REMOVE!
         gameData = new GameData(0);
     }
     GameData gameData() {

src/main/java/bwapi/FrameBuffer.java

@@ -39,7 +39,7 @@ of this software and associated documentation files (the "Software"), to deal
 class FrameBuffer {
     private static final int BUFFER_SIZE = ClientData.GameData.SIZE;
 
-    private ByteBuffer dataSource;
+    private ByteBuffer liveData;
     private PerformanceMetrics performanceMetrics;
     private int size;
     private int stepGame = 0;
@@ -61,8 +61,8 @@ class FrameBuffer {
     /**
      * Resets for a new game
      */
-    void initialize(ByteBuffer dataSource, PerformanceMetrics performanceMetrics) {
-        this.dataSource = dataSource;
+    void initialize(ByteBuffer liveData, PerformanceMetrics performanceMetrics) {
+        this.liveData = liveData;
         this.performanceMetrics = performanceMetrics;
         stepGame = 0;
         stepBot = 0;
@@ -125,7 +125,7 @@ void enqueueFrame() {
 
             performanceMetrics.copyingToBuffer.time(() -> {
                 ByteBuffer dataTarget = dataBuffer.get(indexGame());
-                copyBuffer(dataSource, dataTarget);
+                copyBuffer(liveData, dataTarget);
             });
 
             lockSize.lock();
@@ -190,6 +190,6 @@ void copyBuffer(ByteBuffer source, ByteBuffer destination) {
         // and serves to document the known-good (and cross-platform, for BWAPI 5) way to executing the copy.
         source.rewind();
         destination.rewind();
-        destination.put(dataSource);
+        destination.put(liveData);
     }
 }

src/main/java/bwapi/Game.java

@@ -101,8 +101,8 @@ public class Game {
 
     public final SideEffectQueue sideEffects = new SideEffectQueue();
 
-    Game(ClientData clientData) {
-        this.clientData = clientData;
+    Game() {
+        clientData = new ClientData();
     }
 
     ClientData clientData() {
@@ -142,6 +142,7 @@ private static boolean hasPower(final int x, final int y, final UnitType unitTyp
     Call this method in EventHander::OnMatchStart
     */
     void init() {
+        System.out.println("Game.init()"); // TODO: REMOVE!
         visibleUnits.clear();
 
         final int forceCount = gameData().getForceCount();

src/test/java/bwapi/ClientDataBenchmark.java

@@ -20,7 +20,8 @@ public static class EmptyState {
         @Setup(Level.Invocation)
         public void setup() {
             client = new Client(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
-            game = new Game(client.clientData());
+            game = new Game();
+            game.clientData().setBuffer(client.mapFile());
             strings = buildStrings();
         }
 
@@ -36,7 +37,8 @@ public static class FilledWithStrings {
         public void setup() {
             client = new Client(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
             data = client.clientData().gameData();
-            game = new Game(client.clientData());
+            game = new Game();
+            game.clientData().setBuffer(client.mapFile());
             String[] strings = buildStrings();
             for (String s : strings) {
                 GameDataUtils.addString(client.clientData().gameData(), s);

src/test/java/bwapi/GameBuilder.java

@@ -23,7 +23,8 @@ public static Game createGame(String mapName) throws IOException {
     }
 
     public static Game createGame(Client client) {
-        final Game game = new Game(client.clientData());
+        final Game game = new Game();
+        game.clientData().setBuffer(client.mapFile());
         game.init();
         return game;
     }

src/test/java/bwapi/GameTest.java

@@ -21,7 +21,7 @@
 public class GameTest {
 
     private List<Unit> allUnits = new ArrayList<>();
-    private Game sut = new Game(mock(ClientData.class)) {
+    private Game sut = new Game() {
         @Override
         public List<Unit> getAllUnits() {
             return allUnits;

src/test/java/bwapi/SynchronizationEnvironment.java

@@ -43,15 +43,15 @@ public class SynchronizationEnvironment {
             return null;
         }).when(client).update();
         doAnswer(answer -> {
-            System.out.println("onStart()");
+            System.out.println("Test: onStart()");
             return null;
         }).when(listener).onStart();
         doAnswer(answer -> {
-            System.out.println("onEnd()");
+            System.out.println("Test: onEnd()");
             return null;
         }).when(listener).onEnd(anyBoolean());
         doAnswer(answer -> {
-            System.out.println("onFrame()");
+            System.out.println("Test: onFrame()");
             if (onFrames.containsKey(liveFrame())) {
                 onFrames.get(liveFrame()).run();
             }
@@ -92,7 +92,7 @@ private int liveFrame() {
 
     private void clientUpdate() {
         client.clientData().gameData().setFrameCount(liveFrame() + 1);
-        System.out.println("clientUpdate() to liveFrame #" + liveFrame());
+        System.out.println("Test: clientUpdate() to liveFrame #" + liveFrame());
         if (liveFrame() == 0) {
             client.clientData().gameData().setIsInGame(true);
             client.clientData().gameData().setEventCount(2);