docs: document fork-safety limitation for gRPC channels#111
Merged
Conversation
gRPC channels are not fork-safe. Forking after creating a ConfigClient (or while a ConfigWatcher thread runs) results in undefined behavior — the child inherits the channel's internal threads and file descriptors in an unrecoverable state. Adds a "Fork safety" section to watching.md with an explanation, a multiprocessing.Pool example showing the correct pattern, and a note on preferring the spawn start method. Adds a brief callout to README.md linking to that section. Co-Authored-By: Claude <noreply@anthropic.com> Closes #69
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
watching.mdexplaining the root cause, showing the correct pattern (create the client inside the worker), and recommending thespawnstart method.README.mdpointing to that section so the warning is visible without digging into the docs.Test plan
#fork-safetyanchor inwatching.mdmatches the README link targetCloses #69