Files
bitchat/bitchatTests/Services/BLEFragmentHandlerTests.swift
T
81c45e9649 Reconnect hygiene: paced acks, persistent gift-wrap dedup, self-fragment sync fix (#1398)
* Reconnect hygiene: paced acks, persistent gift-wrap dedup, self-fragment sync fix

Remaining findings from the July 7 locked-phone test sessions, all rooted
in reconnect/relaunch behavior:

- All Nostr acks (READ and DELIVERED, direct and geohash) now flow through
  the paced queue that previously only throttled direct READ receipts.
  Reconnect redelivery produced 8 DELIVERED acks in under a second, which
  damus rejects ("noting too much").

- Processed gift-wrap event IDs persist across launches
  (NostrProcessedEventStore, wired through MessageDeduplicationService,
  debounced writes, wiped on the existing clear/panic paths). NIP-59
  randomizes gift-wrap timestamps, so the 24h-lookback DM subscriptions
  redeliver the same events every launch; without a cross-launch record
  each relaunch reprocessed old PMs and acks — the re-ack bursts and the
  "delivered ack for unknown mid" warnings (now debug: a stale ack is
  expected occasionally and not actionable).

- Own fragments handed back by sync replay (the deliberate RSR ttl=0
  restore path) now re-enter the gossip sync store before the self-drop.
  The fragment store is not archived, so after a relaunch our sync filter
  did not cover our own fragments and peers re-offered them every 30s
  round indefinitely; recording them stops the redelivery after one round
  while keeping assembly skipped.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Address Codex review on #1398: shared ack pacer, transient clears keep disk record

- Geohash acks are sent through short-lived NostrTransport instances
  (makeGeohashNostrTransport creates one per ack), so the per-instance ack
  queue never paced a burst. Acks now flow through a pacer shared across
  instances: Dependencies.live wires the process-wide sharedAckPacer, and
  the default Dependencies init builds an isolated pacer from the same
  injected scheduleAfter so tests keep stepping the throttle manually.

- clearNostrCaches() runs on every geohash channel switch, so it no longer
  wipes the persisted gift-wrap record (that stays on the clearAll/panic
  path). Persistence is now append-merge instead of snapshot-overwrite —
  serialized on the store's IO queue — so a transient in-memory clear
  between debounced flushes can't shrink the on-disk record either.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: jack <jackjackbits@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-07 21:08:10 +02:00

231 lines
8.4 KiB
Swift

import BitFoundation
import Foundation
import Testing
@testable import bitchat
struct BLEFragmentHandlerTests {
private final class Recorder {
/// Optional override for the assembly result; defaults to `.stored`.
var appendResult: ((BLEFragmentHeader) -> BLEFragmentAssemblyBuffer.AppendResult)?
var accepted = true
var trackedPackets: [BitchatPacket] = []
var appendedHeaders: [BLEFragmentHeader] = []
var ingressChecks: [(packet: BitchatPacket, innerSender: PeerID)] = []
var reinjectedPackets: [(packet: BitchatPacket, from: PeerID)] = []
}
private let localPeerID = PeerID(str: "0102030405060708")
private let remotePeerID = PeerID(str: "1122334455667788")
private func makeHandler(recorder: Recorder) -> BLEFragmentHandler {
let environment = BLEFragmentHandlerEnvironment(
localPeerID: { [localPeerID] in localPeerID },
trackPacketSeen: { packet in
recorder.trackedPackets.append(packet)
},
appendFragment: { header in
recorder.appendedHeaders.append(header)
return recorder.appendResult?(header) ?? .stored(header: header, started: true)
},
isAcceptedIngressPayload: { packet, innerSender in
recorder.ingressChecks.append((packet, innerSender))
return recorder.accepted
},
processReassembledPacket: { packet, from in
recorder.reinjectedPackets.append((packet, from))
}
)
return BLEFragmentHandler(environment: environment)
}
@Test
func ownFragmentIsTrackedForSyncButNotAssembled() {
let recorder = Recorder()
let handler = makeHandler(recorder: recorder)
let packet = makeFragmentPacket(sender: localPeerID, index: 0, total: 2)
handler.handle(packet, from: localPeerID)
// Sync replay hands own fragments back after a relaunch; they must
// re-enter the sync store (so the next round's filter covers them
// and redelivery stops) without being reassembled.
#expect(recorder.trackedPackets.count == 1)
#expect(recorder.appendedHeaders.isEmpty)
#expect(recorder.reinjectedPackets.isEmpty)
}
@Test
func malformedFragmentPayloadIsIgnored() {
let recorder = Recorder()
let handler = makeHandler(recorder: recorder)
let packet = BitchatPacket(
type: MessageType.fragment.rawValue,
senderID: Data(hexString: remotePeerID.id) ?? Data(),
recipientID: nil,
timestamp: 900_000,
payload: Data([0x01, 0x02, 0x03]),
signature: nil,
ttl: TransportConfig.messageTTLDefault
)
handler.handle(packet, from: remotePeerID)
#expect(recorder.trackedPackets.isEmpty)
#expect(recorder.appendedHeaders.isEmpty)
}
@Test
func broadcastFragmentIsTrackedAndAppended() {
let recorder = Recorder()
let handler = makeHandler(recorder: recorder)
let chunk = Data([0xDE, 0xAD, 0xBE, 0xEF])
let packet = makeFragmentPacket(sender: remotePeerID, index: 0, total: 3, chunk: chunk)
handler.handle(packet, from: remotePeerID)
#expect(recorder.trackedPackets.count == 1)
#expect(recorder.appendedHeaders.count == 1)
#expect(recorder.appendedHeaders.first?.index == 0)
#expect(recorder.appendedHeaders.first?.total == 3)
#expect(recorder.appendedHeaders.first?.originalType == MessageType.message.rawValue)
#expect(recorder.appendedHeaders.first?.fragmentData == chunk)
#expect(recorder.ingressChecks.isEmpty)
#expect(recorder.reinjectedPackets.isEmpty)
}
@Test
func directedFragmentIsNotTrackedForSync() {
let recorder = Recorder()
let handler = makeHandler(recorder: recorder)
let packet = makeFragmentPacket(
sender: remotePeerID,
index: 1,
total: 3,
recipientID: Data(hexString: localPeerID.id)
)
handler.handle(packet, from: remotePeerID)
#expect(recorder.trackedPackets.isEmpty)
#expect(recorder.appendedHeaders.count == 1)
}
@Test
func completedReassemblyReinjectsAcceptedPacketWithZeroTTL() throws {
let innerSender = PeerID(str: "99AABBCCDDEEFF00")
let innerPacket = BitchatPacket(
type: MessageType.message.rawValue,
senderID: Data(hexString: innerSender.id) ?? Data(),
recipientID: nil,
timestamp: 900_000,
payload: Data("hello".utf8),
signature: nil,
ttl: 5
)
let reassembled = try #require(innerPacket.toBinaryData())
let recorder = Recorder()
recorder.appendResult = { header in
.complete(header: header, reassembledData: reassembled, started: false)
}
let handler = makeHandler(recorder: recorder)
let packet = makeFragmentPacket(sender: remotePeerID, index: 1, total: 2)
handler.handle(packet, from: remotePeerID)
#expect(recorder.ingressChecks.count == 1)
#expect(recorder.ingressChecks.first?.innerSender == innerSender)
#expect(recorder.reinjectedPackets.count == 1)
let reinjected = recorder.reinjectedPackets.first
#expect(reinjected?.from == remotePeerID)
#expect(reinjected?.packet.type == MessageType.message.rawValue)
#expect(reinjected?.packet.payload == Data("hello".utf8))
// Reassembled packets must re-enter the pipeline with TTL zeroed.
#expect(reinjected?.packet.ttl == 0)
}
@Test
func rejectedReassembledPacketIsNotReinjected() throws {
let innerPacket = BitchatPacket(
type: MessageType.message.rawValue,
senderID: Data(hexString: "99AABBCCDDEEFF00") ?? Data(),
recipientID: nil,
timestamp: 900_000,
payload: Data("hello".utf8),
signature: nil,
ttl: 5
)
let reassembled = try #require(innerPacket.toBinaryData())
let recorder = Recorder()
recorder.accepted = false
recorder.appendResult = { header in
.complete(header: header, reassembledData: reassembled, started: false)
}
let handler = makeHandler(recorder: recorder)
let packet = makeFragmentPacket(sender: remotePeerID, index: 1, total: 2)
handler.handle(packet, from: remotePeerID)
#expect(recorder.ingressChecks.count == 1)
#expect(recorder.reinjectedPackets.isEmpty)
}
@Test
func undecodableReassembledDataIsDropped() {
let recorder = Recorder()
recorder.appendResult = { header in
.complete(header: header, reassembledData: Data([0x00, 0x01]), started: false)
}
let handler = makeHandler(recorder: recorder)
let packet = makeFragmentPacket(sender: remotePeerID, index: 1, total: 2)
handler.handle(packet, from: remotePeerID)
#expect(recorder.ingressChecks.isEmpty)
#expect(recorder.reinjectedPackets.isEmpty)
}
@Test
func incompleteAssemblyDoesNotReinject() {
let recorder = Recorder()
let handler = makeHandler(recorder: recorder)
let packet = makeFragmentPacket(sender: remotePeerID, index: 0, total: 2)
handler.handle(packet, from: remotePeerID)
#expect(recorder.appendedHeaders.count == 1)
#expect(recorder.ingressChecks.isEmpty)
#expect(recorder.reinjectedPackets.isEmpty)
}
private func makeFragmentPacket(
sender: PeerID,
index: UInt16,
total: UInt16,
originalType: UInt8 = MessageType.message.rawValue,
chunk: Data = Data([0xAA, 0xBB]),
recipientID: Data? = nil
) -> BitchatPacket {
var payload = Data()
payload.append(contentsOf: [0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77]) // fragment ID
payload.append(UInt8(index >> 8))
payload.append(UInt8(index & 0xFF))
payload.append(UInt8(total >> 8))
payload.append(UInt8(total & 0xFF))
payload.append(originalType)
payload.append(chunk)
return BitchatPacket(
type: MessageType.fragment.rawValue,
senderID: Data(hexString: sender.id) ?? Data(),
recipientID: recipientID,
timestamp: 900_000,
payload: payload,
signature: nil,
ttl: TransportConfig.messageTTLDefault
)
}
}