Repository navigation
Expand file tree
/
Copy pathPrivatePaykitServiceTests.swift
More file actions
3103 lines (2935 loc) · 149 KB
/
Copy pathPrivatePaykitServiceTests.swift
File metadata and controls
3103 lines (2935 loc) · 149 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
@testable import Bitkit
import Paykit
import XCTest
final class PrivatePaykitServiceTests: XCTestCase {
override func setUp() {
super.setUp()
// Constructing `PrivatePaykitService` and mutating it writes the real cache state, injecting
// fake contacts and invoices into the user's own and flagging the wallet backup dirty. It also
// reaches `PrivatePaykitAddressReservationStore`, which persists its own ledger and removes the
// receive address outright — more keys than are worth enumerating, so snapshot the domain.
snapshotAppDefaultsDomain()
}
func testPrivateMessageDrainKeysRespectLinkStateAndPendingOutbound() {
let peers: [String: LinkedPeerState] = [
"idle": .linked, "pending": .linked, "new": .notLinked,
"linking": .linking, "recovering": .recoveryRequired,
"blocked": .blocked, "unknown": .unknown,
]
let keys = Set(peers.keys).union(["missing", "missing-pending"])
let outbound: Set = ["pending", "missing-pending", "blocked", "unknown", "unrelated"]
for retryMissingPeers in [false, true] {
let pending = PrivatePaykitService.pendingPrivateMessageDrainKeys(
keys, linkedPeers: peers, pendingOutbound: outbound, retryMissingPeers: retryMissingPeers
)
var expected: Set = ["pending", "missing-pending", "new", "linking", "recovering"]
if retryMissingPeers { expected.insert("missing") }
XCTAssertEqual(pending, expected)
}
}
func testNewPeerWakesRetryTimerWithoutInheritingOlderPeerBackoff() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let oldKey = "pubky" + String(repeating: "y", count: 52)
let newKey = "pubky3rsduhcxpw74snwyct86m38c63j3pq8x4ycqikxg64roik8yw5xg"
let now = Date(timeIntervalSince1970: 100)
let oldSleep = expectation(description: "Older peer waits ninety seconds")
let newSleep = expectation(description: "New peer waits only one second")
let linked = expectation(description: "Explicit peer completes targeted intake")
var sleepDelays: [UInt64] = []
var advanced = false
var priorities: [PaykitSdkOperationLock.Priority] = []
var peerReads = 0
var outboundReads = 0
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
sleepDelays.append(delay)
if sleepDelays.count == 1 { oldSleep.fulfill() }
if sleepDelays.count == 2 { newSleep.fulfill() }
try await Task.sleep(for: .seconds(3600))
},
currentPublicKey: { _ in "identity" },
drain: { priority in
priorities.append(priority)
return .init(
ensureLink: { key in XCTAssertEqual(key, newKey); advanced = true },
pendingOutbound: { outboundReads += 1; return [] },
linkedPeers: {
peerReads += 1
return [self.drainPeer(newKey, state: advanced ? .linked : .linking)]
},
processPending: { _ in XCTFail("No outbound messages") },
receive: { XCTAssertEqual($0, newKey) }
)
},
didLink: { identity, key in
XCTAssertEqual(identity, "identity")
XCTAssertEqual(key, newKey)
linked.fulfill()
}
))
_ = await service.rememberSavedContacts([oldKey, newKey], replacing: true)
await service.setTestRetry(.init(nextAttemptAt: now.addingTimeInterval(90), retryIndex: 5), for: oldKey)
await service.schedulePrivatePaymentRecovery(for: oldKey)
await fulfillment(of: [oldSleep], timeout: 2)
await service.schedulePrivatePaymentRecovery(for: newKey)
await fulfillment(of: [newSleep], timeout: 2)
XCTAssertEqual(Array(sleepDelays.prefix(2)), [90_000_000_000, 1_000_000_000])
await service.scheduleExplicitContactLink(publicKey: newKey, identity: "identity")
await fulfillment(of: [linked], timeout: 2)
let olderRetry = await service.pendingMessageDrainRetries[oldKey]
XCTAssertEqual(olderRetry?.nextAttemptAt, now.addingTimeInterval(90))
XCTAssertEqual(olderRetry?.retryIndex, 5)
XCTAssertFalse(priorities.isEmpty)
XCTAssertTrue(priorities.allSatisfy { $0 == .interactive })
XCTAssertEqual(peerReads, 3)
XCTAssertEqual(outboundReads, 2)
await service.invalidateContactPreparation()
}
func testExplicitRetryRetiresMissingPeerDuringCooldown() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
let otherKey = "pubky3rsduhcxpw74snwyct86m38c63j3pq8x4ycqikxg64roik8yw5xg"
for hasPendingOutbound in [false, true] {
var now = Date(timeIntervalSince1970: 100)
var handshakes = 0
var deliveries = 0
var sleeps = 0
let settled = expectation(description: "Retry retires or reaches the longest backoff")
settled.assertForOverFulfill = false
let (resume, continuation) = AsyncStream<Void>.makeStream()
defer { continuation.finish() }
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
sleeps += 1
now = now.addingTimeInterval(TimeInterval(delay) / 1_000_000_000)
if sleeps == 6 {
settled.fulfill()
for await _ in resume {}
}
},
currentPublicKey: { _ in "identity" },
drain: { _ in
.init(
ensureLink: { _ in
handshakes += 1
throw PaykitError.NotFound(code: "not_found", context: "No App Registry")
},
pendingOutbound: { hasPendingOutbound ? [key, otherKey] : [otherKey] },
linkedPeers: { [self.drainPeer(key, state: .notLinked)] },
processPending: { _ in deliveries += 1 },
receive: { _ in XCTFail("No linked peer") }
)
},
didLink: { _, _ in XCTFail("Missing peer cannot link") }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let task = await service.pendingMessageDrainRetryTask
let completion = Task { await task?.value; settled.fulfill() }
await fulfillment(of: [settled], timeout: 2)
let retry = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(retry != nil, hasPendingOutbound)
XCTAssertEqual(deliveries > 0, hasPendingOutbound)
XCTAssertEqual(handshakes, 1)
await service.invalidateContactPreparation()
continuation.finish()
await completion.value
}
}
func testMissingPeerRetiresAfterQueuedDeliveryDrains() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
var now = Date(timeIntervalSince1970: 100)
var handshakes = 0
var deliveries = 0
var sleeps = 0
var hasPendingOutbound = true
var readFailed = false
var confirmedEmpty = false
var failIdentityInspection = false
var identityInspectionFailed = false
let settled = expectation(description: "Queued delivery drains and retry retires")
settled.assertForOverFulfill = false
let (resume, continuation) = AsyncStream<Void>.makeStream()
defer { continuation.finish() }
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
sleeps += 1
now = now.addingTimeInterval(TimeInterval(delay) / 1_000_000_000)
if sleeps == 6 {
settled.fulfill()
for await _ in resume {}
}
},
currentPublicKey: { _ in
if failIdentityInspection {
failIdentityInspection = false
identityInspectionFailed = true
throw PaykitError.Transport(code: "offline", context: "Unavailable homeserver")
}
return "identity"
},
drain: { _ in
.init(
ensureLink: { _ in
handshakes += 1
failIdentityInspection = true
throw PaykitError.NotFound(code: "not_found", context: "No App Registry")
},
pendingOutbound: {
if deliveries == 2, !readFailed {
readFailed = true
throw PaykitError.Transport(code: "offline", context: "Unavailable homeserver")
}
if readFailed { confirmedEmpty = !hasPendingOutbound }
return hasPendingOutbound ? [key] : []
},
linkedPeers: { [self.drainPeer(key, state: .notLinked)] },
processPending: {
XCTAssertEqual($0, key)
deliveries += 1
if deliveries == 1 {
throw PaykitError.Transport(code: "offline", context: "Unavailable homeserver")
}
hasPendingOutbound = false
},
receive: { _ in XCTFail("No linked peer") }
)
},
didLink: { _, _ in XCTFail("Missing peer cannot link") }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let task = await service.pendingMessageDrainRetryTask
let completion = Task { await task?.value; settled.fulfill() }
await fulfillment(of: [settled], timeout: 2)
let retry = await service.pendingMessageDrainRetries[key]
XCTAssertNil(retry)
XCTAssertEqual(handshakes, 1)
XCTAssertEqual(deliveries, 2)
XCTAssertTrue(readFailed)
XCTAssertTrue(confirmedEmpty)
XCTAssertTrue(identityInspectionFailed)
XCTAssertFalse(hasPendingOutbound)
await service.invalidateContactPreparation()
continuation.finish()
await completion.value
}
func testExplicitRetrySurvivesTransportCooldown() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
var now = Date(timeIntervalSince1970: 100)
var handshakes = 0
var publicationHandshakes = 0
var sleeps = 0
var armCooldown: (() async -> Void)?
let settled = expectation(description: "Retry retires or reaches the expired cooldown")
settled.assertForOverFulfill = false
let (resume, continuation) = AsyncStream<Void>.makeStream()
defer { continuation.finish() }
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
sleeps += 1
if sleeps == 1 { await armCooldown?() }
now = now.addingTimeInterval(TimeInterval(delay) / 1_000_000_000)
if handshakes >= 2 || sleeps == 12 {
settled.fulfill()
for await _ in resume {}
}
},
currentPublicKey: { _ in "identity" },
drain: { _ in
.init(
ensureLink: { _ in
handshakes += 1
throw PaykitError.Transport(code: "offline", context: "Unavailable homeserver")
},
pendingOutbound: { [] }, linkedPeers: { [] },
processPending: { _ in XCTFail("No outbound messages") },
receive: { _ in XCTFail("No linked peer") }
)
},
didLink: { _, _ in XCTFail("Unreachable peer cannot link") }
))
_ = await service.rememberSavedContacts([key], replacing: true)
armCooldown = {
_ = await service.syncLocalEndpointPublication(
for: [key], reason: "test", requireImmediatePublication: false,
operations: .init(
currentPublicKey: { "pubkylocal" },
ensureLink: { _ in
publicationHandshakes += 1
throw PaykitError.Transport(code: "offline", context: "Unavailable homeserver")
},
buildEndpoints: { _ in XCTFail("Failed links must not reserve addresses"); return [] },
syncPaymentLists: { _ in .init(queued: [], cleared: [], failedToQueue: [], failedToDeliver: []) },
linkedPeers: { [] }
)
)
}
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let task = await service.pendingMessageDrainRetryTask
let completion = Task { await task?.value; settled.fulfill() }
await fulfillment(of: [settled], timeout: 2)
let retry = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(publicationHandshakes, 1)
XCTAssertNotNil(retry)
XCTAssertEqual(handshakes, 2)
await service.invalidateContactPreparation()
continuation.finish()
await completion.value
}
func testExplicitRetryCoalescesIdentityChecksWithoutReusingAcrossReads() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
for changedDuring in ["none", "peers", "outbound"] {
var identity = "identity"
var identityReads = 0
var receives = 0
var completions = 0
let service = PrivatePaykitService(messageRetryOperations: .init(
currentPublicKey: { _ in identityReads += 1; return identity },
drain: { _ in
.init(
ensureLink: { _ in XCTFail("Already linked") },
pendingOutbound: {
if changedDuring == "outbound" { identity = "other" }
return []
},
linkedPeers: {
if changedDuring == "peers" { identity = "other" }
return [self.drainPeer(key)]
},
processPending: { _ in XCTFail("No outbound messages") },
receive: { _ in receives += 1 }
)
},
didLink: { _, _ in completions += 1 }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: identity)
let task = await service.pendingMessageDrainRetryTask
await task?.value
XCTAssertEqual(receives, changedDuring == "none" ? 1 : 0)
XCTAssertEqual(completions, changedDuring == "none" ? 1 : 0)
if changedDuring == "none" { XCTAssertLessThanOrEqual(identityReads, 7) }
await service.invalidateContactPreparation()
}
}
func testExplicitRetryBacksOffIdentityInspectionFailuresAndRecoversAfterAdmittedWrite() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
let startedAt = Date(timeIntervalSince1970: 100)
var now = startedAt
var inspectionFails = true
var sent = false
var receives = 0
var delays: [UInt64] = []
let firstBackoff = expectation(description: "Initial inspection failure backs off")
let secondBackoff = expectation(description: "Post-write inspection failure backs off")
let completed = expectation(description: "Recovered identity completes intake")
let (firstResume, firstContinuation) = AsyncStream<Void>.makeStream()
let (secondResume, secondContinuation) = AsyncStream<Void>.makeStream()
defer { firstContinuation.finish(); secondContinuation.finish() }
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
delays.append(delay)
if delays.count == 1 {
firstBackoff.fulfill()
for await _ in firstResume {}
} else {
secondBackoff.fulfill()
for await _ in secondResume {}
}
now = now.addingTimeInterval(TimeInterval(delay) / 1_000_000_000)
},
currentPublicKey: { _ in
if inspectionFails { throw PaykitError.Transport(code: "offline", context: "Registry unavailable") }
return "identity"
},
drain: { _ in
XCTAssertFalse(inspectionFails)
return .init(
ensureLink: { _ in XCTFail("Peer is already linked") },
pendingOutbound: { sent ? [] : [key] },
linkedPeers: { [self.drainPeer(key)] },
processPending: { _ in
XCTAssertFalse(sent)
sent = true
inspectionFails = true
},
receive: { _ in receives += 1 }
)
},
didLink: { _, _ in completed.fulfill() }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
await fulfillment(of: [firstBackoff], timeout: 2)
let initial = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(initial?.nextAttemptAt, startedAt.addingTimeInterval(1))
XCTAssertFalse(sent)
inspectionFails = false
firstContinuation.finish()
await fulfillment(of: [secondBackoff], timeout: 2)
let retained = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(retained?.id, initial?.id)
XCTAssertEqual(retained?.foregroundUntil, startedAt.addingTimeInterval(20))
XCTAssertEqual(retained?.nextAttemptAt, startedAt.addingTimeInterval(4))
XCTAssertEqual(delays, [1_000_000_000, 3_000_000_000])
XCTAssertTrue(sent)
XCTAssertEqual(receives, 0)
inspectionFails = false
let task = await service.pendingMessageDrainRetryTask
secondContinuation.finish()
await fulfillment(of: [completed], timeout: 2)
await task?.value
XCTAssertEqual(receives, 1)
let remaining = await service.pendingMessageDrainRetries[key]
XCTAssertNil(remaining)
await service.invalidateContactPreparation()
}
@MainActor
func testExplicitLinkStartRetainsIntentWhenIdentityInspectionFails() async throws {
PrivatePaykitService.setContactSharingCleanupPending(false)
UserDefaults.standard.set(true, forKey: PaykitFeatureFlags.uiEnabledKey)
let savedSecret = try Keychain.load(key: .pubkySecretKey)
addTeardownBlock {
if let savedSecret {
try Keychain.upsert(key: .pubkySecretKey, data: savedSecret)
} else {
try Keychain.delete(key: .pubkySecretKey)
}
}
let secret = String(repeating: "01", count: 32)
try Keychain.upsert(key: .pubkySecretKey, data: Data(secret.utf8))
let identity = try XCTUnwrap(PubkyPublicKeyFormat.normalized(PubkyService.pubkyPublicKeyFromSecret(secretKeyHex: secret)))
let key = "pubky" + String(repeating: "y", count: 52)
let inspected = expectation(description: "Preparation and retry inspect identity")
inspected.expectedFulfillmentCount = 2
let backedOff = expectation(description: "Explicit intent remains scheduled")
let now = Date(timeIntervalSince1970: 100)
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
XCTAssertEqual(delay, 1_000_000_000)
backedOff.fulfill()
try await Task.sleep(for: .seconds(3600))
},
currentPublicKey: { _ in
inspected.fulfill()
throw PaykitError.Transport(code: "offline", context: "Registry unavailable")
},
drain: { _ in XCTFail("Unverified identity must not drain"); return .live() }
))
await service.startExplicitContactLink(publicKey: key, expectedIdentity: identity, wallet: WalletViewModel())
await fulfillment(of: [inspected, backedOff], timeout: 2)
let retry = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(retry?.expectedIdentity, identity)
XCTAssertEqual(retry?.foregroundUntil, now.addingTimeInterval(20))
XCTAssertEqual(retry?.nextAttemptAt, now.addingTimeInterval(1))
let preparation = await service.preparationTask
XCTAssertNil(preparation)
let task = await service.pendingMessageDrainRetryTask
await service.invalidateContactPreparation()
await task?.value
}
func testExplicitRetryRetainsFailedIntakeUntilRecoveryOrForegroundExpiry() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
for expires in [false, true] {
let key = "pubky" + String(repeating: "y", count: 52)
let startedAt = Date(timeIntervalSince1970: 100)
var now = startedAt
var receiveFails = true
var priorities: [PaykitSdkOperationLock.Priority] = []
let backedOff = expectation(description: "Failed intake remains scheduled")
let completed = expectation(description: "Only successful foreground intake signals readiness")
completed.isInverted = expires
let (resume, continuation) = AsyncStream<Void>.makeStream()
defer { continuation.finish() }
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
XCTAssertEqual(delay, 1_000_000_000)
backedOff.fulfill()
for await _ in resume {}
},
currentPublicKey: { _ in "identity" },
drain: { priority in
.init(
ensureLink: { _ in XCTFail("Peer is already linked") }, pendingOutbound: { [] },
linkedPeers: { [self.drainPeer(key)] },
processPending: { _ in XCTFail("No outbound messages") },
receive: { _ in
priorities.append(priority)
if receiveFails { throw PaykitError.Transport(code: "offline", context: "Intake unavailable") }
}
)
},
didLink: { _, _ in completed.fulfill() }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
await fulfillment(of: [backedOff], timeout: 2)
let retry = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(retry?.foregroundUntil, startedAt.addingTimeInterval(20))
XCTAssertEqual(retry?.nextAttemptAt, startedAt.addingTimeInterval(1))
now = startedAt.addingTimeInterval(expires ? 20 : 1)
receiveFails = expires
let task = await service.pendingMessageDrainRetryTask
continuation.finish()
await task?.value
await fulfillment(of: [completed], timeout: expires ? 0.1 : 2)
XCTAssertEqual(priorities, [.interactive, expires ? .background : .interactive])
let remaining = await service.pendingMessageDrainRetries[key]
XCTAssertNil(remaining)
await service.invalidateContactPreparation()
}
}
func testRecoveredMissingPeerRetriesFailedIntake() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
var now = Date(timeIntervalSince1970: 100)
var linked = false
var pending = true
var receives = 0
var completions = 0
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
now = now.addingTimeInterval(TimeInterval(delay) / 1_000_000_000)
linked = true
},
currentPublicKey: { _ in "identity" },
drain: { _ in
.init(
ensureLink: { _ in throw PaykitError.NotFound(code: "missing", context: "Peer unavailable") },
pendingOutbound: { pending ? [key] : [] },
linkedPeers: { [self.drainPeer(key, state: linked ? .linked : .notLinked)] },
processPending: { _ in
guard linked else { throw PaykitError.Transport(code: "offline", context: "Delivery unavailable") }
pending = false
},
receive: { _ in
receives += 1
if receives == 1 { throw PaykitError.Transport(code: "offline", context: "Intake unavailable") }
}
)
},
didLink: { _, _ in completions += 1 }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let task = await service.pendingMessageDrainRetryTask
await task?.value
XCTAssertFalse(pending)
XCTAssertEqual(receives, 2)
XCTAssertEqual(completions, 1)
let remaining = await service.pendingMessageDrainRetries[key]
XCTAssertNil(remaining)
await service.invalidateContactPreparation()
}
func testExplicitLinkWindowUsesExistingBackoffAndDoesNotExtendOnDuplicate() async throws {
PrivatePaykitService.setContactSharingCleanupPending(false)
let now = Date(timeIntervalSince1970: 100)
let key = "pubky" + String(repeating: "y", count: 52)
let service = PrivatePaykitService(messageRetryOperations: .init(now: { now }))
await service.setBackgroundWorkPaused(true)
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let initial = await service.pendingMessageDrainRetries[key]
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
await service.schedulePrivatePaymentRecovery(for: key)
let repeated = await service.pendingMessageDrainRetries[key]
XCTAssertEqual(initial?.id, repeated?.id)
XCTAssertEqual(repeated?.foregroundUntil, now.addingTimeInterval(20))
XCTAssertEqual(repeated?.nextAttemptAt, now)
var retry = try XCTUnwrap(initial)
for (completedAt, nextAt) in [(0.0, 1.0), (1, 4), (4, 12), (12, 32), (32, 77), (77, 167)] {
retry.completeAttempt(at: now.addingTimeInterval(completedAt))
XCTAssertEqual(retry.nextAttemptAt, now.addingTimeInterval(nextAt))
}
XCTAssertEqual(retry.priority(at: now.addingTimeInterval(19)), .interactive)
XCTAssertEqual(retry.priority(at: now.addingTimeInterval(20)), .background)
await service.invalidateContactPreparation()
}
func testExplicitLinkJoinsAdmittedPreparationAndCoalescesCompletion() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
let started = expectation(description: "Preparation admitted")
let completed = expectation(description: "One targeted completion")
let (resume, continuation) = AsyncStream<Void>.makeStream()
defer { continuation.finish() }
var advances = 0
var linked = false
var receives = 0
let operations = PrivatePaykitService.PrivateMessageDrainOperations(
ensureLink: { _ in
advances += 1
started.fulfill()
for await _ in resume {}
XCTAssertFalse(Task.isCancelled)
linked = true
},
pendingOutbound: { [] },
linkedPeers: { [self.drainPeer(key, state: linked ? .linked : .linking)] },
processPending: { _ in },
receive: { _ in receives += 1 }
)
let service = PrivatePaykitService(messageRetryOperations: .init(
currentPublicKey: { _ in "identity" }, drain: { _ in operations }, didLink: { _, _ in completed.fulfill() }
))
_ = await service.rememberSavedContacts([key], replacing: true)
let preparation = Task {
await service.drainPendingPrivateMessages(reason: "preparation", advancing: [key], operations: operations)
}
await fulfillment(of: [started], timeout: 2)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let caller = Task { await service.schedulePrivatePaymentRecovery(for: key) }
caller.cancel()
await caller.value
continuation.finish()
await preparation.value
await fulfillment(of: [completed], timeout: 2)
XCTAssertEqual(advances, 1)
XCTAssertGreaterThan(receives, 0)
await service.invalidateContactPreparation()
}
func testExplicitRetryPausesAfterAdmittedWriteAndRejectsStaleIdentity() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
for change in ["resume", "expired", "identity", "generation", "deletion", "contact"] {
let key = "pubky" + String(repeating: "y", count: 52)
let admitted = expectation(description: "Write admitted")
let finished = expectation(description: "Admitted write finishes")
let ready = expectation(description: "Current identity is refreshed")
ready.isInverted = change != "resume"
let (resume, continuation) = AsyncStream<Void>.makeStream()
var identity = "identity"
var sent = false
var now = Date(timeIntervalSince1970: 100)
var laterPriorities: [PaykitSdkOperationLock.Priority] = []
let operations = PrivatePaykitService.PrivateMessageDrainOperations(
ensureLink: { _ in }, pendingOutbound: { sent ? [] : [key] },
linkedPeers: { [self.drainPeer(key)] },
processPending: { _ in
admitted.fulfill()
for await _ in resume {}
XCTAssertFalse(Task.isCancelled)
sent = true
finished.fulfill()
},
receive: { _ in XCTAssertTrue(change == "resume" || change == "expired") }
)
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now }, currentPublicKey: { _ in identity },
drain: { priority in
if sent { laterPriorities.append(priority) }
return operations
}, didLink: { _, _ in ready.fulfill() }
))
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: identity)
await fulfillment(of: [admitted], timeout: 2)
await service.setBackgroundWorkPaused(true)
continuation.finish()
await fulfillment(of: [finished], timeout: 2)
switch change {
case "expired": now = now.addingTimeInterval(20)
case "identity": identity = "other"
case "generation": await service.invalidateContactPreparation()
case "deletion": await service.beginProfileDeletion()
case "contact": _ = await service.rememberSavedContacts([], replacing: true)
default: break
}
await service.setBackgroundWorkPaused(false)
await fulfillment(of: [ready], timeout: change == "resume" ? 2 : 0.1)
if change == "expired" {
XCTAssertFalse(laterPriorities.isEmpty)
XCTAssertTrue(laterPriorities.allSatisfy { $0 == .background })
}
let task = await service.pendingMessageDrainRetryTask
await service.invalidateContactPreparation()
await task?.value
}
}
func testDueBackgroundPeerRunsBetweenForegroundBursts() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let keys = ["y", "o", "e", "u", "i"].map { "pubky" + String(repeating: $0, count: 52) }
let now = Date(timeIntervalSince1970: 100)
var linkedKeys = Set<String>()
var advances: [PaykitSdkOperationLock.Priority] = []
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now }, currentPublicKey: { _ in "identity" },
drain: { priority in
.init(
ensureLink: { key in linkedKeys.insert(key); advances.append(priority) },
pendingOutbound: { [] },
linkedPeers: { keys.map { self.drainPeer($0, state: linkedKeys.contains($0) ? .linked : .linking) } },
processPending: { _ in }, receive: { _ in }
)
}, didLink: { _, _ in }
))
await service.setBackgroundWorkPaused(true)
_ = await service.rememberSavedContacts(keys, replacing: true)
await service.setTestRetry(.init(nextAttemptAt: now), for: keys[0])
await service.schedulePrivatePaymentRecovery(for: keys[0])
for key in keys.dropFirst() {
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
}
let task = await service.pendingMessageDrainRetryTask
await service.setBackgroundWorkPaused(false)
await task?.value
XCTAssertEqual(advances, [.interactive, .interactive, .interactive, .background, .interactive])
}
func testDuePeersShareSchedulingReadsAndInspectStateAfterEachMutation() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let keys = ["e", "o", "y"].map { "pubky" + String(repeating: $0, count: 52) }
for explicit in [false, true] {
let now = Date(timeIntervalSince1970: 100)
var linked = Set<String>()
var pending = Set<String>()
var sent: [String] = []
var received: [String] = []
var peerReads = 0
var outboundReads = 0
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now }, currentPublicKey: { _ in "identity" },
drain: { priority in
XCTAssertEqual(priority, explicit ? .interactive : .background)
return .init(
ensureLink: { key in
XCTAssertTrue(linked.insert(key).inserted)
pending.insert(key)
},
pendingOutbound: { outboundReads += 1; return Array(pending) },
linkedPeers: {
peerReads += 1
return keys.map { self.drainPeer($0, state: linked.contains($0) ? .linked : .linking) }
},
processPending: { key in
XCTAssertNotNil(pending.remove(key))
sent.append(key)
},
receive: { key in
XCTAssertTrue(linked.contains(key))
XCTAssertFalse(pending.contains(key))
received.append(key)
}
)
}, didLink: { _, _ in }
))
await service.setBackgroundWorkPaused(true)
_ = await service.rememberSavedContacts(keys, replacing: true)
for key in keys {
if explicit {
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
} else {
await service.setTestRetry(.init(nextAttemptAt: now), for: key)
await service.schedulePrivatePaymentRecovery(for: key)
}
}
let task = await service.pendingMessageDrainRetryTask
await service.setBackgroundWorkPaused(false)
await task?.value
XCTAssertEqual(sent, keys)
XCTAssertEqual(received, keys)
XCTAssertEqual(peerReads, 7)
XCTAssertEqual(outboundReads, explicit ? 6 : 7)
let retries = await service.pendingMessageDrainRetryKeys
XCTAssertTrue(retries.isEmpty)
}
}
func testDuePeerSnapshotIsDiscardedAfterPreparationPauseOrIdentityInvalidation() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let keys = ["o", "y"].map { "pubky" + String(repeating: $0, count: 52) }
for change in ["preparation", "resume", "expired", "identity", "generation", "cancel"] {
var now = Date(timeIntervalSince1970: 100)
var identity = "identity"
var secondLinked = change != "preparation"
var advanced: [String] = []
var received: [String] = []
var priorities: [PaykitSdkOperationLock.Priority] = []
let firstCompleted = expectation(description: "First due contact completed")
let (resume, continuation) = AsyncStream<Void>.makeStream()
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now }, currentPublicKey: { _ in identity },
drain: { priority in
.init(
ensureLink: { key in
XCTAssertFalse(secondLinked)
advanced.append(key)
priorities.append(priority)
secondLinked = true
},
pendingOutbound: { [] },
linkedPeers: {
[self.drainPeer(keys[0]), self.drainPeer(keys[1], state: secondLinked ? .linked : .linking)]
},
processPending: { _ in XCTFail("No outbound messages") },
receive: { received.append($0) }
)
}, didLink: { _, key in
if key == keys[0] {
firstCompleted.fulfill()
for await _ in resume {}
}
}
))
await service.setBackgroundWorkPaused(true)
_ = await service.rememberSavedContacts(keys, replacing: true)
for key in keys {
await service.scheduleExplicitContactLink(publicKey: key, identity: identity)
}
let task = await service.pendingMessageDrainRetryTask
await service.setBackgroundWorkPaused(false)
await fulfillment(of: [firstCompleted], timeout: 2)
if change != "preparation" {
await service.setBackgroundWorkPaused(true)
secondLinked = false
}
switch change {
case "preparation":
await service.drainPendingPrivateMessages(reason: "preparation", advancing: [keys[1]], operations: .init(
ensureLink: { _ in secondLinked = true }, pendingOutbound: { [] },
linkedPeers: { [self.drainPeer(keys[1], state: secondLinked ? .linked : .linking)] },
processPending: { _ in XCTFail("No outbound messages") }, receive: { _ in }
))
case "expired": now = now.addingTimeInterval(20)
case "identity": identity = "other"
case "generation": await service.invalidateContactPreparation()
case "cancel": task?.cancel()
default: break
}
XCTAssertEqual(received, [keys[0]])
continuation.finish()
await service.setBackgroundWorkPaused(false)
await task?.value
let resumes = change == "resume" || change == "expired"
XCTAssertEqual(advanced, resumes ? [keys[1]] : [])
XCTAssertEqual(received, resumes || change == "preparation" ? keys : [keys[0]])
XCTAssertEqual(priorities, resumes ? [change == "expired" ? .background : .interactive] : [])
await service.invalidateContactPreparation()
}
}
func testRetryRereadsSchedulingStateAfterTimerWait() async {
PrivatePaykitService.setContactSharingCleanupPending(false)
let key = "pubky" + String(repeating: "y", count: 52)
var now = Date(timeIntervalSince1970: 100)
var linked = false
var advances = 0
var receives = 0
let service = PrivatePaykitService(messageRetryOperations: .init(
now: { now },
sleep: { delay in
XCTAssertEqual(delay, 1_000_000_000)
now = now.addingTimeInterval(1)
linked = true
},
currentPublicKey: { _ in "identity" },
drain: { _ in
.init(
ensureLink: { _ in
XCTAssertFalse(linked)
advances += 1
},
pendingOutbound: { [] },
linkedPeers: { [self.drainPeer(key, state: linked ? .linked : .linking)] },
processPending: { _ in XCTFail("No outbound messages") },
receive: { _ in receives += 1 }
)
}, didLink: { _, _ in }
))
await service.setBackgroundWorkPaused(true)
_ = await service.rememberSavedContacts([key], replacing: true)
await service.scheduleExplicitContactLink(publicKey: key, identity: "identity")
let task = await service.pendingMessageDrainRetryTask
await service.setBackgroundWorkPaused(false)
await task?.value
XCTAssertEqual(advances, 1)
XCTAssertEqual(receives, 1)
let retries = await service.pendingMessageDrainRetryKeys
XCTAssertTrue(retries.isEmpty)
}
func testPendingEndpointReconciliationRestoresSavedContactsWhenPublishingRemainsEnabled() throws {
try withIsolatedDefaults { defaults in
defaults.set(true, forKey: PrivatePaykitService.cleanupPendingKey)
defaults.set(true, forKey: PrivatePaykitService.publishingEnabledKey)
XCTAssertEqual(
PrivatePaykitService.fullCleanupReconciliationMode(defaults: defaults),
.restoreSavedContacts
)
}
}
func testPendingEndpointReconciliationRemovesPublishedStateWhenPublishingIsDisabled() throws {
try withIsolatedDefaults { defaults in
defaults.set(true, forKey: PrivatePaykitService.cleanupPendingKey)
defaults.set(false, forKey: PrivatePaykitService.publishingEnabledKey)
XCTAssertEqual(
PrivatePaykitService.fullCleanupReconciliationMode(defaults: defaults),
.removePublishedState
)
}
}
@MainActor
func testPendingEndpointReconciliationKeepsKnownContactsWhenLoadedListIsEmpty() async {
let defaults = UserDefaults.standard
let previousCleanupPending = defaults.object(forKey: PrivatePaykitService.cleanupPendingKey)
let previousPublishingEnabled = defaults.object(forKey: PrivatePaykitService.publishingEnabledKey)
defer {
defaults.set(previousCleanupPending, forKey: PrivatePaykitService.cleanupPendingKey)
defaults.set(previousPublishingEnabled, forKey: PrivatePaykitService.publishingEnabledKey)
}
defaults.set(true, forKey: PrivatePaykitService.cleanupPendingKey)
defaults.set(true, forKey: PrivatePaykitService.publishingEnabledKey)
let publicKey = "pubky3rsduhcxpw74snwyct86m38c63j3pq8x4ycqikxg64roik8yw5xg"
let service = PrivatePaykitService()
_ = await service.rememberSavedContacts([publicKey], replacing: true)
await service.retryPendingEndpointReconciliation(wallet: WalletViewModel(), savedPublicKeys: [])
let knownSavedContactKeys = await service.knownSavedContactKeys
XCTAssertEqual(knownSavedContactKeys, [publicKey])
XCTAssertTrue(defaults.bool(forKey: PrivatePaykitService.cleanupPendingKey))
}
func testPreparingSavedContactsDefersWhenPublicationIsUnavailable() async {
let service = PrivatePaykitService()
let contacts = ["pubky3rsduhcxpw74snwyct86m38c63j3pq8x4ycqikxg64roik8yw5xg"]
var preparedContacts = [String]()
let error = await service.prepareSavedContacts(
contacts,
publicationUnavailableReason: "the Lightning node is not running",
prepareLinks: { preparedContacts = $0 },
publishEndpoints: { _ in
XCTFail("Unavailable endpoints must not be published")
return PrivatePaykitError.privateUnavailable
}
)
XCTAssertNil(error)
XCTAssertEqual(preparedContacts, contacts)
}
@MainActor
func testPreparingSavedContactsPublishesReservationsInBackground() async throws {
PrivatePaykitService.setContactSharingCleanupPending(false)
let publicKey = "pubky3rsduhcxpw74snwyct86m38c63j3pq8x4ycqikxg64roik8yw5xg"
let endpoint = PublicPaykitService.Endpoint(
methodId: .regtestOnchainP2wpkh, value: "bcrt1qendpoint", min: nil, max: nil,
rawPayload: #"{"value":"bcrt1qendpoint"}"#
)
let publishing = expectation(description: "Private reservation publication started")
let published = expectation(description: "Private reservations published")
let (resume, continuation) = AsyncStream<Void>.makeStream()
defer { continuation.finish() }
var syncedUpdates = [PrivatePaymentListReservationUpdateInput]()
let service = PrivatePaykitService(publicationOperations: .init(
currentPublicKey: { "pubkylocal" },
ensureLink: { _ in .linked },
buildEndpoints: { key in
XCTAssertEqual(key, publicKey)
return [endpoint]
},
syncPaymentLists: { updates in
publishing.fulfill()
for await _ in resume {
break
}
syncedUpdates = updates
published.fulfill()
return .init(queued: [], cleared: [], failedToQueue: [], failedToDeliver: [])
}
))
let error = await service.prepareSavedContacts([publicKey], wallet: WalletViewModel())
await fulfillment(of: [publishing], timeout: 2)
let returnedBeforePublication = expectation(description: "Preparation wait does not finish before publication")
returnedBeforePublication.isInverted = true
let waiter = Task {
try await service.awaitContactPreparation()
if syncedUpdates.isEmpty { returnedBeforePublication.fulfill() }
}
await fulfillment(of: [returnedBeforePublication], timeout: 0.1)
continuation.finish()
try await waiter.value
await fulfillment(of: [published], timeout: 2)
XCTAssertNil(error)
XCTAssertEqual(syncedUpdates.count, 1)
let update = try XCTUnwrap(syncedUpdates.first)
XCTAssertEqual(update.counterparty, publicKey)
XCTAssertEqual(update.reservations.count, 1)
let reservation = try XCTUnwrap(update.reservations.first)
XCTAssertEqual(reservation.identifier, endpoint.methodId.rawValue)
XCTAssertEqual(reservation.payload, endpoint.rawPayload)
XCTAssertEqual(reservation.attribution["counterparty"], publicKey)
}
@MainActor
func testContactPreparationRevalidatesAfterPruningDuringSessionCheck() async throws {
PrivatePaykitService.setContactSharingCleanupPending(false)