Skip to content

8364768: JDK javax.imageio ImageWriters do not all flush the output stream #26703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

8364768: JDK javax.imageio ImageWriters do not all flush the output stream #26703

wants to merge 2 commits into from
+78 −0

Conversation

prrace
Copy link
Contributor

@prrace prrace commented Aug 8, 2025 •
edited by openjdk bot
Loading

4 of the 6 JDK ImageWriters flush the stream at the end of writing. 2 (TIFF and GIF) do not.

This will matter if you are using a caching ImageOutputStream.

This fix makes it consistent.

Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8364768: JDK javax.imageio ImageWriters do not all flush the output stream (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/26703/head:pull/26703
$ git checkout pull/26703

Update a local copy of the PR:
$ git checkout pull/26703
$ git pull https://git.openjdk.org/jdk.git pull/26703/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26703

View PR using the GUI difftool:
$ git pr show -t 26703

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26703.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Aug 8, 2025

👋 Welcome back prr! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Aug 8, 2025 •
edited
Loading

@prrace This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8364768: JDK javax.imageio ImageWriters do not all flush the output stream

Reviewed-by: psadhukhan, azvegint

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 163 new commits pushed to the master branch:

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot changed the title 8364768 8364768: JDK javax.imageio ImageWriters do not all flush the output stream Aug 8, 2025
@openjdk
Copy link

openjdk bot commented Aug 8, 2025

@prrace The following label will be automatically applied to this pull request:

  • client

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added client [email protected] rfr Pull request is ready for review labels Aug 8, 2025
@mlbridge
Copy link

mlbridge bot commented Aug 8, 2025 •
edited
Loading

Webrevs

prsadhuk
prsadhuk reviewed Aug 20, 2025
View reviewed changes
test/jdk/javax/imageio/FlushTest.java Outdated
@@ -0,0 +1,79 @@
/*
* Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2025?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

test/jdk/javax/imageio/FlushTest.java Outdated
if (sz0 != sz1) {
failed = true;
}
} finally {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for finally block or do we need to do baos.close here since FileCacheImageOutputStream.close says "The destination OutputStream is not closed."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BAOS doesn't need a close() call to report its size.
I can actually dispense with the whole try block since the method throws IOException

src/java.desktop/share/classes/com/sun/imageio/plugins/gif/GIFImageWriter.java
@@ -734,6 +734,7 @@ private void write(boolean writeHeader,
if (writeTrailer) {
writeTrailer();
}
stream.flush();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we call flush or flushBefore(current stream position) as is being done in BMP writer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean like BMP does this
stream.flushBefore(stream.getStreamPosition());

flush() is exactly equivalent to that.

public void flush() throws IOException {
    flushBefore(getStreamPosition());
}

prsadhuk
prsadhuk approved these changes Aug 22, 2025
View reviewed changes
Copy link
Contributor

@prsadhuk prsadhuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Aug 22, 2025
@prrace
Copy link
Contributor Author

prrace commented Aug 22, 2025

/integrate

@openjdk
Copy link

openjdk bot commented Aug 22, 2025

Going to push as commit 603526b.
Since your change was applied there have been 169 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Aug 22, 2025
@openjdk openjdk bot closed this Aug 22, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Aug 22, 2025
@openjdk
Copy link

openjdk bot commented Aug 22, 2025

@prrace Pushed as commit 603526b.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
2 more reviewers

@prsadhuk prsadhuk prsadhuk approved these changes

@azvegint azvegint azvegint approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
client [email protected] integrated Pull request has been integrated
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@prrace @prsadhuk @azvegint