Skip to content

Fix resource leak pattern in DependencyGraphParser.parseLiteral() - #2018

Open
joshinii wants to merge 2 commits into
apache:masterfrom
joshinii:master
Open

Fix resource leak pattern in DependencyGraphParser.parseLiteral()#2018
joshinii wants to merge 2 commits into
apache:masterfrom
joshinii:master

Conversation

@joshinii

Copy link
Copy Markdown

Wrap the BufferedReader in try-with-resources so it is closed even if parse() throws. StringReader.close() is currently a no-op, but this is to keep the method consistent with the rest of the codebase.

Fixes #1996

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

… parse() throws. StringReader.close() is currently a no-op, but this is to keep the method consistent with the rest of the codebase.

Fixes apache#1996

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Correct and minimal conversion of parseLiteral() to try-with-resources, consistent with the same pattern already applied to parseMultiResource() in commit 16bbda7. The change is trivially safe since the underlying StringReader.close() is a no-op, but it eliminates a latent leak pattern if the reader type ever changes.

One optional follow-up opportunity: the parse(URL resource) method (lines 175-189) still uses the pre-Java-7 try-finally-catch pattern with manual null checks and a swallowed IOException. Unlike parseLiteral(), that method wraps a real InputStreamReader over resource.openStream(), so converting it to try-with-resources would be more meaningful and would complete the consistency cleanup within this file.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

Reviewer follow-up: this method wraps a real InputStreamReader and
was still using the old try-finally-catch pattern with a swallowed
IOException.
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.

Minor resource leak in DependencyGraphParser.parseLiteral()

2 participants