Pipe the devTools FrameId from blink into the browser for headless

headless/lib/frame_id_browsertest.cc

+// Copyright 2017 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 "base/bind.h"
+#include "base/run_loop.h"
+#include "content/public/test/browser_test.h"
+#include "headless/lib/browser/headless_browser_context_impl.h"
+#include "headless/lib/browser/headless_web_contents_impl.h"
+#include "headless/public/devtools/domains/page.h"
+#include "headless/public/headless_devtools_client.h"
+#include "headless/public/util/expedited_dispatcher.h"
+#include "headless/public/util/generic_url_request_job.h"
+#include "headless/public/util/url_fetcher.h"
+#include "headless/test/headless_browser_test.h"
+#include "net/http/http_response_headers.h"
+#include "net/url_request/url_request_job_factory.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "url/gurl.h"
+
+using testing::ContainerEq;
+
+namespace headless {
+
+namespace {
+class TestProtocolHandler : public net::URLRequestJobFactory::ProtocolHandler {
+ public:
+  explicit TestProtocolHandler(
+      scoped_refptr<base::SingleThreadTaskRunner> io_thread_task_runner)
+      : test_delegate_(new TestDelegate(this)),
+        dispatcher_(new ExpeditedDispatcher(io_thread_task_runner)),
+        headless_browser_context_(nullptr) {}
+
+  ~TestProtocolHandler() override {}
+
+  void SetHeadlessBrowserContext(
+      HeadlessBrowserContext* headless_browser_context) {
+    headless_browser_context_ = headless_browser_context;
+  }
+
+  struct Response {
+    Response() {}
+    Response(const std::string& body, const std::string& mime_type)
+        : data("HTTP/1.1 200 OK\r\nContent-Type: " + mime_type + "\r\n\r\n" +
+               body) {}
+
+    std::string data;
+  };
+
+  void InsertResponse(const std::string& url, const Response& response) {
+    response_map_[url] = response;
+  }
+
+  const Response* GetResponse(const std::string& url) const {
+    std::map<std::string, Response>::const_iterator find_it =
+        response_map_.find(url);
+    if (find_it == response_map_.end())
+      return nullptr;
+    return &find_it->second;
+  }
+
+  class MockURLFetcher : public URLFetcher {
+   public:
+    explicit MockURLFetcher(const TestProtocolHandler* protocol_handler)
+        : protocol_handler_(protocol_handler) {}
+    ~MockURLFetcher() override {}
+
+    // URLFetcher implementation:
+    void StartFetch(const GURL& url,
+                    const std::string& method,
+                    const std::string& post_data,
+                    const net::HttpRequestHeaders& request_headers,
+                    ResultListener* result_listener) override {
+      EXPECT_EQ("GET", method);
+
+      const Response* response = protocol_handler_->GetResponse(url.spec());
+      if (!response)
+        result_listener->OnFetchStartError(net::ERR_FILE_NOT_FOUND);
+
+      result_listener->OnFetchCompleteExtractHeaders(
+          url, response->data.c_str(), response->data.size());
+    }
+
+   private:
+    const TestProtocolHandler* protocol_handler_;
+
+    DISALLOW_COPY_AND_ASSIGN(MockURLFetcher);
+  };
+
+  class TestDelegate : public GenericURLRequestJob::Delegate {
+   public:
+    explicit TestDelegate(TestProtocolHandler* protocol_handler)
+        : protocol_handler_(protocol_handler) {}
+
+    ~TestDelegate() override {}
+
+    // GenericURLRequestJob::Delegate implementation:
+    void OnPendingRequest(PendingRequest* pending_request) override {
+      const Request* request = pending_request->GetRequest();
+      std::string url = request->GetURLRequest()->url().spec();
+      int frame_tree_node_id = request->GetFrameTreeNodeId();
+      DCHECK_NE(frame_tree_node_id, -1);
+      protocol_handler_->url_to_frame_tree_node_id_[url] = frame_tree_node_id;
+      pending_request->AllowRequest();
+    }
+
+    void OnResourceLoadFailed(const Request* request,
+                              net::Error error) override {}
+
+    void OnResourceLoadComplete(
+        const Request* request,
+        const GURL& final_url,
+        scoped_refptr<net::HttpResponseHeaders> response_headers,
+        const char* body,
+        size_t body_size) override {}
+
+   private:
+    TestProtocolHandler* protocol_handler_;  // NOT OWNED
+    scoped_refptr<base::SingleThreadTaskRunner> ui_thread_task_runner_;
+
+    DISALLOW_COPY_AND_ASSIGN(TestDelegate);
+  };
+
+  // net::URLRequestJobFactory::ProtocolHandler implementation::
+  net::URLRequestJob* MaybeCreateJob(
+      net::URLRequest* request,
+      net::NetworkDelegate* network_delegate) const override {
+    return new GenericURLRequestJob(
+        request, network_delegate, dispatcher_.get(),
+        base::MakeUnique<MockURLFetcher>(this), test_delegate_.get(),
+        headless_browser_context_);
+  }
+
+  std::map<std::string, int> url_to_frame_tree_node_id_;
+
+ private:
+  std::unique_ptr<TestDelegate> test_delegate_;
+  std::unique_ptr<ExpeditedDispatcher> dispatcher_;
+  std::map<std::string, Response> response_map_;
+  HeadlessBrowserContext* headless_browser_context_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestProtocolHandler);
+};
+
+const char* kIndexHtml = R"(
+<html>
+<body>Hello.
+<iframe src="iframe1.html"></iframe>
+<iframe src="iframe2.html"></iframe>
+</body>
+</html>)";
+
+const char* kIFrame1 = "<html><body>IFrame 1</body></html>";
+
+const char* kIFrame2 = "<html><body>IFrame 2</body></html>";
+
+}  // namespace
+
+class FrameIdTest : public HeadlessAsyncDevTooledBrowserTest,
+                    public page::Observer {
+ public:
+  void RunDevTooledTest() override {
+    http_handler_->SetHeadlessBrowserContext(browser_context_);
+
+    EXPECT_TRUE(embedded_test_server()->Start());
+    devtools_client_->GetPage()->AddObserver(this);
+
+    base::RunLoop run_loop;
+    devtools_client_->GetPage()->Enable(run_loop.QuitClosure());
+    base::MessageLoop::ScopedNestableTaskAllower nest_loop(
+        base::MessageLoop::current());
+    run_loop.Run();
+
+    devtools_client_->GetPage()->Navigate("http://foo.com/index.html");
+  }
+
+  ProtocolHandlerMap GetProtocolHandlers() override {
+    ProtocolHandlerMap protocol_handlers;
+    std::unique_ptr<TestProtocolHandler> http_handler(
+        new TestProtocolHandler(browser()->BrowserIOThread()));
+    http_handler_ = http_handler.get();
+    http_handler_->InsertResponse("http://foo.com/index.html",
+                                  {kIndexHtml, "text/html"});
+    http_handler_->InsertResponse("http://foo.com/iframe1.html",
+                                  {kIFrame1, "text/html"});
+    http_handler_->InsertResponse("http://foo.com/iframe2.html",
+                                  {kIFrame2, "text/html"});
+    protocol_handlers[url::kHttpScheme] = std::move(http_handler);
+    return protocol_handlers;
+  }
+
+  // page::Observer implementation:
+  void OnFrameNavigated(const page::FrameNavigatedParams& params) override {
+    url_to_frame_id_[params.GetFrame()->GetUrl()] = params.GetFrame()->GetId();
+  }
+
+  void OnLoadEventFired(const page::LoadEventFiredParams& params) override {
+    std::map<std::string, std::string> protocol_handler_url_to_frame_id_;
+    for (const auto& pair : http_handler_->url_to_frame_tree_node_id_) {
+      HeadlessWebContentsImpl* headless_web_contents_impl =
+          static_cast<HeadlessWebContentsImpl*>(web_contents_);
+      protocol_handler_url_to_frame_id_[pair.first] =
+          headless_web_contents_impl
+              ->GetUntrustedDevToolsFrameIdForFrameTreeNodeId(
+                  headless_web_contents_impl->GetRenderProcessId(),

[Charlie Reis, 2017/04/26 19:52:56]

Is this assuming that the only loads in the test happen in the main frame (or
its process)?  It seems like you could have load events in out-of-process
iframes that wouldn't match this process ID.

[alex clarke (OOO till 29th), 2017/04/27 08:49:44]

Yes I expect we'll have to make an number of changes for OOPIF.  I've filed a
bug to track that. https://bugs.chromium.org/p/chromium/issues/detail?id=715924

+                  pair.second);
+    }
+
+    EXPECT_THAT(url_to_frame_id_, protocol_handler_url_to_frame_id_);
+    EXPECT_EQ(3u, url_to_frame_id_.size());
+    FinishAsynchronousTest();
+  }
+
+ private:
+  std::map<std::string, std::string> url_to_frame_id_;
+  TestProtocolHandler* http_handler_;  // NOT OWNED
+};
+
+HEADLESS_ASYNC_DEVTOOLED_TEST_F(FrameIdTest);
+
+}  // namespace headless