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.

Sign up for GitHub

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

Jump to bottom

Provide Fx types before user types #1191

Merged
merged 2 commits into from
Apr 19, 2024
Merged

Provide Fx types before user types #1191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81d3ff8
Provide internal types first
JacobOaks Apr 18, 2024
4626474
fix typo
JacobOaks Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 7 additions & 4 deletions app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,10 +480,9 @@ func New(opts ...Option) *App {
m.build(app, app.container)
}

for _, m := range app.modules {
m.provideAll()
}

// Provide Fx types first to increase the chance a custom logger
// can be successfully built in the face of unrelated DI failure.
// E.g., for a custom logger that relies on the Lifecycle type.
frames := fxreflect.CallerStack(0, 0) // include New in the stack for default Provides
JacobOaks marked this conversation as resolved.
Show resolved Hide resolved
app.root.provide(provide{
Target: func() Lifecycle { return app.lifecycle },
Expand All @@ -492,6 +491,10 @@ func New(opts ...Option) *App {
app.root.provide(provide{Target: app.shutdowner, Stack: frames})
app.root.provide(provide{Target: app.dotGraph, Stack: frames})

for _, m := range app.modules {
m.provideAll()
}

// Run decorators before executing any Invokes -- including the one
// inside constructCustomLogger.
app.err = multierr.Append(app.err, app.root.decorateAll())
Expand Down
17 changes: 12 additions & 5 deletions app_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,13 @@ func TestNewApp(t *testing.T) {
[]string{"Provided", "Provided", "Provided", "Provided", "LoggerInitialized", "Started"},
spy.EventTypes())

assert.Contains(t, spy.Events()[0].(*fxevent.Provided).OutputTypeNames, "struct {}")
// Fx types get provided first to increase chance of
// successful custom logger build.
assert.Contains(t, spy.Events()[0].(*fxevent.Provided).OutputTypeNames, "fx.Lifecycle")
JacobOaks marked this conversation as resolved.
Show resolved Hide resolved
assert.Contains(t, spy.Events()[1].(*fxevent.Provided).OutputTypeNames, "fx.Shutdowner")
assert.Contains(t, spy.Events()[2].(*fxevent.Provided).OutputTypeNames, "fx.DotGraph")
// Our type should be index 3.
assert.Contains(t, spy.Events()[3].(*fxevent.Provided).OutputTypeNames, "struct {}")
})

t.Run("CircularGraphReturnsError", func(t *testing.T) {
Expand Down Expand Up @@ -575,7 +581,7 @@ func TestWithLogger(t *testing.T) {
)

assert.Equal(t, []string{
"Supplied", "Provided", "Provided", "Provided", "Run", "LoggerInitialized",
"Provided", "Provided", "Provided", "Supplied", "Run", "LoggerInitialized",
}, spy.EventTypes())

spy.Reset()
Expand Down Expand Up @@ -605,7 +611,7 @@ func TestWithLogger(t *testing.T) {
"must provide constructor function, got (type *bytes.Buffer)",
)

assert.Equal(t, []string{"Supplied", "Provided", "Run", "LoggerInitialized"}, spy.EventTypes())
assert.Equal(t, []string{"Provided", "Provided", "Provided", "Supplied", "Provided", "Run", "LoggerInitialized"}, spy.EventTypes())
})

t.Run("logger failed to build", func(t *testing.T) {
Expand Down Expand Up @@ -1166,8 +1172,9 @@ func TestOptions(t *testing.T) {
Provide(&bytes.Buffer{}), // error, not a constructor
WithLogger(func() fxevent.Logger { return spy }),
)
require.Equal(t, []string{"Provided", "LoggerInitialized"}, spy.EventTypes())
assert.Contains(t, spy.Events()[0].(*fxevent.Provided).Err.Error(), "must provide constructor function")
require.Equal(t, []string{"Provided", "Provided", "Provided", "Provided", "LoggerInitialized"}, spy.EventTypes())
// First 3 provides are Fx types (Lifecycle, Shutdowner, DotGraph).
assert.Contains(t, spy.Events()[3].(*fxevent.Provided).Err.Error(), "must provide constructor function")
})
}

Expand Down
10 changes: 5 additions & 5 deletions module_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,15 +261,15 @@ func TestModuleSuccess(t *testing.T) {
desc: "custom logger for module",
giveWithLogger: fx.NopLogger,
wantEvents: []string{
"Supplied", "Provided", "Provided", "Provided",
"Provided", "Provided", "Provided", "Supplied",
"Run", "LoggerInitialized", "Invoking", "Invoked",
},
},
{
desc: "Not using a custom logger for module defaults to app logger",
giveWithLogger: fx.Options(),
wantEvents: []string{
"Supplied", "Provided", "Provided", "Provided", "Provided", "Run",
"Provided", "Provided", "Provided", "Supplied", "Provided", "Run",
"LoggerInitialized", "Invoking", "Run", "Invoked", "Invoking", "Invoked",
},
},
Expand Down Expand Up @@ -660,7 +660,7 @@ func TestModuleFailures(t *testing.T) {
giveAppOpts: spyAsLogger,
wantErrContains: []string{"error building logger"},
wantEvents: []string{
"Supplied", "Provided", "Provided", "Provided", "Run",
"Provided", "Provided", "Provided", "Supplied", "Run",
"LoggerInitialized", "Provided", "LoggerInitialized",
},
},
Expand All @@ -678,7 +678,7 @@ func TestModuleFailures(t *testing.T) {
giveAppOpts: spyAsLogger,
wantErrContains: []string{"error building logger dependency"},
wantEvents: []string{
"Supplied", "Provided", "Provided", "Provided", "Run",
"Provided", "Provided", "Provided", "Supplied", "Run",
"LoggerInitialized", "Provided", "Provided", "Run", "LoggerInitialized",
},
},
Expand All @@ -690,7 +690,7 @@ func TestModuleFailures(t *testing.T) {
"fx.WithLogger", "from:", "Failed",
},
wantEvents: []string{
"Supplied", "Provided", "Provided", "Provided", "Run",
"Provided", "Provided", "Provided", "Supplied", "Run",
"LoggerInitialized", "Provided", "LoggerInitialized",
},
},
Expand Down