[MSHARED-1045] MSHARED-1024 breaks binary backwards compatibility

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Duplicate
• Component/s: maven-reporting-api
• Assignee: Unassigned
• Reporter: Andrei Silviu Dragnea
• Created: 14/Mar/22 18:21
• Updated: 20/Aug/22 10:16
• Resolved: 20/Aug/22 10:16

Description

https://github.com/apache/maven-reporting-api/pull/2 breaks binary backwards compatibility of interface `MavenReport`, because replacing `org.codehaus.doxia.sink.Sink` with `org.apache.maven.doxia.sink.Sink` changes the signature of method:

void generate( Sink sink, Locale locale ) throws MavenReportException;

So nothing compiled against version `3.0` of the `maven-reporting-api` works with `3.1.0` anymore.

I suggest either reverting this commit in a new release or updating the code in a backwards-compatible manner with two mutually recursive default implementations for both the old and new signature (this requires Java 8 support though):

 

@Deprecated
default void generate( org.codehaus.doxia.sink.Sink sink, Locale locale ) throws MavenReportException {
    generate((Sink) sink, locale);
}

default void generate( Sink sink, Locale locale ) throws MavenReportException {
    generate((org.codehaus.doxia.sink.Sink) sink, locale);
} 

The solution above can result in `ClassCastException`s though, because some `org.apache.maven.doxia.sink.Sink` maybe do not implement `org.codehaus.doxia.sink`. I do not know any way of safely evolving the type of an input parameter for a method.

Issue Links

• is caused by: MSHARED-1024 Replace deprecated code
• is fixed by: MSHARED-1118 Restore binary compat for MavenReport (partially revert MSHARED-1024)