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

Have ReverseOrder rule flag Collections.reverseOrder(String::compareTo) #398

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

Conversation

rickie
Copy link
Member

@rickie rickie commented Dec 8, 2022

Encountered this problem when testing downstream.

Without this rule this:

Collections.reverseOrder(String::compareTo)

Would be replaced with:

Collections.reverseOrder(Comparator.naturalOrder())

Which is incompatible so it would lead to non compilable code.

@rickie rickie added the bug Something isn't working label Dec 8, 2022
@rickie rickie added this to the 0.6.0 milestone Dec 8, 2022
@rickie rickie requested a review from Stephan202 December 8, 2022 08:05
@github-actions
Copy link

github-actions bot commented Dec 8, 2022

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie force-pushed the rossendrijver/reverseorder branch from 45d5480 to cf38b37 Compare December 8, 2022 08:07
@rickie rickie requested a review from eric-picnic December 8, 2022 08:08
@github-actions
Copy link

github-actions bot commented Dec 8, 2022

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

If you share a link on Slack to the code that gives trouble I'll try to have a look.

@@ -58,6 +58,7 @@ Comparator<T> after() {
Comparator<T> before() {
return Refaster.anyOf(
Collections.reverseOrder(),
Collections.reverseOrder(T::compareTo),
Copy link
Member

Choose a reason for hiding this comment

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

The rule above is meant to replace T::compareTo with naturalOrder(), so this one shouldn't be necessary. 🤔 (And the build seems to agree 👀)

Copy link
Member Author

Choose a reason for hiding this comment

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

I shared it.

Still I think we should add this one. If we apply the rewrite suggested right now we would end up in a state where you can have:

  .isSortedAccordingTo(Collections.reverseOrder(Comparator.naturalOrder()));

It gives the following error:

'reverseOrder(java.util.Comparator )' in 'java.util.Collections' cannot be applied to '(java.util.Comparator )'

Copy link
Member

Choose a reason for hiding this comment

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

So the problem as I understand it is that:

  1. org.assertj.core.api.AbstractListAssert#isSortedAccordingTo accepts any Comparator<? super ELEMENT>. (For the code at hand ELEMENT is OffsetDateTime.)
  2. java.util.Collections#reverseOrder accepts any Comparable<T>.
  3. java.util.Comparator.naturalOrder() returns a Comparator<T extends Comparable<? super T>>.

As a result the compiler emits:

no suitable method found for reverseOrder(java.util.Comparator<T>)
    method java.util.Collections.<T>reverseOrder(java.util.Comparator<T>) is not applicable
      (inferred type does not conform to equality constraint(s)
        inferred: T
        equality constraints(s): T)
    method java.util.Collections.<T>reverseOrder() is not applicable
      (cannot infer type-variable(s) T
        (actual and formal argument lists differ in length))

This is a general problem with Refaster. Just adding a T::compareTo case here is not enough: the NaturalOrder rule would also "break" e.g. the following expressions:

  • abstractListAssert.isSortedAccordingTo(reverseOrder(comparing(identity())))
  • abstractListAssert.isSortedAccordingTo(reverseOrder(comparing(v -> v)))

We could of course just add those cases as well, but:

  1. That doesn't solve the general problem of rules such as NaturalOrder breaking code.
  2. There are likely other such problematic interactions between rules, and ideally we find a way to identify those, too. (Because otherwise a solution to (1) would prevent certain viable transformations from being applied.)

Yes, that's all much harder... :(

I did play around a bit with a @Placeholder @Matches(CustomMatcher.class) approach, but it appears that the VisitorState passed by Refaster's placeholder logic to the Matcher is "too fake" to infer the symbols and type information we may need to solve problem (1).

Copy link
Member Author

Choose a reason for hiding this comment

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

Wow, okay I didn't expect this. That's indeed a much bigger issue 🤔. Let's sync on this one offline tomorrow.

@rickie rickie modified the milestones: 0.6.0, 0.7.0 Dec 9, 2022
@rickie
Copy link
Member Author

rickie commented Dec 9, 2022

Moved it to the next milestone 0.7.0.

@rickie rickie added the WIP Work in progress label Dec 19, 2022
@rickie rickie removed this from the 0.7.0 milestone Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working WIP Work in progress
Development

Successfully merging this pull request may close these issues.

2 participants