cosmos-sdk/container/module_dep.go

58 lines
1.4 KiB
Go
Raw Normal View History

refactor(container)!: rename Scope -> ModuleKey (#11073) ## 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)
2022-01-31 09:12:08 -08:00
package container
import (
"reflect"
"github.com/goccy/go-graphviz/cgraph"
)
type moduleDepProvider struct {
provider *ProviderDescriptor
calledForModule map[*moduleKey]bool
valueMap map[*moduleKey][]reflect.Value
}
type moduleDepResolver struct {
typ reflect.Type
idxInValues int
node *moduleDepProvider
valueMap map[*moduleKey]reflect.Value
graphNode *cgraph.Node
}
func (s moduleDepResolver) describeLocation() string {
return s.node.provider.Location.String()
}
func (s moduleDepResolver) resolve(ctr *container, moduleKey *moduleKey, caller Location) (reflect.Value, error) {
// Log
ctr.logf("Providing %v from %s to %s", s.typ, s.node.provider.Location, caller.Name())
// Resolve
if val, ok := s.valueMap[moduleKey]; ok {
return val, nil
}
if !s.node.calledForModule[moduleKey] {
values, err := ctr.call(s.node.provider, moduleKey)
if err != nil {
return reflect.Value{}, err
}
s.node.valueMap[moduleKey] = values
s.node.calledForModule[moduleKey] = true
}
value := s.node.valueMap[moduleKey][s.idxInValues]
s.valueMap[moduleKey] = value
return value, nil
}
func (s moduleDepResolver) addNode(p *simpleProvider, _ int) error {
return duplicateDefinitionError(s.typ, p.provider.Location, s.node.provider.Location.String())
}
func (s moduleDepResolver) typeGraphNode() *cgraph.Node {
return s.graphNode
}