[Document Intelligence] Corrupted images #31908
Draft
+107
−6
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
HarshaNalluru
commented
Nov 23, 2024
| @@ -349,7 +356,8 @@ function streamToText(stream: NodeJS.ReadableStream): Promise<string> { | |||
| } | |||
| }); | |||
| stream.on("end", () => { | |||
| resolve(Buffer.concat(buffer).toString("utf8")); | |||
There was a problem hiding this comment.
utf8 encoding corrupts the image data
… harshan/d-i-png-issue
|
API change check API changes are not detected in this pull request. |
mpodwysocki
reviewed
Nov 23, 2024
| outputFile: { | ||
| junit: "test-results.browser.xml", | ||
| }, | ||
| fakeTimers: { | ||
| toFake: ["setTimeout", "Date"], | ||
| }, | ||
| watch: false, | ||
| include: ["test/**/*.spec.ts"], | ||
| include: ["test/**/figures.spec.ts"], |
There was a problem hiding this comment.
Do we only want to keep it at one test file?
There was a problem hiding this comment.
No, apologies about this. I was testing my changes in core- with this example.
I'll revert this back once the changes in core are finalized :)
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.
Background
We encode the response Buffer to "utf8" by default in the
NodeFetchClientat@azure/core-rest-pipeline."utf8" encoding of Buffer has been found to corrupt the output in certain cases, such as when dealing with PNG files (
image/pngcontent-type response).This issue arises because "utf8" encoding is not suitable for binary data like images, which leads to corrupted files and unexpected behavior in applications that rely on this data.
What changed?
To address this issue, I've implemented the following changes
Content-Type Check: Introduced a check for the content type of the response header. If the content type is
"image/png", the encoding is now set to"binary"instead of"utf8". This ensures that binary data, like PNG images, is handled correctly without corruption.Encoding Parameter: The
streamToTextfunction has been updated to accept an additional parameter,encoding, which can be either "utf8" or "binary". This allows for more flexible handling of different types of response data, ensuring that the appropriate encoding is used based on the content type.TO DO
While the changes in this PR address the immediate issue with PNG files, there are further improvements needed to ensure robust handling of various content types:
bodyAsBufferProperty: As an alternative approach, we could introduce a newbodyAsBufferproperty. By doing so, we can bypass the need for encoding altogether for certain types of responses, allowing the data to be handled as a raw Buffer. This approach could simplify the handling of binary data and prevent encoding-related issues.