-
-
Notifications
You must be signed in to change notification settings - Fork 0
fix(receipt): finalize and guard all egress paths #150
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
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c046e06
fix(receipt): finalize and guard all egress paths
Desperado e3936ce
fix(receipt): address egress review findings
Desperado c01e3d5
fix(receipt): redact transport error notes
Desperado fed30ee
fix(receipt): make transport notes opaque
Desperado File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "os" | ||
| "sync" | ||
| ) | ||
|
|
||
| // exitWithReceipt is the only process-exit path used after main has installed | ||
| // the session receipt. os.Exit skips deferred functions, so finalize must run | ||
| // explicitly for command failures that occur after an outbound request. | ||
| var ( | ||
| exitMu sync.RWMutex | ||
| finalizeBeforeExit func() | ||
| processExit = os.Exit | ||
| ) | ||
|
|
||
| func configureExitFinalizer(finalize func()) { | ||
| exitMu.Lock() | ||
| finalizeBeforeExit = finalize | ||
| exitMu.Unlock() | ||
| } | ||
|
|
||
| func exitWithReceipt(code int) { | ||
| exitMu.RLock() | ||
| finalize := finalizeBeforeExit | ||
| exitMu.RUnlock() | ||
| if finalize != nil { | ||
| finalize() | ||
| } | ||
| processExit(code) | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "sync" | ||
| "sync/atomic" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestExitWithReceiptFinalizesBeforeProcessExit(t *testing.T) { | ||
| exitMu.Lock() | ||
| oldFinalize := finalizeBeforeExit | ||
| oldProcessExit := processExit | ||
| exitMu.Unlock() | ||
| t.Cleanup(func() { | ||
| exitMu.Lock() | ||
| finalizeBeforeExit = oldFinalize | ||
| processExit = oldProcessExit | ||
| exitMu.Unlock() | ||
| }) | ||
|
|
||
| var order []string | ||
| configureExitFinalizer(func() { order = append(order, "finalize") }) | ||
| processExit = func(code int) { | ||
| if code != 7 { | ||
| t.Errorf("exit code = %d, want 7", code) | ||
| } | ||
| order = append(order, "exit") | ||
| } | ||
|
|
||
| exitWithReceipt(7) | ||
| if len(order) != 2 || order[0] != "finalize" || order[1] != "exit" { | ||
| t.Fatalf("order = %v, want [finalize exit]", order) | ||
| } | ||
| } | ||
|
|
||
| func TestExitWithReceiptConcurrentFinalizerReconfiguration(t *testing.T) { | ||
| exitMu.Lock() | ||
| oldFinalize := finalizeBeforeExit | ||
| oldProcessExit := processExit | ||
| processExit = func(int) {} | ||
| exitMu.Unlock() | ||
| t.Cleanup(func() { | ||
| exitMu.Lock() | ||
| finalizeBeforeExit = oldFinalize | ||
| processExit = oldProcessExit | ||
| exitMu.Unlock() | ||
| }) | ||
|
|
||
| var finalizations atomic.Int32 | ||
| configureExitFinalizer(func() { finalizations.Add(1) }) | ||
|
|
||
| const calls = 100 | ||
| start := make(chan struct{}) | ||
| var wg sync.WaitGroup | ||
| for range calls { | ||
| wg.Add(2) | ||
| go func() { | ||
| defer wg.Done() | ||
| <-start | ||
| configureExitFinalizer(func() { finalizations.Add(1) }) | ||
| }() | ||
| go func() { | ||
| defer wg.Done() | ||
| <-start | ||
| exitWithReceipt(0) | ||
| }() | ||
| } | ||
| close(start) | ||
| wg.Wait() | ||
|
|
||
| if got := finalizations.Load(); got != calls { | ||
| t.Errorf("finalizations = %d, want %d", got, calls) | ||
| } | ||
| } |
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.