opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-05-17 15:06:47 +08:00
Code Issues Projects Releases Wiki Activity

docs: use fx.Decorate instead of fx.Replace in examples (#9725)

Browse Source 
In practice there are cases when fx.Replace doesn't work as expected,
so this updates the documentation to recommend using fx.Decorate
instead which is a bit easier to use.
This commit is contained in:
Gus Eggert
2023-03-20 17:27:45 -04:00
committed by GitHub
parent 08dcb28866
commit e0b08ed783
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/plugins.md
View File

@ -51,14 +51,15 @@ plugin type is likely the best interim solution.
### fx (experimental) ### fx (experimental)
Fx plugins let you customize the [fx](https://pkg.go.dev/go.uber.org/fx) dependency graph and configuration, Fx plugins let you customize the [fx](https://pkg.go.dev/go.uber.org/fx) dependency graph and configuration,
by customizing the`fx.Option`s that are passed to `fx` when the IPFS node is initialized. by customizing the`fx.Option`s that are passed to `fx` when the Kubo node is initialized.
For example, you can inject custom implementations of interfaces such as [exchange.Interface](https://github.com/ipfs/go-ipfs-exchange-interface) For example, you can override an interface such as [exchange.Interface](https://github.com/ipfs/go-ipfs-exchange-interface)
or [pin.Pinner](https://github.com/ipfs/go-ipfs-pinner) by adding an option like `fx.Replace(fx.Annotate(customExchange, fx.As(new(exchange.Interface))))`. or [pin.Pinner](https://github.com/ipfs/go-ipfs-pinner) with a custom implementation by appending an option like
`fx.Decorate(func() exchange.Interface { return customExchange })`.
Fx supports some advanced customization. Simple interface replacements like above are unlikely to break in the future, Fx supports some advanced customization. Simple interface replacements like above are unlikely to break in the future,
but the more invasive your changes, the more likely they are to break between releases. Kubo cannot guarantee backwards but the more invasive your changes, the more likely they are to break between releases. Kubo cannot guarantee backwards
compatibility for invasive `fx` customizations. compatibility for `fx` customizations.
Fx options are applied across every execution of the `ipfs` binary, including: Fx options are applied across every execution of the `ipfs` binary, including:
@ -68,7 +69,7 @@ Fx options are applied across every execution of the `ipfs` binary, including:
- etc. - etc.
So if you plug in a blockservice that disallows non-allowlisted CIDs, then this may break migrations So if you plug in a blockservice that disallows non-allowlisted CIDs, then this may break migrations
that fetch migration code over IPFS. that fetch migration code over the IPFS network.
### Internal ### Internal