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

Fix typeArguments array not being cloned when resolving ParameterizedType with changed owner #2706

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

TBlueF
Copy link
Contributor

@TBlueF TBlueF commented Jun 25, 2024

Purpose

This PR fixes an inconsistency in $Gson$Types#resolve() where the ParameterizedType#getActualTypeArguments() array is only cloned when the resolved owner-type has not changed from the original owner-type.

Description

In most cases this is a non-issue, as usually all ParameterizedType implementations clone the array themselves when invoking the getActualTypeArguments() getter. However, this is not guaranteed.
Cloning the array only when the owner-type didn't change seems like an inconsistency and an oversight, so this PR is trying to fix that.

Checklist

  • New code follows the Google Java Style Guide
    This is automatically checked by mvn verify, but can also be checked on its own using mvn spotless:check.
    Style violations can be fixed using mvn spotless:apply; this can be done in a separate commit to verify that it did not cause undesired changes.
  • If necessary, new public API validates arguments, for example rejects null
  • New public API has Javadoc
    • Javadoc uses @since $next-version$
      ($next-version$ is a special placeholder which is automatically replaced during release)
  • If necessary, new unit tests have been added
    • Assertions in unit tests use Truth, see existing tests
    • No JUnit 3 features are used (such as extending class TestCase)
    • If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
  • mvn clean verify javadoc:jar passes without errors

Copy link
Member

@eamonnmcmanus eamonnmcmanus left a comment

Choose a reason for hiding this comment

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

Thanks! I agree that the original code seems a bit suspect and this is the cleanest way to fix it.

@eamonnmcmanus eamonnmcmanus merged commit e8cdabf into google:main Jun 27, 2024
11 checks passed
@TBlueF TBlueF deleted the fix/gsontypes branch June 29, 2024 20:23
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.

None yet

3 participants