Serialize BufferedImages as base64 #694
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces toBase64() and encodeGzip() methods for ByteArray and image resizing methods for BufferedImage.
The commit introduces an ImageEncodingOptions class which controls how images are encoded when serializing a DataFrame to JSON with metadata. These options include whether to encode images as Base64, a size limit for resizing images, and an optional GZIP compression.
The default kotlin kernel renderer in the Kotlin Notebook plugin serializes images in their original dimensions, potentially causing an OOM exception. This commit overrides the default renderer to prevent such issues.
koperagen
reviewed
May 10, 2024
core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/impl/io/writeJson.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
May 10, 2024
core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/Integration.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
May 10, 2024
core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/json.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
May 10, 2024
* Refactored image encoding logic for DataFrame serialization. * Removed custom renderer for buffered images as it affects rendering of single image objects
Introduced a configuration option to conditionally downsize BufferedImages in the HTML renderer. This mitigates potential memory problems by resizing images according to the provided DisplayConfiguration, specifically affecting the output of dataframes in the Kotlin Notebook plugin.
This commit introduces ImageSerializationTests for validating image base64 encoding. Additionally, a utility function has been added to Utils.kt to parse string into JsonObject for tests.
Developed a mechanism to enable or disable ImageViewer based on the current IDE version in the JupyterHtmlRenderer.
koperagen
reviewed
May 16, 2024
...erated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/ImageSerializationTests.kt
Outdated
Show resolved
Hide resolved
koperagen
approved these changes
May 16, 2024
In the ImageSerializationTests class, the method 'checkImagesEncodedAsStrings' has been renamed to 'checkImagesEncodedAsToString'.
Jolanrensen
reviewed
May 17, 2024
There was a problem hiding this comment.
@ermolenkodev wow these tests are very heavy! It takes my laptop about 2 full minutes to run just these ones.
Could you make the images like waaay smaller? Like 0.5KB or smaller instead of 2-4MB?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #675