refactor: bundle the transition to FLUSHCOMPLETE into a single function #6327
Conversation
TropicalDog17
requested review from
colin-axner,
AdityaSripal,
damiannolan and
chatton
as code owners
WalkthroughThe recent changes in the Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- modules/core/04-channel/keeper/packet.go (1 hunks)
Additional Context Used
Path-based Instructions (1)
modules/core/04-channel/keeper/packet.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
| if err := k.handleFlushState(ctx, packet, channel); err != nil { | ||
| return err |
There was a problem hiding this comment.
Tip
Codebase Verification
Ensure proper error handling in handleFlushState.
- The
handleFlushStatefunction returnsnilin several scenarios without explicitly handling errors beyond the timeout expiration. Consider adding more comprehensive error handling to cover all potential failure points.
Analysis chain
Ensure proper error handling in handleFlushState.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that `handleFlushState` handles all possible error scenarios correctly.
# Test: Search for error handling in `handleFlushState`. Expect: Proper error handling for all scenarios.
rg --type go $'handleFlushState' modules/core/04-channel/keeper/packet.go
Length of output: 242
Script:
#!/bin/bash
# Extract the full implementation of the `handleFlushState` function from `packet.go`.
ast-grep --lang go --pattern $'func (k *Keeper) handleFlushState($_, $_, $_) error {
$$$
}' modules/core/04-channel/keeper/packet.go
Length of output: 2432
| func (k *Keeper) handleFlushState(ctx sdk.Context, packet types.Packet, channel types.Channel) error { | ||
| counterpartyUpgrade, found := k.GetCounterpartyUpgrade(ctx, packet.GetSourcePort(), packet.GetSourceChannel()) | ||
| if !found { | ||
| return nil | ||
| } | ||
|
|
||
| timeout := counterpartyUpgrade.Timeout | ||
| selfHeight, selfTimestamp := clienttypes.GetSelfHeight(ctx), uint64(ctx.BlockTime().UnixNano()) | ||
|
|
||
| if timeout.Elapsed(selfHeight, selfTimestamp) { | ||
| // packet flushing timeout has expired, abort the upgrade and return nil, | ||
| // committing an error receipt to state, restoring the channel and successfully acknowledging the packet. | ||
| k.MustAbortUpgrade(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), timeout.ErrTimeoutElapsed(selfHeight, selfTimestamp)) | ||
| return nil | ||
| } | ||
|
|
||
| // set the channel state to flush complete if all packets have been acknowledged/flushed. | ||
| if !k.HasInflightPackets(ctx, packet.GetSourcePort(), packet.GetSourceChannel()) { | ||
| channel.State = types.FLUSHCOMPLETE | ||
| k.SetChannel(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), channel) | ||
| emitChannelFlushCompleteEvent(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), channel) | ||
| } |
There was a problem hiding this comment.
Review the implementation of handleFlushState.
- func (k *Keeper) handleFlushState(ctx sdk.Context, packet types.Packet, channel types.Channel) error {
+ func (k *Keeper) handleFlushState(ctx sdk.Context, packet types.Packet, channel *types.Channel) error {Consider passing channel as a pointer to avoid copying the entire struct each time the function is called, which can improve performance especially if Channel is a large struct.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| func (k *Keeper) handleFlushState(ctx sdk.Context, packet types.Packet, channel types.Channel) error { | |
| counterpartyUpgrade, found := k.GetCounterpartyUpgrade(ctx, packet.GetSourcePort(), packet.GetSourceChannel()) | |
| if !found { | |
| return nil | |
| } | |
| timeout := counterpartyUpgrade.Timeout | |
| selfHeight, selfTimestamp := clienttypes.GetSelfHeight(ctx), uint64(ctx.BlockTime().UnixNano()) | |
| if timeout.Elapsed(selfHeight, selfTimestamp) { | |
| // packet flushing timeout has expired, abort the upgrade and return nil, | |
| // committing an error receipt to state, restoring the channel and successfully acknowledging the packet. | |
| k.MustAbortUpgrade(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), timeout.ErrTimeoutElapsed(selfHeight, selfTimestamp)) | |
| return nil | |
| } | |
| // set the channel state to flush complete if all packets have been acknowledged/flushed. | |
| if !k.HasInflightPackets(ctx, packet.GetSourcePort(), packet.GetSourceChannel()) { | |
| channel.State = types.FLUSHCOMPLETE | |
| k.SetChannel(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), channel) | |
| emitChannelFlushCompleteEvent(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), channel) | |
| } | |
| func (k *Keeper) handleFlushState(ctx sdk.Context, packet types.Packet, channel *types.Channel) error { | |
| counterpartyUpgrade, found := k.GetCounterpartyUpgrade(ctx, packet.GetSourcePort(), packet.GetSourceChannel()) | |
| if !found { | |
| return nil | |
| } | |
| timeout := counterpartyUpgrade.Timeout | |
| selfHeight, selfTimestamp := clienttypes.GetSelfHeight(ctx), uint64(ctx.BlockTime().UnixNano()) | |
| if timeout.Elapsed(selfHeight, selfTimestamp) { | |
| // packet flushing timeout has expired, abort the upgrade and return nil, | |
| // committing an error receipt to state, restoring the channel and successfully acknowledging the packet. | |
| k.MustAbortUpgrade(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), timeout.ErrTimeoutElapsed(selfHeight, selfTimestamp)) | |
| return nil | |
| } | |
| // set the channel state to flush complete if all packets have been acknowledged/flushed. | |
| if !k.HasInflightPackets(ctx, packet.GetSourcePort(), packet.GetSourceChannel()) { | |
| channel.State = types.FLUSHCOMPLETE | |
| k.SetChannel(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), channel) | |
| emitChannelFlushCompleteEvent(ctx, packet.GetSourcePort(), packet.GetSourceChannel(), channel) | |
| } |
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- modules/core/04-channel/keeper/packet.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- modules/core/04-channel/keeper/packet.go
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- modules/core/04-channel/keeper/packet.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- modules/core/04-channel/keeper/packet.go
There was a problem hiding this comment.
Thanks for opening the PR, @TropicalDog17.
I would be nice if we could also replace this code with a call to handleFlushState. I just noticed actually that there might be a small bug in that code, since we are not returning if the upgrade is aborted, as the comment indicates that we should.
However, in order to replace that code you need to make sure that we exit the function only if the upgrade is aborted, since there is more logic to execute in case the upgrade is not aborted.
| return nil | ||
| } | ||
|
|
||
| func (k *Keeper) handleFlushState(ctx sdk.Context, packet *types.Packet, channel *types.Channel) error { |
There was a problem hiding this comment.
I think it's better to return a boolean in the call site then you can do:
if aborted := k.handleFlushState(ctx, &packet, &channel); aborted == true {
return nil
}| func (k *Keeper) handleFlushState(ctx sdk.Context, packet *types.Packet, channel *types.Channel) error { | |
| func (k *Keeper) handleFlushState(ctx sdk.Context, packet *types.Packet, channel *types.Channel) bool { |
| selfHeight, selfTimestamp := clienttypes.GetSelfHeight(ctx), uint64(ctx.BlockTime().UnixNano()) | ||
|
|
||
| if timeout.Elapsed(selfHeight, selfTimestamp) { | ||
| // packet flushing timeout has expired, abort the upgrade and return nil, |
There was a problem hiding this comment.
| // packet flushing timeout has expired, abort the upgrade and return nil, | |
| // packet flushing timeout has expired, abort the upgrade, |
|
@crodriguezvega thanks for your review, I've refactored accordingly. |
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- modules/core/04-channel/keeper/packet.go (1 hunks)
- modules/core/04-channel/keeper/timeout.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- modules/core/04-channel/keeper/packet.go
Additional Context Used
Path-based Instructions (1)
modules/core/04-channel/keeper/timeout.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (1)
modules/core/04-channel/keeper/timeout.go (1)
155-162: Refactor to centralize the transition toFLUSHCOMPLETEstate.The addition of
handleFlushStatewithinTimeoutExecutedeffectively centralizes the handling of theFLUSHCOMPLETEstate transition. This change aligns with the PR's objective to make the code more maintainable and less error-prone by consolidating related logic into a single function. Ensure thathandleFlushStateis thoroughly tested to confirm that it behaves as expected under all conditions.
Description
closes: #5733
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/).godoccomments.Files changedin the GitHub PR explorer.SonarCloud Reportin the comment section below once CI passes.Summary by CodeRabbit