master pull

Author: AgraVator

core/src/main/java/io/grpc/internal/ManagedClientDisconnectTransport.java renamed to core/src/main/java/io/grpc/internal/ClientTransportWithDisconnectReason.java

@@ -24,7 +24,7 @@
  *
  */
 @ThreadSafe
-public interface ManagedClientDisconnectTransport extends ClientTransport {
+public interface ClientTransportWithDisconnectReason extends ClientTransport {
 
   /**
    * Initiates a forceful shutdown in which preexisting and new calls are closed. Existing calls

core/src/main/java/io/grpc/internal/DisconnectError.java

@@ -31,4 +31,4 @@ public interface DisconnectError {
    * @return The formatted error tag string.
    */
   String toErrorString();
-}
+}

core/src/main/java/io/grpc/internal/GoAwayDisconnectError.java

@@ -61,4 +61,4 @@ public boolean equals(Object o) {
   public int hashCode() {
     return errorCode.hashCode();
   }
-}
+}

core/src/main/java/io/grpc/internal/KeepAliveManager.java

@@ -262,9 +262,9 @@ public interface KeepAlivePinger {
    * Default client side {@link KeepAlivePinger}.
    */
   public static final class ClientKeepAlivePinger implements KeepAlivePinger {
-    private final ManagedClientDisconnectTransport transport;
+    private final ClientTransportWithDisconnectReason transport;
 
-    public ClientKeepAlivePinger(ManagedClientDisconnectTransport transport) {
+    public ClientKeepAlivePinger(ClientTransportWithDisconnectReason transport) {
       this.transport = transport;
     }
 

core/src/main/java/io/grpc/internal/SimpleDisconnectError.java

@@ -65,4 +65,4 @@ public enum SimpleDisconnectError implements DisconnectError {
   public String toErrorString() {
     return this.errorTag;
   }
-}
+}

core/src/main/java/io/grpc/internal/SubchannelMetrics.java

@@ -105,164 +105,4 @@ public void recordDisconnection(String target, String backendService, String loc
             ImmutableList.of(target),
             ImmutableList.of(securityLevel, backendService, locality));
   }
-
-  /**
-   * Represents the reason for a subchannel failure.
-   */
-  public enum DisconnectError {
-
-    /**
-     * Represents an HTTP/2 GOAWAY frame. The specific error code
-     * (e.g., "NO_ERROR", "PROTOCOL_ERROR") should be handled separately
-     * as it is a dynamic part of the error.
-     * See RFC 9113 for error codes: https://www.rfc-editor.org/rfc/rfc9113.html#name-error-codes
-     */
-    GOAWAY("goaway"),
-
-    /**
-     * The subchannel was shut down for various reasons like parent channel shutdown,
-     * idleness, or load balancing policy changes.
-     */
-    SUBCHANNEL_SHUTDOWN("subchannel shutdown"),
-
-    /**
-     * Connection was reset (e.g., ECONNRESET, WSAECONNERESET).
-     */
-    CONNECTION_RESET("connection reset"),
-
-    /**
-     * Connection timed out (e.g., ETIMEDOUT, WSAETIMEDOUT), including closures
-     * from gRPC keepalives.
-     */
-    CONNECTION_TIMED_OUT("connection timed out"),
-
-    /**
-     * Connection was aborted (e.g., ECONNABORTED, WSAECONNABORTED).
-     */
-    CONNECTION_ABORTED("connection aborted"),
-
-    /**
-     * Any socket error not covered by other specific disconnect errors.
-     */
-    SOCKET_ERROR("socket error"),
-
-    /**
-     * A catch-all for any other unclassified reason.
-     */
-    UNKNOWN("unknown");
-
-    private final String errorTag;
-
-    /**
-     * Private constructor to associate a description with each enum constant.
-     *
-     * @param errorTag The detailed explanation of the error.
-     */
-    DisconnectError(String errorTag) {
-      this.errorTag = errorTag;
-    }
-
-    /**
-     * Gets the error string suitable for use as a metric tag.
-     *
-     * <p>If the reason is {@code GOAWAY}, this method requires the specific
-     * HTTP/2 error code to create the complete tag (e.g., "goaway PROTOCOL_ERROR").
-     * For all other reasons, the parameter is ignored.</p>
-     *
-     * @param goawayErrorCode The specific HTTP/2 error code. This is only
-     *                        used if the reason is GOAWAY and should not be null in that case.
-     * @return The formatted error string.
-     */
-    public String getErrorString(@Nullable String goawayErrorCode) {
-      if (this == GOAWAY) {
-        if (goawayErrorCode == null || goawayErrorCode.isEmpty()) {
-          // Return the base tag if the code is missing, or consider throwing an exception
-          // throw new IllegalArgumentException("goawayErrorCode is required for GOAWAY reason.");
-          return this.errorTag;
-        }
-        return this.errorTag + " " + goawayErrorCode;
-      }
-      return this.errorTag;
-    }
-  }
-
-  /**
-   * Represents the reason for a subchannel failure.
-   */
-  public enum DisconnectError {
-
-    /**
-     * Represents an HTTP/2 GOAWAY frame. The specific error code
-     * (e.g., "NO_ERROR", "PROTOCOL_ERROR") should be handled separately
-     * as it is a dynamic part of the error.
-     * See RFC 9113 for error codes: https://www.rfc-editor.org/rfc/rfc9113.html#name-error-codes
-     */
-    GOAWAY("goaway"),
-
-    /**
-     * The subchannel was shut down for various reasons like parent channel shutdown,
-     * idleness, or load balancing policy changes.
-     */
-    SUBCHANNEL_SHUTDOWN("subchannel shutdown"),
-
-    /**
-     * Connection was reset (e.g., ECONNRESET, WSAECONNERESET).
-     */
-    CONNECTION_RESET("connection reset"),
-
-    /**
-     * Connection timed out (e.g., ETIMEDOUT, WSAETIMEDOUT), including closures
-     * from gRPC keepalives.
-     */
-    CONNECTION_TIMED_OUT("connection timed out"),
-
-    /**
-     * Connection was aborted (e.g., ECONNABORTED, WSAECONNABORTED).
-     */
-    CONNECTION_ABORTED("connection aborted"),
-
-    /**
-     * Any socket error not covered by other specific disconnect errors.
-     */
-    SOCKET_ERROR("socket error"),
-
-    /**
-     * A catch-all for any other unclassified reason.
-     */
-    UNKNOWN("unknown");
-
-    private final String errorTag;
-
-    /**
-     * Private constructor to associate a description with each enum constant.
-     *
-     * @param errorTag The detailed explanation of the error.
-     */
-    DisconnectError(String errorTag) {
-      this.errorTag = errorTag;
-    }
-
-    /**
-     * Gets the error string suitable for use as a metric tag.
-     *
-     * <p>If the reason is {@code GOAWAY}, this method requires the specific
-     * HTTP/2 error code to create the complete tag (e.g., "goaway PROTOCOL_ERROR").
-     * For all other reasons, the parameter is ignored.</p>
-     *
-     * @param goawayErrorCode The specific HTTP/2 error code. This is only
-     *                        used if the reason is GOAWAY and should not be null in that case.
-     * @return The formatted error string.
-     */
-    public String getErrorString(@Nullable String goawayErrorCode) {
-      if (this == GOAWAY) {
-        if (goawayErrorCode == null || goawayErrorCode.isEmpty()) {
-          // Return the base tag if the code is missing, or consider throwing an exception
-          // throw new IllegalArgumentException("goawayErrorCode is required for GOAWAY reason.");
-          return this.errorTag;
-        }
-        return this.errorTag + " " + goawayErrorCode;
-      }
-      return this.errorTag;
-    }
-  }
 }

core/src/test/java/io/grpc/internal/KeepAliveManagerTest.java

@@ -105,7 +105,8 @@ public void keepAlivePingDelayedByIncomingData() {
 
   @Test
   public void clientKeepAlivePinger_pingTimeout() {
-    ManagedClientDisconnectTransport transport = mock(ManagedClientDisconnectTransport.class);
+    ClientTransportWithDisconnectReason transport =
+        mock(ClientTransportWithDisconnectReason.class);
     ClientKeepAlivePinger pinger = new ClientKeepAlivePinger(transport);
 
     pinger.onPingTimeout();
@@ -121,7 +122,8 @@ public void clientKeepAlivePinger_pingTimeout() {
 
   @Test
   public void clientKeepAlivePinger_pingFailure() {
-    ManagedClientDisconnectTransport transport = mock(ManagedClientDisconnectTransport.class);
+    ClientTransportWithDisconnectReason transport =
+        mock(ClientTransportWithDisconnectReason.class);
     ClientKeepAlivePinger pinger = new ClientKeepAlivePinger(transport);
     pinger.ping();
     ArgumentCaptor<ClientTransport.PingCallback> pingCallbackCaptor =

netty/src/main/java/io/grpc/netty/NettyClientTransport.java

@@ -36,14 +36,14 @@
 import io.grpc.MethodDescriptor;
 import io.grpc.Status;
 import io.grpc.internal.ClientStream;
+import io.grpc.internal.ClientTransportWithDisconnectReason;
 import io.grpc.internal.ConnectionClientTransport;
 import io.grpc.internal.DisconnectError;
 import io.grpc.internal.FailingClientStream;
 import io.grpc.internal.GrpcUtil;
 import io.grpc.internal.Http2Ping;
 import io.grpc.internal.KeepAliveManager;
 import io.grpc.internal.KeepAliveManager.ClientKeepAlivePinger;
-import io.grpc.internal.ManagedClientDisconnectTransport;
 import io.grpc.internal.SimpleDisconnectError;
 import io.grpc.internal.StatsTraceContext;
 import io.grpc.internal.TransportTracer;
@@ -71,7 +71,8 @@
 /**
  * A Netty-based {@link ConnectionClientTransport} implementation.
  */
-class NettyClientTransport implements ConnectionClientTransport, ManagedClientDisconnectTransport {
+class NettyClientTransport implements ConnectionClientTransport,
+    ClientTransportWithDisconnectReason {
 
   private final InternalLogId logId;
   private final Map<ChannelOption<?>, ?> channelOptions;

okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java

@@ -47,6 +47,7 @@
 import io.grpc.TlsChannelCredentials;
 import io.grpc.internal.CertificateUtils;
 import io.grpc.internal.ClientStreamListener.RpcProgress;
+import io.grpc.internal.ClientTransportWithDisconnectReason;
 import io.grpc.internal.ConnectionClientTransport;
 import io.grpc.internal.DisconnectError;
 import io.grpc.internal.GoAwayDisconnectError;
@@ -56,7 +57,6 @@
 import io.grpc.internal.InUseStateAggregator;
 import io.grpc.internal.KeepAliveManager;
 import io.grpc.internal.KeepAliveManager.ClientKeepAlivePinger;
-import io.grpc.internal.ManagedClientDisconnectTransport;
 import io.grpc.internal.NoopSslSession;
 import io.grpc.internal.SerializingExecutor;
 import io.grpc.internal.SimpleDisconnectError;
@@ -133,7 +133,7 @@
  * A okhttp-based {@link ConnectionClientTransport} implementation.
  */
 class OkHttpClientTransport implements ConnectionClientTransport, TransportExceptionHandler,
-      OutboundFlowController.Transport, ManagedClientDisconnectTransport {
+      OutboundFlowController.Transport, ClientTransportWithDisconnectReason {
   private static final Map<ErrorCode, Status> ERROR_CODE_TO_STATUS = buildErrorCodeToStatusMap();
   private static final Logger log = Logger.getLogger(OkHttpClientTransport.class.getName());
   private static final String GRPC_ENABLE_PER_RPC_AUTHORITY_CHECK =