mirror of
https://github.com/permissionlesstech/bitchat.git
synced 2026-07-24 22:25:18 +00:00
jackandClaude Fable 5
51186c3be6
The two stress tests I added (test_concurrentUpsertsAndForceSaveDoNotRaceOrHang and test_manyManagersDeinitDoNotWedgeTeardown) spawned units of work that the test could not deterministically join before returning: - test_manyManagersDeinitDoNotWedgeTeardown created 200 managers that each scheduled a fire-and-forget queue.async(.barrier) save on the manager's own private queue; the test has no handle to await that per-manager barrier work, so a large backlog of it could still be executing after the test returned. - test_concurrentUpsertsAndForceSaveDoNotRaceOrHang spawned 32 DispatchQueue.global().async workers, each also scheduling per-manager barrier saves; the DispatchGroup only joined the worker loops, not the manager's internal barrier work. Under --enable-code-coverage (CI only), LLVM writes .profraw from an atexit handler; if instrumented worker threads are still live during that dump the process deadlocks at exit — matching the CI signature exactly: all 145 tests start, then a ~5-minute wedge, then Killed:9. It reproduced only on the constrained CI runner, not locally (18 cores drained the backlog before exit), which is why earlier local runs looked clean. The production fix is already verified: ThreadSanitizer is clean on the identity + announce-handler suites (no data race, no re-entrant deadlock), and the deterministic unit tests cover the signing-key pin refusal, persistence across re-init, and the persisted-pin fallback. A stress test that destabilizes CI is worse than no stress test, so both are removed along with the now-unused LockedKeychain double. Verified: `time swift test --parallel --enable-code-coverage --skip PerformanceBaselineTests` is green 6x and the process exits ~2.9s after the last test (tests run in ~1.5s); no teardown wedge under coverage even with LIBDISPATCH_COOPERATIVE_POOL_STRICT=1 and a single worker. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Test Harness Guide
This test suite uses an in-memory networking harness to make end-to-end and integration tests deterministic, fast, and race-free without touching production code.
In-Memory Bus
- File:
bitchatTests/Mocks/MockBLEService.swift - Registry/Adjacency: Global
registrymapspeerIDto aMockBLEServiceinstance;adjacencyrecords simulated links between peers. - Setup: Call
MockBLEService.resetTestBus()insetUp()to clear state between tests. - Topology: Use
simulateConnectedPeer(_:)andsimulateDisconnectedPeer(_:)to add/remove links.connectFullMesh()helpers in tests build larger topologies. - Handlers: Tests can observe data via
messageDeliveryHandler(decodedBitchatMessage) andpacketDeliveryHandler(rawBitchatPacket). - De‑duplication: A thread-safe
seenMessageIDsprevents duplicate deliveries during flooding/relays.
Broadcast Flooding
- Flag:
MockBLEService.autoFloodEnabled - Intent: When
true, public broadcasts propagate across the entire connected component (ignores TTL for reach) while still de‑duping to prevent loops. - Usage: Enabled in Integration tests (
setUp) to simulate large-network broadcast; disabled in E2E tests to keep routing explicit and verify TTL behavior (seePublicChatE2ETests.testZeroTTLNotRelayed).
Rehandshake Flow (Noise)
- Why: The legacy NACK recovery path was removed; recovery now relies on Noise session rehandshake after decrypt failure or desync.
- Manager:
NoiseSessionManagermanages per-peer sessions. - Pattern: On decrypt failure, proactively clear the local session and re-initiate a handshake. The peer accepts and replaces their session.
- Test:
IntegrationTests.testRehandshakeAfterDecryptionFailure- Corrupts ciphertext to induce a decrypt error.
- Calls
removeSession(for:)on the initiator’s manager beforeinitiateHandshake(with:)to avoidalreadyEstablished. - Verifies encrypt/decrypt succeeds post-rehandshake.
Tips
- Determinism: Add small async delays only where handler installation/topology changes could race the first send.
- Scoping: Keep
autoFloodEnabledtoggled only within Integration tests; always reset intearDown()to avoid cross-test contamination. - Direct vs Relay: Private messages target a specific peer when adjacent; otherwise they are surfaced to neighbors for relay and, if known, also delivered to the target.
Quick Start
- Create nodes and connect them:
let svc = MockBLEService(); svc.myPeerID = "PEER1"svc.simulateConnectedPeer("PEER2")
- Observe messages:
svc.messageDeliveryHandler = { msg in /* asserts */ }
- Enable broadcast flooding for Integration suites only:
MockBLEService.autoFloodEnabled = true