Fix completion status for asynchronous custom resource handler requests (issue #1066, issue #1187).

git-svn-id: https://chromiumembedded.googlecode.com/svn/trunk@1594 5089003a-bbd8-11dd-ad1f-f1f9622dbc98

libcef/browser/resource_request_job.cc

@@ -112,19 +112,13 @@ class CefResourceRequestJobCallback : public CefCallback {
           dest_size_ = 0;
           dest_ = NULL;
 
-          if (bytes_read > 0) {
           // Clear the IO_PENDING status.
           job_->SetStatus(URLRequestStatus());
 
-            // Notify about the available bytes. This may cause another call to
+          // Notify about the available bytes. If bytes_read > 0 then
-            // ReadRawData() from URLRequest::Read.
+          // ReadRawData may be called from URLRequest::Read. If bytes_read == 0
+          // then Kill will be called from the URLRequest destructor.
           job_->NotifyReadComplete(bytes_read);
-          } else {
-            // Either we read all requested bytes or the handler detected the
-            // end of the resource.
-            job_->NotifyDone(URLRequestStatus());
-            Detach();
-          }
         } else if (!job_->GetStatus().is_io_pending()) {
           // Failed due to an error.
           NOTREACHED() <<
@@ -158,6 +152,7 @@ CefResourceRequestJob::CefResourceRequestJob(
     CefRefPtr<CefResourceHandler> handler)
     : net::URLRequestJob(request, network_delegate),
       handler_(handler),
+      done_(false),
       remaining_bytes_(0),
       response_cookies_save_index_(0),
       weak_factory_(this) {
@@ -207,8 +202,10 @@ void CefResourceRequestJob::Start() {
 void CefResourceRequestJob::Kill() {
   CEF_REQUIRE_IOT();
 
+  if (!done_) {
     // Notify the handler that the request has been canceled.
     handler_->Cancel();
+  }
 
   if (callback_) {
     callback_->Detach();
@@ -221,16 +218,15 @@ void CefResourceRequestJob::Kill() {
 // This method will be called by URLRequestJob::Read and our callback.
 // It can indicate the following states:
 // 1. If the request is complete set |bytes_read| == 0 and return true. The
-//    caller is then responsible for calling NotifyDone. ReadRawData should not
+//    caller is then responsible for calling NotifyReadComplete. ReadRawData
-//    be called again.
+//    should not be called again.
 // 2. If data is available synchronously set |bytes_read| > 0 and return true.
 //    The caller is then responsible for calling NotifyReadComplete. ReadRawData
 //    may be called again by URLRequestJob::Read.
 // 3. If data is not available now but may be available asynchronously set
 //    status to IO_PENDING and return false. When executed asynchronously the
 //    callback will again call ReadRawData. If data is returned at that time the
-//    callback will clear the status and call NotifyReadComplete or NotifyDone
+//    callback will clear the status and call NotifyReadComplete.
-//    as appropriate.
 bool CefResourceRequestJob::ReadRawData(net::IOBuffer* dest, int dest_size,
                                         int* bytes_read) {
   CEF_REQUIRE_IOT();
@@ -241,6 +237,7 @@ bool CefResourceRequestJob::ReadRawData(net::IOBuffer* dest, int dest_size,
   if (remaining_bytes_ == 0) {
     // No more data to read.
     *bytes_read = 0;
+    done_ = true;
     return true;
   } else if (remaining_bytes_ > 0 && remaining_bytes_ < dest_size) {
     // The handler knows the content size beforehand.
@@ -260,6 +257,7 @@ bool CefResourceRequestJob::ReadRawData(net::IOBuffer* dest, int dest_size,
   if (!rv) {
     // The handler has indicated completion of the request.
     *bytes_read = 0;
+    done_ = true;
     return true;
   } else if (*bytes_read == 0) {
     // Continue reading asynchronously. May happen multiple times in a row so

libcef/browser/resource_request_job.h

@@ -60,6 +60,7 @@ class CefResourceRequestJob : public net::URLRequestJob {
   void FetchResponseCookies(std::vector<std::string>* cookies);
 
   CefRefPtr<CefResourceHandler> handler_;
+  bool done_;
   CefRefPtr<CefResponse> response_;
   GURL redirect_url_;
   int64 remaining_bytes_;

tests/unittests/stream_resource_handler_unittest.cc

@@ -5,11 +5,15 @@
 #include <algorithm>
 #include <cstdlib>
 #include <string>
+#include "include/cef_runnable.h"
 #include "include/cef_stream.h"
 #include "include/wrapper/cef_stream_resource_handler.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "tests/unittests/routing_test_handler.h"
 
+// Comment out this define to disable the unit test timeout.
+#define TIMEOUT_ENABLED 1
+
 namespace {
 
 const char kTestUrl[] = "http://tests-srh/test.html";
@@ -96,6 +100,12 @@ class ReadTestHandler : public RoutingTestHandler {
   virtual void RunTest() OVERRIDE {
     // Create the browser.
     CreateBrowser(kTestUrl);
+
+#if defined(TIMEOUT_ENABLED)
+    // Time out the test after a reasonable period of time.
+    CefPostDelayedTask(TID_UI,
+        NewCefRunnableMethod(this, &ReadTestHandler::DestroyTest), 3000);
+#endif
   }
 
   virtual CefRefPtr<CefResourceHandler> GetResourceHandler(
@@ -127,15 +137,31 @@ class ReadTestHandler : public RoutingTestHandler {
     const int actual_result = atoi(request.ToString().c_str());
     EXPECT_EQ(expected_result_, actual_result);
 
-    DestroyTest();
+    DestroyTestIfDone();
 
     return true;
   }
 
+  virtual void OnLoadingStateChange(CefRefPtr<CefBrowser> browser,
+                                    bool isLoading,
+                                    bool canGoBack,
+                                    bool canGoForward) OVERRIDE {
+    if (!isLoading) {
+      got_on_loading_state_change_done_.yes();
+      DestroyTestIfDone();
+    }
+  }
+
  private:
+  void DestroyTestIfDone() {
+    if (got_on_query_ && got_on_loading_state_change_done_)
+      DestroyTest();
+  }
+
   virtual void DestroyTest() OVERRIDE {
     EXPECT_TRUE(got_resource_handler_);
     EXPECT_TRUE(got_on_query_);
+    EXPECT_TRUE(got_on_loading_state_change_done_);
     RoutingTestHandler::DestroyTest();
   }
 
@@ -144,6 +170,7 @@ class ReadTestHandler : public RoutingTestHandler {
   int expected_result_;
   TrackCallback got_resource_handler_;
   TrackCallback got_on_query_;
+  TrackCallback got_on_loading_state_change_done_;
 };
 
 }  // namespace