fix: node graceful shutdown by handling SIGTERM

[auricom]

Fix graceful shutdown in Docker containers

Problem

When running the rollkit node in a Docker container and using docker stop, the process doesn't shutdown gracefully and causes database corruption.

Logs

7:00AM INF creating empty block height=10 module=BlockManager
7:00AM INF creating empty block height=11 module=BlockManager
7:00AM INF creating empty block height=12 module=BlockManager

# command: `docker stop <container_name>

# command: `docker start <container_name>

7:00AM INF creating new client module=main namespace=000000000000000000000000000000000000002777d4d961c75a526dd8
7:00AM INF using default mempool ttl MempoolTTL=25 module=BlockManager
7:00AM INF starting P2P client module=main
7:00AM INF started RPC server addr=127.0.0.1:7331 module=main
7:00AM INF listening on address=/ip4/127.0.0.1/tcp/7676/p2p/12D3KooWMubR4af4S9VW9xZMix4HYptuM9htnvccLuT6q7BhAGWf module=main
7:00AM INF listening on address=/ip4/172.28.0.4/tcp/7676/p2p/12D3KooWMubR4af4S9VW9xZMix4HYptuM9htnvccLuT6q7BhAGWf module=main
7:00AM INF no peers - only listening for connections module=main
7:00AM INF working in aggregator mode block time=1s module=main
7:00AM INF Reaper started interval=1000 module=Reaper
7:00AM INF creating empty block height=13 module=BlockManager
7:00AM ERR unrecoverable error in one of the go routines... error="error in normal aggregation loop: error while publishing block: failed to broadcast: validation failed" module=main
7:00AM INF halting full node and its sub services... module=main
7:00AM INF data submission loop stopped module=BlockManager
7:00AM INF Reaper stopped module=Reaper
2025-06-04T07:00:46.080Z	ERROR	header/sync	sync/sync.go:229	syncing headers	{"from": 2, "to": 13, "err": "header/p2p: exchange is closed"}
7:00AM INF full node halted successfully module=main
7:00AM ERR node error error="context canceled" module=main
Error: context canceled

Solution

• Added SIGTERM signal handling alongside existing SIGINT handling
• Added syscall import to support syscall.SIGTERM
• Now responds to both interactive shutdown (Ctrl+C) and Docker stop commands

Changes

• Modified StartNode() function in cmd/run_node.go to listen for both os.Interrupt and syscall.SIGTERM
• Added syscall import

Testing

• Graceful shutdown with Ctrl+C still works
• Graceful shutdown with docker stop now works
• No database corruption after Docker container shutdown

7:00AM INF creating empty block height=10 module=BlockManager
7:00AM INF creating empty block height=11 module=BlockManager
7:00AM INF creating empty block height=12 module=BlockManager

# command: `docker stop <container_name>

7:04AM INF shutting down node... module=main
7:04AM INF context canceled, stopping node module=main
7:04AM INF halting full node and its sub services... module=main
7:04AM INF Reaper stopped module=Reaper
7:04AM INF data submission loop stopped module=BlockManager
7:04AM INF full node halted successfully module=main

# command: `docker start <container_name>

7:04AM INF creating new client module=main namespace=000000000000000000000000000000000000002777d4d961c75a526dd8
7:04AM INF using default mempool ttl MempoolTTL=25 module=BlockManager
7:04AM INF starting P2P client module=main
7:04AM INF started RPC server addr=127.0.0.1:7331 module=main
7:04AM INF listening on address=/ip4/127.0.0.1/tcp/7676/p2p/12D3KooWS5qA2Soarjzy5CwVukArsqnZ9qyAq1wWxoCyZ9q3egKv module=main
7:04AM INF listening on address=/ip4/172.28.0.4/tcp/7676/p2p/12D3KooWS5qA2Soarjzy5CwVukArsqnZ9qyAq1wWxoCyZ9q3egKv module=main
7:04AM INF no peers - only listening for connections module=main
7:04AM INF working in aggregator mode block time=1s module=main
7:04AM INF Reaper started interval=1000 module=Reaper
7:04AM INF creating empty block height=13 module=BlockManager
7:04AM INF creating empty block height=14 module=BlockManager

Summary by CodeRabbit

• New Features
  • The application now supports graceful shutdown when receiving SIGTERM signals, in addition to existing support for SIGINT.

[coderabbitai]

Walkthrough

The update enhances the node's shutdown behavior by adding handling for the SIGTERM signal, in addition to the existing SIGINT handling. This ensures that the node performs a graceful shutdown when either of these signals is received by the process.

Changes

File(s)	Change Summary
pkg/cmd/run_node.go	Added syscall.SIGTERM to the list of signals triggering shutdown.

Sequence Diagram(s)

sequenceDiagram
    participant OS
    participant NodeProcess
    participant Logger

    OS->>NodeProcess: Send SIGINT or SIGTERM
    NodeProcess->>NodeProcess: Cancel context (initiate shutdown)
    NodeProcess->>Logger: Log shutdown event
    NodeProcess-->>OS: Graceful shutdown

Loading

Suggested labels

T:bug

Suggested reviewers

• Manav-Aggarwal
• randygrok

Poem

When signals arrive, both TERM and INT,
The node now knows just what is meant.
With a hop and a log, it starts to unwind,
Graceful shutdown, peace of mind.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 907c7df and 6554b89.

📒 Files selected for processing (1)

• pkg/cmd/run_node.go (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: rollkit-docker / docker-build (GHCR; ghcr.io/rollkit/rollkit)
• GitHub Check: test / Run EVM Execution Tests
• GitHub Check: test / Run Unit Tests
• GitHub Check: lint / markdown-lint
• GitHub Check: test / Build All Rollkit Binaries
• GitHub Check: Summary

🔇 Additional comments (2)

pkg/cmd/run_node.go (2)

11-11: LGTM! Necessary import for SIGTERM handling.

The syscall package import is correctly added to access the syscall.SIGTERM constant required for Docker graceful shutdown.

---

172-172: Excellent fix for Docker graceful shutdown!

Adding syscall.SIGTERM to the signal handling correctly addresses the database corruption issue. Docker sends SIGTERM when using docker stop, and this change ensures the node can respond gracefully instead of being forcefully killed after the timeout period.

The existing graceful shutdown logic with context cancellation and 5-second timeout remains intact, providing a robust shutdown mechanism for both interactive (Ctrl+C) and containerized environments.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[damiannolan]

Looks possibly related: celestiaorg/celestia-zkevm#50

[alpe]

👍

[codecov]

Codecov Report

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

Project coverage is 54.89%. Comparing base (907c7df) to head (6554b89).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/cmd/run_node.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2335   +/-   ##
=======================================
  Coverage   54.89%   54.89%           
=======================================
  Files          82       82           
  Lines        7503     7503           
=======================================
  Hits         4119     4119           
  Misses       2963     2963           
  Partials      421      421           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.