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
|
package quic
import (
"fmt"
"io"
"net"
"os"
"sync/atomic"
"testing"
"time"
"github.com/quic-go/quic-go/internal/mocks"
"github.com/quic-go/quic-go/internal/protocol"
"github.com/quic-go/quic-go/internal/wire"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/mock/gomock"
)
type readerWithTimeout struct {
io.Reader
Timeout time.Duration
}
func (r *readerWithTimeout) Read(p []byte) (n int, err error) {
done := make(chan struct{})
go func() {
defer close(done)
n, err = r.Reader.Read(p)
}()
select {
case <-done:
return n, err
case <-time.After(r.Timeout):
return 0, fmt.Errorf("read timeout after %s", r.Timeout)
}
}
func TestReceiveStreamReadData(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
str := newReceiveStream(42, nil, mockFC)
// read an entire frame
now := time.Now()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(4), false, now)
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(4))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte{0xde, 0xad, 0xbe, 0xef}}, now))
b := make([]byte, 4)
n, err := (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 4, n)
require.Equal(t, []byte{0xde, 0xad, 0xbe, 0xef}, b)
// split a frame across multiple reads
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(8), false, now)
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2)).Times(2)
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 4, Data: []byte{0xca, 0xfe, 0xba, 0xbe}}, now))
b = make([]byte, 2)
n, err = (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 2, n)
require.Equal(t, []byte{0xca, 0xfe}, b)
n, err = (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 2, n)
require.Equal(t, []byte{0xba, 0xbe}, b)
// combine two frames
gomock.InOrder(
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(11), false, now),
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(14), false, now),
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(3)).Times(2),
)
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 8, Data: []byte{'f', 'o', 'o'}}, now))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 11, Data: []byte{'b', 'a', 'r'}}, now))
b = make([]byte, 6)
n, err = (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 6, n)
require.Equal(t, []byte{'f', 'o', 'o', 'b', 'a', 'r'}, b)
// reordered frames
gomock.InOrder(
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(20), false, now),
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(17), false, now),
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(3)).Times(2),
)
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 17, Data: []byte{'b', 'a', 'z'}}, now))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 14, Data: []byte{'f', 'o', 'o'}}, now))
b = make([]byte, 6)
n, err = (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 6, n)
require.Equal(t, []byte{'f', 'o', 'o', 'b', 'a', 'z'}, b)
}
func TestReceiveStreamBlockRead(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(2), false, gomock.Any())
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2))
errChan := make(chan error, 1)
go func() {
frame := wire.StreamFrame{Data: []byte{0xDE, 0xAD}}
time.Sleep(scaleDuration(5 * time.Millisecond))
errChan <- str.handleStreamFrame(&frame, time.Now())
}()
n, err := (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(make([]byte, 2))
require.NoError(t, err)
require.Equal(t, 2, n)
require.NoError(t, <-errChan)
}
func TestReceiveStreamReadOverlappingData(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
str := newReceiveStream(42, nil, mockFC)
// receive the same frame multiple times
now := time.Now()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(4), false, now).Times(3)
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(4))
for i := 0; i < 3; i++ {
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte{0xde, 0xad, 0xbe, 0xef}}, now))
}
b := make([]byte, 4)
n, err := (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 4, n)
require.Equal(t, []byte{0xde, 0xad, 0xbe, 0xef}, b)
// receive overlapping data
gomock.InOrder(
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(8), false, now),
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), false, now),
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(4)),
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2)),
)
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 4, Data: []byte{'f', 'o', 'o', 'b'}}, now))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 6, Data: []byte{'o', 'b', 'a', 'r'}}, now))
b = make([]byte, 6)
n, err = (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 6, n)
require.Equal(t, []byte{'f', 'o', 'o', 'b', 'a', 'r'}, b)
}
func TestReceiveStreamFlowControlUpdates(t *testing.T) {
t.Run("stream", func(t *testing.T) {
testReceiveStreamFlowControlUpdates(t, true, false)
})
t.Run("connection", func(t *testing.T) {
testReceiveStreamFlowControlUpdates(t, false, true)
})
}
func testReceiveStreamFlowControlUpdates(t *testing.T, hasStreamWindowUpdate, hasConnWindowUpdate bool) {
const streamID protocol.StreamID = 42
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(streamID, mockSender, mockFC)
now := time.Now()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(4), false, now)
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte{0xde, 0xad, 0xbe, 0xef}}, now))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(3)).Return(hasStreamWindowUpdate, hasConnWindowUpdate)
if hasStreamWindowUpdate {
mockSender.EXPECT().onHasStreamControlFrame(streamID, str)
}
if hasConnWindowUpdate {
mockSender.EXPECT().onHasConnectionData()
}
n, err := (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(make([]byte, 3))
require.NoError(t, err)
require.Equal(t, 3, n)
require.True(t, mockCtrl.Satisfied())
if hasStreamWindowUpdate {
now = now.Add(time.Second)
mockFC.EXPECT().GetWindowUpdate(now).Return(protocol.ByteCount(1337))
f, ok, hasMore := str.getControlFrame(now)
require.True(t, ok)
require.Equal(t, &wire.MaxStreamDataFrame{StreamID: streamID, MaximumStreamData: 1337}, f.Frame)
require.False(t, hasMore)
}
if hasConnWindowUpdate {
_, ok, hasMore := str.getControlFrame(now)
require.False(t, ok)
require.False(t, hasMore)
}
}
func TestReceiveStreamDeadlineInThePast(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
str := newReceiveStream(42, nil, mockFC)
// no data is read when the deadline is in the past
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), false, gomock.Any()).AnyTimes()
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar")}, time.Now()))
require.NoError(t, str.SetReadDeadline(time.Now().Add(-time.Second)))
b := make([]byte, 6)
n, err := (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.Error(t, err)
require.Zero(t, n)
var nerr net.Error
require.ErrorAs(t, err, &nerr)
require.True(t, nerr.Timeout())
// data is read when the deadline is in the future
require.NoError(t, str.SetReadDeadline(time.Now().Add(time.Second)))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(6))
n, err = (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(b)
require.NoError(t, err)
require.Equal(t, 6, n)
}
func TestReceiveStreamDeadlineRemoval(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
str := newReceiveStream(42, nil, mockFC)
deadline := scaleDuration(20 * time.Millisecond)
require.NoError(t, str.SetReadDeadline(time.Now().Add(deadline)))
errChan := make(chan error, 1)
go func() {
_, err := (&readerWithTimeout{Reader: str, Timeout: 5 * time.Second}).Read([]byte{0})
errChan <- err
}()
select {
case err := <-errChan:
t.Fatalf("read should not have returned yet: %v", err)
case <-time.After(deadline / 2):
}
// remove the deadline after a while (but before it expires)
require.NoError(t, str.SetReadDeadline(time.Time{}))
select {
case err := <-errChan:
t.Fatalf("read should not have returned yet: %v", err)
case <-time.After(deadline):
}
// now set the deadline to the past to make Read return immediately
require.NoError(t, str.SetReadDeadline(time.Now().Add(-time.Second)))
select {
case err := <-errChan:
require.ErrorIs(t, err, os.ErrDeadlineExceeded)
case <-time.After(time.Second):
t.Fatal("timeout")
}
}
func TestReceiveStreamDeadlineExtension(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
str := newReceiveStream(42, nil, mockFC)
deadline := scaleDuration(20 * time.Millisecond)
require.NoError(t, str.SetReadDeadline(time.Now().Add(deadline)))
errChan := make(chan error, 1)
go func() {
_, err := (&readerWithTimeout{Reader: str, Timeout: 5 * time.Second}).Read([]byte{0})
errChan <- err
}()
select {
case err := <-errChan:
t.Fatalf("read should not have returned yet: %v", err)
case <-time.After(deadline / 2):
}
// extend the deadline
require.NoError(t, str.SetReadDeadline(time.Now().Add(deadline)))
select {
case err := <-errChan:
require.ErrorIs(t, err, os.ErrDeadlineExceeded)
case <-time.After(deadline * 3 / 2):
t.Fatal("timeout")
}
}
func TestReceiveStreamEOFWithData(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
now := time.Now()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(4), true, now)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(2), false, now)
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Offset: 2, Data: []byte{0xbe, 0xef}, Fin: true}, now))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte{0xde, 0xad}}, now))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2)).Times(2)
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
strWithTimeout := &readerWithTimeout{Reader: str, Timeout: time.Second}
b := make([]byte, 6)
n, err := strWithTimeout.Read(b)
require.ErrorIs(t, err, io.EOF)
require.Equal(t, 4, n)
require.Equal(t, []byte{0xde, 0xad, 0xbe, 0xef}, b[:n])
n, err = strWithTimeout.Read(b)
require.Zero(t, n)
require.ErrorIs(t, err, io.EOF)
}
func TestReceiveStreamImmediateFINs(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(0), true, gomock.Any())
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(0))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Fin: true}, time.Now()))
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
n, err := (&readerWithTimeout{Reader: str, Timeout: time.Second}).Read(make([]byte, 4))
require.Zero(t, n)
require.ErrorIs(t, err, io.EOF)
}
func TestReceiveStreamCloseForShutdown(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
strWithTimeout := &readerWithTimeout{Reader: str, Timeout: time.Second}
// Test immediate return of reads
errChan := make(chan error, 1)
go func() {
_, err := strWithTimeout.Read([]byte{0})
errChan <- err
}()
select {
case err := <-errChan:
t.Fatalf("read returned before closeForShutdown: %v", err)
case <-time.After(scaleDuration(5 * time.Millisecond)): // short wait to ensure read is blocked
}
str.closeForShutdown(assert.AnError)
select {
case err := <-errChan:
require.ErrorIs(t, err, assert.AnError)
case <-time.After(time.Second):
t.Fatal("read did not return after closeForShutdown")
}
// following calls to Read should return the error
n, err := strWithTimeout.Read([]byte{0})
require.Zero(t, n)
require.ErrorIs(t, err, assert.AnError)
// receiving a RESET_STREAM frame after closeForShutdown does nothing
require.NoError(t, str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1234, FinalSize: 42}, time.Now()))
n, err = strWithTimeout.Read([]byte{0})
require.Zero(t, n)
require.ErrorIs(t, err, assert.AnError)
// calling CancelRead after closeForShutdown does nothing
str.CancelRead(1234)
n, err = strWithTimeout.Read([]byte{0})
require.Zero(t, n)
require.ErrorIs(t, err, assert.AnError)
}
func TestReceiveStreamCancellation(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
strWithTimeout := &readerWithTimeout{Reader: str, Timeout: time.Second}
mockSender.EXPECT().onHasStreamControlFrame(str.StreamID(), gomock.Any())
errChan := make(chan error, 1)
go func() {
_, err := strWithTimeout.Read([]byte{0})
errChan <- err
}()
select {
case err := <-errChan:
t.Fatalf("read returned before CancelRead: %v", err)
case <-time.After(scaleDuration(5 * time.Millisecond)):
}
str.CancelRead(1234)
// this queues a STOP_SENDING frame
f, ok, hasMore := str.getControlFrame(time.Now())
require.True(t, ok)
require.Equal(t, &wire.StopSendingFrame{StreamID: 42, ErrorCode: 1234}, f.Frame)
require.False(t, hasMore)
require.True(t, mockCtrl.Satisfied())
select {
case err := <-errChan:
var streamErr *StreamError
require.ErrorAs(t, err, &streamErr)
require.Equal(t, StreamError{StreamID: 42, ErrorCode: 1234, Remote: false}, *streamErr)
case <-time.After(time.Second):
t.Fatal("Read was not unblocked")
}
// further Read calls return the error
n, err := strWithTimeout.Read([]byte{0})
require.Zero(t, n)
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: false})
// calling CancelRead again does nothing
// especially:
// 1. no more calls to onHasStreamControlFrame
// 2. no changes of the error code returned by Read
str.CancelRead(1234)
str.CancelRead(4321)
n, err = strWithTimeout.Read([]byte{0})
require.Zero(t, n)
// error code unchanged
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: false})
require.True(t, mockCtrl.Satisfied())
// receiving the FIN bit has no effect
mockFC.EXPECT().Abandon()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), true, gomock.Any()).Times(2)
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
// receive two of them, to make sure onStreamCompleted is not called twice
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar"), Fin: true}, time.Now()))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar"), Fin: true}, time.Now()))
require.True(t, mockCtrl.Satisfied())
// receiving a RESET_STREAM frame after CancelRead has no effect
mockFC.EXPECT().Abandon()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(42), true, gomock.Any())
require.NoError(t, str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 4321, FinalSize: 42}, time.Now()))
n, err = strWithTimeout.Read([]byte{0})
require.Zero(t, n)
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: false})
}
func TestReceiveStreamCancelReadAfterFIN(t *testing.T) {
t.Run("FIN not read", func(t *testing.T) {
testReceiveStreamCancelReadAfterFIN(t, false)
})
t.Run("FIN read", func(t *testing.T) {
testReceiveStreamCancelReadAfterFIN(t, true)
})
}
func testReceiveStreamCancelReadAfterFIN(t *testing.T, finRead bool) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), true, gomock.Any())
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar"), Fin: true}, time.Now()))
if finRead {
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(6))
n, err := str.Read(make([]byte, 10))
require.ErrorIs(t, err, io.EOF)
require.Equal(t, 6, n)
}
// if the FIN was received, but not read yet, a STOP_SENDING frame is queued
if !finRead {
mockFC.EXPECT().Abandon()
mockSender.EXPECT().onHasStreamControlFrame(str.StreamID(), str)
}
str.CancelRead(1337)
f, ok, hasMore := str.getControlFrame(time.Now())
// if the EOF was already read, no STOP_SENDING frame is queued
if finRead {
require.False(t, ok)
require.False(t, hasMore)
} else {
require.True(t, ok)
require.Equal(t, &wire.StopSendingFrame{StreamID: 42, ErrorCode: 1337}, f.Frame)
require.False(t, hasMore)
}
// Read returns the error
n, err := str.Read([]byte{0})
require.Zero(t, n)
if finRead {
require.ErrorIs(t, err, io.EOF)
} else {
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1337, Remote: false})
}
}
func TestReceiveStreamReset(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
strWithTimeout := &readerWithTimeout{Reader: str, Timeout: time.Second}
errChan := make(chan error, 1)
go func() {
_, err := strWithTimeout.Read([]byte{0})
errChan <- err
}()
select {
case err := <-errChan:
t.Fatalf("read returned before reset: %v", err)
case <-time.After(scaleDuration(5 * time.Millisecond)):
}
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
gomock.InOrder(
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(42), true, gomock.Any()),
mockFC.EXPECT().Abandon().MinTimes(1),
)
require.NoError(t, str.handleResetStreamFrame(
&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1234, FinalSize: 42},
time.Now(),
))
select {
case err := <-errChan:
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: true})
case <-time.After(time.Second):
t.Fatal("Read was not unblocked")
}
// Test that further calls to Read return the error
_, err := strWithTimeout.Read([]byte{0})
require.Equal(t, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: true}, err)
// further RESET_STREAM frames have no effect
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(42), true, gomock.Any())
require.NoError(t, str.handleResetStreamFrame(
&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 4321, FinalSize: 42},
time.Now(),
))
n, err := str.Read([]byte{0})
require.Zero(t, n)
// error code unchanged
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: true})
// CancelRead after a RESET_STREAM frame has no effect
str.CancelRead(100)
n, err = str.Read([]byte{0})
require.Zero(t, n)
// error code and remote flag unchanged
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1234, Remote: true})
}
func TestReceiveStreamResetAfterFINRead(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), true, gomock.Any())
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
require.NoError(t, str.handleStreamFrame(
&wire.StreamFrame{StreamID: 42, Data: []byte("foobar"), Fin: true},
time.Now(),
))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(6))
n, err := str.Read(make([]byte, 6))
require.Equal(t, 6, n)
require.ErrorIs(t, err, io.EOF)
// make sure that onStreamCompleted was called due to the EOF
require.True(t, mockCtrl.Satisfied())
// Now receive a RESET_STREAM frame.
// We don't expect any more calls to onStreamCompleted.
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), true, gomock.Any())
mockFC.EXPECT().Abandon()
require.NoError(t, str.handleResetStreamFrame(
&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1234, FinalSize: 6},
time.Now(),
))
// now read the error
n, err = str.Read([]byte{0})
require.Error(t, err)
require.Zero(t, n)
}
// Calling Read concurrently doesn't make any sense (and is forbidden),
// but we still want to make sure that we don't complete the stream more than once
// if the user misuses our API.
// This would lead to an INTERNAL_ERROR ("tried to delete unknown outgoing stream"),
// which can be hard to debug.
// Note that even without the protection built into the receiveStream, this test
// is very timing-dependent, and would need to run a few hundred times to trigger the failure.
func TestReceiveStreamConcurrentReads(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), gomock.Any(), gomock.Any()).AnyTimes()
var bytesRead protocol.ByteCount
mockFC.EXPECT().AddBytesRead(gomock.Any()).Do(func(n protocol.ByteCount) (bool, bool) {
bytesRead += n
return false, false
}).AnyTimes()
var numCompleted atomic.Int32
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42)).Do(func(protocol.StreamID) {
numCompleted.Add(1)
}).AnyTimes()
const num = 3
errChan := make(chan error, num)
for range num {
go func() {
_, err := str.Read(make([]byte, 8))
errChan <- err
}()
}
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar"), Fin: true}, time.Now()))
for range num {
select {
case err := <-errChan:
require.ErrorIs(t, err, io.EOF)
case <-time.After(time.Second):
t.Fatal("timeout")
}
}
require.Equal(t, protocol.ByteCount(6), bytesRead)
require.Equal(t, int32(1), numCompleted.Load())
}
func TestReceiveStreamResetStreamAtBeforeReadOffset(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), false, gomock.Any())
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar")}, time.Now()))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(3))
b := make([]byte, 3)
n, err := str.Read(b)
require.NoError(t, err)
require.Equal(t, 3, n)
require.Equal(t, []byte("foo"), b)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
mockFC.EXPECT().Abandon()
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10, ReliableSize: 3}, time.Now())
require.True(t, mockCtrl.Satisfied())
// Read returns the error
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
n, err = str.Read([]byte{0})
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1337, Remote: true})
require.Zero(t, n)
}
func TestReceiveStreamResetStreamAtAfterReadOffset(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), false, gomock.Any())
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar")}, time.Now()))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2))
b := make([]byte, 2)
n, err := str.Read(b)
require.NoError(t, err)
require.Equal(t, 2, n)
require.Equal(t, []byte("fo"), b)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10, ReliableSize: 6}, time.Now())
require.True(t, mockCtrl.Satisfied())
// Read returns the error
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2))
n, err = str.Read(b)
require.NoError(t, err)
require.Equal(t, 2, n)
require.Equal(t, []byte("ob"), b)
require.True(t, mockCtrl.Satisfied())
gomock.InOrder(
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(2)),
mockFC.EXPECT().Abandon(),
)
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
n, err = str.Read(b)
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1337, Remote: true})
require.Equal(t, 2, n)
require.Equal(t, []byte("ar"), b)
}
func TestReceiveStreamMultipleResetStreamAt(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), false, gomock.Any())
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar")}, time.Now()))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(3))
b := make([]byte, 3)
n, err := str.Read(b)
require.NoError(t, err)
require.Equal(t, 3, n)
require.Equal(t, []byte("foo"), b)
require.True(t, mockCtrl.Satisfied())
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10, ReliableSize: 6}, time.Now())
require.True(t, mockCtrl.Satisfied())
// receiving a reordered RESET_STREAM_AT frame has no effect
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10, ReliableSize: 8}, time.Now())
require.True(t, mockCtrl.Satisfied())
// receiving a RESET_STREAM_AT frame with a smaller reliable size is valid
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
mockFC.EXPECT().Abandon()
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10, ReliableSize: 3}, time.Now())
// Read returns the error
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
n, err = str.Read(b)
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1337, Remote: true})
require.Zero(t, n)
}
func TestReceiveStreamResetStreamAtAfterResetStream(t *testing.T) {
mockCtrl := gomock.NewController(t)
mockFC := mocks.NewMockStreamFlowController(mockCtrl)
mockSender := NewMockStreamSender(mockCtrl)
str := newReceiveStream(42, mockSender, mockFC)
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(6), false, gomock.Any())
require.NoError(t, str.handleStreamFrame(&wire.StreamFrame{Data: []byte("foobar")}, time.Now()))
mockFC.EXPECT().AddBytesRead(protocol.ByteCount(3))
b := make([]byte, 3)
n, err := str.Read(b)
require.NoError(t, err)
require.Equal(t, 3, n)
require.Equal(t, []byte("foo"), b)
require.True(t, mockCtrl.Satisfied())
mockFC.EXPECT().Abandon()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10}, time.Now())
require.True(t, mockCtrl.Satisfied())
// receiving a reordered RESET_STREAM_AT frame has no effect
mockFC.EXPECT().Abandon()
mockFC.EXPECT().UpdateHighestReceived(protocol.ByteCount(10), true, gomock.Any())
str.handleResetStreamFrame(&wire.ResetStreamFrame{StreamID: 42, ErrorCode: 1337, FinalSize: 10, ReliableSize: 8}, time.Now())
require.True(t, mockCtrl.Satisfied())
// Read returns the error
mockSender.EXPECT().onStreamCompleted(protocol.StreamID(42))
n, err = str.Read(b)
require.ErrorIs(t, err, &StreamError{StreamID: 42, ErrorCode: 1337, Remote: true})
require.Zero(t, n)
}
|