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

[BUG]: properly catch and propogate panics in component handlers #3374

Merged
merged 2 commits into from
Jan 3, 2025

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Dec 30, 2024

Description of changes

In Rust, panics (should) always semantically indicate a program bug. By default panics will terminate the current thread. This makes sense for single-tenant programs, e.g. CLI tools, GUI programs, etc.

However, if we assume that most program bugs are triggered via user-provided input, this behavior is much less desirable for multi-tenant systems. A bad code path triggered by a small percentage of users should not cause service degradation for all users.

Given this, I decided to continue down the path of catching panics rather than crashing the entire process upon a panic.

This approach (I assume because of similar reasoning) is also taken by tonic, our gRPC server, which catches panics at the gRPC service handler layer. Tokio also catches panics at the task level.


This PR cleans up panic-related code and adds logic to catch panics inside component handlers (this is where we have previously observed hangs because of improperly handled panics).

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Also tested by inserting a panic! into a compaction handler and observing that the error correctly propagated and compaction continued to progress (previously hung the process).

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

n/a

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@codetheweb codetheweb marked this pull request as ready for review December 30, 2024 23:22
@codetheweb codetheweb merged commit 51b8ebd into main Jan 3, 2025
78 checks passed
@codetheweb codetheweb deleted the feat-compactor-panics branch January 3, 2025 19:01
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