ParamDiff is a tool that mines a given Java GitHub code repository. The program analyses all the commits in that repository and finds commits that have added a parameter to an existing method.
The tool generates a CSV file with columns Commit SHA, Java File, Old function signature, New function signature.
ParamDiff is an executable jar file that requires Java 12. Download the latest version of the tool from the release page. This can be run with java -jar command. Here is an example:
java -jar ParamDiff.jar -url https://github.com/seaswalker/spring-analysis
This will clone the repository from the given URL, traverse all the revisions and generate the output CSV. "Sprint analysis" repository used in the example is a small one (89 commits on October 31, 2019) therefore is good for the first test run.
Here are the details of all supported command parameters:
-url: URL of the git repository.-outdir: Directory for program output. Defaults toout. If the directory does not exist, the program will automatically create it.-rn: Repository name. A short name of the repository.
The outdir parameter is optional. However, at least one of the url and rn parameters must be specified. If rn is not specified, this will be the last part of the url parameter.
- Repository: If there is no repository in
rnsubdirectory of theoutdirdirectory, the tool will clone the repository fromurlintorn. If the repository already exists atrn, the tool will pull it instead of cloning. Also, if repository exists locally and theurlargument is not passed, the current state of the local repository will be used. - CSV: Output is written to a CSV file inside the
out-dir. Name of the file is<rn>_<timestamp>.csv. A new file will be generated every time the tool is run for a repository. - Console output: Progress is reported in the console for every 100 revisions processed.
The tool has been run on the following Java git repositories:
| Project | Stars | Revisions | Processed Files | Param Addition Found | |
|---|---|---|---|---|---|
| 1 | Elastic Search | 45.2K | 49.0K | 220.7K | 10140 |
| 2 | RxJava | 40.9K | 5.6K | 24.9K | 163 |
| 3 | Mockito | 9.8K | 5.2K | 14.5K | 144 |
| 4 | Book Keeper | 778 | 2.2K | 10.5K | 545 |
| 5 | Camel Quarkus | 30 | 504 | 616 | 26 |
| 6 | Spring Analysis | 5.7K | 89 | 53 | 2 |
The results of the projects can be found in the results directory of the repository.
To be considered as an addition of parameter, the new version must have all the parameters of the previous version in same sequence, and there must be at least one additional parameter.
The tool will consider the followings changes as addition of parameter:
func(int) -> func(int, int)func(int) -> func(int, int)func(int) -> func(int, int)func(int, String, double) -> func(String, int, String, float, double)
The followings are not considered as an addition of parameter
func(int) -> func(float)func(int, float) -> func(float, int, String). It may seem like an addition of parameter, but I have ignored this case.
Overloads
One critical case is when a method has overloads, and parameters are added to more than one overloads in the same commit. For example, the old version had:
- (1)
replaySupplier(Flowable, int) - (2)
replaySupplier(Flowable, int, long, TimeUnit, Scheduler)
New version has
- (3)
replaySupplier(Flowable, int, boolean) - (4)
replaySupplier(Flowable, int, long, TimeUnit, Scheduler, boolean)
The tool identifies (4) to be from both (1) and (2). There seems to be no way to correctly identify exactly from which old method (4) has been formed. It is possible to solve with a heuristic approach, but I wanted to keep all the possibilities.
Merge commits
I have excluded any merge commits from processing. This is because generally any change that is found in a merge commit is also found earlier in a non-merge commit, where the developer actually made the change. Therefore considering merge would yield duplicate results.
The tool parses the full modified file in a revision and compares it with its parent. Performance can be improved by only parsing the lines which were changed.