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 AddParent() method #34

Merged
merged 1 commit into from
Jun 16, 2021
Merged
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
6 changes: 6 additions & 0 deletions container.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ func (c *Container) Provide(constructor Constructor, options ...ProvideOption) e
return nil
}

// AddParent adds a parent container. Types are resolved from the container,
// it's parents, and ancestors. An error is a cycle is detected in ancestry tree.
func (c *Container) AddParent(parent *Container) error {
return c.schema.addParent(parent.schema)
}

// ProvideValue provides value as is.
func (c *Container) ProvideValue(value Value, options ...ProvideOption) error {
if err := c.provideValue(value, options...); err != nil {
Expand Down
78 changes: 78 additions & 0 deletions container_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1306,3 +1306,81 @@ func TestContainer_Cleanup(t *testing.T) {
require.Equal(t, []string{"server", "mux"}, cleanupCalls)
})
}

func TestParentContainer(t *testing.T) {
t.Run("provide ancestor and resolve in child", func(t *testing.T) {

papaw, err := di.New()
require.NoError(t, err)
require.NotNil(t, papaw)
parent, err := di.New()
require.NoError(t, err)
require.NotNil(t, parent)
child, err := di.New()
require.NoError(t, err)
require.NotNil(t, child)

require.NoError(t, parent.AddParent(papaw))
require.NoError(t, child.AddParent(parent))

conn1 := &net.TCPConn{}
require.NoError(t, papaw.Provide(func() *net.TCPConn { return conn1 }))

var conn *net.TCPConn
require.NoError(t, child.Resolve(&conn))
require.Equal(t, fmt.Sprintf("%p", conn1), fmt.Sprintf("%p", conn))
})

t.Run("resolve multiple type instances across ancestors", func(t *testing.T) {
papaw, err := di.New()
require.NoError(t, err)
require.NotNil(t, papaw)
parent, err := di.New()
require.NoError(t, err)
require.NotNil(t, parent)
child, err := di.New()
require.NoError(t, err)
require.NotNil(t, child)

require.NoError(t, parent.AddParent(papaw))
require.NoError(t, child.AddParent(parent))

conn1 := &net.TCPConn{}
conn2 := &net.TCPConn{}
conn3 := &net.TCPConn{}
require.NoError(t, papaw.Provide(func() *net.TCPConn { return conn1 }))
require.NoError(t, parent.Provide(func() *net.TCPConn { return conn2 }))
require.NoError(t, child.Provide(func() *net.TCPConn { return conn3 }))

var conns []*net.TCPConn
require.NoError(t, child.Resolve(&conns))
require.Len(t, conns, 3)
require.Equal(t, fmt.Sprintf("%p", conn1), fmt.Sprintf("%p", conns[0]))
require.Equal(t, fmt.Sprintf("%p", conn2), fmt.Sprintf("%p", conns[1]))
require.Equal(t, fmt.Sprintf("%p", conn3), fmt.Sprintf("%p", conns[2]))
})

t.Run("add parent errors", func(t *testing.T) {
parent, err := di.New()
require.NoError(t, err)
require.NotNil(t, parent)
err = parent.AddParent(parent)
require.Contains(t, err.Error(), "self cycle detected")
child, err := di.New()
require.NoError(t, err)
require.NotNil(t, child)
err = child.AddParent(parent)
require.NoError(t, err)
err = parent.AddParent(child)
require.Contains(t, err.Error(), "cycle detected")
err = child.AddParent(parent)
require.Contains(t, err.Error(), "parent already chained")
papaw, err := di.New()
require.NoError(t, err)
require.NotNil(t, papaw)
err = parent.AddParent(papaw)
err = papaw.AddParent(child)
require.Contains(t, err.Error(), "cycle detected")
})

}
19 changes: 19 additions & 0 deletions docs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,3 +204,22 @@ if err != nil {
container.Cleanup() // file was closed
```

### Container Chains
You can chain containers together so that values can be resolved from a parent container. The child

```go
parent, err := container.New(
di.Provide(NewServer),
di.Provide(NewServeMux),
)

child, err := container.New()

err = child.AddParent(parent)
if err != nil {
// handle error
}

var server *http.Server
err := child.Resolve(&server)
```
47 changes: 45 additions & 2 deletions schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ type schema interface {

// schema is a dependency injection schema.
type defaultSchema struct {
parents []*defaultSchema
nodes map[reflect.Type][]*node
cleanups []func()
}
Expand Down Expand Up @@ -43,7 +44,7 @@ func (s *defaultSchema) register(n *node) {

// find finds provideFunc by its reflect.Type and Tags.
func (s *defaultSchema) find(t reflect.Type, tags Tags) (*node, error) {
nodes, ok := s.nodes[t]
nodes, ok := s.list(t)
defval marked this conversation as resolved.
Show resolved Hide resolved
// type found
if ok {
matched := matchTags(nodes, tags)
Expand Down Expand Up @@ -78,7 +79,7 @@ func (s *defaultSchema) find(t reflect.Type, tags Tags) (*node, error) {
}

func (s *defaultSchema) group(t reflect.Type, tags Tags) (*node, error) {
group, ok := s.nodes[t.Elem()]
group, ok := s.list(t.Elem())
if !ok {
return nil, fmt.Errorf("type %s%s %w", t, tags, ErrTypeNotExists)
}
Expand All @@ -94,3 +95,45 @@ func (s *defaultSchema) group(t reflect.Type, tags Tags) (*node, error) {
}
return node, nil
}

// list lists all the nodes of its reflect.Type
func (s *defaultSchema) list(t reflect.Type) (nodes []*node, ok bool) {
for _, parent := range s.parents {
if n, o := parent.list(t); o {
nodes = append(nodes, n...)
ok = true
}
}
if n, o := s.nodes[t]; o {
nodes = append(nodes, n...)
ok = true
}
return nodes, ok
}

// isAncestor returns true if a
func (s *defaultSchema) isAncestor(a *defaultSchema) bool {
for _, parent := range s.parents {
if parent == a {
return true
}
if parent.isAncestor(a) {
return true
}
}
return false
}

func (s *defaultSchema) addParent(parent *defaultSchema) error {
if parent == s {
return fmt.Errorf("self cycle detected")
}
if parent.isAncestor(s) {
return fmt.Errorf("cycle detected")
}
if s.isAncestor(parent) {
return fmt.Errorf("parent already chained")
}
s.parents = append(s.parents, parent)
return nil
}