Improve error message when Dagger compiler not run over module - #5245
Open
arimu1 wants to merge 1 commit into
Open
Improve error message when Dagger compiler not run over module#5245arimu1 wants to merge 1 commit into
arimu1 wants to merge 1 commit into
Conversation
When a @module from a dependency is missing its generated *Factory types (because dagger-compiler/KSP was not applied to that library), report a clear error instead of letting javac fail with a vague "does not exist" message on the generated component. Modules being compiled in the current compilation are skipped, since their factories are generated in-round by ModuleProcessingStep and may not yet be visible via findTypeElement. Fixes google#5146
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
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.
Summary
When a
@Modulelives in a dependency that was compiled without the Dagger annotation processor / KSP plugin, generated component code references missing*Factorytypes and the user only sees a vague javac "does not exist" error.This PR detects that situation during component validation and reports a clear diagnostic:
Approach (aligned with option 1 from #5146, using the existing
knownModulesset so it works for both Javac and KSP):ModuleValidator.addKnownModules(as before).@Provides/@Producesfactory exists on the classpath.ModuleProcessingStepand may not yet be visible viafindTypeElement.@Binds-only modules do not require factories and are unaffected.Fixes #5146
Test plan
bazel test //javatests/dagger/internal/codegen:ModuleMissingFactoryErrorTestbazel test //javatests/dagger/internal/codegen:AssistedFactoryTestbazel test //javatests/dagger/internal/codegen:ModuleValidationTest