forked from apple/swift-nio-http3
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEndToEndTests.swift
More file actions
1676 lines (1419 loc) · 68.3 KB
/
Copy pathEndToEndTests.swift
File metadata and controls
1676 lines (1419 loc) · 68.3 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2026 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import HTTP3
import HTTPTypes
import Logging
import NIOConcurrencyHelpers
import NIOCore
@_spi(HTTP3AsyncInterface) import NIOHTTP3
import NIOHTTPTypes
import NIOPosix
import NIOQUIC
import NIOQUICHelpers
import QPACK
import Testing
import X509
/// Buffers incoming body data until end. Then echoes it all back with a 200 status header.
final class EchoHTTPServerHandler: ChannelInboundHandler {
typealias InboundIn = HTTPRequestPart
typealias OutboundOut = HTTPResponsePart
private var receivedData = ByteBuffer()
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
let part = self.unwrapInboundIn(data)
switch part {
case .head: break
case .body(let body):
self.receivedData.writeImmutableBuffer(body)
case .end:
context.write(self.wrapOutboundOut(.head(.init(status: .ok))), promise: nil)
context.write(self.wrapOutboundOut(.body(self.receivedData)), promise: nil)
context.write(self.wrapOutboundOut(.end()), promise: nil)
}
context.fireChannelRead(data)
}
}
/// Whenever something comes in, holds on to it for some time before firing. Can be used to force one stream to be slower, to find races.
final class InboundSlowingHandler: ChannelInboundHandler {
typealias InboundIn = Any
private let delay: TimeAmount
init(delay: TimeAmount) {
self.delay = delay
}
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
context.eventLoop.assumeIsolated().scheduleTask(in: self.delay) {
context.fireChannelRead(data)
}
}
}
final class InboundDataRecorder<DataType: Sendable>: ChannelInboundHandler {
typealias InboundIn = DataType
typealias InboundOut = DataType
enum Error: Swift.Error {
case countNotMet
}
private var data: [DataType] = []
private let promise: EventLoopPromise<[DataType]>
private let targetCount: Int
init(promise: EventLoopPromise<[DataType]>, targetCount: Int) {
self.promise = promise
self.targetCount = targetCount
}
func handlerRemoved(context: ChannelHandlerContext) {
self.promise.fail(Error.countNotMet)
}
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
let typed = unwrapInboundIn(data)
self.data.append(typed)
if self.data.count == self.targetCount {
self.promise.succeed(self.data)
}
context.fireChannelRead(data)
}
func errorCaught(context: ChannelHandlerContext, error: any Swift.Error) {
self.promise.fail(error)
}
}
/// Server handler that waits for external signal before responding.
/// Uses two promises for control: one signals when request is received,
/// another controls when response is sent.
/// Request number `immediateResponseCount + 1` waits for signal; all others respond immediately.
private final class ControllableEchoResponseHandler: ChannelInboundHandler {
typealias InboundIn = HTTPRequestPart
typealias OutboundOut = HTTPResponsePart
private let requestReceivedSignal: EventLoopPromise<Void>
private let responseSignal: EventLoopPromise<Void>
private let responseToSend: HTTPResponse
private let immediateResponseCount: Int
private let requestCounter: NIOLockedValueBox<Int>
private var receivedData = ByteBuffer()
init(
requestReceivedSignal: EventLoopPromise<Void>,
responseSignal: EventLoopPromise<Void>,
responseToSend: HTTPResponse,
immediateResponseCount: Int,
requestCounter: NIOLockedValueBox<Int>
) {
self.requestReceivedSignal = requestReceivedSignal
self.responseSignal = responseSignal
self.responseToSend = responseToSend
self.immediateResponseCount = immediateResponseCount
self.requestCounter = requestCounter
}
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
let part = self.unwrapInboundIn(data)
switch part {
case .head:
break
case .body(let body):
self.receivedData.writeImmutableBuffer(body)
case .end:
let requestNum = self.requestCounter.withLockedValue { requestCounter in
requestCounter += 1
return requestCounter
}
let responseData = self.receivedData
self.receivedData.clear()
if requestNum == self.immediateResponseCount + 1 {
// This is the request we want to control - signal and wait
self.requestReceivedSignal.succeed()
self.responseSignal.futureResult
.hop(to: context.eventLoop)
.assumeIsolated()
.whenComplete { _ in
self.sendResponse(context: context, body: responseData)
}
} else {
self.sendResponse(context: context, body: responseData)
}
}
context.fireChannelRead(data)
}
private func sendResponse(context: ChannelHandlerContext, body: ByteBuffer) {
context.write(self.wrapOutboundOut(.head(self.responseToSend)), promise: nil)
context.write(self.wrapOutboundOut(.body(body)), promise: nil)
context.writeAndFlush(self.wrapOutboundOut(.end()), promise: nil)
}
}
/// Closes immediately after activation
private final class SelfClosingHandler: ChannelInboundHandler, Sendable {
typealias InboundIn = Never
typealias OutboundIn = Never
func channelActive(context: ChannelHandlerContext) {
context.fireChannelActive()
context.close(promise: nil)
}
func handlerAdded(context: ChannelHandlerContext) {
if context.channel.isActive {
context.close(promise: nil)
}
}
}
/// Sends a `STOP_SENDING` immediately after activation.
private final class RequestStopSendingHandler: ChannelInboundHandler, Sendable {
typealias InboundIn = Never
typealias OutboundIn = Never
func channelActive(context: ChannelHandlerContext) {
context.fireChannelActive()
context.triggerUserOutboundEvent(QUICStopSendingEvent(code: QUICApplicationErrorCode(0)!), promise: nil)
}
func handlerAdded(context: ChannelHandlerContext) {
if context.channel.isActive {
context.triggerUserOutboundEvent(QUICStopSendingEvent(code: QUICApplicationErrorCode(0)!), promise: nil)
}
}
}
/// We fail promises with this error when they are about to be dropped.
/// This prevents hitting an assertion in the implementation of promise.
struct NeverFulfilled: Error {}
struct EndToEndTests {
private let eventLoopGroup = MultiThreadedEventLoopGroup.singleton
private static let standardAuthenticationConfigurations: [AuthenticationConfiguration] = {
[.keys, .certs]
}()
@Test(arguments: Self.standardAuthenticationConfigurations)
@available(anyAppleOS 26, *)
func testSettingsFrame(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
// These settings are arbitrary, just so we can test whether they come through to the other side
let clientSettings = try HTTP3Settings(parsing: [.init(identifier: .init(extensionSetting: 10001)!, value: 10)])
let serverSettings = try HTTP3Settings(parsing: [.init(identifier: .init(extensionSetting: 10002)!, value: 20)])
let serverControlStreamFramesPromise = self.eventLoopGroup.any().makePromise(of: [HTTP3Frame].self)
let clientControlStreamFramesPromise = self.eventLoopGroup.any().makePromise(of: [HTTP3Frame].self)
defer {
serverControlStreamFramesPromise.fail(NeverFulfilled())
clientControlStreamFramesPromise.fail(NeverFulfilled())
}
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: serverSettings,
logger: serverLogger,
inboundStreamInitializer: {
// This is important. Although there is a control stream, that shouldn't be visible to us here
Issue.record("Unexpected inbound stream with ID \($0.streamID)")
return $0.channel.eventLoop.makeSucceededVoidFuture()
},
internalInboundStreamInitializer: { channel, _, streamType in
switch streamType {
case .control:
return channel.eventLoop.makeCompletedFuture {
let recorder = InboundDataRecorder(promise: serverControlStreamFramesPromise, targetCount: 1)
try channel.pipeline.syncOperations.addHandler(recorder)
}
default:
// We don't care about this stream
return channel.eventLoop.makeSucceededVoidFuture()
}
}
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: clientSettings,
logger: clientLogger,
internalInboundStreamInitializer: { streamChannel, _, streamType in
switch streamType {
case .control:
return streamChannel.eventLoop.makeCompletedFuture {
let recorder = InboundDataRecorder(promise: clientControlStreamFramesPromise, targetCount: 1)
try streamChannel.pipeline.syncOperations.addHandler(recorder)
}
default:
// We don't care about this stream
return streamChannel.eventLoop.makeSucceededVoidFuture()
}
}
)
// Assert that the client and server get each others settings
let serverReceivedControlFrames = try await serverControlStreamFramesPromise.futureResult.get()
let clientReceivedControlFrames = try await clientControlStreamFramesPromise.futureResult.get()
#expect(serverReceivedControlFrames == [.settings(clientSettings)])
#expect(clientReceivedControlFrames == [.settings(serverSettings)])
// Tear down
try await serverChannel.pipeline.handler(type: QUICHandler.self).flatMap {
$0.shutdownGracefully(deadline: .now())
}.get()
try await clientConnectionChannel.closeFuture.get()
}
// This test enables the dynamic table on both sides, but adds a handler which causes QPACK instructions to be delayed.
// This test will currently fail, because the clients stream channel will close before the instructions arrive for decoding the response headers.
// This problem, and potential solutions, are explored in the `DynamicTable` document in the `NIOHTTP3` module.
@Test(
.disabled("See DynamicTable document in NIOHTTP3 module"),
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testRoundtripWithSlowDynamicTable(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientReceivedFramesPromise = self.eventLoopGroup.any().makePromise(of: [HTTP3Frame].self)
let serverReceivedFramesPromise = self.eventLoopGroup.any().makePromise(of: [HTTP3Frame].self)
let serverReceivedQpackEncoderInstructionsPromise = self.eventLoopGroup.any().makePromise(
of: [QPACKEncoderInstruction].self
)
let clientReceivedQpackEncoderInstructionsPromise = self.eventLoopGroup.any().makePromise(
of: [QPACKEncoderInstruction].self
)
let serverReceivedQpackDecoderInstructionsPromise = self.eventLoopGroup.any().makePromise(
of: [QPACKDecoderInstruction].self
)
let clientReceivedQpackDecoderInstructionsPromise = self.eventLoopGroup.any().makePromise(
of: [QPACKDecoderInstruction].self
)
let serverReceivedEncoderInstructionStream = self.eventLoopGroup.any().makePromise(of: Void.self)
let clientReceivedEncoderInstructionStream = self.eventLoopGroup.any().makePromise(of: Void.self)
defer {
clientReceivedFramesPromise.fail(NeverFulfilled())
serverReceivedFramesPromise.fail(NeverFulfilled())
serverReceivedQpackEncoderInstructionsPromise.fail(NeverFulfilled())
clientReceivedQpackEncoderInstructionsPromise.fail(NeverFulfilled())
serverReceivedQpackDecoderInstructionsPromise.fail(NeverFulfilled())
clientReceivedQpackDecoderInstructionsPromise.fail(NeverFulfilled())
serverReceivedEncoderInstructionStream.fail(NeverFulfilled())
clientReceivedEncoderInstructionStream.fail(NeverFulfilled())
}
let settings: HTTP3Settings = .forTestingWithDynamicTable
final class TestServerHandler: ChannelInboundHandler {
typealias InboundIn = HTTP3Frame
typealias OutboundOut = HTTP3Frame
init() {}
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
let fields: [HTTPField] = [
.init(name: .status, value: "200"),
.init(name: .init("test")!, value: "hello"),
]
context.writeAndFlush(self.wrapOutboundOut(.headers(fields)), promise: nil)
context.close(mode: .output, promise: nil)
}
}
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: settings,
logger: serverLogger,
inboundStreamInitializer: {
// Only the one request stream should be visible here
#expect($0.streamID.isBidirectional)
#expect($0.streamID.isClientInitiated)
let serverRecorder = InboundDataRecorder(
promise: serverReceivedFramesPromise,
targetCount: 1
)
let channel = $0.channel
return channel.eventLoop.makeCompletedFuture {
try channel.pipeline.syncOperations.addHandler(serverRecorder)
try channel.pipeline.syncOperations.addHandler(TestServerHandler())
}
},
internalInboundStreamInitializer: { streamChannel, _, streamType in
streamChannel.eventLoop.makeCompletedFuture {
switch streamType {
case .qpackEncoder:
let recorder = InboundDataRecorder(
promise: serverReceivedQpackEncoderInstructionsPromise,
targetCount: 3
)
try streamChannel.pipeline.syncOperations.addHandler(recorder)
serverReceivedEncoderInstructionStream.succeed()
case .qpackDecoder:
let recorder = InboundDataRecorder(
promise: serverReceivedQpackDecoderInstructionsPromise,
targetCount: 1
)
try streamChannel.pipeline.syncOperations.addHandler(recorder)
case .control:
break // not interested in the control stream for this test
default: Issue.record("Not expecting any other streams")
}
}
}
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: settings,
logger: clientLogger,
internalInboundStreamInitializer: { streamChannel, _, streamType in
streamChannel.eventLoop.makeCompletedFuture {
switch streamType {
case .qpackDecoder:
let recorder = InboundDataRecorder(
promise: clientReceivedQpackDecoderInstructionsPromise,
targetCount: 1
)
try streamChannel.pipeline.syncOperations.addHandler(recorder)
case .qpackEncoder:
try streamChannel.pipeline.syncOperations.addHandler(
InboundSlowingHandler(delay: .milliseconds(500)),
position: .first
)
let recorder = InboundDataRecorder(
promise: clientReceivedQpackEncoderInstructionsPromise,
targetCount: 2
)
try streamChannel.pipeline.syncOperations.addHandler(recorder)
clientReceivedEncoderInstructionStream.succeed()
case .control:
break // not interested in the control stream for this test
default: Issue.record("Not expecting any other streams")
}
}
}
)
let requestStreamChannel = try await clientConnectionChannel.makeHTTP3RequestChannel {
let clientRecorder = InboundDataRecorder(promise: clientReceivedFramesPromise, targetCount: 1)
try $0.channel.pipeline.syncOperations.addHandler(clientRecorder)
}.get()
// Wait for qpack dynamic table to be initialized. This happens when both sides have received the encoder instruction stream.
// After that point, both sides are able to create dynamic table entries and send them over that stream.
try await serverReceivedEncoderInstructionStream.futureResult.get()
try await clientReceivedEncoderInstructionStream.futureResult.get()
let frame = HTTP3Frame.headers(
[
.init(name: .method, value: "GET"),
.init(name: .path, value: "/"),
.init(name: .scheme, value: "https"),
.init(name: .authority, value: "test"),
.init(name: .userAgent, value: "test-agent"),
]
)
try await requestStreamChannel.writeAndFlush(frame)
requestStreamChannel.close(mode: .output, promise: nil)
try await requestStreamChannel.closeFuture.get()
let serverReceivedFrames = try await serverReceivedFramesPromise.futureResult.get()
let clientReceivedFrames = try await clientReceivedFramesPromise.futureResult.get()
#expect(serverReceivedFrames == [frame])
#expect(
clientReceivedFrames == [
.headers([.init(name: .status, value: "200"), .init(name: .init("test")!, value: "hello")])
]
)
// Make sure it used the dynamic table as expected
// Server should have received the dynamic table capacity + the 2 headers the client sent
let serverReceivedEncoderInstructions = try await serverReceivedQpackEncoderInstructionsPromise.futureResult
.get()
try #require(serverReceivedEncoderInstructions.count == 3)
#expect(serverReceivedEncoderInstructions[0] == .setDynamicTableCapacity(1024))
#expect(
serverReceivedEncoderInstructions[1]
== .insertWithNameReference(.staticTable, relativeIndex: 0, value: "test")
)
#expect(
serverReceivedEncoderInstructions[2]
== .insertWithNameReference(.staticTable, relativeIndex: 95, value: "test-agent")
)
// Client receives an ack for those
let clientReceivedDecoderInstructions = try await clientReceivedQpackDecoderInstructionsPromise.futureResult
.get()
try #require(clientReceivedDecoderInstructions.count == 1)
#expect(
clientReceivedDecoderInstructions.first == QPACKDecoderInstruction.insertCountIncrement(increment: 1)
)
// client should have received the dynamic table capacity + the 1 header the server sent
let clientReceivedEncoderInstructions = try await clientReceivedQpackEncoderInstructionsPromise.futureResult
.get()
try #require(clientReceivedEncoderInstructions.count == 2)
#expect(clientReceivedEncoderInstructions[0] == .setDynamicTableCapacity(1024))
#expect(
clientReceivedEncoderInstructions[1]
== .insertWithLiteralName(name: "test", value: "hello")
)
// server receives an ack for those
let serverReceivedDecoderInstructions = try await serverReceivedQpackDecoderInstructionsPromise.futureResult
.get()
try #require(serverReceivedDecoderInstructions.count == 1)
#expect(
serverReceivedDecoderInstructions.first == QPACKDecoderInstruction.insertCountIncrement(increment: 1)
)
// Tear down
try await serverChannel.pipeline.handler(type: QUICHandler.self).flatMap {
$0.shutdownGracefully(deadline: .now())
}.get()
try await clientConnectionChannel.closeFuture.get()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testRoundtripWithoutDynamicTable(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientReceivedFramesPromise = self.eventLoopGroup.any().makePromise(of: [HTTP3Frame].self)
let serverReceivedFramesPromise = self.eventLoopGroup.any().makePromise(of: [HTTP3Frame].self)
defer {
clientReceivedFramesPromise.fail(NeverFulfilled())
serverReceivedFramesPromise.fail(NeverFulfilled())
}
let settings = HTTP3Settings() // No qpack
final class TestServerHandler: ChannelInboundHandler {
typealias InboundIn = HTTP3Frame
typealias OutboundOut = HTTP3Frame
init() {}
func channelRead(context: ChannelHandlerContext, data: NIOAny) {
context.writeAndFlush(
self.wrapOutboundOut(.headers([.init(name: .status, value: "200")])),
promise: nil
)
context.close(mode: .output, promise: nil)
}
}
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: settings,
logger: serverLogger,
inboundStreamInitializer: {
// Only the one request stream should be visible here
#expect($0.streamID.isBidirectional)
#expect($0.streamID.isClientInitiated)
let serverRecorder = InboundDataRecorder(promise: serverReceivedFramesPromise, targetCount: 1)
let channel = $0.channel
return channel.eventLoop.makeCompletedFuture {
try channel.pipeline.syncOperations.addHandler(serverRecorder)
try channel.pipeline.syncOperations.addHandler(TestServerHandler())
}
}
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: settings,
logger: clientLogger,
internalInboundStreamInitializer: { channel, _, streamType in
switch streamType {
case .control:
break // not interested in the control stream for this test
default: Issue.record("Not expecting any other streams")
}
return channel.eventLoop.makeSucceededVoidFuture()
}
)
let requestStreamChannel = try await clientConnectionChannel.makeHTTP3RequestChannel {
let clientRecorder = InboundDataRecorder(promise: clientReceivedFramesPromise, targetCount: 1)
try $0.channel.pipeline.syncOperations.addHandler(clientRecorder)
}.get()
let frame = HTTP3Frame.headers(
[
.init(name: .method, value: "GET"),
.init(name: .path, value: "/"),
.init(name: .scheme, value: "https"),
.init(name: .authority, value: "test"),
.init(name: .userAgent, value: "test-agent"),
]
)
try await requestStreamChannel.writeAndFlush(frame)
requestStreamChannel.close(mode: .output, promise: nil)
// After server sends response, stream should self-close
try await requestStreamChannel.closeFuture.get()
// Make sure server saw request and client saw response
let serverReceivedFrames = try await serverReceivedFramesPromise.futureResult.get()
let clientReceivedFrames = try await clientReceivedFramesPromise.futureResult.get()
#expect(serverReceivedFrames == [frame])
#expect(clientReceivedFrames == [.headers([HTTPField(name: .status, value: "200")])])
// Tear down
try await serverChannel.pipeline.handler(type: QUICHandler.self).flatMap {
$0.shutdownGracefully(deadline: .now())
}.get()
try await clientConnectionChannel.closeFuture.get()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testConnectionError(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientErrorPromise = self.eventLoopGroup.any().makePromise(of: (any Error).self)
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: .init(),
logger: serverLogger
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: .init(),
logger: clientLogger,
connectionInitializer: { channel in
channel.pipeline.addHandler(ErrorCatchingHandler(errorPromise: clientErrorPromise))
}
)
let requestStreamChannel = try await clientConnectionChannel.makeHTTP3RequestChannel().get()
// Write a settings frame, which is illegal on the request stream
// Our outbound handlers will prevent writing an invalid frame, so we need to skip past the stream handler
_ = requestStreamChannel.eventLoop.submit {
let streamHandler = try requestStreamChannel.pipeline.syncOperations.handler(type: HTTP3StreamHandler.self)
let streamHandlerContext = try requestStreamChannel.pipeline.syncOperations.context(handler: streamHandler)
var buffer = ByteBuffer()
buffer.writeHTTP3PartialFrame(.settings(HTTP3Settings()), preferHuffmanEncoding: false)
streamHandlerContext.writeAndFlush(NIOAny(buffer), promise: nil)
}
let clientConnectionError = try await clientErrorPromise.futureResult.get()
let clientH3ConnectionError = clientConnectionError as? HTTP3Error
#expect(clientH3ConnectionError?.code == .remoteConnectionError)
#expect(clientH3ConnectionError?.h3ErrorCode == .H3_FRAME_UNEXPECTED)
#expect(clientH3ConnectionError?.message == "Expected headers, got settings")
// Client connection should close itself
try await clientConnectionChannel.closeFuture.get()
try await serverChannel.close()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testServerClosesConnection(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientErrorPromise = self.eventLoopGroup.any().makePromise(of: (any Error).self)
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: .init(),
logger: serverLogger,
inboundConnectionInitializer: { channel in
// we want to immediately force-close all incoming connections
channel.pipeline.addHandler(SelfClosingHandler())
}
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: .init(),
logger: clientLogger,
connectionInitializer: { channel in
channel.pipeline.addHandler(ErrorCatchingHandler(errorPromise: clientErrorPromise))
}
)
let clientConnectionError = try await clientErrorPromise.futureResult.get()
let clientH3ConnectionError = clientConnectionError as? HTTP3Error
#expect(clientH3ConnectionError?.code == .remoteConnectionError)
#expect(clientH3ConnectionError?.h3ErrorCode == .H3_NO_ERROR)
// Client connection should close itself
try await clientConnectionChannel.closeFuture.get()
try await serverChannel.close()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testClosingConnectionAlsoClosesStreams(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let lastServerConnection: NIOLockedValueBox<(any Channel)?> = .init(nil)
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: .init(),
logger: serverLogger,
inboundConnectionInitializer: { conn in
lastServerConnection.withLockedValue { $0 = conn }
return conn.eventLoop.makeSucceededVoidFuture()
}
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: .init(),
logger: clientLogger
)
let requestStreamChannel = try await clientConnectionChannel.makeHTTP3RequestChannel().get()
// Close the client connection
try await clientConnectionChannel.close()
// request stream channel should close
try await requestStreamChannel.closeFuture.get()
// Client connection should close
try await clientConnectionChannel.closeFuture.get()
// server connection should close itself
let serverConnection = lastServerConnection.withLockedValue { $0 }
try #require(serverConnection != nil)
try await serverConnection!.closeFuture.get()
// Cleanup: close the whole server
try await serverChannel.close()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testServerClosesConnectionWithActiveStream(
authenticationConfiguration: AuthenticationConfiguration
) async throws {
// When the server closes the connection while the client has a request stream open,
// the client's request stream should see an error rather than a clean close.
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let streamErrorPromise = self.eventLoopGroup.any().makePromise(of: (any Error).self)
defer { streamErrorPromise.fail(NeverFulfilled()) }
let lastServerConnection: NIOLockedValueBox<(any Channel)?> = .init(nil)
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: .init(),
logger: serverLogger,
inboundConnectionInitializer: { conn in
lastServerConnection.withLockedValue { $0 = conn }
return conn.eventLoop.makeSucceededVoidFuture()
}
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: .init(),
logger: clientLogger
)
// Create a request stream with an error catcher
let requestStreamChannel = try await clientConnectionChannel.makeHTTP3RequestChannel {
try $0.channel.pipeline.syncOperations.addHandler(
ErrorCatchingHandler(errorPromise: streamErrorPromise)
)
}.get()
// Now close the server connection while the request stream is open
let serverConnection = try #require(lastServerConnection.withLockedValue { $0 })
try await serverConnection.close()
// The request stream should see an error, not a clean close
let streamError = try await streamErrorPromise.futureResult.get()
let h3Error = streamError as? HTTP3Error
#expect(h3Error?.code == .remoteConnectionError)
// Request stream should close
try await requestStreamChannel.closeFuture.get()
// Client connection should close
try await clientConnectionChannel.closeFuture.get()
// Cleanup
try await serverChannel.close()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testStreamError(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientErrorPromise = self.eventLoopGroup.any().makePromise(of: (any Error).self)
defer {
clientErrorPromise.fail(NeverFulfilled())
}
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: .init(),
logger: serverLogger
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: .init(),
logger: clientLogger
)
let requestStreamChannel = try await clientConnectionChannel.makeHTTP3RequestChannel {
try $0.channel.pipeline.syncOperations.addHandler(ErrorCatchingHandler(errorPromise: clientErrorPromise))
}.get()
// Write a malformed header, which can't decode.
// Our outbound handlers will prevent writing an invalid frame, so we need to skip past the stream handler.
_ = requestStreamChannel.eventLoop.submit {
let streamHandler = try requestStreamChannel.pipeline.syncOperations.handler(type: HTTP3StreamHandler.self)
let streamHandlerContext = try requestStreamChannel.pipeline.syncOperations.context(handler: streamHandler)
var buffer = ByteBuffer()
buffer.writeHTTP3PartialFrame(
.headers(
.init(
fieldSection: .init(
prefix: .init(encodedRequiredInsertCount: 0, deltaBase: 0, signBit: false),
// Uppercase field names are illegal
lines: [.literal(requireLiteralRepresentation: false, name: "A", value: "B")]
)
)
),
preferHuffmanEncoding: false
)
streamHandlerContext.writeAndFlush(NIOAny(buffer), promise: nil)
}
let streamError = try await clientErrorPromise.futureResult.get()
let clientH3ConnectionError = streamError as? HTTP3Error
#expect(clientH3ConnectionError?.code == .remoteStreamError)
#expect(clientH3ConnectionError?.h3ErrorCode == .H3_MESSAGE_ERROR)
// Request stream should close because of the error
try await requestStreamChannel.closeFuture.get()
try await serverChannel.close()
try await clientConnectionChannel.close()
}
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testUnknownIncomingStream(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientErrorPromise = self.eventLoopGroup.any().makePromise(of: (any Error).self)
defer {
clientErrorPromise.fail(NeverFulfilled())
}
let credentials = try TestCertificates.makeCredentials(for: authenticationConfiguration)
let serverChannel = try await self.makeServer(
credentials: credentials,
host: host,
settings: .init(),
logger: serverLogger
)
let serverPort = serverChannel.localAddress!.port!
let clientConnectionChannel = try await self.makeClient(
credentials: credentials,
host: host,
port: serverPort,
settings: .init(),
logger: clientLogger
)
let streamChannel = try await clientConnectionChannel.makeHTTP3UnidirectionalStreamChannel(
streamType: .unknown(raw: 101)
) {
try $0.channel.pipeline.syncOperations.addHandler(ErrorCatchingHandler(errorPromise: clientErrorPromise))
}.get()
// Write any random bytes into this stream. The other end should never read them anyway (because data in streams of unknown types should be dropped)
_ = streamChannel.eventLoop.submit {
streamChannel.writeAndFlush(ByteBuffer(string: "hello"), promise: nil)
}
let clientStreamError = try await clientErrorPromise.futureResult.get()
let clientStreamQUICError = clientStreamError as? QUICStopSendingError
#expect(clientStreamQUICError?.code == QUICApplicationErrorCode(.H3_STREAM_CREATION_ERROR))
// Client stream should close
try await streamChannel.closeFuture.get()
// Cleanup
try await serverChannel.close()
}
// This is always an error; clients must not open push streams to servers.
@Test(
arguments: Self.standardAuthenticationConfigurations
)
@available(anyAppleOS 26, *)
func testIncomingPushStreamOnServer(authenticationConfiguration: AuthenticationConfiguration) async throws {
let host = "127.0.0.1"
let clientLogger = Logger(label: "Client")
let serverLogger = Logger(label: "Server")
let clientErrorPromise = self.eventLoopGroup.any().makePromise(of: (any Error).self)