Skip to content

catch panic from decodeLogFunc #215

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

Merged
merged 3 commits into from
Jun 4, 2025
Merged

catch panic from decodeLogFunc #215

merged 3 commits into from
Jun 4, 2025

Conversation

nischitpra
Copy link
Contributor

@nischitpra nischitpra commented Jun 3, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved stability by preventing unexpected crashes during log decoding. Errors are now logged if a problem occurs, ensuring the application continues running smoothly.

Copy link

coderabbitai bot commented Jun 3, 2025

Walkthrough

A panic recovery mechanism was introduced in the goroutine responsible for log decoding within the DecodeLogs function. This addition ensures that any panic during concurrent log decoding is caught, logged with relevant context, and does not terminate the overall process.

Changes

File Change Summary
internal/common/log.go Added deferred panic recovery and error logging to goroutine in DecodeLogs to handle panics.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant DecodeLogs
    participant Goroutine
    participant Logger

    Caller->>DecodeLogs: Call DecodeLogs(logs, chainId)
    loop For each log
        DecodeLogs->>Goroutine: Launch decodeLogFunc in goroutine
        alt Panic occurs in Goroutine
            Goroutine->>Logger: Log error with chainId, logs, and panic error
        else No panic
            Goroutine->>Goroutine: Process log normally
        end
    end
    DecodeLogs-->>Caller: Return results
Loading

📜 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 c6c5c3a and 4d12177.

📒 Files selected for processing (1)
  • internal/common/log.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • internal/common/log.go
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.

Copy link

@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: 1

🧹 Nitpick comments (1)
internal/common/log.go (1)

88-131: Consider adding bounds checking for concurrent slice access.

While the current implementation uses proper synchronization with WaitGroup, there's a potential race condition concern. The decodedLogs slice is accessed concurrently by multiple goroutines without explicit bounds checking.

Consider adding bounds validation to make the code more robust:

 go func(idx int, eventLog Log, mut *sync.Mutex) {
+	if idx >= len(decodedLogs) {
+		log.Error().Int("index", idx).Int("length", len(decodedLogs)).Msg("Index out of bounds in DecodeLogs")
+		wg.Done()
+		return
+	}
 	defer func() {
 		if err := recover(); err != nil {
 			log.Error().

This prevents potential out-of-bounds access in edge cases where the slice might be modified concurrently.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f757184 and c6c5c3a.

📒 Files selected for processing (1)
  • internal/common/log.go (1 hunks)

Copy link
Collaborator

@iuwqyir iuwqyir left a comment

Choose a reason for hiding this comment

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

set the log to decodedLogs slice when the panic is caught

@nischitpra nischitpra merged commit 4ae507a into main Jun 4, 2025
5 checks passed
@nischitpra nischitpra deleted the np/catch_panic branch June 4, 2025 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants