Debug server debug logs: use EventHandler instead of Logger.

Logger messages aren't printed to the console, they're written to /usr/local/google/tmp, and can be prohibitively large for these debug server logs.

Instead I'm going with your original suggestion in https://github.com/bazelbuild/bazel/commit/b74922932b25a71c626b47ea9a9afb7dbc506cec, and selectively suppressing debug events by wrapping the EventHandler on the way in to SkylarkDebugServer.

PiperOrigin-RevId: 202166571

2 files changed, 22 insertions, 12 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/DebugServerTransport.java b/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/DebugServerTransport.java
index 5f5020f29a..34b2f3abec 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/DebugServerTransport.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/DebugServerTransport.java
@@ -23,7 +23,6 @@ import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.ServerSocket;
 import java.net.Socket;
-import java.util.logging.Logger;
 import javax.annotation.Nullable;
 
 /**
@@ -47,8 +46,6 @@ final class DebugServerTransport {
         clientSocket.getOutputStream());
   }
 
-  private static final Logger logger = Logger.getLogger(DebugServerTransport.class.getName());
-
   private final EventHandler eventHandler;
   private final ServerSocket serverSocket;
   private final Socket clientSocket;
@@ -77,7 +74,7 @@ final class DebugServerTransport {
     synchronized (requestStream) {
       try {
         DebugRequest request = DebugRequest.parseDelimitedFrom(requestStream);
-        logger.fine("Received debug client request:\n" + request);
+        eventHandler.handle(Event.debug("Received debug client request:\n" + request));
         return request;
       } catch (IOException e) {
         handleParsingError(e);
@@ -98,7 +95,7 @@ final class DebugServerTransport {
 
   /** Posts a debug event. */
   void postEvent(DebugEvent event) {
-    logger.fine("Sending debug event:\n" + event);
+    eventHandler.handle(Event.debug("Sending debug event:\n" + event));
     synchronized (eventStream) {
       try {
         event.writeDelimitedTo(eventStream);
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/SkylarkDebugServer.java b/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/SkylarkDebugServer.java
index 433f4ef4cc..26f31793c2 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/SkylarkDebugServer.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkdebug/server/SkylarkDebugServer.java
@@ -19,6 +19,7 @@ import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Throwables;
 import com.google.devtools.build.lib.events.Event;
 import com.google.devtools.build.lib.events.EventHandler;
+import com.google.devtools.build.lib.events.EventKind;
 import com.google.devtools.build.lib.events.Location;
 import com.google.devtools.build.lib.skylarkdebugging.SkylarkDebuggingProtos;
 import com.google.devtools.build.lib.syntax.DebugServer;
@@ -30,7 +31,6 @@ import java.io.IOException;
 import java.net.ServerSocket;
 import java.util.List;
 import java.util.function.Function;
-import java.util.logging.Logger;
 import javax.annotation.Nullable;
 
 /** Manages the network socket and debugging state for threads running Skylark code. */
@@ -41,29 +41,42 @@ public final class SkylarkDebugServer implements DebugServer {
    * debug server socket and blocks waiting for an incoming connection.
    *
    * @param port the port on which the server should listen for connections
+   * @param verboseLogging if false, debug-level events will be suppressed
    * @throws IOException if an I/O error occurs while opening the socket or waiting for a connection
    */
-  public static SkylarkDebugServer createAndWaitForConnection(EventHandler eventHandler, int port)
-      throws IOException {
+  public static SkylarkDebugServer createAndWaitForConnection(
+      EventHandler eventHandler, int port, boolean verboseLogging) throws IOException {
     ServerSocket serverSocket = new ServerSocket(port, /* backlog */ 1);
-    return createAndWaitForConnection(eventHandler, serverSocket);
+    return createAndWaitForConnection(eventHandler, serverSocket, verboseLogging);
   }
 
   /**
    * Initializes debugging support, setting up any debugging-specific overrides, then opens the
    * debug server socket and blocks waiting for an incoming connection.
    *
+   * @param verboseLogging if false, debug-level events will be suppressed
    * @throws IOException if an I/O error occurs while waiting for a connection
    */
   @VisibleForTesting
   static SkylarkDebugServer createAndWaitForConnection(
-      EventHandler eventHandler, ServerSocket serverSocket) throws IOException {
+      EventHandler eventHandler, ServerSocket serverSocket, boolean verboseLogging)
+      throws IOException {
+    if (!verboseLogging) {
+      eventHandler = getHandlerSuppressingDebugEvents(eventHandler);
+    }
     DebugServerTransport transport =
         DebugServerTransport.createAndWaitForClient(eventHandler, serverSocket);
     return new SkylarkDebugServer(eventHandler, transport);
   }
 
-  private static final Logger logger = Logger.getLogger(SkylarkDebugServer.class.getName());
+  /** Wraps an event handler, suppressing debug-level events. */
+  private static EventHandler getHandlerSuppressingDebugEvents(EventHandler handler) {
+    return event -> {
+      if (event.getKind() != EventKind.DEBUG) {
+        handler.handle(event);
+      }
+    };
+  }
 
   private final EventHandler eventHandler;
   /** Handles all thread-related state. */
@@ -120,7 +133,7 @@ public final class SkylarkDebugServer implements DebugServer {
   @Override
   public void close() {
     try {
-      logger.fine("Closing debug server");
+      eventHandler.handle(Event.debug("Closing debug server"));
       transport.close();
 
     } catch (IOException e) {