mirror of
https://github.com/permissionlesstech/bitchat.git
synced 2026-07-24 23:25:19 +00:00
Image prep downscaled every photo to 448 px and force-compressed to a 45 KB byte budget, so a typical camera photo landed ~40 KB — below TransportConfig.wifiBulkMinPayloadBytes (64 KiB). WifiBulkPolicy.shouldOffer requires payloadBytes > 64 KiB, so the Wi-Fi bulk (AWDL) data plane never triggered in production even when it worked on-device: real photos always fell back to BLE fragmentation. Raise the prep budget so genuinely detailed photos land well above 64 KiB while staying under the 512 KiB FileTransferLimits.maxImageBytes hard cap: - defaultMaxDimension 448 -> 1024 px - compressionQuality 0.82 -> 0.85 - targetImageBytes 45 KB -> 200 KB (a ceiling, not a target to hit) Measured on a representative photo-like image: ~40 KB before -> ~190 KB after, crossing the 64 KiB offer threshold while remaining ~2.6x under the hard cap. Because the raised dimension makes near-incompressible inputs (e.g. full- frame noise) able to exceed maxImageBytes at the quality floor, prep now downscales-and-retries until the payload fits the hard cap, so a send can never fail with imageTooLarge on pathological input (it couldn't at 448 px). Also de-dupes the previously copy-pasted per-platform encodeJPEG into one shared helper. Residual limitation: prep is not recipient-capability-aware. Images are prepared at this fidelity regardless of whether the recipient supports Wi-Fi bulk, so BLE-only peers and public broadcasts now carry ~190 KB images too (still within the existing 512 KiB image cap). Making prep choose fidelity per-recipient would need capability plumbing into the prep pipeline and doesn't help public broadcasts, so it's deferred. 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