op-batcher: remove `ChannelManager.CheckExpectedProgress()` and add channel timeout log #14553

geoknee · 2025-02-26T21:45:08Z

This code is not being used. The functionality was moved to

optimism/op-batcher/batcher/sync_actions.go

Lines 114 to 129 in 56b7f49

    
           for _, ch := range channels { 
        
           	if ch.isFullySubmitted() && 
        
           		!ch.isTimedOut() && 
        
           		newSyncStatus.CurrentL1.Number > ch.MaxInclusionBlock() && 
        
           		newSyncStatus.LocalSafeL2.Number < ch.LatestL2().Number { 
        
           		// Safe head did not make the expected progress 
        
           		// for a fully submitted channel. This indicates 
        
           		// that the derivation pipeline may have stalled 
        
           		// e.g. because of Holocene strict ordering rules. 
        
           		l.Warn("sequencer did not make expected progress", 
        
           			"syncActions", startAfresh, 
        
           			"existingBlock", ch.LatestL2(), 
        
           			"safeL2", newSyncStatus.LocalSafeL2) 
        
           		return startAfresh, false 
        
           	} 
        
           }

Also adds a log line.

codecov · 2025-02-26T21:51:51Z

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 41.99%. Comparing base (3085c73) to head (a1fd52e).
Report is 4 commits behind head on develop.

Files with missing lines	Patch %	Lines
op-batcher/batcher/channel_manager.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #14553      +/-   ##
===========================================
- Coverage    46.45%   41.99%   -4.47%     
===========================================
  Files         1036      865     -171     
  Lines        88796    78824    -9972     
===========================================
- Hits         41253    33103    -8150     
+ Misses       44475    42822    -1653     
+ Partials      3068     2899     -169

Flag	Coverage Δ
cannon-go-tests-32	`?`
cannon-go-tests-64	`?`
contracts-bedrock-tests	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
op-batcher/batcher/channel_manager.go	`85.26% <0.00%> (-0.67%)`	⬇️

... and 176 files with indirect coverage changes

sebastianst

Removed code is the best code 🔥
Suggesting to add other logs as well.

op-batcher/batcher/channel_manager.go

…hannel timeout log (ethereum-optimism#14553) * op-batcher: remove ChannelManager.CheckExpectedProgress * op-batcher: add warning log when a channel times out on chain

* op-batcher: prevent `SpanChannelOut` RLP bytes overflowing `MaxRLPBytesPerChannel` (ethereum-optimism#14310) * fix op-batcher pack over MaxRLPBytesChannel * add test cases from different CompressionAlgo * add fresh compression logic and corresponding comments * refactor: enhance MaxRLPBytesPerChannel test * refactor: rename variable and add required messages * op-batcher: use local-safe to reduce lag during interop sync (ethereum-optimism#14265) * op-batcher: remove `ThrottleInterval` and split block loading and batch publishing into separate goroutines (ethereum-optimism#14244) * op-batcher: overhaul throttling, reading and writing loops * no longer evaluate throttling conditions on a ticker * break main loop into "reading" and "writing" * reading loop signals to throttling and writing when ALL blocks are loaded (this could be done in a more fine grained way, even when each block is loaded) * these run concurrently * improvements * readloop unblocks writing loop once, and then writing loop goes forever (pausing when it runs out of data) tests pass but timeout due to bad shutdown * rename to prevent shadowing * allow for receipt handling when receipt and err are both nil * split shutdownCtx into producers and consumers * throttling loop ranges over a channel, does not take a context * processReceiptsLoop ranges over a channel, does not take a context * unify wait groups * unify contexts * writeLoop uses a ticker instead of a sleep * WIP: add throughput test for batcher * make txQueue local, not global state * reduce diff * reduce diff further * make pendingBytesUpdated a local, not global * read and write loop communicate with a channel no more ticker required * rename * rename * abstract promptLoop * rename * update readme * add diagram to readme * remove test I'm not sure it is adding any value. May return to it in future * sendToThrottlingLoop uses mutex * harmonize "*Loop returning" logs * tidy * remove TODO * rip out ThrottleInterval config var * add activeSequencerChanged channel and wire it up to onActiveSequencerChanged hook in active rollup provider * set callback at runtime, not in constructor * reinstate startup order * tidy * remove dead code * remove unintentional change * rename readLoop to blockLoadingLoop and writeLoop to publishingLoop * improve diagram * replace ThrottleInterval with ThrottleThreshold as enabling var * remove onActiveProviderChanged arg from constructors * protect callback invocation with nullity check * lint * Apply suggestions from code review Co-authored-by: Sebastian Stammler <seb@oplabs.co> * remove ThrottelInterval from flags * docs: mention active sequencer signal * only attach callback if throttling is enabled * increase buffer of activeSequencerChanged means that we buffer a single event if the throttlingLoop is busy, even when using a try-send * add buffer to pendingBytesUpdated see previous commit * reduce indentation * remove dangling ref * pass killCtx to publishingLoop and avoid accessing this context globally * remove continue and always signal publishing loop * remove unecessary mutex wrangle * replace signalPublishingLoop method with trySignal fn * extend TestRollupProvider_FailoverOnInactiveSequencer to cover callback fn * use retryTimer in throttlingLoop if RPC calls fail, they will be retried after retryInterval (or before, if another event triggers updateParams) * op-batcher: improve active-seq-changed signalling setup * remove unused state var * rename blocksLoaded channel to publishSignal channel --------- Co-authored-by: Sebastian Stammler <seb@oplabs.co> * op-batcher: add `TestBatchSubmitter_sendTx_FloorDataGas` and patch `driver.sendTx` (ethereum-optimism#14517) * op-batcher: add TestBatchSubmitter_sendTx_FloorDataGas * op-batcher: use floorDataGas for transactions if greater than intrinsicGas * Update op-batcher/batcher/driver.go Co-authored-by: Sebastian Stammler <seb@oplabs.co> * log error instead of ignoring --------- Co-authored-by: Sebastian Stammler <seb@oplabs.co> * op-batcher: always `updateCursorAndMetrics` when returning from `processBlocks()` (ethereum-optimism#14520) * op-batcher: always updateCursorAndMetrics when returning from processBlocks() * Update op-batcher/batcher/channel_manager.go Co-authored-by: Sebastian Stammler <seb@oplabs.co> --------- Co-authored-by: Sebastian Stammler <seb@oplabs.co> * op-batcher: remove `ChannelManager.CheckExpectedProgress()` and add channel timeout log (ethereum-optimism#14553) * op-batcher: remove ChannelManager.CheckExpectedProgress * op-batcher: add warning log when a channel times out on chain * op-batcher: correctly track block metrics in `handleChannelInvalidated()` (ethereum-optimism#14561) * op-batcher: correctly track block metrics in handleChannelInvalidated Includes test which fails without the fix. * op-batcher: log out channels which are dropped during handleChannelInvalidated() * change to warn log for dropped channels * op-batcher: improve `computeSyncActions()` logging (ethereum-optimism#14563) * improve computeSyncActions logging * fixup test and make sure all cases run (!) * use more friendly format for structured logger * op-batcher: introduce `PREFER_LOCAL_SAFE_L2` config var (ethereum-optimism#14587) * op-batcher: introduce PREFER_LOCAL_SAFE_L2 config var * lint * Apply suggestions from code review Co-authored-by: Sebastian Stammler <seb@oplabs.co> * lint --------- Co-authored-by: Sebastian Stammler <seb@oplabs.co> * batcher: Wait for DA write before shutdown --------- Co-authored-by: olga yang <ya1994ng@gmail.com> Co-authored-by: protolambda <proto@protolambda.com> Co-authored-by: George Knee <georgeknee@googlemail.com> Co-authored-by: Sebastian Stammler <seb@oplabs.co>

op-batcher: remove ChannelManager.CheckExpectedProgress

6ac8faf

geoknee requested review from a team as code owners February 26, 2025 21:45

geoknee requested a review from bitwiseguy February 26, 2025 21:45

geoknee added the A-op-batcher Area: op-batcher label Feb 26, 2025

geoknee requested a review from sebastianst February 26, 2025 21:45

geoknee changed the title ~~op-batcher: remove ChannelManager.CheckExpectedProgress~~ op-batcher: remove ChannelManager.CheckExpectedProgress() Feb 26, 2025

op-batcher: add warning log when a channel times out on chain

a1fd52e

geoknee changed the title ~~op-batcher: remove ChannelManager.CheckExpectedProgress()~~ op-batcher: remove ChannelManager.CheckExpectedProgress() and add channel timeout log Feb 26, 2025

sebastianst approved these changes Feb 27, 2025

View reviewed changes

op-batcher/batcher/channel_manager.go Show resolved Hide resolved

geoknee added this pull request to the merge queue Feb 27, 2025

Merged via the queue into develop with commit 0d761a4 Feb 27, 2025
46 checks passed

geoknee deleted the gk/batcher-dead-code branch February 27, 2025 13:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

op-batcher: remove `ChannelManager.CheckExpectedProgress()` and add channel timeout log #14553

op-batcher: remove `ChannelManager.CheckExpectedProgress()` and add channel timeout log #14553

geoknee commented Feb 26, 2025 •

edited

Loading

codecov bot commented Feb 26, 2025 •

edited

Loading

sebastianst left a comment

	for _, ch := range channels {
	if ch.isFullySubmitted() &&
	!ch.isTimedOut() &&
	newSyncStatus.CurrentL1.Number > ch.MaxInclusionBlock() &&
	newSyncStatus.LocalSafeL2.Number < ch.LatestL2().Number {
	// Safe head did not make the expected progress
	// for a fully submitted channel. This indicates
	// that the derivation pipeline may have stalled
	// e.g. because of Holocene strict ordering rules.
	l.Warn("sequencer did not make expected progress",
	"syncActions", startAfresh,
	"existingBlock", ch.LatestL2(),
	"safeL2", newSyncStatus.LocalSafeL2)
	return startAfresh, false
	}
	}

op-batcher: remove ChannelManager.CheckExpectedProgress() and add channel timeout log #14553

op-batcher: remove ChannelManager.CheckExpectedProgress() and add channel timeout log #14553

Conversation

geoknee commented Feb 26, 2025 • edited Loading

codecov bot commented Feb 26, 2025 • edited Loading

Codecov Report

sebastianst left a comment

Choose a reason for hiding this comment

op-batcher: remove `ChannelManager.CheckExpectedProgress()` and add channel timeout log #14553

op-batcher: remove `ChannelManager.CheckExpectedProgress()` and add channel timeout log #14553

geoknee commented Feb 26, 2025 •

edited

Loading

codecov bot commented Feb 26, 2025 •

edited

Loading