Merge branch 'main' into sdk-4293-fix-creation-ongoing-legal-hold-policy-with-start-date

Author: lukaszsocha2

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [4.13.1](https://github.com/box/box-java-sdk/compare/v4.13.0...v4.13.1) (2024-11-29)
+
+
+### Bug Fixes:
+
+* Correctly calculate `Content-Length` when reading from a stream ([#1277](https://github.com/box/box-java-sdk/issues/1277)) ([b1d5371](https://github.com/box/box-java-sdk/commit/b1d5371491abe1729a95eb9dc39d375135c8681d))
+
 ## [4.13.0](https://github.com/box/box-java-sdk/compare/v4.12.0...v4.13.0) (2024-11-21)
 
 

README.md

@@ -14,7 +14,7 @@ The Box Java SDK for interacting with the
 [Box Content API](https://developers.box.com/docs/).
 
 ## Latest Release
-Latest release can be found [here](https://github.com/box/box-java-sdk/tree/v4.13.0).
+Latest release can be found [here](https://github.com/box/box-java-sdk/tree/v4.13.1).
 
 ## Upgrades
 You can read about how to migrate to the 4 version [here](doc/upgrades/3.x.x%20to%204.x.x.md).
@@ -233,31 +233,31 @@ You can find guides and tutorials in the `doc` directory.
 
 * [BUILD ON BOX PLATFORM](https://developer.box.com/guides/getting-started/)
 * [Javadocs](http://box.github.io/box-java-sdk/javadoc/com/box/sdk/package-summary.html)
-* [Overview](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/overview.md)
-* [Configuration](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/configuration.md)
-* [Logging](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/logging.md)
-* [Authentication](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/authentication.md)
-* [Files](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/files.md)
-* [Folders](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/folders.md)
-* [Comments](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/comments.md)
-* [Collaborations](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/collaborations.md)
-* [Collaboration Allowlists](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/collaboration_allowlists.md)
-* [Events](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/events.md)
-* [Search](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/search.md)
-* [Users](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/users.md)
-* [Groups](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/groups.md)
-* [Tasks](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/tasks.md)
-* [Trash](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/trash.md)
-* [Collections](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/collections.md)
-* [Devices](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/devices.md)
-* [Retention Policies](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/retention_policies.md)
-* [Legal Holds Policy](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/legal_holds.md)
-* [Watermarking](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/watermarking.md)
-* [Webhooks](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/webhooks.md)
-* [Web Links](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/weblinks.md)
-* [Metadata Templates](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/metadata_template.md)
-* [Classifications](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/classifications.md)
-* [Recent Items](https://github.com/box/box-java-sdk/blob/v4.13.0/doc/recent_items.md)
+* [Overview](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/overview.md)
+* [Configuration](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/configuration.md)
+* [Logging](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/logging.md)
+* [Authentication](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/authentication.md)
+* [Files](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/files.md)
+* [Folders](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/folders.md)
+* [Comments](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/comments.md)
+* [Collaborations](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/collaborations.md)
+* [Collaboration Allowlists](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/collaboration_allowlists.md)
+* [Events](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/events.md)
+* [Search](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/search.md)
+* [Users](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/users.md)
+* [Groups](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/groups.md)
+* [Tasks](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/tasks.md)
+* [Trash](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/trash.md)
+* [Collections](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/collections.md)
+* [Devices](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/devices.md)
+* [Retention Policies](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/retention_policies.md)
+* [Legal Holds Policy](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/legal_holds.md)
+* [Watermarking](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/watermarking.md)
+* [Webhooks](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/webhooks.md)
+* [Web Links](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/weblinks.md)
+* [Metadata Templates](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/metadata_template.md)
+* [Classifications](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/classifications.md)
+* [Recent Items](https://github.com/box/box-java-sdk/blob/v4.13.1/doc/recent_items.md)
 
 
 Javadocs are generated when `gradle javadoc` is run and can be found in

build.gradle

@@ -13,7 +13,7 @@ sourceCompatibility = 1.8
 
 group = "com.box"
 archivesBaseName = "box-java-sdk"
-version = "4.13.0"
+version = "4.13.1"
 
 java {
     withJavadocJar()

src/intTest/java/com/box/sdk/BoxAIIT.java

@@ -317,7 +317,7 @@ public void aiExtractStructuredWithMetadataTemplate() throws InterruptedExceptio
                 JsonObject sourceJson = response.getSourceJson();
                 assertThat(sourceJson.get("firstName").asString(), is(equalTo("John")));
                 assertThat(sourceJson.get("lastName").asString(), is(equalTo("Doe")));
-                assertThat(sourceJson.get("dateOfBirth").asString(), is(equalTo("1990-07-04")));
+                assertThat(sourceJson.get("dateOfBirth").asString(), is(equalTo("1990-07-04T00:00:00Z")));
                 assertThat(sourceJson.get("age").asInt(), is(equalTo(34)));
                 assertThat(sourceJson.get("hobby").asArray().get(0).asString(), is(equalTo("guitar")));
                 assertThat(sourceJson.get("hobby").asArray().get(1).asString(), is(equalTo("books")));

src/intTest/java/com/box/sdk/BoxFileIT.java

@@ -146,6 +146,27 @@ public void getRepresentationContentSucceeds() throws InterruptedException {
         }
     }
 
+    @Test
+    public void getRepresentationContentWithExtractedTextSucceeds() throws InterruptedException {
+        BoxAPIConnection api = jwtApiForServiceAccount();
+        String fileName = "text.pdf";
+        BoxFile file = null;
+        try {
+            file = uploadSampleFileToUniqueFolder(api, fileName);
+            final String fileId = file.getID();
+            String representationHint = "[extracted_text]";
+            ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+            Retry.retry(() -> {
+                new BoxFile(api, fileId).getRepresentationContent(representationHint, outputStream);
+                byte[] downloadedRepresentationContent = outputStream.toByteArray();
+                String text = new String(downloadedRepresentationContent, StandardCharsets.UTF_8);
+                assertTrue(text.contains("Lorem ipsum"));
+            }, 5, 100);
+        } finally {
+            deleteFile(file);
+        }
+    }
+
     @Test
     public void uploadFileStreamSucceeds() {
         BoxAPIConnection api = jwtApiForServiceAccount();
@@ -156,7 +177,7 @@ public void uploadFileStreamSucceeds() {
 
         BoxFile uploadedFile = null;
         try {
-            InputStream uploadStream =  new ByteArrayInputStream(fileContent);
+            InputStream uploadStream = new ByteArrayInputStream(fileContent);
             BoxFile.Info uploadedFileInfo = folder.uploadFile(uploadStream, BoxFileIT.generateString());
             uploadedFile = uploadedFileInfo.getResource();
 
@@ -552,11 +573,11 @@ public void canPaginateOverListOfVersions() {
 
             byte[] fileBytes = "Version 2".getBytes(StandardCharsets.UTF_8);
             uploadedFile.uploadNewVersion(
-                    new ByteArrayInputStream(fileBytes), null, fileBytes.length, mock(ProgressListener.class));
+                new ByteArrayInputStream(fileBytes), null, fileBytes.length, mock(ProgressListener.class));
 
             fileBytes = "Version 3".getBytes(StandardCharsets.UTF_8);
             uploadedFile.uploadNewVersion(
-                    new ByteArrayInputStream(fileBytes), null, fileBytes.length, mock(ProgressListener.class));
+                new ByteArrayInputStream(fileBytes), null, fileBytes.length, mock(ProgressListener.class));
 
             Collection<BoxFileVersion> versionsPart1 = uploadedFile.getVersionsRange(0, 1);
             assertThat(versionsPart1.size(), is(1));

src/main/java/com/box/sdk/BinaryBodyUtils.java

@@ -1,5 +1,6 @@
 package com.box.sdk;
 
+import com.box.sdk.http.HttpHeaders;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -73,12 +74,43 @@ static void writeStreamWithContentLength(BoxAPIResponse response, OutputStream o
             } else {
                 input = response.getBody();
             }
-            writeStreamTo(input, output, response.getContentLength());
+            writeStreamTo(input, output, getContentLengthFromAPIResponse(response));
         } finally {
             response.close();
         }
     }
 
+    /**
+     * Get the content length from the API response.
+     * In some cases, the Content-Length is not provided in the response headers.
+     * This could happen when getting the content representation for a compressed data.
+     * In that case the API will switch to chunk mode and provide the length in the "X-Original-Content-Length" header.
+     *
+     * @param response API response.
+     * @return Content length.
+     */
+    private static long getContentLengthFromAPIResponse(BoxAPIResponse response) {
+        long length = response.getContentLength();
+        if (length == -1) {
+            String headerValue = null;
+            if (response.getHeaders().containsKey(HttpHeaders.CONTENT_LENGTH)) {
+                headerValue = response.getHeaders().get(HttpHeaders.CONTENT_LENGTH).get(0);
+            } else if (response.getHeaders().containsKey(HttpHeaders.X_ORIGINAL_CONTENT_LENGTH)) {
+                headerValue = response.getHeaders().get(HttpHeaders.X_ORIGINAL_CONTENT_LENGTH).get(0);
+            }
+
+            if (headerValue != null) {
+                try {
+                    length = Integer.parseInt(headerValue);
+                } catch (NumberFormatException e) {
+                    throw new RuntimeException("Invalid content length: " + headerValue);
+                }
+            }
+        }
+
+        return length;
+    }
+
     /**
      * Writes content of input stream to provided output.
      *
@@ -126,8 +158,8 @@ static void writeStreamTo(InputStream input, OutputStream output, long expectedL
                 totalBytesRead += n;  // Track the total bytes read
             }
             if (totalBytesRead != expectedLength) {
-                throw new IOException("Stream ended prematurely. Expected " + expectedLength
-                        + " bytes, but read " + totalBytesRead + " bytes.");
+                throw new IOException("Stream ended prematurely. Expected "
+                    + expectedLength + " bytes, but read " + totalBytesRead + " bytes.");
             }
         } catch (IOException e) {
             throw new RuntimeException("Error during streaming: " + e.getMessage(), e);

src/main/java/com/box/sdk/BoxAPIConnection.java

@@ -85,7 +85,7 @@ public class BoxAPIConnection {
     private static final String BOX_NOTIFICATIONS_HEADER = "Box-Notifications";
 
     private static final String JAVA_VERSION = System.getProperty("java.version");
-    private static final String SDK_VERSION = "4.13.0";
+    private static final String SDK_VERSION = "4.13.1";
 
     /**
      * The amount of buffer time, in milliseconds, to use when determining if an access token should be refreshed. For

src/main/java/com/box/sdk/http/HttpHeaders.java

@@ -10,6 +10,11 @@ public final class HttpHeaders {
      */
     public static final String CONTENT_LENGTH = "Content-Length";
 
+    /**
+     * HTTP header key X-Original-Content-Length.
+     */
+    public static final String X_ORIGINAL_CONTENT_LENGTH = "X-Original-Content-Length";
+
     /**
      * HTTP header key Content-Type.
      */