hashmail: fix flacky tests #199
Open
Conversation
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
Register the Aperture instance created in setupAperture with t.Cleanup so that every test stops its own server even if it fails. This keeps the global HashMail stream map clean and prevents TestHashMailServerLargeMessage from inheriting leftover streams from TestHashMailServerReturnStream. This prevents cascading test failures, when a failure in one test is replicated as many failures in many tests, complicating debugging from logs.
Fix flaky tests. Reproducer: go test -run TestHashMailServerReturnStream -count=20 TestHashMailServerReturnStream fails because the test cancels a read stream and immediately dials RecvStream again expecting the same stream to be handed out once the server returns it. The hashmail server implemented RequestReadStream/RequestWriteStream with a non-blocking channel poll and returned "read/write stream occupied" as soon as the mailbox was busy. That raced with the deferred ReturnStream call and the reconnect often happened before the stream got pushed back, so clients received the occupancy error instead of the context cancellation they triggered. Teach RequestReadStream/RequestWriteStream to wait for the stream to become available (or the caller's context / server shutdown) with a bounded timeout. If the wait expires we still return the "... stream occupied" error, so callers that legitimately pile up can see that signal. The new streamAcquireTimeout constant documents the policy, and the blocking select removes the race, so reconnect attempts now either succeed or surface the original context error.
starius
force-pushed
the
fix-flacky-tests
branch
from
fcf5621 to
e734b4a
Compare
hieblmi
approved these changes
Nov 27, 2025
Collaborator
hieblmi
left a comment
hieblmi
left a comment
There was a problem hiding this comment.
Thanks for the fix, LGTM!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
make
RequestReadStream/RequestWriteStreamwait for their respective channels (bounded bystreamAcquireTimeoutand respecting context) instead of immediately returning "stream occupied", removing the race that causedTestHashMailServerReturnStreamto flakeensure
setupAperturestops its Aperture instance viat.Cleanup, so each test tears down its server even when it fails midway; this prevents one test from leaving a live HashMail stream that causes the next test'sNewCipherBoxcall to hitAlreadyExistsTesting
go test -run 'TestHashMailServer(ReturnStream|LargeMessage)' -count=20