dagger.internal.codegen.bindinggraphvalidation.MissingBindingValidator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dagger-compiler Show documentation
Show all versions of dagger-compiler Show documentation
A fast dependency injector for Android and Java.
/*
* Copyright (C) 2018 The Dagger Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package dagger.internal.codegen.bindinggraphvalidation;
import static androidx.room.compiler.processing.compat.XConverters.getProcessingEnv;
import static com.google.common.base.Verify.verify;
import static com.google.common.collect.Iterables.getLast;
import static com.google.common.collect.Iterables.getOnlyElement;
import static dagger.internal.codegen.base.Keys.isValidImplicitProvisionKey;
import static dagger.internal.codegen.base.Keys.isValidMembersInjectionKey;
import static dagger.internal.codegen.base.RequestKinds.canBeSatisfiedByProductionBinding;
import static dagger.internal.codegen.binding.DependencyRequestFormatter.DOUBLE_INDENT;
import static dagger.internal.codegen.extension.DaggerStreams.instancesOf;
import static dagger.internal.codegen.extension.DaggerStreams.toImmutableList;
import static dagger.internal.codegen.extension.DaggerStreams.toImmutableSet;
import static dagger.internal.codegen.xprocessing.XTypes.isDeclared;
import static dagger.internal.codegen.xprocessing.XTypes.isWildcard;
import static javax.tools.Diagnostic.Kind.ERROR;
import androidx.room.compiler.processing.XType;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterators;
import com.google.common.collect.Lists;
import com.squareup.javapoet.TypeName;
import com.squareup.javapoet.WildcardTypeName;
import dagger.internal.codegen.binding.DependencyRequestFormatter;
import dagger.internal.codegen.binding.InjectBindingRegistry;
import dagger.internal.codegen.model.Binding;
import dagger.internal.codegen.model.BindingGraph;
import dagger.internal.codegen.model.BindingGraph.ComponentNode;
import dagger.internal.codegen.model.BindingGraph.DependencyEdge;
import dagger.internal.codegen.model.BindingGraph.Edge;
import dagger.internal.codegen.model.BindingGraph.MissingBinding;
import dagger.internal.codegen.model.BindingGraph.Node;
import dagger.internal.codegen.model.ComponentPath;
import dagger.internal.codegen.model.DaggerAnnotation;
import dagger.internal.codegen.model.DiagnosticReporter;
import dagger.internal.codegen.model.Key;
import dagger.internal.codegen.validation.DiagnosticMessageGenerator;
import dagger.internal.codegen.validation.ValidationBindingGraphPlugin;
import dagger.internal.codegen.xprocessing.XTypes;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import javax.inject.Inject;
/** Reports errors for missing bindings. */
final class MissingBindingValidator extends ValidationBindingGraphPlugin {
private final InjectBindingRegistry injectBindingRegistry;
private final DependencyRequestFormatter dependencyRequestFormatter;
private final DiagnosticMessageGenerator.Factory diagnosticMessageGeneratorFactory;
@Inject
MissingBindingValidator(
InjectBindingRegistry injectBindingRegistry,
DependencyRequestFormatter dependencyRequestFormatter,
DiagnosticMessageGenerator.Factory diagnosticMessageGeneratorFactory) {
this.injectBindingRegistry = injectBindingRegistry;
this.dependencyRequestFormatter = dependencyRequestFormatter;
this.diagnosticMessageGeneratorFactory = diagnosticMessageGeneratorFactory;
}
@Override
public String pluginName() {
return "Dagger/MissingBinding";
}
@Override
public void visitGraph(BindingGraph graph, DiagnosticReporter diagnosticReporter) {
// Don't report missing bindings when validating a full binding graph or a graph built from a
// subcomponent.
if (graph.isFullBindingGraph() || graph.rootComponentNode().isSubcomponent()) {
return;
}
// A missing binding might exist in a different component as unused binding, thus getting
// stripped. Therefore, full graph needs to be traversed to capture the stripped bindings.
if (!graph.missingBindings().isEmpty()) {
requestVisitFullGraph(graph);
}
}
@Override
public void revisitFullGraph(
BindingGraph prunedGraph, BindingGraph fullGraph, DiagnosticReporter diagnosticReporter) {
prunedGraph
.missingBindings()
.forEach(
missingBinding ->
reportMissingBinding(missingBinding, prunedGraph, fullGraph, diagnosticReporter));
}
private void reportMissingBinding(
MissingBinding missingBinding,
BindingGraph prunedGraph,
BindingGraph fullGraph,
DiagnosticReporter diagnosticReporter) {
ImmutableSet wildcardAlternatives =
getSimilarTypeBindings(fullGraph, missingBinding.key());
String wildcardTypeErrorMessage = "";
if (!wildcardAlternatives.isEmpty()) {
wildcardTypeErrorMessage =
String.format(
"\nFound similar bindings:\n %s",
String.join(
"\n ",
wildcardAlternatives.stream()
.map(
binding -> binding.key().type() + " in [" + binding.componentPath() + "]")
.collect(toImmutableSet())))
+ "\n(In Kotlin source, a type like 'Set' may"
+ " be translated as 'Set'. To avoid this implicit"
+ " conversion you can add '@JvmSuppressWildcards' on the associated type"
+ " argument, e.g. 'Set<@JvmSuppressWildcards Foo>'.)";
}
List alternativeComponents =
wildcardAlternatives.isEmpty()
? fullGraph.bindings(missingBinding.key()).stream()
.map(Binding::componentPath)
.distinct()
.collect(toImmutableList())
: ImmutableList.of();
// Print component name for each binding along the dependency path if the missing binding
// exists in a different component than expected
if (alternativeComponents.isEmpty()) {
// TODO(b/266993189): the passed in diagnostic reporter is constructed with full graph, so it
// doesn't print out full dependency path for a binding when invoking reportBinding on it.
// Therefore, we manually constructed the binding dependency path and passed into
// reportComponent.
diagnosticReporter.reportComponent(
ERROR,
fullGraph.componentNode(missingBinding.componentPath()).get(),
missingBindingErrorMessage(missingBinding, fullGraph)
+ wildcardTypeErrorMessage
+ "\n\nMissing binding usage:"
+ diagnosticMessageGeneratorFactory.create(prunedGraph).getMessage(missingBinding));
} else {
diagnosticReporter.reportComponent(
ERROR,
fullGraph.componentNode(missingBinding.componentPath()).get(),
missingBindingErrorMessage(missingBinding, fullGraph)
+ wrongComponentErrorMessage(missingBinding, alternativeComponents, prunedGraph));
}
}
private static ImmutableSet getSimilarTypeBindings(
BindingGraph graph, Key missingBindingKey) {
XType missingBindingType = missingBindingKey.type().xprocessing();
Optional missingBindingQualifier = missingBindingKey.qualifier();
ImmutableList flatMissingBindingType = flattenBindingType(missingBindingType);
if (flatMissingBindingType.size() <= 1) {
return ImmutableSet.of();
}
return graph.bindings().stream()
.filter(
binding ->
binding.key().qualifier().equals(missingBindingQualifier)
&& isSimilarType(binding.key().type().xprocessing(), flatMissingBindingType))
.collect(toImmutableSet());
}
/**
* Unwraps a parameterized type to a list of TypeNames. e.g. {@code Map>} to {@code
* [Map, Foo, List, Bar]}.
*/
private static ImmutableList flattenBindingType(XType type) {
return ImmutableList.copyOf(new TypeDfsIterator(type));
}
private static boolean isSimilarType(XType type, List flatTypeNames) {
return Iterators.elementsEqual(flatTypeNames.iterator(), new TypeDfsIterator(type));
}
private static TypeName getBound(WildcardTypeName wildcardType) {
// Note: The javapoet API returns a list to be extensible, but there's currently no way to get
// multiple bounds, and it's not really clear what we should do if there were multiple bounds
// so we just assume there's only one for now. The javapoet API also guarantees that there will
// always be at least one upper bound -- in the absence of an explicit upper bound the Object
// type is used (e.g. Set has an upper bound of Object).
return !wildcardType.lowerBounds.isEmpty()
? getOnlyElement(wildcardType.lowerBounds)
: getOnlyElement(wildcardType.upperBounds);
}
private String missingBindingErrorMessage(MissingBinding missingBinding, BindingGraph graph) {
Key key = missingBinding.key();
StringBuilder errorMessage = new StringBuilder();
// Wildcards should have already been checked by DependencyRequestValidator.
verify(!isWildcard(key.type().xprocessing()), "unexpected wildcard request: %s", key);
// TODO(ronshapiro): replace "provided" with "satisfied"?
errorMessage.append(key).append(" cannot be provided without ");
if (isValidImplicitProvisionKey(key)) {
errorMessage.append("an @Inject constructor or ");
}
errorMessage.append("an @Provides-"); // TODO(dpb): s/an/a
if (allIncomingDependenciesCanUseProduction(missingBinding, graph)) {
errorMessage.append(" or @Produces-");
}
errorMessage.append("annotated method.");
if (isValidMembersInjectionKey(key) && typeHasInjectionSites(key)) {
errorMessage.append(
" This type supports members injection but cannot be implicitly provided.");
}
return errorMessage.toString();
}
private String wrongComponentErrorMessage(
MissingBinding missingBinding,
List alternativeComponentPath,
BindingGraph graph) {
ImmutableSet entryPoints =
graph.entryPointEdgesDependingOnBinding(missingBinding);
DiagnosticMessageGenerator generator = diagnosticMessageGeneratorFactory.create(graph);
ImmutableList dependencyTrace =
generator.dependencyTrace(missingBinding, entryPoints);
StringBuilder message =
graph.isFullBindingGraph()
? new StringBuilder()
: new StringBuilder(dependencyTrace.size() * 100 /* a guess heuristic */);
// Check in which component the missing binding is requested. This can be different from the
// component the missing binding is in because we'll try to search up the parent components for
// a binding which makes missing bindings end up at the root component. This is different from
// the place we are logically requesting the binding from. Note that this is related to the
// particular dependency trace being shown and so is not necessarily stable.
String missingComponentName =
getComponentFromDependencyEdge(dependencyTrace.get(0), graph, false);
boolean hasSameComponentName = false;
for (ComponentPath component : alternativeComponentPath) {
message.append("\nNote: A binding for ").append(missingBinding.key()).append(" exists in ");
String currentComponentName = component.currentComponent().className().canonicalName();
if (currentComponentName.contentEquals(missingComponentName)) {
hasSameComponentName = true;
message.append("[").append(component).append("]");
} else {
message.append(currentComponentName);
}
message.append(":");
}
for (DependencyEdge edge : dependencyTrace) {
String line = dependencyRequestFormatter.format(edge.dependencyRequest());
if (line.isEmpty()) {
continue;
}
// If we ran into a rare case where the component names collide and we need to show the full
// path, only show the full path for the first dependency request. This is guaranteed to be
// the component in question since the logic for checking for a collision uses the first
// edge in the trace. Do not expand subsequent component paths to reduce spam.
String componentName =
String.format("[%s] ", getComponentFromDependencyEdge(edge, graph, hasSameComponentName));
hasSameComponentName = false;
message.append("\n").append(line.replace(DOUBLE_INDENT, DOUBLE_INDENT + componentName));
}
if (!dependencyTrace.isEmpty()) {
generator.appendComponentPathUnlessAtRoot(message, source(getLast(dependencyTrace), graph));
}
message.append(
generator.getRequestsNotInTrace(
dependencyTrace, generator.requests(missingBinding), entryPoints));
return message.toString();
}
private boolean allIncomingDependenciesCanUseProduction(
MissingBinding missingBinding, BindingGraph graph) {
return graph.network().inEdges(missingBinding).stream()
.flatMap(instancesOf(DependencyEdge.class))
.allMatch(edge -> dependencyCanBeProduction(edge, graph));
}
// TODO(ronshapiro): merge with
// ProvisionDependencyOnProduerBindingValidator.dependencyCanUseProduction
private boolean dependencyCanBeProduction(DependencyEdge edge, BindingGraph graph) {
Node source = graph.network().incidentNodes(edge).source();
if (source instanceof ComponentNode) {
return canBeSatisfiedByProductionBinding(edge.dependencyRequest().kind());
}
if (source instanceof Binding) {
return ((Binding) source).isProduction();
}
throw new IllegalArgumentException(
"expected a dagger.internal.codegen.model.Binding or ComponentNode: " + source);
}
private boolean typeHasInjectionSites(Key key) {
return injectBindingRegistry
.getOrFindMembersInjectionBinding(key)
.map(binding -> !binding.injectionSites().isEmpty())
.orElse(false);
}
private static String getComponentFromDependencyEdge(
DependencyEdge edge, BindingGraph graph, boolean completePath) {
ComponentPath componentPath = graph.network().incidentNodes(edge).source().componentPath();
return completePath
? componentPath.toString()
: componentPath.currentComponent().className().canonicalName();
}
private Node source(Edge edge, BindingGraph graph) {
return graph.network().incidentNodes(edge).source();
}
/**
* An iterator over a list of TypeNames produced by flattening a parameterized type. e.g. {@code
* Map>} to {@code [Map, Foo, List, Bar]}.
*
* The iterator returns the bound when encounters a wildcard type.
*/
private static class TypeDfsIterator implements Iterator {
final Deque stack = new ArrayDeque<>();
TypeDfsIterator(XType root) {
stack.push(root);
}
@Override
public boolean hasNext() {
return !stack.isEmpty();
}
@Override
public TypeName next() {
XType next = stack.pop();
if (isDeclared(next)) {
if (XTypes.isRawParameterizedType(next)) {
XType obj = getProcessingEnv(next).requireType(TypeName.OBJECT);
for (int i = 0; i < next.getTypeElement().getType().getTypeArguments().size(); i++) {
stack.push(obj);
}
} else {
for (XType arg : Lists.reverse(next.getTypeArguments())) {
stack.push(arg);
}
}
}
return getBaseTypeName(next);
}
private static TypeName getBaseTypeName(XType type) {
if (isDeclared(type)) {
return type.getRawType().getTypeName();
}
TypeName typeName = type.getTypeName();
if (typeName instanceof WildcardTypeName) {
return getBound((WildcardTypeName) typeName);
}
return typeName;
}
}
}