Add documentation and tests for soft group values #909
Conversation
Codecov Report
@@ Coverage Diff @@
## master #909 +/- ##
=======================================
Coverage 98.71% 98.71%
=======================================
Files 30 30
Lines 1328 1328
=======================================
Hits 1311 1311
Misses 11 11
Partials 6 6 📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
| ), | ||
| fx.Provide( | ||
| fx.Annotate( | ||
| func() (string, int) { return "mushroomburger", 35 }, |
There was a problem hiding this comment.
non-review comment: mushroom burger...? 🤣
There was a problem hiding this comment.
While I was writing this I couldn't remember the name of another burger hahaha
inout.go
Outdated
| // will be populated only with values from already-executed constructors, this | ||
| // means constructors of soft value groups will be called only if they provide | ||
| // another requested value. |
There was a problem hiding this comment.
| // will be populated only with values from already-executed constructors, this | |
| // means constructors of soft value groups will be called only if they provide | |
| // another requested value. | |
| // will be populated only with values from already-executed constructors. |
The last statement isn't quite true. If there's another function consuming the value then it will still populate it.
It's better to describe soft value groups as specifying the parameter as an 'opportunistic' consumer - if the values are already provided in the DI container, it consumes them. Otherwise, it doesn't.
You also want to specify that this is only a valid option for input parameters in the docs.
inout.go
Outdated
| // Handlers []Handler `group:"server"` | ||
| // Logger *zap.Logger |
inout.go
Outdated
| // When `NewHandlerAndLogger` and `NewHandler`are provided, and `Foo` invoked, | ||
| // the only constructor called is `NewHandler`, because this also provides | ||
| // `*zap.Logger` needed in the `Params` struct. | ||
| // |
There was a problem hiding this comment.
Apart from this example, can you also provide an example where:
- If you have a constructor for a type, and the only consumer is the soft value group, it is not populated.
- In the exact same case above, add a consumer that also consumes that type. Then show that it is populated.
|
Also it looks like you have a merge conflict. You might want to rebase master :) |
This adds documentation regarding soft group values feature and also adds test cases to check this feature works with modules, `Supply`, `Decorate` and `Annotate`.
This adds documentation regarding soft group values feature and also adds test cases to check this feature works with modules, `Supply`, `Decorate` and `Annotate`.
sywhang
force-pushed
the
soft-group-values
branch
from
11d3b12
to
01e82b1
Compare
This adds documentation regarding soft group values feature and also
adds test cases to check this feature works with modules,
Supply,DecorateandAnnotate.