-
Notifications
You must be signed in to change notification settings - Fork 291
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
Implement struct fx.Annotated to inject named values without relying on fx.Out #633
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// Copyright (c) 2018 Uber Technologies, Inc. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files (the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
// THE SOFTWARE. | ||
|
||
package fx | ||
|
||
type Annotated struct { | ||
Name string | ||
Fn interface{} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
package fx_test | ||
|
||
import ( | ||
"testing" | ||
"go.uber.org/fx/fxtest" | ||
"github.com/stretchr/testify/assert" | ||
"go.uber.org/fx" | ||
) | ||
|
||
func TestAnnotated(t *testing.T) { | ||
type a struct { | ||
name string | ||
} | ||
|
||
type in struct { | ||
fx.In | ||
|
||
A *a `name:"foo"` | ||
} | ||
newA := func() *a { | ||
return &a{name: "foo"} | ||
} | ||
|
||
t.Run("Provided", func(t *testing.T) { | ||
app := fxtest.New(t, | ||
fx.Provide( | ||
fx.Annotated{ | ||
Name: "foo", | ||
Fn: newA, | ||
}, | ||
), | ||
fx.Invoke(func(in in) { | ||
assert.NotNil(t, in.A, "expected in.A to be injected") | ||
assert.Equal(t, "foo", in.A.name, "expected to get a type 'a' of name 'foo'") | ||
}), | ||
) | ||
app.RequireStart().RequireStop() | ||
}) | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -404,6 +404,13 @@ func (app *App) provide(constructor interface{}) { | |
return | ||
} | ||
|
||
if a, ok := constructor.(Annotated); ok { | ||
if err := app.container.Provide(a.Fn, dig.Name(a.Name)); err != nil { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For the case where the constructor is just a function, we should probably You should be able to adapt some of the code in |
||
app.err = err | ||
} | ||
return | ||
} | ||
|
||
if err := app.container.Provide(constructor); err != nil { | ||
app.err = err | ||
} | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
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.
Instead of putting assertions in the
Invoke
, consider moving them out withthe use of an
fx.Populate
.Otherwise, if we have a bug that neglects to call that
fx.Invoke
, theassertion will be ignored and the test will still pass.