cosmos-sdk/container
Facundo Medica bc2d553f77
chore: rename container.AutoGroupType to container.ManyPerContainerType (#11978)
Co-authored-by: Marko <marbar3778@yahoo.com>
2022-05-18 23:20:03 +02:00
..
internal refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
testdata chore: rename container.AutoGroupType to container.ManyPerContainerType (#11978) 2022-05-18 23:20:03 +02:00
Makefile refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
README.md refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
build.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
container.go chore: rename container.AutoGroupType to container.ManyPerContainerType (#11978) 2022-05-18 23:20:03 +02:00
container_test.go chore: rename container.AutoGroupType to container.ManyPerContainerType (#11978) 2022-05-18 23:20:03 +02:00
debug.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
errors.go feat: implement low-level dependency injection container (#9666) 2021-10-04 20:36:41 +00:00
go.mod refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
go.sum refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
group.go chore: rename container.AutoGroupType to container.ManyPerContainerType (#11978) 2022-05-18 23:20:03 +02:00
location.go feat: implement low-level dependency injection container (#9666) 2021-10-04 20:36:41 +00:00
module_dep.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
module_key.go fix!(container): fix issue with providing a module-scoped dependency from within a module (#11913) 2022-05-09 18:43:26 -04:00
one_per_module.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
option.go refactor(container)!: rename Scope -> ModuleKey (#11073) 2022-01-31 17:12:08 +00:00
provider_desc.go refactor(container)!: rename Scope -> ModuleKey (#11073) 2022-01-31 17:12:08 +00:00
provider_desc_test.go refactor(container)!: rename Scope -> ModuleKey (#11073) 2022-01-31 17:12:08 +00:00
resolver.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
simple.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00
struct_args.go refactor(container)!: use build instead of run model to get dependencies (#11916) 2022-05-10 13:24:09 +00:00
supply.go refactor(container)!: remove dependency on C graphviz (#11934) 2022-05-12 17:00:55 +00:00

README.md

Cosmos SDK Dependency Injection container Module

Overview

TODO

Usage

TODO

Debugging

Issues with resolving dependencies in the container can be done with logs and Graphviz renderings of the container tree. By default, whenever there is an error, logs will be printed to stderr and a rendering of the dependency graph in Graphviz DOT format will be saved to debug_container.dot.

Here is an example Graphviz rendering of a successful build of a dependency graph: Graphviz Example

Rectangles represent functions, ovals represent types, rounded rectangles represent modules and the single hexagon represents the function which called Build. Black-colored shapes mark functions and types that were called/resolved without an error. Gray-colored nodes mark functions and types that could have been called/resolved in the container but were left unused.

Here is an example Graphviz rendering of a dependency graph build which failed: Graphviz Error Example

Graphviz DOT files can be converted into SVG's for viewing in a web browser using the dot command-line tool, ex:

> dot -Tsvg debug_container.dot > debug_container.svg

Many other tools including some IDEs support working with DOT files.