SPDY - chunked upload - speech recognition doesn't work with SPDY/3

net/spdy/spdy_http_stream_spdy2_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/spdy/spdy_http_stream.h"
 
 #include "crypto/ec_private_key.h"
 #include "crypto/ec_signature_creator.h"
 #include "crypto/signature_creator.h"
 #include "net/base/asn1_util.h"
 #include "net/base/default_server_bound_cert_store.h"
 #include "net/http/http_response_headers.h"
 #include "net/http/http_response_info.h"
 #include "net/spdy/spdy_session.h"
 #include "net/spdy/spdy_test_util_spdy2.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using namespace net::test_spdy2;
 
 namespace net {
 
 class SpdyHttpStreamSpdy2Test : public testing::Test {
  public:
   OrderedSocketData* data() { return data_.get(); }
  protected:
   SpdyHttpStreamSpdy2Test() {}
 
   virtual void SetUp() {
     SpdySession::set_default_protocol(kProtoSPDY2);
+    merge_chunks_ = UploadDataStream::merge_chunks();
   }
 
   virtual void TearDown() {
     crypto::ECSignatureCreator::SetFactoryForTesting(NULL);
+    UploadDataStream::set_merge_chunks(merge_chunks_);
     MessageLoop::current()->RunAllPending();
   }
 
   int InitSession(MockRead* reads, size_t reads_count,
                   MockWrite* writes, size_t writes_count,
                   HostPortPair& host_port_pair) {
     HostPortProxyPair pair(host_port_pair, ProxyServer::Direct());
     data_.reset(new OrderedSocketData(reads, reads_count,
                                       writes, writes_count));
     session_deps_.socket_factory->AddSocketDataProvider(data_.get());
@@ skipping 17 matching lines @@
   }
 
   SpdySessionDependencies session_deps_;
   scoped_ptr<OrderedSocketData> data_;
   scoped_refptr<HttpNetworkSession> http_session_;
   scoped_refptr<SpdySession> session_;
   scoped_refptr<TransportSocketParams> transport_params_;
 
  private:
   SpdyTestStateHelper spdy_state_;
+  bool merge_chunks_;
 };
 
 TEST_F(SpdyHttpStreamSpdy2Test, SendRequest) {
   scoped_ptr<SpdyFrame> req(ConstructSpdyGet(NULL, 0, false, 1, LOWEST));
   MockWrite writes[] = {
     CreateMockWrite(*req.get(), 1),
   };
   scoped_ptr<SpdyFrame> resp(ConstructSpdyGetSynReply(NULL, 0, 1));
   MockRead reads[] = {
     CreateMockRead(*resp, 2),
@@ skipping 30 matching lines @@
   data()->CompleteRead();
 
   // Because we abandoned the stream, we don't expect to find a session in the
   // pool anymore.
   EXPECT_FALSE(http_session_->spdy_session_pool()->HasSession(pair));
   EXPECT_TRUE(data()->at_read_eof());
   EXPECT_TRUE(data()->at_write_eof());
 }
 
 TEST_F(SpdyHttpStreamSpdy2Test, SendChunkedPost) {
+  // TODO(satish): Remove this once we have a better way to unit test POST
+  // requests with chunked uploads.
   UploadDataStream::set_merge_chunks(false);
 
   scoped_ptr<SpdyFrame> req(ConstructChunkedSpdyPost(NULL, 0));
   scoped_ptr<SpdyFrame> chunk1(ConstructSpdyBodyFrame(1, false));
   scoped_ptr<SpdyFrame> chunk2(ConstructSpdyBodyFrame(1, true));
   MockWrite writes[] = {
-    CreateMockWrite(*req.get(), 1),
-    CreateMockWrite(*chunk1, 2),  // POST upload frames
-    CreateMockWrite(*chunk2, 3),
+    CreateMockWrite(*req.get(), 0),
+    CreateMockWrite(*chunk1, 1),  // POST upload frames
+    CreateMockWrite(*chunk2, 2),
   };
   scoped_ptr<SpdyFrame> resp(ConstructSpdyPostSynReply(NULL, 0));
   MockRead reads[] = {
-    CreateMockRead(*resp, 4),
-    CreateMockRead(*chunk1, 5),
+    CreateMockRead(*resp, 3),
+    CreateMockRead(*chunk1, 4),
     CreateMockRead(*chunk2, 5),
     MockRead(SYNCHRONOUS, 0, 6)  // EOF
   };
 
   HostPortPair host_port_pair("www.google.com", 80);
   HostPortProxyPair pair(host_port_pair, ProxyServer::Direct());
   EXPECT_EQ(OK, InitSession(reads, arraysize(reads), writes, arraysize(writes),
                             host_port_pair));
 
   HttpRequestInfo request;
@@ skipping 26 matching lines @@
   data()->CompleteRead();
   MessageLoop::current()->RunAllPending();
 
   // Because we abandoned the stream, we don't expect to find a session in the
   // pool anymore.
   EXPECT_FALSE(http_session_->spdy_session_pool()->HasSession(pair));
   EXPECT_TRUE(data()->at_read_eof());
   EXPECT_TRUE(data()->at_write_eof());
 }
 
+TEST_F(SpdyHttpStreamSpdy2Test, DelayedSendChunkedPost) {
+  // TODO(satish): Remove this once we have a better way to unit test POST
+  // requests with chunked uploads.
+  UploadDataStream::set_merge_chunks(false);
+
+  const char kUploadData1[] = "12345678";
+  const int kUploadData1Size = arraysize(kUploadData1)-1;
+  scoped_ptr<SpdyFrame> req(ConstructChunkedSpdyPost(NULL, 0));
+  scoped_ptr<SpdyFrame> chunk1(ConstructSpdyBodyFrame(1, false));
+  scoped_ptr<SpdyFrame> chunk2(
+      ConstructSpdyBodyFrame(1, kUploadData1, kUploadData1Size, false));
+  scoped_ptr<SpdyFrame> chunk3(ConstructSpdyBodyFrame(1, true));
+  MockWrite writes[] = {
+    CreateMockWrite(*req.get(), 0),
+    CreateMockWrite(*chunk1, 1),  // POST upload frames
+    CreateMockWrite(*chunk2, 2),
+    CreateMockWrite(*chunk3, 3),
+  };
+  scoped_ptr<SpdyFrame> resp(ConstructSpdyPostSynReply(NULL, 0));
+  MockRead reads[] = {
+    CreateMockRead(*resp, 4),
+    CreateMockRead(*chunk1, 5),
+    CreateMockRead(*chunk2, 6),
+    CreateMockRead(*chunk3, 7),
+    MockRead(ASYNC, 0, 8)  // EOF
+  };
+
+  HostPortPair host_port_pair("www.google.com", 80);
+  HostPortProxyPair pair(host_port_pair, ProxyServer::Direct());
+
+  scoped_refptr<DeterministicSocketData> data(
+      new DeterministicSocketData(reads, arraysize(reads),
+                                  writes, arraysize(writes)));
+
+  DeterministicMockClientSocketFactory* socket_factory =
+      session_deps_.deterministic_socket_factory.get();
+  socket_factory->AddSocketDataProvider(data.get());
+
+  http_session_ = SpdySessionDependencies::SpdyCreateSessionDeterministic(
+      &session_deps_);
+  session_ = http_session_->spdy_session_pool()->Get(pair, BoundNetLog());
+  transport_params_ = new TransportSocketParams(host_port_pair,
+                                                MEDIUM, false, false,
+                                                OnHostResolutionCallback());
+
+  TestCompletionCallback callback;
+  scoped_ptr<ClientSocketHandle> connection(new ClientSocketHandle);
+
+  EXPECT_EQ(ERR_IO_PENDING,
+            connection->Init(host_port_pair.ToString(),
+                             transport_params_,
+                             MEDIUM,
+                             callback.callback(),
+                             http_session_->GetTransportSocketPool(
+                                 HttpNetworkSession::NORMAL_SOCKET_POOL),
+                             BoundNetLog()));
+
+  callback.WaitForResult();
+  EXPECT_EQ(OK,
+            session_->InitializeWithSocket(connection.release(), false, OK));
+
+  HttpRequestInfo request;
+  request.method = "POST";
+  request.url = GURL("http://www.google.com/");
+  request.upload_data = new UploadData();
+  request.upload_data->set_is_chunked(true);
+
+  BoundNetLog net_log;
+  scoped_ptr<SpdyHttpStream> http_stream(
+      new SpdyHttpStream(session_.get(), true));
+  ASSERT_EQ(OK,
+            http_stream->InitializeStream(&request,
+                                          net_log,
+                                          CompletionCallback()));
+
+  scoped_ptr<UploadDataStream> upload_stream(
+      new UploadDataStream(request.upload_data));
+  ASSERT_EQ(OK, upload_stream->Init());
+
+  request.upload_data->AppendChunk(kUploadData, kUploadDataSize, false);
+
+  HttpRequestHeaders headers;
+  HttpResponseInfo response;
+  // This will attempt to Write() the initial request and headers, which will
+  // complete asynchronously.
+  EXPECT_EQ(ERR_IO_PENDING,
+            http_stream->SendRequest(headers,
+                                     upload_stream.Pass(),
+                                     &response,
+                                     callback.callback()));
+  EXPECT_TRUE(http_session_->spdy_session_pool()->HasSession(pair));
+
+  // Complete the initial request write and the first chunk.
+  data->RunFor(1);
+
+  // Now append the second chunk. This will enqueue another write.
+  request.upload_data->AppendChunk(kUploadData1, kUploadData1Size, false);
+  // Now append final chunk. This will enqueue another write.
+  request.upload_data->AppendChunk(kUploadData, kUploadDataSize, true);
+
+  data->RunFor(1);
+  ASSERT_TRUE(callback.have_result());

[Ryan Sleevi, 2012/07/06 20:20:03]

I would add an

ASSERT_FALSE(callback.have_result()) on lines 280 and between 282/283

The point is that callback.have_result() should only be true once the
UploadDataStream has indicated EOF. Until then, it should remain false -
correct? If so, lets explicitly test that.

[ramant (doing other things), 2012/07/06 22:55:42]

Done.

+
+  // Finish writing all the chunks.
+  data->RunFor(3);
+  int rv = callback.WaitForResult();
+  EXPECT_GT(rv, 0);
+  EXPECT_EQ(OK, http_stream->ReadResponseHeaders(callback.callback()));
+
+  // Finish reading |chunk1|, |chunk2| and |chunk3|.
+  data->RunFor(4);

[Ryan Sleevi, 2012/07/06 20:20:03]

It's not clear to me how this is better.

In particular, if for some reason all four reads are NOT consumed, this will run
off into infinity (or a test timeout), which is a similar-but-different BUG?
then the one I had mentioned in the previous comment.

My thought was that (in the old patch), you'd simply add something between lines
300 - 301
int rv = http_stream->ReadResponseBody(...)
ASSERT_EQ(kUploadDataSize, rv);
EXPECT_EQ(...)

The fact is, ReadResponseBody takes a net::CompletionCallback, therefore it's
valid for it to return ERR_IO_PENDING. This test assumes that the only way
ERR_IO_PENDING can be returned is if the network IO is slow - but I don't think
that's at all guaranteed by the interface.

Because this test is not setup to handle ERR_IO_PENDING, you should explicitly
ASSERT you only ever get your expected result.

I also think your RunFor(1) + those ASSERTs are safer than RunFor(4), since the
RunFor(4) assumes (again, not guaranteed by the interface) that the SpdyStream
will consume all data available to it from the network. I don't know if that's
guaranteed, since there is a degree of internal buffering that happens.

[ramant (doing other things), 2012/07/06 22:55:42]

Done.

+
+  // Check |chunk1| response.
+  scoped_refptr<IOBuffer> buf1(new IOBuffer(kUploadDataSize));
+  http_stream->ReadResponseBody(buf1, kUploadDataSize, callback.callback());
+  EXPECT_EQ(kUploadData, std::string(buf1->data(), kUploadDataSize));
+
+  // Check |chunk2| response.
+  scoped_refptr<IOBuffer> buf2(new IOBuffer(kUploadData1Size));
+  http_stream->ReadResponseBody(buf2, kUploadData1Size, callback.callback());
+  EXPECT_EQ(kUploadData1, std::string(buf2->data(), kUploadData1Size));
+
+  // Check |chunk3| response.
+  scoped_refptr<IOBuffer> buf3(new IOBuffer(kUploadDataSize));
+  http_stream->ReadResponseBody(buf3, kUploadDataSize, callback.callback());
+  EXPECT_EQ(kUploadData, std::string(buf3->data(), kUploadDataSize));
+
+  // Finish reading the |EOF|.
+  ASSERT_TRUE(response.headers.get());
+  ASSERT_EQ(200, response.headers->response_code());
+  EXPECT_TRUE(data->at_read_eof());
+  EXPECT_TRUE(data->at_write_eof());
+}
+
 // Test case for bug: http://code.google.com/p/chromium/issues/detail?id=50058
 TEST_F(SpdyHttpStreamSpdy2Test, SpdyURLTest) {
   const char * const full_url = "http://www.google.com/foo?query=what#anchor";
   const char * const base_url = "http://www.google.com/foo?query=what";
   scoped_ptr<SpdyFrame> req(ConstructSpdyGet(base_url, false, 1, LOWEST));
   MockWrite writes[] = {
     CreateMockWrite(*req.get(), 1),
   };
   scoped_ptr<SpdyFrame> resp(ConstructSpdyGetSynReply(NULL, 0, 1));
   MockRead reads[] = {
@@ skipping 40 matching lines @@
   // pool anymore.
   EXPECT_FALSE(http_session_->spdy_session_pool()->HasSession(pair));
   EXPECT_TRUE(data()->at_read_eof());
   EXPECT_TRUE(data()->at_write_eof());
 }
 
 // TODO(willchan): Write a longer test for SpdyStream that exercises all
 // methods.
 
 }  // namespace net