Removed commented-out printlns. Stubbed diagnostics configuration variable.

dgant · dgant · commit 4cf39fcbe68d · 2020-08-07T15:42:16.000-04:00
diff --git a/src/main/java/bwapi/BWClient.java b/src/main/java/bwapi/BWClient.java
@@ -52,13 +52,9 @@ public void startGame(BWClientConfiguration configuration) {
         client.reconnect();
 
         do {
-            //System.out.println("Client: Beginning game loop");
             ClientData.GameData liveGameData = client.clientData().gameData();
             while (!liveGameData.isInGame()) {
-                if (client.isConnected()) {
-                    //System.out.println("Client: Not in game; Connected.");
-                } else  {
-                    //System.out.println("Client: Not in game; Not connected.");
+                if (!client.isConnected()) {
                     return;
                 }
                 client.update();
@@ -67,17 +63,14 @@ public void startGame(BWClientConfiguration configuration) {
                 }
             }
             while (liveGameData.isInGame()) {
-                //System.out.println("Client: In game on frame " + liveGameData.getFrameCount());
                 botWrapper.onFrame();
-                //System.out.println("Client: Sending commands for frame " + liveGameData.getFrameCount());
                 getGame().sideEffects.flushTo(liveGameData);
                 client.update();
                 if (!client.isConnected()) {
-                    //System.out.println("Reconnecting...");
                     client.reconnect();
                 }
             }
             botWrapper.endGame();
-        } while (configuration.autoContinue); // lgtm [java/constant-loop-condition]
+        } while (configuration.autoContinue);
     }
 }
diff --git a/src/main/java/bwapi/BWClientConfiguration.java b/src/main/java/bwapi/BWClientConfiguration.java
@@ -49,6 +49,12 @@ public class BWClientConfiguration {
      */
     public boolean asyncWaitOnFrameZero = true;
 
+    /**
+     * Enables collection of diagnostics.
+     * When enabled, JBWAPI collects and publishes performance metrics.
+     */
+    public boolean diagnosePerformance = false;
+
     /**
      * Checks that the configuration is in a valid state. Throws an IllegalArgumentException if it isn't.
      */
diff --git a/src/main/java/bwapi/BotWrapper.java b/src/main/java/bwapi/BotWrapper.java
@@ -72,7 +72,6 @@ void onFrame() {
             long startNanos = System.nanoTime();
             long endNanos = startNanos + configuration.asyncFrameDurationNanos;
             if (botThread == null) {
-                //System.out.println("Creating bot thread");
                 botThread = createBotThread();
                 botThread.setName("JBWAPI Bot");
                 botThread.start();
@@ -116,12 +115,9 @@ private Thread createBotThread() {
                 try { while (frameBuffer.empty()) frameBuffer.conditionSize.awaitUninterruptibly(); } finally { frameBuffer.lockSize.unlock(); }
 
                 game.clientData().setBuffer(frameBuffer.peek());
-                //System.out.println("Bot thread: Handling events.");
                 handleEvents();
-                //System.out.println("Bot thread: Handled events.");
                 frameBuffer.dequeue();
             }
-            //System.out.println("Bot thread: Ending because game is over.");
         });
     }
 
diff --git a/src/main/java/bwapi/FrameBuffer.java b/src/main/java/bwapi/FrameBuffer.java
@@ -44,7 +44,6 @@ class FrameBuffer {
 
     // Synchronization locks
     private final Lock lockWrite = new ReentrantLock();
-    private final Lock lockRead = lockWrite;
     final Lock lockSize = new ReentrantLock();
     final Condition conditionSize = lockSize.newCondition();
 
@@ -120,36 +119,30 @@ void enqueueFrame() {
             lockSize.lock();
             try {
                 ++stepGame;
-                //System.out.println("FrameBuffer: Enqueued buffer " + indexGame() + " on game step #" + stepGame);
-                if (framesBuffered() > 0) {
-                    //System.out.println("FrameBuffer: There are now " + framesBuffered() + " frames buffered.");
-                }
                 conditionSize.signalAll();
             } finally { lockSize.unlock(); }
         } finally { lockWrite.unlock(); }
     }
 
     /**
-     * Peeks the frontmost value in the buffer.
+     * Peeks the front-most value in the buffer.
      */
     ByteBuffer peek() {
         lockSize.lock();
         try {
             while(empty()) conditionSize.awaitUninterruptibly();
-            //System.out.println("FrameBuffer: Sharing buffer " + indexBot() + " on bot step #" + stepBot);
             return dataBuffer.get(indexBot());
         } finally { lockSize.unlock(); }
 
     }
 
     /**
-     * Removes the frontmost frame in the buffer.
+     * Removes the front-most frame in the buffer.
      */
     void dequeue() {
         lockSize.lock();
         try {
             while(empty()) conditionSize.awaitUninterruptibly();
-            //System.out.println("FrameBuffer: Dequeuing buffer " + indexBot() + " on bot step #" + stepBot);
             ++stepBot;
             conditionSize.signalAll();
         } finally { lockSize.unlock(); }

Original file line number	Diff line number	Diff line change
`@@ -52,13 +52,9 @@ public void startGame(BWClientConfiguration configuration) {`
`52`	`52`	`client.reconnect();`
`53`	`53`
`54`	`54`	`do {`
`55`		`- //System.out.println("Client: Beginning game loop");`
`56`	`55`	`ClientData.GameData liveGameData = client.clientData().gameData();`
`57`	`56`	`while (!liveGameData.isInGame()) {`
`58`		`- if (client.isConnected()) {`
`59`		`- //System.out.println("Client: Not in game; Connected.");`
`60`		`- } else {`
`61`		`- //System.out.println("Client: Not in game; Not connected.");`
	`57`	`+ if (!client.isConnected()) {`
`62`	`58`	`return;`
`63`	`59`	`}`
`64`	`60`	`client.update();`
`@@ -67,17 +63,14 @@ public void startGame(BWClientConfiguration configuration) {`
`67`	`63`	`}`
`68`	`64`	`}`
`69`	`65`	`while (liveGameData.isInGame()) {`
`70`		`- //System.out.println("Client: In game on frame " + liveGameData.getFrameCount());`
`71`	`66`	`botWrapper.onFrame();`
`72`		`- //System.out.println("Client: Sending commands for frame " + liveGameData.getFrameCount());`
`73`	`67`	`getGame().sideEffects.flushTo(liveGameData);`
`74`	`68`	`client.update();`
`75`	`69`	`if (!client.isConnected()) {`
`76`		`- //System.out.println("Reconnecting...");`
`77`	`70`	`client.reconnect();`
`78`	`71`	`}`
`79`	`72`	`}`
`80`	`73`	`botWrapper.endGame();`
`81`		`- } while (configuration.autoContinue); // lgtm [java/constant-loop-condition]`
	`74`	`+ } while (configuration.autoContinue);`
`82`	`75`	`}`
`83`	`76`	`}`