mirror of
https://github.com/permissionlesstech/bitchat.git
synced 2026-07-27 16:25:22 +00:00
* Deflake two iOS-sim CI tests with unbounded timing assumptions Both failed on main-adjacent CI runs during this session's PRs. Neither was a product bug; both asserted things about real time that a loaded runner is under no obligation to honour. **NetworkReachabilityGateTests: a wall-clock upper bound.** test_monitor_duplicateUpdatesDoNotPostponeOfflineCommit slept 500ms for real, then asserted total elapsed time was under 1.4s to prove a duplicate mid-window had not restarted the 1.0s debounce. One CI run took 3.75s. No wall-clock bound can separate "deadline preserved" from "runner is slow", because Task.sleep and the asyncAfter flush are both real time and neither is bounded above. The deadline property was already covered deterministically one level down: test_debounce_duplicateObservationsPreservePendingDeadline drives ReachabilityDebounce with injected timestamps and checks pendingRemaining directly. So the monitor test now asserts only what needs a real monitor — that a duplicate still yields exactly one committed false through the debounce — with an injected clock for the arithmetic and a generous liveness budget. Renamed to say what it actually checks. No coverage lost, and it runs in 0.14s instead of ~3.8s because the real sleep is gone. **NoiseEncryptionServiceTests: injected timeouts that also arm during setup.** #1483 diagnosed and fixed exactly this in the quarantine-restore test, but two sibling tests kept the shape. Their injected ordinaryResponderHandshakeTimeout (0.04 and 0.06) also arms during the establishSessions setup handshake, where bob is the responder — so a preempted runner fires it mid-setup, tears down the half-open responder, and message 3 gets answered as a fresh initiation. The CI failure named setup's own `#expect(finalMessage == nil)` seeing a 96-byte message 2, which is precisely the signature #1483 recorded. Raised both to 1.0s, matching #1483's remedy: the scenarios still need the responder timeout to fire, and it still does, just with room for setup to complete first. Thin 1-second waitUntil budgets in the file now use the shared TestConstants.longTimeout; every one of them backs a positive assertion, so waitUntil still returns the moment the condition holds and nothing gets slower in the passing case. No assertion weakened in either file. Verified 3x sequentially and 3x with all 18 cores saturated. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Raise two more starvation-prone test deadlines Both surfaced on the CI runs for this PR and #1487, both in tests neither PR touches, both the same shape as the two already fixed here: a deadline sized for the work rather than for a runner executing many suites at once. VoiceNotePlaybackControllerTests waited 5s for a @MainActor Task that playback schedules for the session acquire and its failure path. When that Task is not scheduled in time the helper reports *two* failures — the wait, and the `!isPlaying` the un-run failure path has not reset yet — which reads like a playback bug rather than a starved scheduler. That is exactly what CI showed. GeoRelayDirectoryTests waited 10s for work the directory runs in Task.detached(priority: .utility); utility priority competes with every other suite. The retry-scheduling case timed out at exactly 10.06s with the retry never scheduled, reading like a missing retry rather than a starved background task. Raised to 30s each with the reasoning recorded at the helper. Both helpers return as soon as their condition holds, so nothing slows down when tests pass — only the genuine-failure case takes longer to report. Verified 3x with all cores saturated: both suites clean. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Make the flake class unrepeatable, not just fixed Raising four deadlines fixed the four tests that happened to fire. The class was still there: fourteen separate waitUntil helpers, most defaulting to 1.0s, plus wait call sites with literal budgets. The fifth instance would have landed the same way, on someone else's unrelated PR. The rule, now written down in TestConstants.settleTimeout: **a wait deadline is not a latency budget.** It exists so a genuine hang eventually fails the suite, so size it for the worst-case scheduler, never for how long the operation should take. Waits return as soon as their condition holds, so a generous deadline is free in the passing case and only extends genuine failures. - Every wait helper now defaults to TestConstants.settleTimeout (30s), and the literal wait call sites below the floor were converted too — sixteen sites across ten files. - TestTimingHygieneTests enforces it by scanning the test sources: wait defaults and wait call sites must be at least minimumSettleTimeout, and no test may assert an upper bound on elapsed wall-clock time (the assertion that started this, which cannot separate correct behaviour from a slow machine). - Both rules waive per line with "test-timing-ok: <reason>", accepted on the line or in the comment block above it so the reason has room to be a sentence. One legitimate use so far: a NEGATIVE wait in NoiseCoverageTests asserting a promotion has *not* completed within 50ms, where a long deadline would only make the suite slow while still passing. Injected production timeouts are deliberately not matched — the Noise handshake timeouts are the behaviour under test, and short values are correct there. Verified the guard actually fails: a canary file with both banned shapes was flagged with file and line, and the suite went green again once it was removed. Full suite passes with all 18 cores saturated. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Close the guard's blind spot: named short timeouts A fifth flake landed on CI while the first guard was in review — GossipSyncBoardTests timing out at 1.03s — and the guard did not catch it, because the deadline was `TestConstants.shortTimeout` rather than a literal. A literals-only scan cannot see a short value behind a symbol, which is the more common way it is written: 81 wait sites used shortTimeout (1s) or defaultTimeout (5s), every one of them below the floor. Rather than guess which of those were safe to raise, all 81 were converted and the suite timed. Runtime went 15s -> 72s, which located the genuine negative waits precisely: ten tests that assert something does *not* happen and therefore always run their deadline out. Measurement instead of a heuristic, since a mis-guess in either direction is invisible — too short reintroduces the flake, too long silently costs a minute a run. Those 28 sites now use `TestConstants.negativeWaitWindow`, a named constant whose doc explains the inverted reasoning: for a negative wait, starvation can only make the assertion *more* likely to hold, so short is correct, and the name states the polarity instead of leaving a bare literal that reads like the mistake. Suite is back to 15.3s. The guard now also rejects `timeout: TestConstants.shortTimeout` and `defaultTimeout`, while accepting `negativeWaitWindow` by name. Re-verified with a canary carrying every banned shape — literal default, both named constants, and an elapsed-time upper bound. All four were flagged with file and line; the suite went green again on removal. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Delete shortTimeout now that nothing may use it The hygiene guard bans `TestConstants.shortTimeout` at every wait site and the last users were converted, so Periphery correctly flagged the constant itself as dead and failed CI. Remove it from both TestConstants copies; the banned-name entry stays so the symbol cannot quietly return. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: jack <jackjackbits@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
881 lines
36 KiB
Swift
881 lines
36 KiB
Swift
import Foundation
|
|
import Testing
|
|
import BitFoundation
|
|
@testable import bitchat
|
|
|
|
struct GossipSyncManagerTests {
|
|
|
|
private let myPeerID = PeerID(str: "0102030405060708")
|
|
|
|
@Test func concurrentPacketIntakeAndSyncRequest() async throws {
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
try await confirmation("sync request sent") { sent in
|
|
delegate.onSend = {
|
|
delegate.onSend = nil
|
|
sent()
|
|
}
|
|
|
|
let iterations = 200
|
|
let senderID = try #require(Data(hexString: "1122334455667788"))
|
|
|
|
for i in 0..<iterations {
|
|
let packet = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: senderID,
|
|
recipientID: nil,
|
|
timestamp: 1_000_000 + UInt64(i),
|
|
payload: Data([UInt8(truncatingIfNeeded: i)]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(packet)
|
|
try await sleep(0.001)
|
|
}
|
|
|
|
manager.scheduleInitialSyncToPeer(PeerID(str: "FFFFFFFFFFFFFFFF"), delaySeconds: 0.0)
|
|
try await TestHelpers.waitFor({ delegate.lastPacket != nil }, timeout: TestConstants.settleTimeout)
|
|
}
|
|
|
|
let lastPacket = try #require(delegate.lastPacket, "Expected sync packet to be sent")
|
|
#expect(lastPacket.type == MessageType.requestSync.rawValue)
|
|
#expect(RequestSyncPacket.decode(from: lastPacket.payload) != nil)
|
|
}
|
|
|
|
@Test func staleAnnouncementsArePurgedWithMessages() throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.stalePeerCleanupIntervalSeconds = 0
|
|
config.stalePeerTimeoutSeconds = 5
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let peerHex = "0011223344556677"
|
|
let senderData = try #require(Data(hexString: peerHex))
|
|
let initialTimestampMs = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
|
|
let announcePacket = BitchatPacket(
|
|
type: MessageType.announce.rawValue,
|
|
senderID: senderData,
|
|
recipientID: nil,
|
|
timestamp: initialTimestampMs,
|
|
payload: Data(),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
let messagePacket = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: senderData,
|
|
recipientID: nil,
|
|
timestamp: initialTimestampMs,
|
|
payload: Data([0x01]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
manager.onPublicPacketSeen(announcePacket)
|
|
manager.onPublicPacketSeen(messagePacket)
|
|
|
|
// Flush queue without triggering stale cleanup yet
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
#expect(manager._hasAnnouncement(for: PeerID(str: peerHex)))
|
|
#expect(manager._messageCount(for: PeerID(str: peerHex)) == 1)
|
|
|
|
// Run cleanup past the timeout
|
|
let future = Date().addingTimeInterval(config.stalePeerTimeoutSeconds + 1)
|
|
manager._performMaintenanceSynchronously(now: future)
|
|
#expect(manager._hasAnnouncement(for: PeerID(str: peerHex)) == false)
|
|
#expect(manager._messageCount(for: PeerID(str: peerHex)) == 0)
|
|
}
|
|
|
|
@Test func removePublicMessagesPurgesOnlyThatSender() throws {
|
|
// Block-time archive hygiene: purging a blocked sender's carried
|
|
// public messages must not touch other senders' messages or the
|
|
// blocked sender's announcement.
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, requestSyncManager: requestSyncManager)
|
|
let blockedHex = "00112233445566aa"
|
|
let otherHex = "00112233445566bb"
|
|
let blockedData = try #require(Data(hexString: blockedHex))
|
|
let otherData = try #require(Data(hexString: otherHex))
|
|
let nowMs = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
|
|
manager.onPublicPacketSeen(BitchatPacket(
|
|
type: MessageType.announce.rawValue,
|
|
senderID: blockedData,
|
|
recipientID: nil,
|
|
timestamp: nowMs,
|
|
payload: Data(),
|
|
signature: nil,
|
|
ttl: 1
|
|
))
|
|
for (index, sender) in [blockedData, blockedData, otherData].enumerated() {
|
|
manager.onPublicPacketSeen(BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: nowMs + UInt64(index),
|
|
payload: Data([UInt8(index)]),
|
|
signature: nil,
|
|
ttl: 1
|
|
))
|
|
}
|
|
#expect(manager._messageCount(for: PeerID(str: blockedHex)) == 2)
|
|
|
|
manager.removePublicMessages(from: PeerID(str: blockedHex))
|
|
|
|
#expect(manager._messageCount(for: PeerID(str: blockedHex)) == 0)
|
|
#expect(manager._messageCount(for: PeerID(str: otherHex)) == 1)
|
|
#expect(manager._hasAnnouncement(for: PeerID(str: blockedHex)))
|
|
}
|
|
|
|
@Test func ignoresAnnounceOlderThanStaleTimeout() throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.stalePeerTimeoutSeconds = 5
|
|
config.maxMessageAgeSeconds = 100
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let peerHex = "8899aabbccddeeff"
|
|
let senderData = try #require(Data(hexString: peerHex))
|
|
let staleTimestampMs = UInt64(Date().addingTimeInterval(-(config.stalePeerTimeoutSeconds + 1)).timeIntervalSince1970 * 1000)
|
|
|
|
let freshMessage = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: senderData,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: Data([0xAA]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(freshMessage)
|
|
|
|
let announcePacket = BitchatPacket(
|
|
type: MessageType.announce.rawValue,
|
|
senderID: senderData,
|
|
recipientID: nil,
|
|
timestamp: staleTimestampMs,
|
|
payload: Data(),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
manager.onPublicPacketSeen(announcePacket)
|
|
|
|
manager._performMaintenanceSynchronously()
|
|
|
|
#expect(manager._hasAnnouncement(for: PeerID(str: peerHex)) == false)
|
|
#expect(manager._messageCount(for: PeerID(str: peerHex)) == 0)
|
|
}
|
|
|
|
@Test func maintenanceEmitsTypedSyncRequests() throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 10
|
|
config.fragmentCapacity = 5
|
|
config.fileTransferCapacity = 4
|
|
config.messageSyncIntervalSeconds = 1
|
|
config.fragmentSyncIntervalSeconds = 1
|
|
config.fileTransferSyncIntervalSeconds = 1
|
|
config.prekeyBundleSyncIntervalSeconds = 1
|
|
config.maintenanceIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "1122334455667788"))
|
|
let now = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
|
|
let announcePacket = BitchatPacket(
|
|
type: MessageType.announce.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: now,
|
|
payload: Data(),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
let messagePacket = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: now,
|
|
payload: Data([0x01]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
let fragmentPacket = BitchatPacket(
|
|
type: MessageType.fragment.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: now,
|
|
payload: Data([0xAA]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
let filePacket = BitchatPacket(
|
|
type: MessageType.fileTransfer.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: now,
|
|
payload: Data([0xBB]),
|
|
signature: nil,
|
|
ttl: 1,
|
|
version: 2
|
|
)
|
|
|
|
manager.onPublicPacketSeen(announcePacket)
|
|
manager.onPublicPacketSeen(messagePacket)
|
|
manager.onPublicPacketSeen(fragmentPacket)
|
|
manager.onPublicPacketSeen(filePacket)
|
|
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
|
|
// One request per due schedule so each type group gets the full
|
|
// filter capacity: publicMessages, fragment, fileTransfer, and
|
|
// prekeyBundle.
|
|
let sentPackets = delegate.packets
|
|
#expect(sentPackets.count == 4)
|
|
let decoded = sentPackets.compactMap { RequestSyncPacket.decode(from: $0.payload) }
|
|
#expect(decoded.count == 4)
|
|
let allTypes = decoded.compactMap(\.types).reduce(SyncTypeFlags(rawValue: 0)) { $0.union($1) }
|
|
#expect(allTypes.contains(.announce))
|
|
#expect(allTypes.contains(.message))
|
|
#expect(allTypes.contains(.fragment))
|
|
#expect(allTypes.contains(.fileTransfer))
|
|
#expect(allTypes.contains(.prekeyBundle))
|
|
#expect(allTypes.contains(.groupMessage))
|
|
// The message schedule also asks for group messages (bit 10);
|
|
// responders that don't know the bit just ignore it.
|
|
#expect(decoded.contains { $0.types == SyncTypeFlags.publicMessages.union(.groupMessage) })
|
|
#expect(decoded.contains { $0.types == .fragment })
|
|
#expect(decoded.contains { $0.types == .fileTransfer })
|
|
#expect(decoded.contains { $0.types == .prekeyBundle })
|
|
}
|
|
|
|
@Test func truncatedFilterCarriesSinceCursor() throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 100
|
|
config.gcsMaxBytes = 32 // caps the filter at 28 IDs (256 bits / 9 bits per element)
|
|
config.messageSyncIntervalSeconds = 1
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.maintenanceIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "1122334455667788"))
|
|
let baseTimestamp = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
let totalMessages = 40
|
|
for i in 0..<totalMessages {
|
|
let packet = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: baseTimestamp + UInt64(i),
|
|
payload: Data([UInt8(truncatingIfNeeded: i)]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(packet)
|
|
}
|
|
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
|
|
let packet = try #require(delegate.packets.first)
|
|
let request = try #require(RequestSyncPacket.decode(from: packet.payload))
|
|
// The store (40) exceeds what the tiny filter can cover, so a cursor
|
|
// must be present. It points at the oldest timestamp the filter
|
|
// actually encodes: the filter covers the newest ~28, and byte-budget
|
|
// trimming can only shrink that further, so the cursor sits at or
|
|
// above baseTimestamp + 12 (= 40 - 28) and below the newest message.
|
|
let since = try #require(request.sinceTimestamp)
|
|
#expect(since >= baseTimestamp + 12)
|
|
#expect(since < baseTimestamp + UInt64(totalMessages))
|
|
}
|
|
|
|
@Test func fullCoverageFilterOmitsSinceCursor() throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 100
|
|
config.messageSyncIntervalSeconds = 1
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.maintenanceIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "1122334455667788"))
|
|
let packet = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: Data([0x01]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(packet)
|
|
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
|
|
let sent = try #require(delegate.packets.first)
|
|
let request = try #require(RequestSyncPacket.decode(from: sent.payload))
|
|
#expect(request.sinceTimestamp == nil)
|
|
}
|
|
|
|
@Test func handleRequestSyncHonorsSinceCursorButAlwaysSendsAnnounces() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 5
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.prekeyBundleSyncIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "aabbccddeeff0011"))
|
|
let nowMs = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
|
|
// Announce older than the cursor: must still be sent (identity is
|
|
// needed to verify everything else).
|
|
let announcePacket = BitchatPacket(
|
|
type: MessageType.announce.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: nowMs - 50_000,
|
|
payload: Data(),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
let oldMessage = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: nowMs - 60_000,
|
|
payload: Data([0x01]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
let newMessage = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: nowMs,
|
|
payload: Data([0x02]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
manager.onPublicPacketSeen(announcePacket)
|
|
manager.onPublicPacketSeen(oldMessage)
|
|
manager.onPublicPacketSeen(newMessage)
|
|
|
|
let peer = PeerID(str: "FFFFFFFFFFFFFFFF")
|
|
let request = RequestSyncPacket(
|
|
p: 7,
|
|
m: 1,
|
|
data: Data(),
|
|
types: .publicMessages,
|
|
sinceTimestamp: nowMs - 30_000
|
|
)
|
|
manager.handleRequestSync(from: peer, request: request)
|
|
|
|
try await TestHelpers.waitFor({ delegate.packets.count == 2 }, timeout: TestConstants.settleTimeout)
|
|
// Barrier: flush the sync queue so a late third packet would be visible.
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
let sentPackets = delegate.packets
|
|
#expect(sentPackets.count == 2)
|
|
#expect(sentPackets.contains { $0.type == MessageType.announce.rawValue })
|
|
let sentMessages = sentPackets.filter { $0.type == MessageType.message.rawValue }
|
|
#expect(sentMessages.count == 1)
|
|
#expect(sentMessages.first?.payload == Data([0x02]))
|
|
#expect(sentPackets.allSatisfy { $0.isRSR })
|
|
}
|
|
|
|
@Test func handleRequestSyncSkipsAnnounceAlreadyInFilter() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.prekeyBundleSyncIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "aabbccddeeff0011"))
|
|
let announcePacket = BitchatPacket(
|
|
type: MessageType.announce.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: Data(),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(announcePacket)
|
|
|
|
// A filter that already contains the announce's canonical ID must
|
|
// suppress the response — this only holds if the responder recomputes
|
|
// the ID the same way the filter was built (the dual-path bug would
|
|
// diff a stored hex string instead).
|
|
let announceID = PacketIdUtil.computeId(announcePacket)
|
|
let params = GCSFilter.buildFilter(ids: [announceID], maxBytes: 256, targetFpr: 0.01)
|
|
let request = RequestSyncPacket(p: params.p, m: params.m, data: params.data, types: .announce)
|
|
|
|
let peer = PeerID(str: "FFFFFFFFFFFFFFFF")
|
|
manager.handleRequestSync(from: peer, request: request)
|
|
// Barrier: the async handler is enqueued, so this sync flush runs after it.
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
#expect(delegate.packets.isEmpty)
|
|
}
|
|
|
|
@Test func handleRequestSyncIsRateLimitedPerPeer() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 5
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.prekeyBundleSyncIntervalSeconds = 0
|
|
config.responseRateLimitMaxResponses = 1
|
|
config.responseRateLimitWindowSeconds = 60
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "aabbccddeeff0011"))
|
|
let messagePacket = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: Data([0x10]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(messagePacket)
|
|
|
|
let peer = PeerID(str: "FFFFFFFFFFFFFFFF")
|
|
let request = RequestSyncPacket(p: 7, m: 1, data: Data(), types: .message)
|
|
manager.handleRequestSync(from: peer, request: request)
|
|
manager.handleRequestSync(from: peer, request: request)
|
|
|
|
try await TestHelpers.waitFor({ delegate.packets.count >= 1 }, timeout: TestConstants.settleTimeout)
|
|
// Barrier: both requests have been processed once this returns.
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
#expect(delegate.packets.count == 1)
|
|
}
|
|
|
|
@Test func initialSyncCoalescesEnabledTypes() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 10
|
|
config.fragmentCapacity = 5
|
|
config.fileTransferCapacity = 4
|
|
config.fragmentSyncIntervalSeconds = 1
|
|
config.fileTransferSyncIntervalSeconds = 1
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
manager.scheduleInitialSyncToPeer(PeerID(str: "FFFFFFFFFFFFFFFF"), delaySeconds: 0.0)
|
|
|
|
try await TestHelpers.waitFor({ delegate.packets.count == 1 }, timeout: TestConstants.settleTimeout)
|
|
let packet = try #require(delegate.packets.first)
|
|
let request = try #require(RequestSyncPacket.decode(from: packet.payload))
|
|
let types = try #require(request.types)
|
|
#expect(types.contains(.announce))
|
|
#expect(types.contains(.message))
|
|
#expect(types.contains(.fragment))
|
|
#expect(types.contains(.fileTransfer))
|
|
#expect(types.contains(.prekeyBundle))
|
|
}
|
|
|
|
@Test func handleRequestSyncHonorsTypeFilter() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.seenCapacity = 5
|
|
config.fragmentCapacity = 5
|
|
config.fileTransferCapacity = 0
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "aabbccddeeff0011"))
|
|
let now = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
|
|
let messagePacket = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: now,
|
|
payload: Data([0x10]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
let fragmentPacket = BitchatPacket(
|
|
type: MessageType.fragment.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: now,
|
|
payload: Data([0x20]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
manager.onPublicPacketSeen(messagePacket)
|
|
manager.onPublicPacketSeen(fragmentPacket)
|
|
|
|
let peer = PeerID(str: "FFFFFFFFFFFFFFFF")
|
|
let request = RequestSyncPacket(p: 4, m: 1, data: Data(), types: .fragment)
|
|
manager.handleRequestSync(from: peer, request: request)
|
|
|
|
try await TestHelpers.waitFor({ delegate.packets.count == 1 }, timeout: TestConstants.settleTimeout)
|
|
let sentPackets = delegate.packets
|
|
#expect(sentPackets.count == 1)
|
|
#expect(sentPackets[0].type == MessageType.fragment.rawValue)
|
|
}
|
|
|
|
// MARK: - Fragment-ID filter (targeted resync)
|
|
|
|
private func makeFragmentPacket(sender: Data, fragmentID: Data, index: UInt16, timestamp: UInt64) -> BitchatPacket {
|
|
// Fragment payload: 8-byte stream ID + index + total + original type.
|
|
var payload = fragmentID
|
|
payload.append(contentsOf: withUnsafeBytes(of: index.bigEndian) { Data($0) })
|
|
payload.append(contentsOf: withUnsafeBytes(of: UInt16(4).bigEndian) { Data($0) })
|
|
payload.append(MessageType.fileTransfer.rawValue)
|
|
payload.append(Data([0xEE]))
|
|
return BitchatPacket(
|
|
type: MessageType.fragment.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: timestamp,
|
|
payload: payload,
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
}
|
|
|
|
@Test func handleRequestSyncHonorsFragmentIdFilter() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.fragmentCapacity = 10
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.prekeyBundleSyncIntervalSeconds = 0
|
|
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
let sender = try #require(Data(hexString: "aabbccddeeff0011"))
|
|
let wantedID = try #require(Data(hexString: "0102030405060708"))
|
|
let otherID = try #require(Data(hexString: "1112131415161718"))
|
|
let nowMs = UInt64(Date().timeIntervalSince1970 * 1000)
|
|
|
|
let wanted = makeFragmentPacket(sender: sender, fragmentID: wantedID, index: 1, timestamp: nowMs - 60_000)
|
|
let other = makeFragmentPacket(sender: sender, fragmentID: otherID, index: 2, timestamp: nowMs)
|
|
manager.onPublicPacketSeen(wanted)
|
|
manager.onPublicPacketSeen(other)
|
|
|
|
// The since-cursor sits after both fragments; without the filter the
|
|
// responder would send nothing for `wanted`. The filter both bypasses
|
|
// the cursor and restricts the diff to exactly the named stream.
|
|
let request = RequestSyncPacket(
|
|
p: 7,
|
|
m: 1,
|
|
data: Data(),
|
|
types: .fragment,
|
|
sinceTimestamp: nowMs + 1,
|
|
fragmentIdFilter: RequestSyncPacket.encodeFragmentIdFilter([wantedID])
|
|
)
|
|
manager.handleRequestSync(from: PeerID(str: "FFFFFFFFFFFFFFFF"), request: request)
|
|
|
|
try await TestHelpers.waitFor({ delegate.packets.count == 1 }, timeout: TestConstants.settleTimeout)
|
|
// Barrier: flush the sync queue so a late second packet would be visible.
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
let sentPackets = delegate.packets
|
|
#expect(sentPackets.count == 1)
|
|
let sent = try #require(sentPackets.first)
|
|
#expect(sent.type == MessageType.fragment.rawValue)
|
|
#expect(sent.payload.prefix(8) == wantedID)
|
|
#expect(sent.ttl == 0)
|
|
#expect(sent.isRSR)
|
|
}
|
|
|
|
@Test func requestMissingFragmentsSendsFilteredRequestToConnectedPeers() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
let requestSyncManager = RequestSyncManager()
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: requestSyncManager)
|
|
let delegate = RecordingDelegate()
|
|
delegate.connectedPeers = [PeerID(str: "FFFFFFFFFFFFFFFF")]
|
|
manager.delegate = delegate
|
|
|
|
let stalledID = try #require(Data(hexString: "0102030405060708"))
|
|
manager.requestMissingFragments(fragmentIDs: [stalledID])
|
|
|
|
try await TestHelpers.waitFor({ delegate.packets.count == 1 }, timeout: TestConstants.settleTimeout)
|
|
let sent = try #require(delegate.packets.first)
|
|
#expect(sent.type == MessageType.requestSync.rawValue)
|
|
#expect(sent.ttl == 0)
|
|
let request = try #require(RequestSyncPacket.decode(from: sent.payload))
|
|
#expect(request.types == .fragment)
|
|
let ids = try #require(RequestSyncPacket.decodeFragmentIdFilter(request.fragmentIdFilter))
|
|
#expect(ids == Set([stalledID]))
|
|
}
|
|
|
|
@Test func prekeyBundlesServeSyncAndSurviveStalePeerCleanup() async throws {
|
|
var config = GossipSyncManager.Config()
|
|
config.messageSyncIntervalSeconds = 0
|
|
config.fragmentSyncIntervalSeconds = 0
|
|
config.fileTransferSyncIntervalSeconds = 0
|
|
config.prekeyBundleSyncIntervalSeconds = 0
|
|
config.stalePeerCleanupIntervalSeconds = 0
|
|
config.stalePeerTimeoutSeconds = 5
|
|
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, config: config, requestSyncManager: RequestSyncManager())
|
|
let delegate = RecordingDelegate()
|
|
manager.delegate = delegate
|
|
|
|
// Bundles are keyed by their authenticated identity (the noise static
|
|
// key), not the packet senderID, so the payload must be a real bundle.
|
|
let noiseKey = Data(repeating: 0xAB, count: 32)
|
|
let senderPeer = PeerID(publicKey: noiseKey)
|
|
let sender = try #require(Data(hexString: senderPeer.id))
|
|
let bundle = PrekeyBundle(
|
|
noiseStaticPublicKey: noiseKey,
|
|
prekeys: [PrekeyBundle.Prekey(id: 0, publicKey: Data(repeating: 0x11, count: 32))],
|
|
generatedAt: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
signature: Data(count: PrekeyBundle.signatureLength)
|
|
)
|
|
let bundlePacket = BitchatPacket(
|
|
type: MessageType.prekeyBundle.rawValue,
|
|
senderID: sender,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: try #require(bundle.encode()),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(bundlePacket)
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
#expect(manager._hasPrekeyBundle(for: senderPeer))
|
|
|
|
// Bundles outlive the owner's announce: a leave plus stale cleanup
|
|
// must not drop them (they exist to reach offline owners).
|
|
manager.removeAnnouncementForPeer(senderPeer)
|
|
manager._performMaintenanceSynchronously(now: Date().addingTimeInterval(config.stalePeerTimeoutSeconds + 1))
|
|
#expect(manager._hasPrekeyBundle(for: senderPeer))
|
|
|
|
// And a .prekeyBundle sync request is answered with the stored packet.
|
|
let request = RequestSyncPacket(p: 7, m: 1, data: Data(), types: .prekeyBundle)
|
|
manager.handleRequestSync(from: PeerID(str: "FFFFFFFFFFFFFFFF"), request: request)
|
|
try await TestHelpers.waitFor({ delegate.packets.count == 1 }, timeout: TestConstants.settleTimeout)
|
|
let served = try #require(delegate.packets.first)
|
|
#expect(served.type == MessageType.prekeyBundle.rawValue)
|
|
#expect(served.isRSR)
|
|
}
|
|
|
|
@Test func prekeyBundleGossipIsKeyedByOwnerNotSenderID() {
|
|
// One valid bundle re-broadcast under many fabricated sender IDs must
|
|
// collapse to a single entry keyed by the bundle's own identity — the
|
|
// spray-to-exhaust-the-cap DoS produces one entry, not N.
|
|
let manager = GossipSyncManager(myPeerID: myPeerID, requestSyncManager: RequestSyncManager())
|
|
let noiseKey = Data(repeating: 0xCD, count: 32)
|
|
let ownerPeer = PeerID(publicKey: noiseKey)
|
|
let bundle = PrekeyBundle(
|
|
noiseStaticPublicKey: noiseKey,
|
|
prekeys: [PrekeyBundle.Prekey(id: 0, publicKey: Data(repeating: 0x22, count: 32))],
|
|
generatedAt: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
signature: Data(count: PrekeyBundle.signatureLength)
|
|
)
|
|
guard let payload = bundle.encode() else { return }
|
|
|
|
for i in 0..<5 {
|
|
let fakeSender = Data((0..<8).map { j in UInt8(truncatingIfNeeded: i * 31 + j) })
|
|
let packet = BitchatPacket(
|
|
type: MessageType.prekeyBundle.rawValue,
|
|
senderID: fakeSender,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000) + UInt64(i),
|
|
payload: payload,
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
manager.onPublicPacketSeen(packet)
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
// No fabricated sender ID ever creates its own entry.
|
|
#expect(!manager._hasPrekeyBundle(for: PeerID(hexData: fakeSender)))
|
|
}
|
|
// Exactly the owner-keyed entry exists.
|
|
#expect(manager._hasPrekeyBundle(for: ownerPeer))
|
|
}
|
|
|
|
// MARK: - Archive persistence
|
|
|
|
@Test func publicMessagesRestoreFromArchiveAcrossRestart() async throws {
|
|
let fileURL = FileManager.default.temporaryDirectory
|
|
.appendingPathComponent("gossip-archive-\(UUID().uuidString).json")
|
|
defer { try? FileManager.default.removeItem(at: fileURL) }
|
|
|
|
let senderID = try #require(Data(hexString: "1122334455667788"))
|
|
let packet = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: senderID,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: Data([0x01, 0x02]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
let first = GossipSyncManager(
|
|
myPeerID: myPeerID,
|
|
requestSyncManager: RequestSyncManager(),
|
|
archive: GossipMessageArchive(fileURL: fileURL)
|
|
)
|
|
first.onPublicPacketSeen(packet)
|
|
// Maintenance persists the dirty store to disk.
|
|
first._performMaintenanceSynchronously(now: Date())
|
|
#expect(FileManager.default.fileExists(atPath: fileURL.path))
|
|
|
|
// "App restart": a fresh manager over the same archive re-serves it.
|
|
let second = GossipSyncManager(
|
|
myPeerID: myPeerID,
|
|
requestSyncManager: RequestSyncManager(),
|
|
archive: GossipMessageArchive(fileURL: fileURL)
|
|
)
|
|
let restored = await TestHelpers.waitUntil(
|
|
{ second._messageCount(for: PeerID(hexData: senderID)) == 1 },
|
|
timeout: TestConstants.settleTimeout
|
|
)
|
|
#expect(restored)
|
|
}
|
|
|
|
@Test func archiveDropsMessagesOlderThanPublicWindow() throws {
|
|
let fileURL = FileManager.default.temporaryDirectory
|
|
.appendingPathComponent("gossip-archive-\(UUID().uuidString).json")
|
|
defer { try? FileManager.default.removeItem(at: fileURL) }
|
|
|
|
var config = GossipSyncManager.Config()
|
|
config.publicMessageMaxAgeSeconds = 60
|
|
|
|
let senderID = try #require(Data(hexString: "1122334455667788"))
|
|
let stale = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: senderID,
|
|
recipientID: nil,
|
|
timestamp: UInt64((Date().timeIntervalSince1970 - 120) * 1000),
|
|
payload: Data([0x01]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
let archive = GossipMessageArchive(fileURL: fileURL)
|
|
archive.save([stale.toBinaryData(padding: false)!])
|
|
|
|
let manager = GossipSyncManager(
|
|
myPeerID: myPeerID,
|
|
config: config,
|
|
requestSyncManager: RequestSyncManager(),
|
|
archive: archive
|
|
)
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
#expect(manager._messageCount(for: PeerID(hexData: senderID)) == 0)
|
|
}
|
|
|
|
/// Clearing the mesh timeline must leave nothing behind on disk: a
|
|
/// relaunch that restored the archive would undo the clear.
|
|
@Test func removeAllPublicMessagesErasesTheArchiveOnDisk() async throws {
|
|
let fileURL = FileManager.default.temporaryDirectory
|
|
.appendingPathComponent("gossip-archive-\(UUID().uuidString).json")
|
|
defer { try? FileManager.default.removeItem(at: fileURL) }
|
|
|
|
let senderID = try #require(Data(hexString: "1122334455667788"))
|
|
let packet = BitchatPacket(
|
|
type: MessageType.message.rawValue,
|
|
senderID: senderID,
|
|
recipientID: nil,
|
|
timestamp: UInt64(Date().timeIntervalSince1970 * 1000),
|
|
payload: Data([0x01, 0x02]),
|
|
signature: nil,
|
|
ttl: 1
|
|
)
|
|
|
|
let manager = GossipSyncManager(
|
|
myPeerID: myPeerID,
|
|
requestSyncManager: RequestSyncManager(),
|
|
archive: GossipMessageArchive(fileURL: fileURL)
|
|
)
|
|
manager.onPublicPacketSeen(packet)
|
|
manager._performMaintenanceSynchronously(now: Date())
|
|
#expect(FileManager.default.fileExists(atPath: fileURL.path))
|
|
|
|
manager.removeAllPublicMessages()
|
|
|
|
let erased = await TestHelpers.waitUntil(
|
|
{
|
|
!FileManager.default.fileExists(atPath: fileURL.path)
|
|
&& manager._messageCount(for: PeerID(hexData: senderID)) == 0
|
|
},
|
|
timeout: TestConstants.settleTimeout
|
|
)
|
|
#expect(erased)
|
|
}
|
|
|
|
}
|
|
|
|
private final class RecordingDelegate: GossipSyncManager.Delegate {
|
|
var onSend: (() -> Void)?
|
|
var connectedPeers: [PeerID] = []
|
|
private(set) var lastPacket: BitchatPacket?
|
|
private(set) var packets: [BitchatPacket] = []
|
|
private let lock = NSLock()
|
|
|
|
func sendPacket(_ packet: BitchatPacket) {
|
|
lock.lock()
|
|
lastPacket = packet
|
|
packets.append(packet)
|
|
lock.unlock()
|
|
onSend?()
|
|
}
|
|
|
|
func sendPacket(to peerID: PeerID, packet: BitchatPacket) {
|
|
sendPacket(packet)
|
|
}
|
|
|
|
func signPacketForBroadcast(_ packet: BitchatPacket) -> BitchatPacket {
|
|
packet
|
|
}
|
|
|
|
func getConnectedPeers() -> [PeerID] {
|
|
return connectedPeers
|
|
}
|
|
}
|