fix: Decrease log level for directpath warnings outside GCE

Author: nimf

gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java

@@ -441,43 +441,47 @@ public boolean isDirectPathXdsEnabled() {
   // builder or createSingleChannel, only in getTransportChannel which creates the first channel
   // for a client.
   private void logDirectPathMisconfig() {
-    if (isDirectPathXdsEnabled()) {
-      if (!isDirectPathEnabled()) {
-        // This misconfiguration occurs when Direct Path xDS is enabled, but Direct Path is not
-        // Direct Path xDS can be enabled two ways: via environment variable or via builder.
-        // Case 1: Direct Path is only enabled via xDS env var. We will _warn_ the user that this is
-        // a misconfiguration if they intended to set the env var.
-        if (isDirectPathXdsEnabledViaEnv()) {
-          LOG.log(
-              Level.WARNING,
-              "Env var "
-                  + DIRECT_PATH_ENV_ENABLE_XDS
-                  + " was found and set to TRUE, but DirectPath was not enabled for this client. If this is intended for "
-                  + "this client, please note that this is a misconfiguration and set the attemptDirectPath option as well.");
-        }
-        // Case 2: Direct Path xDS was enabled via Builder. Direct Path Traffic Director must be set
-        // (enabled with `setAttemptDirectPath(true)`) along with xDS.
-        // Here we warn the user about this.
-        else if (isDirectPathXdsEnabledViaBuilderOption()) {
-          LOG.log(
-              Level.WARNING,
-              "DirectPath is misconfigured. The DirectPath XDS option was set, but the attemptDirectPath option was not. Please set both the attemptDirectPath and attemptDirectPathXds options.");
-        }
-      } else {
-        // Case 3: credential is not correctly set
-        if (!isCredentialDirectPathCompatible()) {
-          LOG.log(
-              Level.WARNING,
-              "DirectPath is misconfigured. Please make sure the credential is an instance of "
-                  + ComputeEngineCredentials.class.getName()
-                  + " .");
-        }
-        // Case 4: not running on GCE
-        if (!isOnComputeEngine()) {
-          LOG.log(
-              Level.WARNING,
-              "DirectPath is misconfigured. DirectPath is only available in a GCE environment.");
-        }
+    if (!isDirectPathXdsEnabled()) {
+      return;
+    }
+
+    Level level = isOnComputeEngine() ? Level.WARNING : Level.FINE;
+
+    if (!isDirectPathEnabled()) {
+      // This misconfiguration occurs when Direct Path xDS is enabled, but Direct Path is not
+      // Direct Path xDS can be enabled two ways: via environment variable or via builder.
+      // Case 1: Direct Path is only enabled via xDS env var. We will _warn_ the user that this is
+      // a misconfiguration if they intended to set the env var.
+      if (isDirectPathXdsEnabledViaEnv()) {
+        LOG.log(
+            level,
+            "Env var "
+                + DIRECT_PATH_ENV_ENABLE_XDS
+                + " was found and set to TRUE, but DirectPath was not enabled for this client. If this is intended for "
+                + "this client, please note that this is a misconfiguration and set the attemptDirectPath option as well.");
+      }
+      // Case 2: Direct Path xDS was enabled via Builder. Direct Path Traffic Director must be set
+      // (enabled with `setAttemptDirectPath(true)`) along with xDS.
+      // Here we warn the user about this.
+      else if (isDirectPathXdsEnabledViaBuilderOption()) {
+        LOG.log(
+            level,
+            "DirectPath is misconfigured. The DirectPath XDS option was set, but the attemptDirectPath option was not. Please set both the attemptDirectPath and attemptDirectPathXds options.");
+      }
+    } else {
+      // Case 3: credential is not correctly set
+      if (!isCredentialDirectPathCompatible()) {
+        LOG.log(
+            level,
+            "DirectPath is misconfigured. Please make sure the credential is an instance of "
+                + ComputeEngineCredentials.class.getName()
+                + " .");
+      }
+      // Case 4: not running on GCE
+      if (!isOnComputeEngine()) {
+        LOG.log(
+            level,
+            "DirectPath is misconfigured. DirectPath is only available in a GCE environment.");
       }
     }
   }

gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java

@@ -77,6 +77,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 import java.util.logging.Handler;
+import java.util.logging.Level;
 import java.util.logging.LogRecord;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
@@ -85,6 +86,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentCaptor;
+import org.mockito.MockedStatic;
 import org.mockito.Mockito;
 
 class InstantiatingGrpcChannelProviderTest extends AbstractMtlsTransportChannelTest {
@@ -651,7 +653,13 @@ private void createAndCloseTransportChannel(InstantiatingGrpcChannelProvider pro
             .setAttemptDirectPathXds()
             .setCertificateBasedAccess(certificateBasedAccess)
             .build();
-    createAndCloseTransportChannel(provider);
+
+    try (MockedStatic<InstantiatingGrpcChannelProvider> mocked =
+        Mockito.mockStatic(InstantiatingGrpcChannelProvider.class, Mockito.CALLS_REAL_METHODS)) {
+      mocked.when(() -> InstantiatingGrpcChannelProvider.isOnComputeEngine()).thenReturn(true);
+      createAndCloseTransportChannel(provider);
+    }
+
     assertThat(logHandler.getAllMessages())
         .contains(
             "DirectPath is misconfigured. The DirectPath XDS option was set, but the attemptDirectPath option was not. Please set both the attemptDirectPath and attemptDirectPathXds options.");
@@ -668,7 +676,13 @@ void testLogDirectPathMisconfig_AttemptDirectPathNotSetAndAttemptDirectPathXdsSe
         createChannelProviderBuilderForDirectPathLogTests()
             .setCertificateBasedAccess(certificateBasedAccess)
             .build();
-    createAndCloseTransportChannel(provider);
+
+    try (MockedStatic<InstantiatingGrpcChannelProvider> mocked =
+        Mockito.mockStatic(InstantiatingGrpcChannelProvider.class, Mockito.CALLS_REAL_METHODS)) {
+      mocked.when(() -> InstantiatingGrpcChannelProvider.isOnComputeEngine()).thenReturn(true);
+      createAndCloseTransportChannel(provider);
+    }
+
     assertThat(logHandler.getAllMessages())
         .contains(
             "Env var GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS was found and set to TRUE, but DirectPath was not enabled for this client. If this is intended for "
@@ -679,12 +693,18 @@ void testLogDirectPathMisconfig_AttemptDirectPathNotSetAndAttemptDirectPathXdsSe
   @Test
   void testLogDirectPathMisconfig_shouldNotLogInTheBuilder() {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
-    InstantiatingGrpcChannelProvider.newBuilder()
-        .setAttemptDirectPathXds()
-        .setAttemptDirectPath(true)
-        .setCertificateBasedAccess(certificateBasedAccess)
-        .build();
+
+    try (MockedStatic<InstantiatingGrpcChannelProvider> mocked =
+        Mockito.mockStatic(InstantiatingGrpcChannelProvider.class, Mockito.CALLS_REAL_METHODS)) {
+      mocked.when(() -> InstantiatingGrpcChannelProvider.isOnComputeEngine()).thenReturn(true);
+      InstantiatingGrpcChannelProvider.newBuilder()
+          .setAttemptDirectPathXds()
+          .setAttemptDirectPath(true)
+          .setCertificateBasedAccess(certificateBasedAccess)
+          .build();
+    }
 
     assertThat(logHandler.getAllMessages()).isEmpty();
     InstantiatingGrpcChannelProvider.LOG.removeHandler(logHandler);
@@ -704,7 +724,13 @@ void testLogDirectPathMisconfigWrongCredential() throws Exception {
             .setCertificateBasedAccess(certificateBasedAccess)
             .build();
 
-    TransportChannel transportChannel = provider.getTransportChannel();
+    TransportChannel transportChannel;
+
+    try (MockedStatic<InstantiatingGrpcChannelProvider> mocked =
+        Mockito.mockStatic(InstantiatingGrpcChannelProvider.class, Mockito.CALLS_REAL_METHODS)) {
+      mocked.when(() -> InstantiatingGrpcChannelProvider.isOnComputeEngine()).thenReturn(true);
+      transportChannel = provider.getTransportChannel();
+    }
 
     assertThat(logHandler.getAllMessages())
         .contains(
@@ -719,6 +745,7 @@ void testLogDirectPathMisconfigWrongCredential() throws Exception {
   @Test
   void testLogDirectPathMisconfigNotOnGCE() throws Exception {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
     InstantiatingGrpcChannelProvider provider =
         InstantiatingGrpcChannelProvider.newBuilder()
@@ -731,7 +758,13 @@ void testLogDirectPathMisconfigNotOnGCE() throws Exception {
             .setCertificateBasedAccess(certificateBasedAccess)
             .build();
 
-    TransportChannel transportChannel = provider.getTransportChannel();
+    TransportChannel transportChannel;
+
+    try (MockedStatic<InstantiatingGrpcChannelProvider> mocked =
+        Mockito.mockStatic(InstantiatingGrpcChannelProvider.class, Mockito.CALLS_REAL_METHODS)) {
+      mocked.when(() -> InstantiatingGrpcChannelProvider.isOnComputeEngine()).thenReturn(false);
+      transportChannel = provider.getTransportChannel();
+    }
 
     if (!InstantiatingGrpcChannelProvider.isOnComputeEngine()) {
       assertThat(logHandler.getAllMessages())

gax-java/gax-grpc/src/test/resources/org.mockito.plugins.MockMaker

@@ -0,0 +1 @@
+mock-maker-inline