Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(sdk-java): name transport errors, never print the key

Yudhi Armyndharis4d52f65d6691
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java b/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java
index 9b1df3197..79f59cd80 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java
@@ -28,9 +28,9 @@ public final class ClientConfig {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("OpenWAClient: apiKey is required");
}
- if (hasControlChar(key)) {
+ if (hasIllegalChar(key)) {
throw new IllegalArgumentException(
- "OpenWAClient: apiKey contains illegal characters (whitespace or control) — check for a stray newline");
+ "OpenWAClient: apiKey contains illegal characters (whitespace, control or non-ASCII) — check for a stray newline");
}
if (b.timeout != null && (b.timeout.isZero() || b.timeout.isNegative())) {
throw new IllegalArgumentException("OpenWAClient: timeout must be positive");
@@ -50,10 +50,10 @@ public final class ClientConfig {
this.transport = b.transport;
}
- private static boolean hasControlChar(String s) {
+ private static boolean hasIllegalChar(String s) {
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
- if (c < 0x20 || c == 0x7f) {
+ if (c < 0x20 || c > 0x7e) {
return true;
}
}
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java b/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java
index 7abbf70f2..09d2d2022 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java
@@ -214,6 +214,12 @@ public final class OpenWAClient {
: gson;
}
+ /** A refused connection carries no detail text; name the exception class instead of printing "null". */
+ private static String reason(Exception e) {
+ String message = e.getMessage();
+ return message != null ? message : e.getClass().getSimpleName();
+ }
+
private HttpResponseData execute(HttpMethod method, String path, Object query, Object body) {
return execute(method, path, query, body, null);
}
@@ -242,14 +248,14 @@ public final class OpenWAClient {
// A timeout surfaces as OpenWATimeoutError (unchecked) and propagates.
res = transport.send(reqData);
} catch (IOException e) {
- throw new OpenWAError("Transport error — " + method + " " + path + ": " + e.getMessage());
+ throw new OpenWAError("Transport error — " + method + " " + path + ": " + reason(e), e);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
- throw new OpenWAError("Transport interrupted — " + method + " " + path);
+ throw new OpenWAError("Transport interrupted — " + method + " " + path, e);
} catch (IllegalArgumentException e) {
// e.g. a JDK-restricted header name in defaultHeaders, or a URI-illegal char — keep it
// inside the OpenWAError contract instead of leaking a raw JDK exception to the caller.
- throw new OpenWAError("Invalid request — " + method + " " + path + ": " + e.getMessage());
+ throw new OpenWAError("Invalid request — " + method + " " + path + ": " + reason(e));
}
if (res.status() < 200 || res.status() >= 300) {
throw OpenWAApiError.fromResponse(res.status(), "", utf8(res.body()), method + " " + path, res.headers());
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/errors/OpenWAError.java b/sdk/java/src/main/java/com/rmyndharis/openwa/errors/OpenWAError.java
index 15691f04b..6d6bd7a36 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/errors/OpenWAError.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/errors/OpenWAError.java
@@ -5,4 +5,8 @@ public class OpenWAError extends RuntimeException {
public OpenWAError(String message) {
super(message);
}
+
+ public OpenWAError(String message, Throwable cause) {
+ super(message, cause);
+ }
}
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/http/HttpRequestData.java b/sdk/java/src/main/java/com/rmyndharis/openwa/http/HttpRequestData.java
index 098ea30cf..499691a48 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/http/HttpRequestData.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/http/HttpRequestData.java
@@ -2,6 +2,15 @@ package com.rmyndharis.openwa.http;
import java.time.Duration;
import java.util.Map;
+import java.util.Set;
/** A fully-resolved outbound request (absolute URL, final headers, serialized body). */
-public record HttpRequestData(HttpMethod method, String url, Map<String, String> headers, String body, Duration timeout) {}
+public record HttpRequestData(HttpMethod method, String url, Map<String, String> headers, String body, Duration timeout) {
+ /** Header values and the body are left out: a logging transport prints the request it is handed. */
+ @Override
+ public String toString() {
+ return "HttpRequestData[method=" + method + ", url=" + url
+ + ", headers=" + (headers == null ? Set.of() : headers.keySet())
+ + ", bodyLength=" + (body == null ? 0 : body.length()) + ", timeout=" + timeout + "]";
+ }
+}
diff --git a/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java b/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java
index 74a829fed..fc97649be 100644
--- a/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java
+++ b/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java
@@ -1,6 +1,8 @@
package com.rmyndharis.openwa;
import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -9,6 +11,7 @@ import com.rmyndharis.openwa.http.HttpMethod;
import com.rmyndharis.openwa.http.HttpTransport;
import com.rmyndharis.openwa.model.SuccessResult;
import com.rmyndharis.openwa.support.MockTransport;
+import java.net.ConnectException;
import java.time.Duration;
import java.util.HashMap;
import java.util.Map;
@@ -75,4 +78,27 @@ class ConfigTest {
() -> c.request(HttpMethod.GET, "/x", null, null, SuccessResult.class));
assertTrue(e.getMessage().contains("Invalid request"));
}
+
+ @Test
+ void rejectsApiKeyWithNonAsciiCharacterWithoutEchoingIt() {
+ // A zero-width space is a common copy artifact; the JDK would quote the whole key when it
+ // refused the header, so the key is refused here and never repeated.
+ String key = "owa_k1_0123456789abcdef\u200b";
+ IllegalArgumentException e = assertThrows(IllegalArgumentException.class,
+ () -> ClientConfig.builder().baseUrl("http://h").apiKey(key).build());
+ assertFalse(e.getMessage().contains("owa_k1_0123456789abcdef"));
+ }
+
+ @Test
+ void transportFailureWithoutDetailTextNamesTheExceptionAndKeepsTheCause() {
+ ConnectException refused = new ConnectException();
+ HttpTransport down = req -> {
+ throw refused;
+ };
+ OpenWAClient c = new OpenWAClient(base().transport(down).build());
+ OpenWAError e = assertThrows(OpenWAError.class,
+ () -> c.request(HttpMethod.GET, "/x", null, null, SuccessResult.class));
+ assertTrue(e.getMessage().endsWith(": ConnectException"), e.getMessage());
+ assertSame(refused, e.getCause());
+ }
}
diff --git a/sdk/java/src/test/java/com/rmyndharis/openwa/http/HttpTest.java b/sdk/java/src/test/java/com/rmyndharis/openwa/http/HttpTest.java
index 8f4b85964..5b53d7cbf 100644
--- a/sdk/java/src/test/java/com/rmyndharis/openwa/http/HttpTest.java
+++ b/sdk/java/src/test/java/com/rmyndharis/openwa/http/HttpTest.java
@@ -6,6 +6,7 @@ import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import com.google.gson.Gson;
+import java.time.Duration;
import java.util.LinkedHashMap;
import java.util.Map;
import org.junit.jupiter.api.Test;
@@ -95,4 +96,15 @@ class HttpTest {
}
private record Query(String chatId, Integer limit, String cursor) {}
+
+ @Test
+ void requestToStringShowsNeitherTheApiKeyNorTheBody() {
+ // A logging transport prints the request it is handed.
+ HttpRequestData req = new HttpRequestData(HttpMethod.POST, "https://h/api/x",
+ Map.of("X-API-Key", "owa_k1_secret"), "{\"text\":\"private words\"}", Duration.ofSeconds(5));
+ String text = req.toString();
+ assertFalse(text.contains("owa_k1_secret"), text);
+ assertFalse(text.contains("private words"), text);
+ assertTrue(text.contains("POST https://h/api/x") || text.contains("https://h/api/x"), text);
+ }
}