Make provide's errors more expressive for fx.Annotate-ed functions #844
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
Because of the use of reflection in fx.Annotate, the error messages for provide tend to refer to the annotated function as `"reflect".makeFuncStub` which is not helpful for debugging. This change updates error messages that previously looked like: ``` Failed: cannot provide function "reflect".makeFuncStub (/usr/local/go/src/reflect/asm_arm64.s:12): cannot provide *fx_test.Logger from [0].Field0: already provided by "reflect".makeFuncStub (/usr/local/go/src/reflect/asm_arm64.s:12) ``` To looking like this: ``` Failed: cannot provide function "reflect".makeFuncStub (/usr/local/go/src/reflect/asm_amd64.s:12): cannot provide *fx_test.Logger from [0].Field0: already provided by "go.uber.org/fx_test".TestAnnotate.func1 (/gocode/src/github.com/uber-go/fx/annotated_test.go:515) ``` WIP: Planning on making a future fix that gives a more readable name to the first function which still is referred to as "reflect".makeFuncStub after this change.
Codecov Report
@@ Coverage Diff @@
## master #844 +/- ##
==========================================
+ Coverage 98.45% 98.63% +0.18%
==========================================
Files 30 30
Lines 1098 1100 +2
==========================================
+ Hits 1081 1085 +4
+ Misses 11 10 -1
+ Partials 6 5 -1
Continue to review full report at Codecov.
|
moisesvega
reviewed
Feb 18, 2022
Co-authored-by: Moises Vega <moises.vega@gmail.com>
Co-authored-by: Moises Vega <moises.vega@gmail.com>
Co-authored-by: Moises Vega <moises.vega@gmail.com>
Co-authored-by: Moises Vega <moises.vega@gmail.com>
sywhang
approved these changes
Feb 18, 2022
There was a problem hiding this comment.
Please address the linter error before merging. Also it'd be nice if you can edit the commit message here to mention that the "other half" of the error message that wasn't fixed by this PR is due to an issue in Dig and will be addressed in follow-up work in Dig.
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.
Because of the use of reflection in fx.Annotate, the error
messages for provide tend to refer to the annotated function as
"reflect".makeFuncStubwhich is not helpful for debugging.This change updates error messages that previously looked like:
To looking like this:
WIP: Planning on making a future fix that gives a more
readable name to the first function which still is referred to
as "reflect".makeFuncStub after this change.