/
Http2ConnectionTest.java
2073 lines (1839 loc) · 80.5 KB
/
Http2ConnectionTest.java
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
/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package okhttp3.internal.http2;
import java.io.EOFException;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.Socket;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import okhttp3.Headers;
import okhttp3.internal.Util;
import okhttp3.internal.concurrent.TaskFaker;
import okhttp3.internal.concurrent.TaskQueue;
import okhttp3.internal.concurrent.TaskRunner;
import okhttp3.internal.http2.MockHttp2Peer.InFrame;
import okio.AsyncTimeout;
import okio.Buffer;
import okio.BufferedSink;
import okio.BufferedSource;
import okio.Okio;
import okio.Sink;
import okio.Source;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestRule;
import org.junit.rules.Timeout;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.Arrays.asList;
import static okhttp3.TestUtil.headerEntries;
import static okhttp3.TestUtil.repeat;
import static okhttp3.internal.Util.EMPTY_BYTE_ARRAY;
import static okhttp3.internal.Util.EMPTY_HEADERS;
import static okhttp3.internal.http2.Http2Connection.AWAIT_PING;
import static okhttp3.internal.http2.Http2Connection.DEGRADED_PING;
import static okhttp3.internal.http2.Http2Connection.DEGRADED_PONG_TIMEOUT_NS;
import static okhttp3.internal.http2.Http2Connection.Listener.REFUSE_INCOMING_STREAMS;
import static okhttp3.internal.http2.Settings.DEFAULT_INITIAL_WINDOW_SIZE;
import static okhttp3.internal.http2.Settings.ENABLE_PUSH;
import static okhttp3.internal.http2.Settings.HEADER_TABLE_SIZE;
import static okhttp3.internal.http2.Settings.INITIAL_WINDOW_SIZE;
import static okhttp3.internal.http2.Settings.MAX_CONCURRENT_STREAMS;
import static okhttp3.internal.http2.Settings.MAX_FRAME_SIZE;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.data.Offset.offset;
import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.fail;
public final class Http2ConnectionTest {
private final MockHttp2Peer peer = new MockHttp2Peer();
@Rule public final TestRule timeout = new Timeout(5_000, TimeUnit.MILLISECONDS);
@After public void tearDown() throws Exception {
peer.close();
}
@Test public void serverPingsClientHttp2() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.sendFrame().ping(false, 2, 3);
peer.acceptFrame(); // PING
peer.play();
// play it back
connect(peer);
// verify the peer received what was expected
InFrame ping = peer.takeFrame();
assertThat(ping.type).isEqualTo(Http2.TYPE_PING);
assertThat(ping.streamId).isEqualTo(0);
assertThat(ping.payload1).isEqualTo(2);
assertThat(ping.payload2).isEqualTo(3);
assertThat(ping.ack).isTrue();
}
@Test public void peerHttp2ServerLowersInitialWindowSize() throws Exception {
Settings initial = new Settings();
initial.set(INITIAL_WINDOW_SIZE, 1684);
Settings shouldntImpactConnection = new Settings();
shouldntImpactConnection.set(INITIAL_WINDOW_SIZE, 3368);
peer.sendFrame().settings(initial);
peer.acceptFrame(); // ACK
peer.sendFrame().settings(shouldntImpactConnection);
peer.acceptFrame(); // ACK 2
peer.acceptFrame(); // HEADERS
peer.play();
Http2Connection connection = connect(peer);
// Verify the peer received the second ACK.
InFrame ackFrame = peer.takeFrame();
assertThat(ackFrame.type).isEqualTo(Http2.TYPE_SETTINGS);
assertThat(ackFrame.streamId).isEqualTo(0);
assertThat(ackFrame.ack).isTrue();
// This stream was created *after* the connection settings were adjusted.
Http2Stream stream = connection.newStream(headerEntries("a", "android"), false);
assertThat(connection.getPeerSettings().getInitialWindowSize()).isEqualTo(3368L);
// New Stream is has the most recent initial window size.
assertThat(stream.getWriteBytesTotal()).isEqualTo(0L);
assertThat(stream.getWriteBytesMaximum()).isEqualTo(3368L);
}
@Test public void peerHttp2ServerZerosCompressionTable() throws Exception {
boolean client = false; // Peer is server, so we are client.
Settings settings = new Settings();
settings.set(HEADER_TABLE_SIZE, 0);
Http2Connection connection = connectWithSettings(client, settings);
// Verify the peer's settings were read and applied.
assertThat(connection.getPeerSettings().getHeaderTableSize()).isEqualTo(0);
Http2Writer writer = connection.getWriter();
assertThat(writer.getHpackWriter().dynamicTableByteCount).isEqualTo(0);
assertThat(writer.getHpackWriter().headerTableSizeSetting).isEqualTo(0);
}
@Test public void peerHttp2ClientDisablesPush() throws Exception {
boolean client = false; // Peer is client, so we are server.
Settings settings = new Settings();
settings.set(ENABLE_PUSH, 0); // The peer client disables push.
Http2Connection connection = connectWithSettings(client, settings);
// verify the peer's settings were read and applied.
assertThat(connection.getPeerSettings().getEnablePush(true)).isFalse();
}
@Test public void peerIncreasesMaxFrameSize() throws Exception {
int newMaxFrameSize = 0x4001;
Settings settings = new Settings();
settings.set(MAX_FRAME_SIZE, newMaxFrameSize);
Http2Connection connection = connectWithSettings(true, settings);
// verify the peer's settings were read and applied.
assertThat(connection.getPeerSettings().getMaxFrameSize(-1)).isEqualTo(newMaxFrameSize);
assertThat(connection.getWriter().maxDataLength()).isEqualTo(newMaxFrameSize);
}
/**
* Webservers may set the initial window size to zero, which is a special case because it means
* that we have to flush headers immediately before any request body can be sent.
* https://github.com/square/okhttp/issues/2543
*/
@Test public void peerSetsZeroFlowControl() throws Exception {
peer.setClient(true);
// Write the mocking script.
peer.sendFrame().settings(new Settings().set(INITIAL_WINDOW_SIZE, 0));
peer.acceptFrame(); // ACK
peer.sendFrame().windowUpdate(0, 10); // Increase the connection window size.
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0);
peer.acceptFrame(); // HEADERS STREAM 3
peer.sendFrame().windowUpdate(3, 5);
peer.acceptFrame(); // DATA STREAM 3 "abcde"
peer.sendFrame().windowUpdate(3, 5);
peer.acceptFrame(); // DATA STREAM 3 "fghi"
peer.play();
// Play it back.
Http2Connection connection = connect(peer);
connection.writePingAndAwaitPong(); // Ensure the SETTINGS have been received.
Http2Stream stream = connection.newStream(headerEntries("a", "android"), true);
BufferedSink sink = Okio.buffer(stream.getSink());
sink.writeUtf8("abcdefghi");
sink.flush();
// Verify the peer received what was expected.
peer.takeFrame(); // PING
InFrame headers = peer.takeFrame();
assertThat(headers.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame data1 = peer.takeFrame();
assertThat(data1.type).isEqualTo(Http2.TYPE_DATA);
assertThat(data1.streamId).isEqualTo(3);
assertArrayEquals("abcde".getBytes(UTF_8), data1.data);
InFrame data2 = peer.takeFrame();
assertThat(data2.type).isEqualTo(Http2.TYPE_DATA);
assertThat(data2.streamId).isEqualTo(3);
assertArrayEquals("fghi".getBytes(UTF_8), data2.data);
}
/**
* Confirm that we account for discarded data frames. It's possible that data frames are in-flight
* just prior to us canceling a stream.
*/
@Test public void discardedDataFramesAreCounted() throws Exception {
// Write the mocking script.
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM 3
peer.sendFrame().headers(false, 3, headerEntries("a", "apple"));
peer.sendFrame().data(false, 3, data(1024), 1024);
peer.acceptFrame(); // RST_STREAM
peer.sendFrame().data(true, 3, data(1024), 1024);
peer.acceptFrame(); // RST_STREAM
peer.play();
Http2Connection connection = connect(peer);
Http2Stream stream1 = connection.newStream(headerEntries("b", "bark"), false);
Source source = stream1.getSource();
Buffer buffer = new Buffer();
while (buffer.size() != 1024) source.read(buffer, 1024);
stream1.close(ErrorCode.CANCEL, null);
InFrame frame1 = peer.takeFrame();
assertThat(frame1.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame frame2 = peer.takeFrame();
assertThat(frame2.type).isEqualTo(Http2.TYPE_RST_STREAM);
InFrame frame3 = peer.takeFrame();
assertThat(frame3.type).isEqualTo(Http2.TYPE_RST_STREAM);
assertThat(connection.getReadBytesAcknowledged()).isEqualTo(0L);
assertThat(connection.getReadBytesTotal()).isEqualTo(2048L);
}
@Test public void receiveGoAwayHttp2() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM 3
peer.acceptFrame(); // SYN_STREAM 5
peer.sendFrame().goAway(3, ErrorCode.PROTOCOL_ERROR, EMPTY_BYTE_ARRAY);
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0);
peer.acceptFrame(); // DATA STREAM 3
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream1 = connection.newStream(headerEntries("a", "android"), true);
Http2Stream stream2 = connection.newStream(headerEntries("b", "banana"), true);
connection.writePingAndAwaitPong(); // Ensure the GO_AWAY that resets stream2 has been received.
BufferedSink sink1 = Okio.buffer(stream1.getSink());
BufferedSink sink2 = Okio.buffer(stream2.getSink());
sink1.writeUtf8("abc");
try {
sink2.writeUtf8("abc");
sink2.flush();
fail();
} catch (IOException expected) {
assertThat(expected.getMessage()).isEqualTo("stream was reset: REFUSED_STREAM");
}
sink1.writeUtf8("def");
sink1.close();
try {
connection.newStream(headerEntries("c", "cola"), true);
fail();
} catch (ConnectionShutdownException expected) {
}
assertThat(stream1.isOpen()).isTrue();
assertThat(stream2.isOpen()).isFalse();
assertThat(connection.openStreamCount()).isEqualTo(1);
// verify the peer received what was expected
InFrame synStream1 = peer.takeFrame();
assertThat(synStream1.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame synStream2 = peer.takeFrame();
assertThat(synStream2.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame ping = peer.takeFrame();
assertThat(ping.type).isEqualTo(Http2.TYPE_PING);
InFrame data1 = peer.takeFrame();
assertThat(data1.type).isEqualTo(Http2.TYPE_DATA);
assertThat(data1.streamId).isEqualTo(3);
assertArrayEquals("abcdef".getBytes(UTF_8), data1.data);
}
@Test public void readSendsWindowUpdateHttp2() throws Exception {
int windowSize = 100;
int windowUpdateThreshold = 50;
// Write the mocking script.
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
for (int i = 0; i < 3; i++) {
// Send frames of summing to size 50, which is windowUpdateThreshold.
peer.sendFrame().data(false, 3, data(24), 24);
peer.sendFrame().data(false, 3, data(25), 25);
peer.sendFrame().data(false, 3, data(1), 1);
peer.acceptFrame(); // connection WINDOW UPDATE
peer.acceptFrame(); // stream WINDOW UPDATE
}
peer.sendFrame().data(true, 3, data(0), 0);
peer.play();
// Play it back.
Http2Connection connection = connect(peer);
connection.getOkHttpSettings().set(INITIAL_WINDOW_SIZE, windowSize);
Http2Stream stream = connection.newStream(headerEntries("b", "banana"), false);
assertThat(stream.getReadBytesAcknowledged()).isEqualTo(0L);
assertThat(stream.getReadBytesTotal()).isEqualTo(0L);
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("a", "android"));
Source in = stream.getSource();
Buffer buffer = new Buffer();
buffer.writeAll(in);
assertThat(in.read(buffer, 1)).isEqualTo(-1);
assertThat(buffer.size()).isEqualTo(150);
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
for (int i = 0; i < 3; i++) {
List<Integer> windowUpdateStreamIds = new ArrayList<>(2);
for (int j = 0; j < 2; j++) {
InFrame windowUpdate = peer.takeFrame();
assertThat(windowUpdate.type).isEqualTo(Http2.TYPE_WINDOW_UPDATE);
windowUpdateStreamIds.add(windowUpdate.streamId);
assertThat(windowUpdate.windowSizeIncrement).isEqualTo(windowUpdateThreshold);
}
// connection
assertThat(windowUpdateStreamIds).contains(0);
// stream
assertThat(windowUpdateStreamIds).contains(3);
}
}
@Test public void serverSendsEmptyDataClientDoesntSendWindowUpdateHttp2() throws Exception {
// Write the mocking script.
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.sendFrame().data(true, 3, data(0), 0);
peer.play();
// Play it back.
Http2Connection connection = connect(peer);
Http2Stream client = connection.newStream(headerEntries("b", "banana"), false);
assertThat(client.getSource().read(new Buffer(), 1)).isEqualTo(-1);
// Verify the peer received what was expected.
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(peer.frameCount()).isEqualTo(5);
}
@Test public void clientSendsEmptyDataServerDoesntSendWindowUpdateHttp2() throws Exception {
// Write the mocking script.
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // DATA
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.play();
// Play it back.
Http2Connection connection = connect(peer);
Http2Stream client = connection.newStream(headerEntries("b", "banana"), true);
BufferedSink out = Okio.buffer(client.getSink());
out.write(EMPTY_BYTE_ARRAY);
out.flush();
out.close();
// Verify the peer received what was expected.
assertThat(peer.takeFrame().type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(peer.takeFrame().type).isEqualTo(Http2.TYPE_DATA);
assertThat(peer.frameCount()).isEqualTo(5);
}
@Test public void maxFrameSizeHonored() throws Exception {
byte[] buff = new byte[peer.maxOutboundDataLength() + 1];
Arrays.fill(buff, (byte) '*');
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.acceptFrame(); // DATA
peer.acceptFrame(); // DATA
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("b", "banana"), true);
BufferedSink out = Okio.buffer(stream.getSink());
out.write(buff);
out.flush();
out.close();
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame data = peer.takeFrame();
assertThat(data.data.length).isEqualTo(peer.maxOutboundDataLength());
data = peer.takeFrame();
assertThat(data.data.length).isEqualTo(1);
}
@Test public void pushPromiseStream() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
final List<Header> expectedRequestHeaders = asList(
new Header(Header.TARGET_METHOD, "GET"),
new Header(Header.TARGET_SCHEME, "https"),
new Header(Header.TARGET_AUTHORITY, "squareup.com"),
new Header(Header.TARGET_PATH, "/cached")
);
peer.sendFrame().pushPromise(3, 2, expectedRequestHeaders);
final List<Header> expectedResponseHeaders = asList(
new Header(Header.RESPONSE_STATUS, "200")
);
peer.sendFrame().headers(true, 2, expectedResponseHeaders);
peer.sendFrame().data(true, 3, data(0), 0);
peer.play();
RecordingPushObserver observer = new RecordingPushObserver();
// play it back
Http2Connection connection = connect(peer, observer, REFUSE_INCOMING_STREAMS);
Http2Stream client = connection.newStream(headerEntries("b", "banana"), false);
assertThat(client.getSource().read(new Buffer(), 1)).isEqualTo(-1);
// verify the peer received what was expected
assertThat(peer.takeFrame().type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(observer.takeEvent()).isEqualTo(expectedRequestHeaders);
assertThat(observer.takeEvent()).isEqualTo(expectedResponseHeaders);
}
@Test public void doublePushPromise() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.sendFrame().pushPromise(3, 2, headerEntries("a", "android"));
peer.acceptFrame(); // SYN_REPLY
peer.sendFrame().pushPromise(3, 2, headerEntries("b", "banana"));
peer.acceptFrame(); // RST_STREAM
peer.play();
// play it back
Http2Connection connection = connect(peer);
connection.newStream(headerEntries("b", "banana"), false);
// verify the peer received what was expected
assertThat(peer.takeFrame().type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(peer.takeFrame().errorCode).isEqualTo(ErrorCode.PROTOCOL_ERROR);
}
@Test public void pushPromiseStreamsAutomaticallyCancel() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.sendFrame().pushPromise(3, 2, asList(
new Header(Header.TARGET_METHOD, "GET"),
new Header(Header.TARGET_SCHEME, "https"),
new Header(Header.TARGET_AUTHORITY, "squareup.com"),
new Header(Header.TARGET_PATH, "/cached")
));
peer.sendFrame().headers(true, 2, asList(
new Header(Header.RESPONSE_STATUS, "200")
));
peer.acceptFrame(); // RST_STREAM
peer.play();
// play it back
connect(peer, PushObserver.CANCEL, REFUSE_INCOMING_STREAMS);
// verify the peer received what was expected
InFrame rstStream = peer.takeFrame();
assertThat(rstStream.type).isEqualTo(Http2.TYPE_RST_STREAM);
assertThat(rstStream.streamId).isEqualTo(2);
assertThat(rstStream.errorCode).isEqualTo(ErrorCode.CANCEL);
}
/**
* When writing a set of headers fails due to an {@code IOException}, make sure the writer is left
* in a consistent state so the next writer also gets an {@code IOException} also instead of
* something worse (like an {@link IllegalStateException}.
*
* <p>See https://github.com/square/okhttp/issues/1651
*/
@Test public void socketExceptionWhileWritingHeaders() throws Exception {
peer.acceptFrame(); // SYN_STREAM.
peer.play();
String longString = repeat('a', Http2.INITIAL_MAX_FRAME_SIZE + 1);
Socket socket = peer.openSocket();
Http2Connection connection = new Http2Connection.Builder(true, TaskRunner.INSTANCE)
.socket(socket)
.pushObserver(IGNORE)
.build();
connection.start(/* sendConnectionPreface = */ false);
socket.shutdownOutput();
try {
connection.newStream(headerEntries("a", longString), false);
fail();
} catch (IOException expected) {
}
try {
connection.newStream(headerEntries("b", longString), false);
fail();
} catch (IOException expected) {
}
}
@Test public void clientCreatesStreamAndServerReplies() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // DATA
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.sendFrame().data(true, 3, new Buffer().writeUtf8("robot"), 5);
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0); // PING
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("b", "banana"), true);
BufferedSink out = Okio.buffer(stream.getSink());
out.writeUtf8("c3po");
out.close();
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("a", "android"));
assertStreamData("robot", stream.getSource());
connection.writePingAndAwaitPong();
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(synStream.outFinished).isFalse();
assertThat(synStream.streamId).isEqualTo(3);
assertThat(synStream.associatedStreamId).isEqualTo(-1);
assertThat(synStream.headerBlock).isEqualTo(headerEntries("b", "banana"));
InFrame requestData = peer.takeFrame();
assertArrayEquals("c3po".getBytes(UTF_8), requestData.data);
}
@Test public void serverFinishesStreamWithHeaders() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // PING
peer.sendFrame().headers(true, 3, headerEntries("headers", "bam"));
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("a", "artichaut"), false);
connection.writePingAndAwaitPong();
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("headers", "bam"));
assertThat(stream.trailers()).isEqualTo(EMPTY_HEADERS);
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(synStream.outFinished).isFalse();
assertThat(synStream.streamId).isEqualTo(3);
assertThat(synStream.associatedStreamId).isEqualTo(-1);
assertThat(synStream.headerBlock).isEqualTo(headerEntries("a", "artichaut"));
}
@Test public void serverWritesTrailersAndClientReadsTrailers() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().headers(false, 3, headerEntries("headers", "bam"));
peer.acceptFrame(); // PING
peer.sendFrame().headers(true, 3, headerEntries("trailers", "boom"));
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("a", "artichaut"), false);
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("headers", "bam"));
connection.writePingAndAwaitPong();
assertThat(stream.trailers()).isEqualTo(Headers.of("trailers", "boom"));
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(synStream.outFinished).isFalse();
assertThat(synStream.streamId).isEqualTo(3);
assertThat(synStream.associatedStreamId).isEqualTo(-1);
assertThat(synStream.headerBlock).isEqualTo(headerEntries("a", "artichaut"));
}
/** A server RST_STREAM shouldn't prevent the client from consuming the response body. */
@Test public void serverResponseBodyRstStream() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // PING
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.sendFrame().data(true, 3, new Buffer().writeUtf8("robot"), 5);
peer.sendFrame().rstStream(3, ErrorCode.NO_ERROR);
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries(), false);
connection.writePingAndAwaitPong();
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("a", "android"));
BufferedSource source = Okio.buffer(stream.getSource());
assertThat(source.readUtf8(5)).isEqualTo("robot");
stream.getSink().close();
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame ping = peer.takeFrame();
assertThat(ping.type).isEqualTo(Http2.TYPE_PING);
}
/** A server RST_STREAM shouldn't prevent the client from consuming trailers. */
@Test public void serverTrailersRstStream() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // PING
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.sendFrame().headers(true, 3, headerEntries("z", "zebra"));
peer.sendFrame().rstStream(3, ErrorCode.NO_ERROR);
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries(), true);
connection.writePingAndAwaitPong();
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("a", "android"));
stream.getSink().close();
assertThat(stream.trailers()).isEqualTo(Headers.of("z", "zebra"));
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame ping = peer.takeFrame();
assertThat(ping.type).isEqualTo(Http2.TYPE_PING);
}
/**
* A server RST_STREAM shouldn't prevent the client from consuming the response body, even if it
* follows a truncated request body.
*/
@Test public void clientRequestBodyServerResponseBodyRstStream() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // PING
peer.sendFrame().headers(false, 3, headerEntries("a", "android"));
peer.sendFrame().data(true, 3, new Buffer().writeUtf8("robot"), 5);
peer.sendFrame().rstStream(3, ErrorCode.NO_ERROR);
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries(), true);
connection.writePingAndAwaitPong();
BufferedSink sink = Okio.buffer(stream.getSink());
sink.writeUtf8("abc");
try {
sink.close();
fail();
} catch (StreamResetException expected) {
assertThat(expected.errorCode).isEqualTo(ErrorCode.NO_ERROR);
}
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("a", "android"));
BufferedSource source = Okio.buffer(stream.getSource());
assertThat(source.readUtf8(5)).isEqualTo("robot");
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame ping = peer.takeFrame();
assertThat(ping.type).isEqualTo(Http2.TYPE_PING);
}
@Test public void serverWritesTrailersWithData() throws Exception {
// We buffer some outbound data and headers and confirm that the END_STREAM flag comes with the
// headers (and not with the data).
// write the mocking script for the client
peer.setClient(true);
// Write the mocking script.
peer.sendFrame().settings(new Settings());
peer.sendFrame().headers(true, 3, headerEntries("client", "abc"));
peer.acceptFrame(); // ACK
peer.acceptFrame(); // HEADERS STREAM 3
peer.acceptFrame(); // DATA STREAM 3 "abcde"
peer.acceptFrame(); // HEADERS STREAM 3
peer.play();
// Play it back.
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("a", "android"), true);
stream.enqueueTrailers(Headers.of("foo", "bar"));
BufferedSink sink = Okio.buffer(stream.getSink());
sink.writeUtf8("abcdefghi");
sink.close();
// Verify the peer received what was expected.
InFrame headers1 = peer.takeFrame();
assertThat(headers1.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame data1 = peer.takeFrame();
assertThat(data1.type).isEqualTo(Http2.TYPE_DATA);
assertThat(data1.streamId).isEqualTo(3);
assertArrayEquals("abcdefghi".getBytes(UTF_8), data1.data);
assertThat(data1.inFinished).isFalse();
InFrame headers2 = peer.takeFrame();
assertThat(headers2.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(headers2.inFinished).isTrue();
}
@Test public void clientCannotReadTrailersWithoutExhaustingStream() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().data(false, 3, new Buffer().writeUtf8("robot"), 5);
peer.sendFrame().headers(true, 3, headerEntries("trailers", "boom"));
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("a", "artichaut"), true);
connection.writePingAndAwaitPong();
try {
stream.trailers();
fail();
} catch (IllegalStateException expected) {
}
}
@Test public void clientCannotReadTrailersIfTheStreamFailed() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().rstStream(3, ErrorCode.PROTOCOL_ERROR);
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("a", "artichaut"), true);
connection.writePingAndAwaitPong();
try {
stream.trailers();
fail();
} catch (StreamResetException expected) {
}
}
@Test public void serverCannotEnqueueTrailersAfterFinishingTheStream() throws Exception {
peer.setClient(true);
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0);
peer.play();
// Play it back.
Http2Connection connection = connect(peer);
connection.writePingAndAwaitPong();
Http2Stream stream = connection.newStream(headerEntries("a", "android"), true);
// finish the stream
stream.writeHeaders(headerEntries("b", "berserk"), true, false);
try {
stream.enqueueTrailers(Headers.of("trailers", "boom"));
fail();
} catch (IllegalStateException expected) {
}
}
@Test public void noTrailersFrameYieldsEmptyTrailers() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.sendFrame().headers(false, 3, headerEntries("headers", "bam"));
peer.sendFrame().data(true, 3, new Buffer().writeUtf8("robot"), 5);
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0); // PONG
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("a", "artichaut"), false);
BufferedSource source = Okio.buffer(stream.getSource());
connection.writePingAndAwaitPong();
assertThat(stream.takeHeaders()).isEqualTo(Headers.of("headers", "bam"));
assertThat(source.readUtf8(5)).isEqualTo("robot");
assertThat(stream.trailers()).isEqualTo(EMPTY_HEADERS);
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(synStream.outFinished).isFalse();
assertThat(synStream.streamId).isEqualTo(3);
assertThat(synStream.associatedStreamId).isEqualTo(-1);
assertThat(synStream.headerBlock).isEqualTo(headerEntries("a", "artichaut"));
}
@Test public void serverReadsHeadersDataHeaders() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // DATA
peer.acceptFrame(); // HEADERS
peer.sendFrame().headers(true, 3, headerEntries("a", "android"));
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 0); // PING
peer.play();
// play it back
Http2Connection connection = connect(peer);
Http2Stream stream = connection.newStream(headerEntries("b", "banana"), true);
BufferedSink out = Okio.buffer(stream.getSink());
out.writeUtf8("c3po");
out.close();
stream.writeHeaders(headerEntries("e", "elephant"), false, false);
connection.writePingAndAwaitPong();
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
assertThat(synStream.outFinished).isFalse();
assertThat(synStream.streamId).isEqualTo(3);
assertThat(synStream.associatedStreamId).isEqualTo(-1);
assertThat(synStream.headerBlock).isEqualTo(headerEntries("b", "banana"));
InFrame requestData = peer.takeFrame();
assertArrayEquals("c3po".getBytes(UTF_8), requestData.data);
InFrame nextFrame = peer.takeFrame();
assertThat(nextFrame.headerBlock).isEqualTo(headerEntries("e", "elephant"));
}
@Test public void clientCreatesStreamAndServerRepliesWithFin() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // SYN_STREAM
peer.acceptFrame(); // PING
peer.sendFrame().headers(true, 3, headerEntries("a", "android"));
peer.sendFrame().ping(true, AWAIT_PING, 0);
peer.play();
// play it back
Http2Connection connection = connect(peer);
connection.newStream(headerEntries("b", "banana"), false);
assertThat(connection.openStreamCount()).isEqualTo(1);
connection.writePingAndAwaitPong(); // Ensure that the SYN_REPLY has been received.
assertThat(connection.openStreamCount()).isEqualTo(0);
// verify the peer received what was expected
InFrame synStream = peer.takeFrame();
assertThat(synStream.type).isEqualTo(Http2.TYPE_HEADERS);
InFrame ping = peer.takeFrame();
assertThat(ping.type).isEqualTo(Http2.TYPE_PING);
}
@Test public void serverPingsClient() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.sendFrame().ping(false, 2, 0);
peer.acceptFrame(); // PING
peer.play();
// play it back
connect(peer);
// verify the peer received what was expected
InFrame ping = peer.takeFrame();
assertThat(ping.streamId).isEqualTo(0);
assertThat(ping.payload1).isEqualTo(2);
assertThat(ping.payload2).isEqualTo(0);
assertThat(ping.ack).isTrue();
}
@Test public void clientPingsServer() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, AWAIT_PING, 5);
peer.play();
// play it back
Http2Connection connection = connect(peer);
long pingAtNanos = System.nanoTime();
connection.writePingAndAwaitPong();
long elapsedNanos = System.nanoTime() - pingAtNanos;
assertThat(elapsedNanos).isGreaterThan(0L);
assertThat(elapsedNanos).isLessThan(TimeUnit.SECONDS.toNanos(1));
// verify the peer received what was expected
InFrame pingFrame = peer.takeFrame();
assertThat(pingFrame.type).isEqualTo(Http2.TYPE_PING);
assertThat(pingFrame.streamId).isEqualTo(0);
assertThat(pingFrame.payload1).isEqualTo(AWAIT_PING);
assertThat(pingFrame.payload2).isEqualTo(0x4f4b6f6b); // OKok.
assertThat(pingFrame.ack).isFalse();
}
@Test public void unexpectedPongIsNotReturned() throws Exception {
// write the mocking script
peer.sendFrame().settings(new Settings());
peer.acceptFrame(); // ACK
peer.sendFrame().ping(false, 2, 0);
peer.acceptFrame(); // PING
peer.sendFrame().ping(true, 99, 0); // This pong is silently ignored.
peer.sendFrame().ping(false, 4, 0);
peer.acceptFrame(); // PING
peer.play();
// play it back
connect(peer);
// verify the peer received what was expected
InFrame ping2 = peer.takeFrame();
assertThat(ping2.payload1).isEqualTo(2);
InFrame ping4 = peer.takeFrame();
assertThat(ping4.payload1).isEqualTo(4);
}
@Test public void serverSendsSettingsToClient() throws Exception {
// write the mocking script
final Settings settings = new Settings();
settings.set(MAX_CONCURRENT_STREAMS, 10);
peer.sendFrame().settings(settings);
peer.acceptFrame(); // ACK
peer.sendFrame().ping(false, 2, 0);
peer.acceptFrame(); // PING
peer.play();
// play it back
final CountDownLatch maxConcurrentStreamsUpdated = new CountDownLatch(1);
final AtomicInteger maxConcurrentStreams = new AtomicInteger();
Http2Connection.Listener listener = new Http2Connection.Listener() {
@Override public void onStream(Http2Stream stream) throws IOException {
throw new AssertionError();
}
@Override public void onSettings(Http2Connection connection, Settings settings) {
maxConcurrentStreams.set(settings.getMaxConcurrentStreams());
maxConcurrentStreamsUpdated.countDown();
}
};
Http2Connection connection = connect(peer, IGNORE, listener);
synchronized (connection) {
assertThat(connection.getPeerSettings().getMaxConcurrentStreams()).isEqualTo(10);
}
maxConcurrentStreamsUpdated.await();
assertThat(maxConcurrentStreams.get()).isEqualTo(10);
}
@Test public void multipleSettingsFramesAreMerged() throws Exception {