feat(op-challenger): Generic Scheduler Refactor

[refcell]

Description

Refactors scaffold scheduler logic into a generic op-service component.

Ideally, this component can be extended to support wiring into the top-level coordinator-scheduler architecture.

For now, it is hooked up in the Bond Claiming Scheduler and the Large Preimage Challenging Scheduler.

Tests

Tests around the op-service/sync/Scheduler.

Metadata

Fixes https://github.com/ethereum-optimism/client-pod/issues/522

[coderabbitai[bot]]

Walkthrough

Walkthrough

The updates across various components in the op-challenger and op-service projects focus on refactoring schedulers to implement a new Scheduler interface, enhancing modularity and reusability. Changes include the introduction of callback functions for task handling, separation of concerns in task scheduling and execution, and method signature adjustments to streamline the scheduling process. The modifications aim to improve clarity, efficiency, and maintainability of the scheduling mechanisms within the system.

Changes

File(s)	Change Summary
.../game/fault/claims/scheduler.go	Refactored BondClaimScheduler to use a Scheduler interface with updated task handling mechanisms. Removed run method in favor of internal scheduler functions.
.../game/keccak/scheduler.go, .../game/keccak/scheduler_test.go, .../game/monitor.go, .../game/monitor_test.go	Refactored to use a Scheduler interface, introducing new functions for task scheduling and verification. Method signatures adjusted for clarity and reusability.
op-service/sync/scheduler.go, op-service/sync/scheduler_test.go	Introduced Scheduler type for processing items with runner functions. Includes methods for task management, error handling, and callbacks. Test suite added for various scenarios like immediate shutdown and buffer full handling.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[refcell]

Current dependencies on/for this PR:

• develop
  • PR #9324 👈

This stack of pull requests is managed by Graphite.

[refcell]

Will continue to work in this branch to extend the scheduler abstraction to the top level Scheduler

[refcell]

lgtm. it'll be useful to add a "drain" function to the scheduler. Since there could be pending tasks that may not get run after Close.

This is a good idea! I've added a Drain() method on the concrete op-service Scheduler that clears the job channel.

When the scheduler is closed in downstream invocations, it also drains the scheduler after Close() error succeeds (doesn't return an error).

[refcell]

There's a bug here whereby there is contention on the cancel between the spawned goroutine and the Close method. Need to work through that. Open to suggestions.

[github-actions[bot]]

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.