Skip to content
This repository has been archived by the owner on Jun 20, 2023. It is now read-only.

Inconsistent library versions reminder. #673

Open
kaifeng-h opened this issue Mar 2, 2020 · 0 comments
Open

Inconsistent library versions reminder. #673

kaifeng-h opened this issue Mar 2, 2020 · 0 comments

Comments

@kaifeng-h
Copy link

Hi. I have implemented a tool to detect library version inconsistencies. Your project have 1 inconsistent library.

Take org.apache.httpcomponents:httpclient for example, this library is declared as version 4.0.1 in jest-droid, 4.5.3 in jest 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.apache.httpcomponents:httpclient for example, if we harmonize all the library versions into 4.5.10. 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 4.5.10. Given that 28 APIs is used in module jest, 0 of them is deleted in a recommended version(which will throw a NoMethodFoundError unless re-compiling the project), 1 of them is regarded as modified which could break the former API contract.

Index Module NA(NAC) NDA(NDAC) NMA(NMAC)
1 jest 28(42) 0(0) 1(5)
2 jest-droid 2(2) 0(0) 0(0)

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
jest jest/src/test/java/io/searchbox/client/http/JestHttpClientTest.java modify org.apache.http.client.config.RequestConfig.Builder.build()

If you are interested, you can have a more complete and detailed report in the attached PDF file.
searchbox-io Jest.pdf

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant