Adding guard when annotating linkage errors #2196
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
suztomo
commented
Aug 20, 2021
| linkageProblem.setCause(UnknownCause.getInstance()); | ||
| } else { | ||
| Artifact artifactInSubtree = entryInSubtree.getArtifact(); | ||
| DependencyPath pathToSourceEntry = rootResult.getDependencyPaths(sourceEntry).get(0); |
There was a problem hiding this comment.
A user reported that this threw ArrayIndexOutOfBoundsException.
suztomo
commented
Aug 20, 2021
| // Different version of that artifact is selected in rootResult | ||
| ImmutableList<DependencyPath> pathToSelectedArtifact = | ||
| rootResult.getDependencyPaths(selectedEntry); | ||
| if (pathToSelectedArtifact.isEmpty()) { |
There was a problem hiding this comment.
Another guard to avoid ArrayIndexOutOfBoundsException
| Artifact artifactInSubtree = entryInSubtree.getArtifact(); | ||
| ImmutableList<DependencyPath> dependencyPathsToSource = | ||
| rootResult.getDependencyPaths(sourceEntry); | ||
| if (dependencyPathsToSource.isEmpty()) { |
There was a problem hiding this comment.
This is the main purpose of this PR.
| } | ||
|
|
||
| // For artifacts with classifiers, there can be multiple resolved artifacts for one node | ||
| for (ResolvedArtifact artifact : moduleArtifacts) { | ||
| // parentPath is null for the first item |
There was a problem hiding this comment.
I found the first item's parentPath is actually set line 352. It's never null.
dzou
approved these changes
Aug 20, 2021
| ClassFile sourceClass = linkageProblem.getSourceClass(); | ||
| ClassPathEntry sourceEntry = sourceClass.getClassPathEntry(); | ||
| // Annotating linkage errors is a nice-to-have feature for Linkage Checker plugins. Let's not | ||
| // fail the entire process when there are problems, such as classPathBuilder unable to resolve |
There was a problem hiding this comment.
Suggested change
| // fail the entire process when there are problems, such as classPathBuilder unable to resolve | |
| // fail the entire process if there are problems, such as classPathBuilder unable to resolve |
| Symbol symbol = linkageProblem.getSymbol(); | ||
| ClassPathEntry entryInSubtree = subtreeResult.findEntryBySymbol(symbol); | ||
| if (entryInSubtree == null) { | ||
| linkageProblem.setCause(UnknownCause.getInstance()); |
There was a problem hiding this comment.
I think it would be more clear to early return and exit the method if entryInSubtree == null and then unindent everything in the else-block. (Fewer levels of indentation).
if (entryInSubtree == null) {
linkageProblem.setCause(UnknownCause.getInstance());
return;
}
There was a problem hiding this comment.
Nice idea. Updated.
| artifactInSubtree.getGroupId(), artifactInSubtree.getArtifactId()); | ||
| if (selectedEntry != null) { | ||
| Artifact selectedArtifact = selectedEntry.getArtifact(); | ||
| if (!selectedArtifact.getVersion().equals(artifactInSubtree.getVersion())) { |
There was a problem hiding this comment.
You could probably combine the guard clause you created here with the other error condition:
ClassPathEntry selectedEntry =
rootResult.findEntryById(
artifactInSubtree.getGroupId(), artifactInSubtree.getArtifactId());
if (selectedEntry != null) {
Artifact selectedArtifact = selectedEntry.getArtifact();
ImmutableList<DependencyPath> pathToSelectedArtifact =
rootResult.getDependencyPaths(selectedEntry);
if (pathToSelectedArtifact.isEmpty() || !selectedArtifact.getVersion().equals(artifactInSubtree.getVersion()) {
linkageProblem.setCause(UnknownCause.getInstance());
return;
}
linkageProblem.setCause(
new DependencyConflict(
linkageProblem, pathToSelectedArtifact.get(0), pathToUnselectedEntry));
} else {
...
}
There was a problem hiding this comment.
It may be logically the same but the current if-statement delivers better meaning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A user reported that pom-packaging artifact is not working correctly.