cosmos-sdk/container/simple.go
Aaron Craelius 7a31a28e24
refactor(container)!: remove dependency on C graphviz (#11934)
## Description

Closes: #11925 

This replace the dependency on https://pkg.go.dev/github.com/goccy/go-graphviz which wraps the whole C Graphviz library and is causing ARM build problems in #11924 and generally probably shouldn't be used because it's a heavyweight dependency just used for debugging.

It adds:
* a custom `graphviz` package that does just what we need for `container`
* updates to graphviz rendering to make it nicer and a README with some examples
* golden tests for graphviz and log debugging
* a `StderrLogger` `DebugOption` which is now the default for `Debug`/`AutoDebug`



---

### 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/main/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/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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-05-12 17:00:55 +00:00

68 lines
1.4 KiB
Go

package container
import (
"reflect"
"github.com/cosmos/cosmos-sdk/container/internal/graphviz"
)
type simpleProvider struct {
provider *ProviderDescriptor
called bool
values []reflect.Value
moduleKey *moduleKey
}
type simpleResolver struct {
node *simpleProvider
idxInValues int
resolved bool
typ reflect.Type
value reflect.Value
graphNode *graphviz.Node
}
func (s *simpleResolver) describeLocation() string {
return s.node.provider.Location.String()
}
func (s *simpleProvider) resolveValues(ctr *container) ([]reflect.Value, error) {
if !s.called {
values, err := ctr.call(s.provider, s.moduleKey)
if err != nil {
return nil, err
}
s.values = values
s.called = true
}
return s.values, nil
}
func (s *simpleResolver) resolve(c *container, _ *moduleKey, caller Location) (reflect.Value, error) {
// Log
c.logf("Providing %v from %s to %s", s.typ, s.node.provider.Location, caller.Name())
// Resolve
if !s.resolved {
values, err := s.node.resolveValues(c)
if err != nil {
return reflect.Value{}, err
}
value := values[s.idxInValues]
s.value = value
s.resolved = true
}
return s.value, nil
}
func (s simpleResolver) addNode(p *simpleProvider, _ int) error {
return duplicateDefinitionError(s.typ, p.provider.Location, s.node.provider.Location.String())
}
func (s simpleResolver) typeGraphNode() *graphviz.Node {
return s.graphNode
}