Skip to content

Add try-with-resources to annotation processor #45193

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

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

Conversation

alzimmermsft
Copy link
Member

Description

Changes annotation processor to use a try-with-resources block when the Response<BinaryData> will be closed. This ensures that if any errors occur before the network response is closed that resources won't be leaked.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

Copy link
Member

@vcolin7 vcolin7 left a comment

Choose a reason for hiding this comment

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

General question: is there was a particular reason you chose to use try-with-resources in some tests and to explicitly call close() in others?

// Always close the network response in this situation as converting to a byte[] will read the entire
// response. This should complete the connection, but let's be safe. This must be done after getting the
// byte[] though.
closeResponse(body, "Close the network response as the body should be consumed.");

// Return responseBodyBytes as-is which will have the behavior of null -> null, empty -> empty, and
Copy link
Member

Choose a reason for hiding this comment

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

nit; responseBodyBytes is not used as a variable any longer.

boolean returnIsResponse = TypeConverter.isResponseType(returnType);

// TODO (alzimmer): Base64Uri needs to be handled. Determine how this will show up in code generation and then
// add support for it.
if (entityType == Void.TYPE || entityType == Void.class) {
// Return is void, Void, or Response<Void>, close the network response and return null as the value.
if (returnType.getKind() == TypeKind.VOID) {
Copy link
Member

Choose a reason for hiding this comment

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

Does this mean we only close the response explicitly if the method returns void? Would we keep it open for Void or Response<Void>? Why?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants