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

recover from process message instead crash the whole app #4016

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

RonaldinhoL
Copy link
Contributor

@RonaldinhoL RonaldinhoL commented Jan 15, 2025

Fixes #4015

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced error handling in message processing to improve system stability and error tracking.
    • Added comprehensive panic recovery mechanism for more robust error management.
    • Updated documentation to clarify changes in error handling and improve user guidance regarding the Mac App Store.

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The changes modify the ProcessMessage method in the Dispatcher struct to improve error handling and prevent process crashes. The method now includes a deferred panic recovery mechanism that captures and converts panics into returnable errors. This ensures that instead of crashing the entire process when an unexpected error occurs, the method can now return an error that can be handled gracefully by the calling code.

Changes

File Change Summary
v2/internal/frontend/dispatcher/dispatcher.go - Updated method signature to use named return values
- Added deferred panic recovery function
- Implemented error logging for message processing errors
website/src/pages/changelog.mdx - Updated changelog to reflect improvements in Dispatcher.ProcessMessage error handling
- Removed outdated references in documentation
- Updated Mac App Store guide for app names with spaces

Assessment against linked issues

Objective Addressed Explanation
Prevent process crash during message processing [#4015]
Handle illegal params gracefully [#4015]

Possibly related PRs

  • [v3] app quit on message #3990: The changes in this PR involve the Dispatcher.ProcessMessage method, which is directly related to the error handling improvements made in the main PR, specifically addressing crash scenarios and enhancing error management.

Suggested reviewers

  • leeanthony

Poem

🐰 A rabbit's tale of code so bright,
Where panics once caused such a fright,
Now errors dance, no process falls,
Dispatcher listens, answers calls!
Safe and sound, our code takes flight! 🚀


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>, please review it.
    • 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 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 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 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. (Beta)
  • @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
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: 1

🧹 Nitpick comments (1)
v2/internal/frontend/dispatcher/dispatcher.go (1)

34-45: Solid panic recovery implementation with room for enhancement.

The implementation successfully prevents app crashes while preserving error context. Consider these enhancements:

  1. Use structured logging for better error tracking:
-			d.log.Error("process message error: %s -> %s", message, err)
+			d.log.Error("process message error: message=%q error=%q stack=%s", 
+				message, 
+				err, 
+				string(debug.Stack()))
  1. Add more context to non-error panics:
-				err = fmt.Errorf("%v", e)
+				err = fmt.Errorf("panic recovered while processing message: %v", e)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c4fdfd6 and 7490b20.

📒 Files selected for processing (1)
  • v2/internal/frontend/dispatcher/dispatcher.go (2 hunks)
🔇 Additional comments (2)
v2/internal/frontend/dispatcher/dispatcher.go (2)

5-5: LGTM!

The addition of the "fmt" import is necessary for error formatting in the panic recovery mechanism.


33-33: LGTM! Well-structured signature change.

The use of named return values, particularly for the error, enables clean error handling in the deferred function while maintaining backward compatibility.

Comment on lines +33 to +45
func (d *Dispatcher) ProcessMessage(message string, sender frontend.Frontend) (_ string, err error) {
defer func() {
if e := recover(); e != nil {
if errPanic, ok := e.(error); ok {
err = errPanic
} else {
err = fmt.Errorf("%v", e)
}
}
if err != nil {
d.log.Error("process message error: %s -> %s", message, err)
}
}()
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Add test coverage for ProcessMessage error handling and panic recovery

The error handling in callers is consistent, but test coverage is missing for:

  • ProcessMessage error handling
  • Panic recovery scenarios
  • Error propagation through the dispatcher

Please add test cases to verify:

  • Normal message processing
  • Error propagation
  • Panic recovery functionality
  • Logger error reporting
🔗 Analysis chain

Verify error handling in callers and test coverage.

Please ensure:

  1. All callers of ProcessMessage properly handle the returned errors
  2. Test coverage exists for panic scenarios

Let's verify the callers and test coverage:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check callers of ProcessMessage
echo "Checking ProcessMessage callers:"
rg -B 2 -A 2 "ProcessMessage\(" --type go

# Check test coverage
echo "Checking test coverage:"
fd -e go -e _test.go | xargs rg "TestProcessMessage|TestDispatcher.*Process"

Length of output: 2390


Script:

#!/bin/bash
# Check for any dispatcher tests with broader patterns
echo "Checking dispatcher tests:"
fd -e _test.go . v2/internal/frontend/dispatcher/ | xargs cat

# Check for any test files that might test ProcessMessage
echo -e "\nChecking for test files containing 'dispatch' or 'message':"
fd -e _test.go . v2/internal/frontend/ | xargs rg -i "dispatch|message" -C 2

Length of output: 66531


Script:

#!/bin/bash
# Search for test files in dispatcher directory
echo "Checking for test files in dispatcher directory:"
fd -e go -g "*_test.go" . v2/internal/frontend/dispatcher/

# Search for dispatcher tests with broader pattern
echo -e "\nChecking for dispatcher-related tests:"
fd -e go -g "*_test.go" . v2/internal/frontend/ | xargs cat

Length of output: 65928

@leaanthony
Copy link
Member

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

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

🧹 Nitpick comments (3)
website/src/pages/changelog.mdx (3)

Line range hint 1-1584: Consider standardizing the PR reference format throughout the changelog.

For consistency, consider adopting a single format for PR references. Currently there's a mix of:

  • Full URLs: [PR](https://github.com/wailsapp/wails/pull/xxxx)
  • Short format: [#xxxx]
  • With/without contributor references

Choose one format and apply it consistently throughout the changelog. For example:

- Fixed by @leaanthony in https://github.com/wailsapp/wails/pull/1230
+ Fixed by @leaanthony in [#1230](https://github.com/wailsapp/wails/pull/1230)

Line range hint 1-1584: Consider reorganizing breaking changes sections.

To improve clarity for users upgrading between versions:

  1. Move all breaking changes to the top of each version entry
  2. Ensure each deprecated feature clearly states the recommended alternative
  3. Consider adding migration guides for significant breaking changes

This helps users quickly assess the impact of upgrading and plan accordingly.


Line range hint 1-1584: Consider improving visual organization of the changelog.

To improve readability of this large changelog:

  1. Add year groupings as headers
  2. Add more prominent visual separation between major versions
  3. Consider splitting into separate files by major version

This would make it easier to navigate the changelog history and find specific versions.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7490b20 and 35107e3.

📒 Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)

website/src/pages/changelog.mdx Show resolved Hide resolved
@leaanthony leaanthony merged commit 4598af4 into wailsapp:master Jan 17, 2025
8 checks passed
@leaanthony
Copy link
Member

Thanks for this!

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.

Dispatcher.ProcessMessage crash process instead of return error
2 participants