Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

skip liquidation task loop if last committed block height is the same #2124

Merged
merged 3 commits into from
Aug 21, 2024

Conversation

jayy04
Copy link
Contributor

@jayy04 jayy04 commented Aug 21, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced error handling in test cases for more precise validation of expected errors.
  • New Features

    • Improved efficiency of the liquidation daemon task loop by preventing unnecessary processing when no new blocks are committed.
    • Added state management capabilities to track the last processed block height within the task loop.

@jayy04 jayy04 requested a review from a team as a code owner August 21, 2024 15:14
Copy link
Contributor

coderabbitai bot commented Aug 21, 2024

Walkthrough

The recent changes enhance error handling in tests and optimize the SubTaskRunnerImpl for the liquidation daemon. The test logic now better distinguishes between expected and unexpected errors, while the task runner efficiently manages block heights to skip unnecessary processing. These improvements lead to more precise testing and enhanced performance in task execution.

Changes

Files Change Summary
protocol/daemons/liquidation/client/..._test.go Improved error handling in TestSendLiquidatableSubaccountIds to differentiate between expected and unexpected errors.
protocol/daemons/liquidation/client/...go Added lastLoopBlockHeight to SubTaskRunnerImpl for better state management. Optimized RunLiquidationDaemonTaskLoop to skip redundant processing when no new blocks are committed.

Poem

Hop along the code, so bright and spry,
With tests that catch errors as they fly.
The task runner now knows when to pause,
Keeping track of blocks without a cause.
A leap for efficiency, a joyous cheer!
Code bunnies rejoice, for improvements are here! 🐇✨


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5030459 and 78cb3fe.

Files selected for processing (2)
  • protocol/daemons/liquidation/client/grpc_helper_test.go (1 hunks)
  • protocol/daemons/liquidation/client/sub_task_runner.go (2 hunks)
Additional comments not posted (4)
protocol/daemons/liquidation/client/sub_task_runner.go (3)

29-31: Addition of lastLoopBlockHeight field is appropriate.

The new field lastLoopBlockHeight is necessary for tracking the last processed block height, which supports the optimization logic.


55-61: Conditional check for skipping the task loop is correctly implemented.

The logic to skip the task loop when lastCommittedBlockHeight equals s.lastLoopBlockHeight is correctly implemented, preventing unnecessary processing.


63-63: Updating lastLoopBlockHeight is correctly placed.

The update of s.lastLoopBlockHeight to lastCommittedBlockHeight ensures that the state is accurately maintained for the next iteration.

protocol/daemons/liquidation/client/grpc_helper_test.go (1)

593-597: Enhanced error handling logic is correctly implemented.

The conditional structure accurately differentiates between expected and unexpected errors, improving the specificity of error assertions.

return nil
}

s.lastLoopBlockHeight = lastCommittedBlockHeight
Copy link
Contributor

@teddyding teddyding Aug 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Playing devil's advocate: are we sure this is thread-safe? Could two liquidation daemon loop overlap? Should we add a sync.Mutex similar to LiquidationServer

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no daemon loops don't overlap since we are not spawning new go routines

for {
		select {
		case <-ticker.C:
			if err := s.RunLiquidationDaemonTaskLoop(
				ctx,
				client,
				flags.Liquidation,
			); err != nil {
				// TODO(DEC-947): Move daemon shutdown to application.
				client.logger.Error("Liquidations daemon returned error", "error", err)
				client.ReportFailure(err)
			} else {
				client.ReportSuccess()
			}
		case <-stop:
			return
		}
	}

@@ -50,6 +52,16 @@ func (s *SubTaskRunnerImpl) RunLiquidationDaemonTaskLoop(
return err
}

if lastCommittedBlockHeight == s.lastLoopBlockHeight {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC if application restarts, lastLoopBlockHeight is by default 0 and we always continue below logic. If so could we document?

return nil
}

s.lastLoopBlockHeight = lastCommittedBlockHeight
Copy link
Contributor

@teddyding teddyding Aug 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I wonder if here's the best place to assign s.lastLoopBlockHeight = lastCommittedBlockHeight since we haven't sent any current block info to application yet. Wdyt think about defering the statement s.lastLoopBlockHeight = lastCommittedBlockHeight

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good question. thought about it a little bit more

putting it here strictly guarantees that loop doesn't run for the same block height, regardless of errors. If we defer the statement to the end (e.g. after SendLiquidatableSubaccountIds), theoretically it's possible that SendLiquidatableSubaccountIds only partially succeeds when first few requests goes through and later requests fail. In this case, we would be running into the same issue. I think might be slightly better here for correctness?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defering guarantees that the s.lastLoopBlockHeight = lastCommittedBlockHeight is always run before return, even if SendLiquidatableSubaccountIds fails right? Trying to understand when we'd send SendLiquidatableSubaccountIdsagain for the same block.

No strong preference though, the current implementation also works. Up to you. Approved to unblock

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ohh you mean defer and update block height regardless of error? I misunderstood

yeah I think it's basically the same - let's keep it as is to unstuck the testnet first

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 78cb3fe and 1eeb66d.

Files selected for processing (1)
  • protocol/daemons/liquidation/client/sub_task_runner.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • protocol/daemons/liquidation/client/sub_task_runner.go

@jayy04 jayy04 merged commit 2d6050f into main Aug 21, 2024
21 of 22 checks passed
@jayy04 jayy04 deleted the jy/daemon-loop-fix branch August 21, 2024 16:13
@jayy04
Copy link
Contributor Author

jayy04 commented Aug 21, 2024

@Mergifyio backport release/protocol/v5.2.x

Copy link
Contributor

mergify bot commented Aug 21, 2024

backport release/protocol/v5.2.x

✅ Backports have been created

@jayy04
Copy link
Contributor Author

jayy04 commented Aug 21, 2024

@Mergifyio backport release/protocol/v6.x

Copy link
Contributor

mergify bot commented Aug 21, 2024

backport release/protocol/v6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Aug 21, 2024
jayy04 added a commit that referenced this pull request Aug 21, 2024
dydxwill pushed a commit that referenced this pull request Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants