feat: emit cached context events

[alexanderbez]

Description

Closes: #12912

Add a new additive API, CacheContextEmitEvents, that automatically emits the events emitted by the cached context when writing.

---

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 in the PR title
• added ! to the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• followed the guidelines for building modules
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• 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 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)

[codecov]

Codecov Report

Merging #13063 (e3da7b4) into main (db8714d) will decrease coverage by 0.07%.
The diff coverage is 100.00%.

❗ Current head e3da7b4 differs from pull request most recent head 30a1617. Consider uploading reports for the commit 30a1617 to get more accurate results

@@            Coverage Diff             @@
##             main   #13063      +/-   ##
==========================================
- Coverage   53.23%   53.15%   -0.08%     
==========================================
  Files         647      642       -5     
  Lines       55116    54953     -163     
==========================================
- Hits        29342    29212     -130     
+ Misses      23437    23411      -26     
+ Partials     2337     2330       -7     

Impacted Files	Coverage Δ
x/gov/abci.go	89.79% <ø> (-0.59%)	⬇️
types/context.go	88.81% <100.00%> (+0.40%)	⬆️
x/group/keeper/msg_server.go	68.47% <100.00%> (-0.21%)	⬇️
crypto/keys/internal/ecdsa/privkey.go	81.13% <0.00%> (-1.89%)	⬇️
x/genutil/client/cli/init.go	67.27% <0.00%> (-0.59%)	⬇️
x/genutil/client/cli/gentx.go	0.00% <0.00%> (ø)
tx/textual/valuerenderer/timestamp.go
tx/textual/valuerenderer/int.go
tx/textual/valuerenderer/dec.go
tx/textual/valuerenderer/valuerenderer.go
... and 5 more

[ValarDragon]

Why a new API, we should just edit the main one?

[alexanderbez]

Why a new API, we should just edit the main one?

So we don't break APIs and allow us to backport this to 0.45/0.46 allowing devs to opt-in.

[tac0turtle]

I don't see how this is api breaking? its fixing something that may have been needed there from the start

[alexanderbez]

It's API breaking to change CacheContext, e.g. CacheContext() ... -> CacheContext(emitEvents bool) ....

Recall, we don't want to emit events on the cached ctx automatically, we want the caller to indicate desired behavior. So we either break the existing CacheContext API or introduce an alternative API to call. I chose the latter in this PR.

[tac0turtle]

Recall, we don't want to emit events on the cached ctx automatically, we want the caller to indicate desired behavior.

can we assume via a nil or 0 check on Events()?

[alexanderbez]

I don't think so because imagine non-empty events but the caller still doesn't want them automatically emitted. Maybe I'm wrong, and there isn't a need or use-case to not automatically emit them. Thoughts?

[amaury1093]

My personal thought is that the default behavior is to emit events from the cache context. That's the intuitive behavior for 99% of use cases.

I can't think of use cases of not emitting the cached context events, but if an app wants that, they can always create their own CacheContextWithoutEmitEvents.

[alexanderbez]

My personal thought is that the default behavior is to emit events from the cache context. That's the intuitive behavior for 99% of use cases.

I can't think of use cases of not emitting the cached context events, but if an app wants that, they can always create their own CacheContextWithoutEmitEvents.

Yes, I can do this, but note this is still breaking as the behavior is changed.

[alexanderbez]

Moving this to draft because I need to remove the explicit emission calls. Afterwards, I'll mark it R4R

[amaury1093]

LGTM, some final nits

[julienrbrt]

lgtm

[cool-develope]

Looks good!

[JeancarloBarrios]

Amazing

[julienrbrt]

@Mergifyio backport release/v0.46.x

[mergify]

backport release/v0.46.x

✅ Backports have been created

• #13702 feat: emit cached context events (backport #13063) has been created for branch release/v0.46.x