quiche: do not arm stream_idle_timer_ if the stream is closed (envoyp…

…roxy#22689)

Commit Message: stream_idle_timer_ is armed to timeout the sending of the bufferred response payload in the quic stream send buffer after the end stream is buffered in the stream. But today this timer is armed even if the the encoding of the payload causes the stream to be closed, in which case the timer can never be cancelled till the stream destruction with ASSERT hit as below:

[2022-08-12 22:23:38.843][12][critical][backtrace] [./source/server/backtrace.h:104] Caught Aborted, suspect faulting address 0x50e8d0000000c
[2022-08-12 22:23:38.844][12][critical][backtrace] [./source/server/backtrace.h:91] Backtrace (use tools/stack_decode.py to get line numbers):
[2022-08-12 22:23:38.844][12][critical][backtrace] [./source/server/backtrace.h:92] Envoy version: 0/1.24.0-dev/test/DEBUG/BoringSSL
[2022-08-12 22:23:38.858][12][critical][backtrace] [./source/server/backtrace.h:96] #0: Envoy::SignalAction::sigHandler() [0x3480b28]
[2022-08-12 22:23:38.858][12][critical][backtrace] [./source/server/backtrace.h:96] #1: __restore_rt [0x7f94b072c200]
[2022-08-12 22:23:38.872][12][critical][backtrace] [./source/server/backtrace.h:96] #2: Envoy::Quic::EnvoyQuicStream::~EnvoyQuicStream() [0x2a2fe98]
[2022-08-12 22:23:38.885][12][critical][backtrace] [./source/server/backtrace.h:96] #3: Envoy::Quic::EnvoyQuicServerStream::~EnvoyQuicServerStream() [0x2a78058]
[2022-08-12 22:23:38.899][12][critical][backtrace] [./source/server/backtrace.h:96] #4: Envoy::Quic::EnvoyQuicServerStream::~EnvoyQuicServerStream() [0x2a77d30]
[2022-08-12 22:23:38.912][12][critical][backtrace] [./source/server/backtrace.h:96] #5: Envoy::Quic::EnvoyQuicServerStream::~EnvoyQuicServerStream() [0x2a77d69]
This change check stream close in this case, so that the idle timer will not be armed for closed streams.

Risk Level: low
Testing: new unit test
Docs Changes: N/A
Release Notes: N/A
Platform Specific Features: N/A
Signed-off-by: Dan Zhang <danzh@google.com>

source/common/quic/envoy_quic_server_stream.cc

@@ -455,7 +455,7 @@ void EnvoyQuicServerStream::onPendingFlushTimer() {
 bool EnvoyQuicServerStream::hasPendingData() {
  // Quic stream sends headers and trailers on the same stream, and buffers them in the same sending
  // buffer if needed. So checking this buffer is sufficient.
- return BufferedDataBytes() > 0;
+ return (!write_side_closed()) && BufferedDataBytes() > 0;
 }
 
 } // namespace Quic

test/common/quic/envoy_quic_server_stream_test.cc

@@ -53,6 +53,7 @@ class EnvoyQuicServerStreamTest : public testing::Test {
  response_trailers_{{"trailer-key", "trailer-value"}} {
  quic_stream_->setRequestDecoder(stream_decoder_);
  quic_stream_->addCallbacks(stream_callbacks_);
+ quic_stream_->getStream().setFlushTimeout(std::chrono::milliseconds(30000));
  quic::test::QuicConnectionPeer::SetAddressValidated(&quic_connection_);
  quic_session_.ActivateStream(std::unique_ptr<EnvoyQuicServerStream>(quic_stream_));
  EXPECT_CALL(quic_session_, ShouldYield(_)).WillRepeatedly(testing::Return(false));
@@ -692,6 +693,41 @@ TEST_F(EnvoyQuicServerStreamTest, ConnectionCloseDuringEncoding) {
  EXPECT_EQ(quic_session_.bytesToSend(), 0u);
 }
 
+TEST_F(EnvoyQuicServerStreamTest, ConnectionCloseDuringEncodingEndStream) {
+ receiveRequest(request_body_, true, request_body_.size() * 2);
+ quic_stream_->encodeHeaders(response_headers_, /*end_stream=*/false);
+ EXPECT_CALL(quic_connection_,
+ SendConnectionClosePacket(_, quic::NO_IETF_QUIC_ERROR, "Closed in WriteHeaders"));
+ EXPECT_CALL(quic_session_, WritevData(_, _, _, _, _, _))
+ .Times(testing::AtLeast(1u))
+ .WillRepeatedly(
+ Invoke([this](quic::QuicStreamId, size_t data_size, quic::QuicStreamOffset,
+ quic::StreamSendingState, bool, absl::optional<quic::EncryptionLevel>) {
+ if (data_size < 10) {
+ // Ietf QUIC sends a small data frame header before sending the data frame payload.
+ return quic::QuicConsumedData{data_size, false};
+ }
+ // Mimic write failure while writing data frame payload.
+ quic_connection_.CloseConnection(
+ quic::QUIC_INTERNAL_ERROR, "Closed in WriteHeaders",
+ quic::ConnectionCloseBehavior::SEND_CONNECTION_CLOSE_PACKET);
+ // This will cause the payload to be buffered.
+ return quic::QuicConsumedData{0, false};
+ }));
+
+ // Send a response which causes connection to close.
+ EXPECT_CALL(quic_session_, MaybeSendRstStreamFrame(_, _, _));
+
+ std::string response(16 * 1024 + 1, 'a');
+ Buffer::OwnedImpl buffer(response);
+ // Though the stream send buffer is above high watermark, onAboveWriteBufferHighWatermark())
+ // shouldn't be called because the connection is closed.
+ quic_stream_->encodeData(buffer, true);
+ EXPECT_EQ(quic_session_.bytesToSend(), 0u);
+ EXPECT_TRUE(quic_stream_->write_side_closed() && quic_stream_->read_side_closed());
+ quic_session_.CleanUpClosedStreams();
+}
+
 // Tests that after end_stream is encoded, closing connection shouldn't call
 // onResetStream() callbacks.
 TEST_F(EnvoyQuicServerStreamTest, ConnectionCloseAfterEndStreamEncoded) {