fix: send the User-Agent to translation memory storage URLs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: hive-bot

CHANGELOG.md

@@ -190,6 +190,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `setExtraBodyParameters()`, added last to the `rephraseText()` request body.
 
 ### Changed
+- Requests to the pre-signed translation memory storage URLs now send the same
+  `User-Agent` as DeepL API requests (the one set with `setHeaders()`, if any);
+  previously they sent the JVM default. They still get no `Authorization` or
+  other custom headers.
 - `translateText()` sends the language codes with the language part
   lower-cased and the rest as given, like document translation, for example
   `zh-Hans`; before, the part after the first `-` was upper-cased.

README.md

@@ -1911,7 +1911,8 @@ The available options setters are:
 - `setHeaders()`: additional HTTP headers to attach to all requests. A header
   with the same name as one the library sets, matched in any casing, replaces
   it, including `Authorization` and `User-Agent`; `Content-Type` keeps the
-  library's value.
+  library's value. Requests to the pre-signed translation memory storage URLs
+  (import upload and export download) get only the `User-Agent`.
 - `setServerUrl()`: base URL for DeepL API, may be overridden for testing
   purposes. By default, the correct DeepL API (Free or Pro) is automatically
   selected.

deepl-java/src/main/java/com/deepl/api/HttpClientWrapper.java

@@ -235,25 +235,36 @@ public HttpResponse uploadWithBackoff(
 
   /**
    * Uploads content to an absolute URL outside of the DeepL API, for example a pre-signed storage
-   * URL returned by a translation memory import job. The DeepL headers, in particular the
-   * Authorization header, are deliberately not sent to third-party storage.
+   * URL returned by a translation memory import job. Only the User-Agent header is sent; the
+   * Authorization header and other custom headers are deliberately not sent to third-party storage.
    */
   public HttpResponse sendAssetPutRequestWithBackoff(
       String url, byte[] fileContent, String contentType)
       throws InterruptedException, DeepLException {
     HttpContent content = HttpContent.buildRawContent(contentType, fileContent);
-    return sendRequestToUrlWithBackoff(PUT, url, content, Collections.emptyMap(), false, true)
+    return sendRequestToUrlWithBackoff(PUT, url, content, storageHeaders(), false, true)
         .toStringResponse();
   }
 
   /**
    * Downloads content from an absolute URL outside of the DeepL API, for example a pre-signed
-   * storage URL returned by a completed translation memory export job. The DeepL headers, in
-   * particular the Authorization header, are deliberately not sent to third-party storage.
+   * storage URL returned by a completed translation memory export job. Only the User-Agent header
+   * is sent; the Authorization header and other custom headers are deliberately not sent to
+   * third-party storage.
    */
   public void downloadAssetWithBackoff(String url, ResponseCheck check, OutputStream outputStream)
       throws InterruptedException, DeepLException, IOException {
-    downloadToStreamWithBackoff(GET, url, null, Collections.emptyMap(), check, outputStream);
+    downloadToStreamWithBackoff(GET, url, null, storageHeaders(), check, outputStream);
+  }
+
+  /** The User-Agent entry of the client headers, in whatever casing it was set. */
+  private Map<String, String> storageHeaders() {
+    for (Map.Entry<String, String> header : headers.entrySet()) {
+      if ("User-Agent".equalsIgnoreCase(header.getKey())) {
+        return Collections.singletonMap(header.getKey(), header.getValue());
+      }
+    }
+    return Collections.emptyMap();
   }
 
   // Retrying after the first byte was written would duplicate it in the output stream, which

deepl-java/src/offlineTest/java/com/deepl/api/TranslationMemoriesTest.java

@@ -10,7 +10,7 @@
 import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
 import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
-import static com.github.tomakehurst.wiremock.client.WireMock.notMatching;
+import static com.github.tomakehurst.wiremock.client.WireMock.matching;
 import static com.github.tomakehurst.wiremock.client.WireMock.okJson;
 import static com.github.tomakehurst.wiremock.client.WireMock.post;
 import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor;
@@ -35,7 +35,9 @@
 import java.nio.file.Path;
 import java.time.Duration;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.junit.jupiter.api.io.TempDir;
@@ -223,13 +225,13 @@ void throwsIllegalArgumentWhenTheImportFileIsInvalid() {
   }
 
   @Test
-  void uploadsTheFileBytesWithoutDeepLHeaders() throws Exception {
+  void uploadsTheFileBytesWithTheUserAgentAndWithoutAuthorization() throws Exception {
     byte[] content = new byte[] {0x3c, (byte) 0xff, 0x00, (byte) 0x80, 0x3e};
     wm.stubFor(
         put("/storage")
             .withHeader("Content-Type", equalTo("application/xml"))
             .withHeader("Authorization", absent())
-            .withHeader("User-Agent", notMatching("deepl-java.*"))
+            .withHeader("User-Agent", matching("deepl-java/.*"))
             .withRequestBody(binaryEqualTo(content))
             .willReturn(aResponse().withStatus(200)));
     client.uploadTranslationMemoryFile(storageUrl(), content, "application/xml");
@@ -454,17 +456,42 @@ void sendsTheIdOfATranslationMemoryObjectWhenCreatingAnExport() throws Exception
   }
 
   @Test
-  void downloadsTheExportToAFileWithoutDeepLHeaders() throws Exception {
+  void downloadsTheExportToAFileWithTheUserAgentAndWithoutAuthorization() throws Exception {
     wm.stubFor(
         get("/storage/export")
             .withHeader("Authorization", absent())
-            .withHeader("User-Agent", notMatching("deepl-java.*"))
+            .withHeader("User-Agent", matching("deepl-java/.*"))
             .willReturn(aResponse().withStatus(200).withBody("<tmx/>")));
     File output = tempDir.resolve("export.tmx").toFile();
     client.downloadTranslationMemoryExport(completedExport(), output);
     assertEquals("<tmx/>", Fixtures.readFile(output));
   }
 
+  @Test
+  void sendsOnlyTheCallersUserAgentToStorage() throws Exception {
+    Map<String, String> headers = new HashMap<>();
+    headers.put("user-agent", "my-app/1.0");
+    headers.put("X-Custom", "v");
+    headers.put("Authorization", "Bearer t");
+    DeepLClient customClient =
+        OfflineClient.createClient(
+            wm, (DeepLClientOptions) new DeepLClientOptions().setHeaders(headers));
+    wm.stubFor(
+        put("/storage")
+            .withHeader("User-Agent", equalTo("my-app/1.0"))
+            .withHeader("X-Custom", absent())
+            .withHeader("Authorization", absent())
+            .willReturn(aResponse().withStatus(200)));
+    wm.stubFor(
+        get("/storage/export")
+            .withHeader("User-Agent", equalTo("my-app/1.0"))
+            .withHeader("X-Custom", absent())
+            .withHeader("Authorization", absent())
+            .willReturn(aResponse().withStatus(200).withBody("<tmx/>")));
+    customClient.uploadTranslationMemoryFile(storageUrl(), new byte[] {0x3c}, "application/xml");
+    customClient.downloadTranslationMemoryExport(completedExport(), new ByteArrayOutputStream());
+  }
+
   @Test
   void downloadsTheExportToAStream() throws Exception {
     byte[] bytes = new byte[] {0x00, (byte) 0xff, (byte) 0x80};