Skip to content
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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions annotated.go
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{}
}
39 changes: 39 additions & 0 deletions annotated_test.go
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'")
Copy link
Collaborator

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 with
the use of an fx.Populate.

var result struct {
    fx.In
    
    A *a `name:"foo"`
}

app := fxtest.New(t,
    ...,
    fx.Populate(&result),
)
defer app.RequireStart().RequireStop()

assert.[..]

Otherwise, if we have a bug that neglects to call that fx.Invoke, the
assertion will be ignored and the test will still pass.

}),
)
app.RequireStart().RequireStop()
})
}
7 changes: 7 additions & 0 deletions app.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Copy link
Collaborator

Choose a reason for hiding this comment

The 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
verify that we're not producing fx.Annotateds into the container. It would
be easy for someone to assume that they can do func() fx.Annotated to get
the same behavior so we can catch that now and give them a better error
message.

You should be able to adapt some of the code in "internal/fxreflect".ReturnTypes
to get a list of reflect.Types being provided by the constructor and check
that one of them isn't reflect.TypeOf(Annotated{}). (The code in that
package has some duplication with dig; we plan on exposing APIs in dig to
reduce that in the future.)

app.err = err
}
return
}

if err := app.container.Provide(constructor); err != nil {
app.err = err
}
Expand Down
10 changes: 5 additions & 5 deletions glide.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion glide.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import:
- package: go.uber.org/multierr
version: ^1
- package: go.uber.org/dig
version: ^1
version: master
testImport:
- package: github.com/stretchr/testify
version: ^1
Expand Down
2 changes: 1 addition & 1 deletion version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
package fx

// Version is exported for runtime compatibility checks.
const Version = "1.7.0"
const Version = "1.8.0"