24c97d529f
## Description This renames `container.Scope` to `container.ModuleKey` to make it more consistent with the usage of scope for modules. It also renames all usages of `constructor` (in docs and variable name) to `provider` for consistency. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
96 lines
2.5 KiB
Go
96 lines
2.5 KiB
Go
package container
|
|
|
|
import (
|
|
"fmt"
|
|
"reflect"
|
|
|
|
"github.com/goccy/go-graphviz/cgraph"
|
|
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// AutoGroupType marks a type which automatically gets grouped together. For an AutoGroupType T,
|
|
// T and []T can be declared as output parameters for providers as many times within the container
|
|
// as desired. All of the provided values for T can be retrieved by declaring an
|
|
// []T input parameter.
|
|
type AutoGroupType interface {
|
|
// IsAutoGroupType is a marker function which just indicates that this is a auto-group type.
|
|
IsAutoGroupType()
|
|
}
|
|
|
|
var autoGroupTypeType = reflect.TypeOf((*AutoGroupType)(nil)).Elem()
|
|
|
|
func isAutoGroupType(t reflect.Type) bool {
|
|
return t.Implements(autoGroupTypeType)
|
|
}
|
|
|
|
func isAutoGroupSliceType(typ reflect.Type) bool {
|
|
return typ.Kind() == reflect.Slice && isAutoGroupType(typ.Elem())
|
|
}
|
|
|
|
type groupResolver struct {
|
|
typ reflect.Type
|
|
sliceType reflect.Type
|
|
idxsInValues []int
|
|
providers []*simpleProvider
|
|
resolved bool
|
|
values reflect.Value
|
|
graphNode *cgraph.Node
|
|
}
|
|
|
|
type sliceGroupResolver struct {
|
|
*groupResolver
|
|
}
|
|
|
|
func (g *groupResolver) describeLocation() string {
|
|
return fmt.Sprintf("auto-group type %v", g.typ)
|
|
}
|
|
|
|
func (g *sliceGroupResolver) resolve(c *container, _ *moduleKey, caller Location) (reflect.Value, error) {
|
|
// Log
|
|
c.logf("Providing auto-group type slice %v to %s from:", g.sliceType, caller.Name())
|
|
c.indentLogger()
|
|
for _, node := range g.providers {
|
|
c.logf(node.provider.Location.String())
|
|
}
|
|
c.dedentLogger()
|
|
|
|
// Resolve
|
|
if !g.resolved {
|
|
res := reflect.MakeSlice(g.sliceType, 0, 0)
|
|
for i, node := range g.providers {
|
|
values, err := node.resolveValues(c)
|
|
if err != nil {
|
|
return reflect.Value{}, err
|
|
}
|
|
value := values[g.idxsInValues[i]]
|
|
if value.Kind() == reflect.Slice {
|
|
n := value.Len()
|
|
for j := 0; j < n; j++ {
|
|
res = reflect.Append(res, value.Index(j))
|
|
}
|
|
} else {
|
|
res = reflect.Append(res, value)
|
|
}
|
|
}
|
|
g.values = res
|
|
g.resolved = true
|
|
}
|
|
|
|
return g.values, nil
|
|
}
|
|
|
|
func (g *groupResolver) resolve(_ *container, _ *moduleKey, _ Location) (reflect.Value, error) {
|
|
return reflect.Value{}, errors.Errorf("%v is an auto-group type and cannot be used as an input value, instead use %v", g.typ, g.sliceType)
|
|
}
|
|
|
|
func (g *groupResolver) addNode(n *simpleProvider, i int) error {
|
|
g.providers = append(g.providers, n)
|
|
g.idxsInValues = append(g.idxsInValues, i)
|
|
return nil
|
|
}
|
|
|
|
func (g groupResolver) typeGraphNode() *cgraph.Node {
|
|
return g.graphNode
|
|
}
|