forked from square/dagger
-
Notifications
You must be signed in to change notification settings - Fork 2k
Improve error message when Dagger compiler not run over module #5245
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arimu1
wants to merge
1
commit into
google:master
Choose a base branch
from
arimu1:fix/5146-module-missing-factory-error
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+202
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
135 changes: 135 additions & 0 deletions
135
javatests/dagger/internal/codegen/ModuleMissingFactoryErrorTest.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| /* | ||
| * Copyright (C) 2026 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; | ||
|
|
||
| import androidx.room3.compiler.processing.util.Source; | ||
| import com.google.common.collect.ImmutableCollection; | ||
| import com.google.common.collect.ImmutableList; | ||
| import dagger.testing.compile.CompilerTests; | ||
| import java.io.File; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.Parameterized; | ||
| import org.junit.runners.Parameterized.Parameters; | ||
|
|
||
| /** | ||
| * Tests that using a {@code @Module} from a library that was not processed by Dagger yields a | ||
| * clear error (https://github.com/google/dagger/issues/5146). | ||
| */ | ||
| @RunWith(Parameterized.class) | ||
| public class ModuleMissingFactoryErrorTest { | ||
| @Parameters(name = "{0}") | ||
| public static ImmutableCollection<Object[]> parameters() { | ||
| return CompilerMode.TEST_PARAMETERS; | ||
| } | ||
|
|
||
| private final CompilerMode compilerMode; | ||
|
|
||
| public ModuleMissingFactoryErrorTest(CompilerMode compilerMode) { | ||
| this.compilerMode = compilerMode; | ||
| } | ||
|
|
||
| @Test | ||
| public void moduleFromLibraryWithoutDaggerCompiler_reportsHelpfulError() { | ||
| Source libraryModule = | ||
| CompilerTests.javaSource( | ||
| "lib.LibraryModule", | ||
| "package lib;", | ||
| "", | ||
| "import dagger.Module;", | ||
| "import dagger.Provides;", | ||
| "", | ||
| "@Module", | ||
| "public final class LibraryModule {", | ||
| " @Provides", | ||
| " static String provideString() {", | ||
| " return \"hello\";", | ||
| " }", | ||
| "}"); | ||
|
|
||
| // Compile the library without Dagger's annotation processor so no *Factory is generated. | ||
| ImmutableList<File> libraryClasspath = CompilerTests.libraryCompiler(libraryModule).compile(); | ||
|
|
||
| Source component = | ||
| CompilerTests.javaSource( | ||
| "test.TestComponent", | ||
| "package test;", | ||
| "", | ||
| "import dagger.Component;", | ||
| "import lib.LibraryModule;", | ||
| "", | ||
| "@Component(modules = LibraryModule.class)", | ||
| "interface TestComponent {", | ||
| " String string();", | ||
| "}"); | ||
|
|
||
| CompilerTests.daggerCompiler(component) | ||
| .withAdditionalClasspath(libraryClasspath) | ||
| .withProcessingOptions(compilerMode.processorOptions()) | ||
| .compile( | ||
| subject -> { | ||
| subject.hasErrorContaining("LibraryModule_ProvideStringFactory is missing"); | ||
| subject.hasErrorContaining("Dagger compiler was not applied"); | ||
| subject.hasErrorContaining("lib.LibraryModule"); | ||
| }); | ||
| } | ||
|
|
||
| @Test | ||
| public void moduleFromLibraryWithOnlyBinds_doesNotRequireFactory() { | ||
| Source libraryModule = | ||
| CompilerTests.javaSource( | ||
| "lib.LibraryBindsModule", | ||
| "package lib;", | ||
| "", | ||
| "import dagger.Binds;", | ||
| "import dagger.Module;", | ||
| "import javax.inject.Inject;", | ||
| "", | ||
| "@Module", | ||
| "public abstract class LibraryBindsModule {", | ||
| " @Binds", | ||
| " abstract Object bindObject(Foo foo);", | ||
| "", | ||
| " public static final class Foo {", | ||
| " @Inject", | ||
| " Foo() {}", | ||
| " }", | ||
| "}"); | ||
|
|
||
| ImmutableList<File> libraryClasspath = CompilerTests.libraryCompiler(libraryModule).compile(); | ||
|
|
||
| Source component = | ||
| CompilerTests.javaSource( | ||
| "test.TestComponent", | ||
| "package test;", | ||
| "", | ||
| "import dagger.Component;", | ||
| "import lib.LibraryBindsModule;", | ||
| "", | ||
| "@Component(modules = LibraryBindsModule.class)", | ||
| "interface TestComponent {", | ||
| " Object object();", | ||
| "}"); | ||
|
|
||
| // @Binds does not generate a module method factory; @Inject on Foo is generated by the | ||
| // consuming compilation via InjectBindingRegistry. | ||
| CompilerTests.daggerCompiler(component) | ||
| .withAdditionalClasspath(libraryClasspath) | ||
| .withProcessingOptions(compilerMode.processorOptions()) | ||
| .compile(subject -> subject.hasErrorCount(0)); | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you need to check both knownModules and knowModuleNames?