From 517abe4ffdceb3c7ca771207fe20b0c813181810 Mon Sep 17 00:00:00 2001
From: Dianna Hohensee <dianna.hohensee@elastic.co>
Date: Tue, 17 Dec 2024 14:51:45 -0500
Subject: [PATCH] ConnectTransportException returns retryable BAD_GATEWAY
 (#118681)

ConnectTransportException and its subclasses previous translated to a
INTERNAL_SERVER_ERROR HTTP 500 code. We are changing it to 502
BAD_GATEWAY so that users may choose to retry it on connectivity
issues.

Related ES-10214
Closes #118320
---
 docs/changelog/118681.yaml                          |  6 ++++++
 .../transport/ConnectTransportException.java        | 13 +++++++++++++
 .../elasticsearch/ExceptionSerializationTests.java  |  1 +
 3 files changed, 20 insertions(+)
 create mode 100644 docs/changelog/118681.yaml

diff --git a/docs/changelog/118681.yaml b/docs/changelog/118681.yaml
new file mode 100644
index 0000000000000..a186c05e6cd7d
--- /dev/null
+++ b/docs/changelog/118681.yaml
@@ -0,0 +1,6 @@
+pr: 118681
+summary: '`ConnectTransportException` returns retryable BAD_GATEWAY'
+area: Network
+type: enhancement
+issues:
+ - 118320
diff --git a/server/src/main/java/org/elasticsearch/transport/ConnectTransportException.java b/server/src/main/java/org/elasticsearch/transport/ConnectTransportException.java
index 648d27c885843..302175cc4f5a0 100644
--- a/server/src/main/java/org/elasticsearch/transport/ConnectTransportException.java
+++ b/server/src/main/java/org/elasticsearch/transport/ConnectTransportException.java
@@ -13,6 +13,7 @@
 import org.elasticsearch.cluster.node.DiscoveryNode;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.rest.RestStatus;
 
 import java.io.IOException;
 
@@ -41,6 +42,18 @@ public ConnectTransportException(StreamInput in) throws IOException {
         }
     }
 
+    /**
+     * The ES REST API is a gateway to a single or multiple clusters. If there is an error connecting to other servers, then we should
+     * return a 502 BAD_GATEWAY status code instead of the parent class' 500 INTERNAL_SERVER_ERROR. Clients tend to retry on a 502 but not
+     * on a 500, and retrying may help on a connection error.
+     *
+     * @return a {@link RestStatus#BAD_GATEWAY} code
+     */
+    @Override
+    public final RestStatus status() {
+        return RestStatus.BAD_GATEWAY;
+    }
+
     @Override
     protected void writeTo(StreamOutput out, Writer<Throwable> nestedExceptionsWriter) throws IOException {
         super.writeTo(out, nestedExceptionsWriter);
diff --git a/server/src/test/java/org/elasticsearch/ExceptionSerializationTests.java b/server/src/test/java/org/elasticsearch/ExceptionSerializationTests.java
index 2abe4157583cd..31f54f9a16359 100644
--- a/server/src/test/java/org/elasticsearch/ExceptionSerializationTests.java
+++ b/server/src/test/java/org/elasticsearch/ExceptionSerializationTests.java
@@ -409,6 +409,7 @@ public void testConnectTransportException() throws IOException {
         ex = serialize(new ConnectTransportException(node, "msg", "action", new NullPointerException()));
         assertEquals("[][" + transportAddress + "][action] msg", ex.getMessage());
         assertThat(ex.getCause(), instanceOf(NullPointerException.class));
+        assertEquals(RestStatus.BAD_GATEWAY, ex.status());
     }
 
     public void testSearchPhaseExecutionException() throws IOException {