kylin-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kaifeng Huang (Jira)" <j...@apache.org>
Subject [jira] [Created] (KYLIN-4395) Inconsistent library versions notice.
Date Sun, 01 Mar 2020 12:34:00 GMT
Kaifeng Huang created KYLIN-4395:
------------------------------------

             Summary: Inconsistent library versions notice.
                 Key: KYLIN-4395
                 URL: https://issues.apache.org/jira/browse/KYLIN-4395
             Project: Kylin
          Issue Type: Improvement
            Reporter: Kaifeng Huang
         Attachments: apache kylin.pdf

Hi. I have implemented a tool to detect library version inconsistencies. Your project have
1 inconsistent library and 10 false consistent libraries.

Take org.mockito:mockito-core for example, this library is declared as version 2.7.14 in server-base,
1.10.19 in source-jdbc and etc... Such version inconsistencies may cause unnecessary maintenance
effort in the long run. For example, if two modules become inter-dependent, library version
conflict may happen. It has already become a common issue and hinders development progress.
Thus a version harmonization is necessary.

Provided we applied a version harmonization, I calculated the cost it may have to harmonize
to all upper versions including an up-to-date one. The cost refers to POM config changes and
API invocation changes. Take org.mockito:mockito-core for example, if we harmonize all the
library versions into 3.2.0. The concern is, how much should the project code adapt to the
newer library version. We list an effort table to quantify the harmonization cost.

The effort table is listed below. It shows the overall harmonization effort by modules. The
columns represents the number of library APIs and API calls(NA,NAC), deleted APIs and API
calls(NDA,NDAC) as well as modified API and API calls(NMA,NMAC). Modified APIs refers to those
APIs whose call graph is not the same as previous version. Take the first row for example,
if upgrading the library into version 3.2.0. Given that 8 APIs is used in module jdbc, 0 of
them is deleted in a recommended version(which will throw a NoMethodFoundError unless re-compiling
the project), 8 of them is regarded as modified which could break the former API contract.


||Index||Module||NA(NAC)||NDA(NDAC)||NMA(NMAC)||
|1|jdbc|8(18)|0(0)|8(18)|
|2|server-base|10(15)|0(0)|10(15)|
|3|core-common|1(15)|0(0)|1(15)|
|4|..|..|..|..|


Also we provided another table to show the potential files that may be affected due to library
API change, which could help to spot the concerned API usage and rerun the test cases. The
table is listed below.


||Module||File||Type||API||
|server-base|server-base/src/test/java/org/apache/kylin/rest/job/StorageCleanupJobTest.java|modify|org.mockito.ArgumentCaptor.getAllValues()|
|server-base|server-base/src/test/java/org/apache/kylin/rest/job/StorageCleanupJobTest.java|modify|org.mockito.ArgumentCaptor.capture()|
|server-base|server-base/src/test/java/org/apache/kylin/rest/job/StorageCleanupJobTest.java|modify|org.mockito.Mockito.times(int)|
|4|..|..|..|



 

As for false consistency, take org.apache.kylin kylin-core-common test-jar for example. The
library is declared in version 3.1.0-SNAPSHOT in all modules. However they are declared differently.
As components are developed in parallel, if one single library version is updated, which could
become inconsistent as mentioned above, may cause above-mentioned inconsistency issues


If you are interested, you can have a more complete and detailed report in the attached PDF
file.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Mime
View raw message