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 #2812 #2814

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

nakulj
Copy link

@nakulj nakulj commented Jun 5, 2024

Before this PR

Tests miss the case when a method is called on the built string, see #2812

After this PR

Parens are now surround the append result, ensuring that the post-build method call is applied to the entire built string, not just the last element.

Possible downsides?

Adds parens even when unnecessary. These can be caught and fixed by UnnecessaryParentheses, but ideally they'd only be added if necessary.

@palantirtech
Copy link
Member

Thanks for your interest in palantir/gradle-baseline, @nakulj! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

@changelog-app
Copy link

changelog-app bot commented Jun 5, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Add a test case to StringBuilderConstantParametersTests

Check the box to generate changelog(s)

  • Generate changelog entry

@nakulj nakulj changed the title Add a test case to StringBuilderConstantParametersTests Fix #2812 Jun 5, 2024
@nakulj nakulj force-pushed the fix-StringBuilderConstantParameters branch from 27b17b2 to 8ada3c1 Compare June 6, 2024 18:10
Comment on lines +98 to +99
.prefixWith(tree, "(")
.postfixWith(tree, ")")
Copy link
Member

Choose a reason for hiding this comment

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

I don't think it's desirable to unconditionally wrap the suggested fix with parenthesis. This will result in unidiomatic code in the common case.

Copy link
Author

Choose a reason for hiding this comment

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

Do you have any suggestions on how to check if the parens are necessary?

Copy link
Member

Choose a reason for hiding this comment

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

Sorry, I don't have any suggestions. I suspect this is fairly non-trivial.

I'm not sure it's worthwhile to fix this issue - I imagine it would significantly complicated the logic here.

Copy link
Author

Choose a reason for hiding this comment

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

Yeah, it seems pretty hard.
That said it seems to me that unidiomatic code is preferable to incorrect code- which is what the fixer currently suggests, especially since UnnecessaryParentheses will automatically catch and fix the unidiomatic generated code.

@nakulj nakulj requested a review from pkoenig10 June 10, 2024 19:49
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.

3 participants