Repository navigation
Reporting issue for nonFinalClassInheritsFromNewClass #235
Description
This is what we did:
- the old XWikiContextInitializationFilter class content has been moved to a new class of the same name in a new package and old class now inherits from the new one:
- old: https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-wysiwyg/xwiki-platform-wysiwyg-api/src/main/java/org/xwiki/wysiwyg/filter/XWikiContextInitializationFilter.java#L28
- new: https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/web/XWikiContextInitializationFilter.java#L55
It's a false positive in our case so we needed to add an ignore. This is what revapi told us to add:
<item>
<code>java.class.nonFinalClassInheritsFromNewClass</code>
<old>class org.xwiki.wysiwyg.filter.XWikiContextInitializationFilter</old>
<new>class org.xwiki.wysiwyg.filter.XWikiContextInitializationFilter</new>
<justification>Not a breakage, the old XWikiContextInitializationFilter content has been moved to a new class of the same name in a new package and old class now inherits from the new one</justification>
</item>
The issue is that the new class is not in org.xwiki.wysiwyg.filter.XWikiContextInitializationFilter but in com.xpn.xwiki.web.XWikiContextInitializationFilter.
Thx
Activity
metlos commentedon May 8, 2021
This is reported on the class that has a new super class. I.e. in
xwiki-platform-13.3org.xwiki.wysiwyg.filter.XWikiContextInitializationFilteronly inherited fromjava.lang.Objectbut in13.4-SNAPSHOTit now inherits fromcom.xpn.xwiki.web.XWikiContextInitializationFilter.https://revapi.org/revapi-java/0.24.1/differences.html#_non_final_class_inherits_from_new_class_java_class_nonfinalclassinheritsfromnewclass states that this change is usually ok, but might not be in the presence of final methods. The check doesn't perform the analysis of the methods of the class so it cannot tell if that can actually be the case or not.
That's something we could try to improve.
If you let Revapi also report on non-identifying info about the differences (
outputNonIdentifyingDifferenceInfoin the maven plugin config), it'd even tell you that the new superclass iscom.xpn.xwiki.web.XWikiContextInitializationFilter.