Skip to content
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.

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

Flush writer after writing generated code #5919

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dagnir
Copy link
Contributor

@dagnir dagnir commented Feb 28, 2025

Motivation and Context

BufferedWriter is created in a try-with-resources, so it is always closed, but closing the writer does not actually flush the output stream; it just flushes the remaining data buffered in BufferedWriter to the stream:

https://github.com/openjdk/jdk/blob/3c72c04de7a43d265dae7160fe53baaaa8ae6f73/src/java.base/share/classes/java/io/BufferedWriter.java#L311-L322

We still need to call BufferedWriter#flush() explicitly so that the output stream is flushed:

https://github.com/openjdk/jdk/blob/3c72c04de7a43d265dae7160fe53baaaa8ae6f73/src/java.base/share/classes/java/io/BufferedWriter.java#L298-L308

This should hopefully fix issues where
CodeWriter#validateFileContentMatches fails when comparing contents because the file on disk is truncated.

Modifications

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

BufferedWriter is created in a try-with-resources, so it is always
closed, but closing the writer does not actually flush the output
stream; it just flushes the remaining data *buffered* in BufferedWriter
to the stream:

https://github.com/openjdk/jdk/blob/3c72c04de7a43d265dae7160fe53baaaa8ae6f73/src/java.base/share/classes/java/io/BufferedWriter.java#L311-L322

We still need to call BufferedWriter#flush() explicitly so that the
output stream is flushed:

https://github.com/openjdk/jdk/blob/3c72c04de7a43d265dae7160fe53baaaa8ae6f73/src/java.base/share/classes/java/io/BufferedWriter.java#L298-L308

This should hopefully fix issues where
CodeWriter#validateFileContentMatches fails when comparing contents
because the file on disk is truncated.
Copy link

sonarqubecloud bot commented Mar 1, 2025

@dagnir dagnir marked this pull request as ready for review March 1, 2025 00:11
@dagnir dagnir requested a review from a team as a code owner March 1, 2025 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants