[wip] new task to create exclusion files from issues

[jrudolph]

This is a WIP for a task to create exclusion files. We sometimes have the situation that you expect lots of exclusions because internal API was touched or similar in which case it is annoying to create those files manually from the console output, especially if multiple submodules are involved. This task creates the files directly where they should go and also add a bit of commentary for which versions they are needed.

This is still a WIP but since I don't know when I would get to finish it, I just dump it here.

Potential TODOs:

• add a test case
• make the task an input task to give a name for the files on the shell instead of having to use an environment var
• optionally add comments with the full error description per issue, so it's easier to understand why it is needed

[jrudolph]

Here's a generated example file:

# Autogenerated MiMa filters, please pull branch and check validity, and add comments why they are needed etc.
# Don't merge like this.

# Incompatibilities against 2.5.17
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.util.ManifestInfo.get")

# Incompatibilities against 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.5.5, 2.5.6, 2.5.7, 2.5.8, 2.5.9, 2.5.10, 2.5.11, 2.5.12, 2.5.13, 2.5.14, 2.5.15, 2.5.16, 2.5.17
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.actor.CoordinatedShutdown.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.actor.TypedActor.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.event.AddressTerminatedTopic.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.io.Dns.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.io.Tcp.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.io.Udp.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.io.UdpConnected.get")
ProblemFilters.exclude[IncompatibleResultTypeProblem]("akka.serialization.SerializationExtension.get")

[dwijnand]

So, while I understand how this can be a productivity boost, I'm concerned about two things:

1. It makes it too easy to create MiMa exclusions, which should be carefully looked at;
2. In addition to the above, it's fixing a symptom of unresolved issues, issues like internal APIs shouldn't false positive and require exclusions

So I'd really like not to include this... :-/

If you're happy to pivot to another resolution for your issues, I'd be happy to collaborate on resolving them, I'm thinking:

• Make MiMa aware of @akka.annotation.ApiMayChange / @akka.annotation.InternalApi #160 Make MiMa aware of @akka.annotation.ApiMayChange / @akka.annotation.InternalApi
• There is no inclusion filter #102 Adding an inclusion filter
• Allow ignoring package private classes #53 Ignoring package private classes

(That last one I've been wanting to fix for a long time, but it's tricky because it requires adding a lot of logic to the already present partial-reimplementation of an Unpickler, to get to the package private detail - and it needs to be an Unpickler that works for all versions of Scala, 2.11-2.13 currently. But we can definitely spend time on it as an alternative to this PR.)

[jrudolph]

I agree in theory. The main reason for exclusions in akka projects is changes to internal classes, so fixing that would help a lot.

In practice, I don't have time to fix issues in mima and every so often need to create lots of exclusion like for akka/akka#28294 which was not caused by any of the above issues but probably by some other bug. In those cases, I need a way to appease mima with as little effort as possible (I still need make sure that the errors are harmless indeed which is lots of work in itself).

[dwijnand]

changes to internal classes, so fixing that would help a lot.

That's annotated classes? We can definitely start there - I'll try to find time for it.

every so often need to create lots of exclusion like for akka/akka#28294 which was not caused by any of the above issues but probably by some other bug

That looks like it's #388, btw. Also, that PR seems to have had to pay back from the accidental misconfiguration of MiMa, which is unfortunate, but also exceptional.

I need a way to appease mima with as little effort as possible (I still need make sure that the errors are harmless indeed which is lots of work in itself).

I'd be fine for you and lots of other engineers, but not for the product in general... I'll think about it some more.

[jrudolph]

That looks like it's #388, btw. Also, that PR seems to have had to pay back from the accidental misconfiguration of MiMa, which is unfortunate, but also exceptional.

Agreed. I filed #433 because it seemed related but different enough.

[jrudolph]

I'd be fine for you and lots of other engineers, but not for the product in general...

Yes, maybe :)

[dwijnand]

Let's try and fix MiMa. 💪

[jrudolph]

👍 Dale Wijnand <notifications@github.com> schrieb am Di., 18. Feb. 2020, 18:12:

…

Closed #432 <#432>. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#432>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAACNDC2J4KB34QC7V6SVGDRDQJHDANCNFSM4JUXGL3A> .