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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <map>
#include <memory>
#include <string>
#include <utility>
#include "base/containers/contains.h"
#include "base/location.h"
#include "base/run_loop.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "components/input/input_constants.h"
#include "content/browser/devtools/devtools_manager.h"
#include "content/browser/devtools/shared_worker_devtools_manager.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/devtools_agent_host.h"
#include "content/public/browser/devtools_external_agent_proxy.h"
#include "content/public/browser/devtools_external_agent_proxy_delegate.h"
#include "content/public/browser/devtools_manager_delegate.h"
#include "content/public/browser/web_contents_delegate.h"
#include "content/public/test/navigation_simulator.h"
#include "content/public/test/test_utils.h"
#include "content/test/test_content_browser_client.h"
#include "content/test/test_render_view_host.h"
#include "content/test/test_web_contents.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace content {
namespace {
class TestDevToolsClientHost : public DevToolsAgentHostClient {
public:
TestDevToolsClientHost() : closed_(false) {}
TestDevToolsClientHost(const TestDevToolsClientHost&) = delete;
TestDevToolsClientHost& operator=(const TestDevToolsClientHost&) = delete;
~TestDevToolsClientHost() override { EXPECT_TRUE(closed_); }
void Close() {
EXPECT_FALSE(closed_);
close_counter++;
agent_host_->DetachClient(this);
closed_ = true;
}
void AgentHostClosed(DevToolsAgentHost* agent_host) override { FAIL(); }
void DispatchProtocolMessage(DevToolsAgentHost* agent_host,
base::span<const uint8_t> message) override {}
void InspectAgentHost(DevToolsAgentHost* agent_host) {
agent_host_ = agent_host;
agent_host_->AttachClient(this);
}
DevToolsAgentHost* agent_host() { return agent_host_.get(); }
static void ResetCounters() { close_counter = 0; }
static int close_counter;
private:
bool closed_;
scoped_refptr<DevToolsAgentHost> agent_host_;
};
int TestDevToolsClientHost::close_counter = 0;
class TestWebContentsDelegate : public WebContentsDelegate {
public:
TestWebContentsDelegate() : renderer_unresponsive_received_(false) {}
// Notification that the contents is hung.
void RendererUnresponsive(
WebContents* source,
RenderWidgetHost* render_widget_host,
base::RepeatingClosure hang_monitor_restarter) override {
renderer_unresponsive_received_ = true;
}
bool renderer_unresponsive_received() const {
return renderer_unresponsive_received_;
}
private:
bool renderer_unresponsive_received_;
};
class BrowserClient : public ContentBrowserClient {
public:
BrowserClient() = default;
~BrowserClient() override = default;
std::unique_ptr<content::DevToolsManagerDelegate>
CreateDevToolsManagerDelegate() override {
return std::make_unique<DevToolsManagerDelegate>();
}
};
} // namespace
class DevToolsAgentHostImplTest : public RenderViewHostImplTestHarness {
public:
DevToolsAgentHostImplTest() {}
protected:
void SetUp() override {
RenderViewHostImplTestHarness::SetUp();
TestDevToolsClientHost::ResetCounters();
browser_content_client_ = std::make_unique<BrowserClient>();
original_client_ =
SetBrowserClientForTesting(browser_content_client_.get());
DevToolsManager::ShutdownForTests();
}
void TearDown() override {
SetBrowserClientForTesting(original_client_);
DevToolsManager::ShutdownForTests();
RenderViewHostImplTestHarness::TearDown();
}
private:
std::unique_ptr<ContentBrowserClient> browser_content_client_;
raw_ptr<ContentBrowserClient> original_client_ = nullptr;
};
TEST_F(DevToolsAgentHostImplTest, OpenAndManuallyCloseDevToolsClientHost) {
scoped_refptr<DevToolsAgentHost> agent(
DevToolsAgentHost::GetOrCreateFor(web_contents()));
EXPECT_FALSE(agent->IsAttached());
TestDevToolsClientHost client_host;
client_host.InspectAgentHost(agent.get());
// Test that the connection is established.
EXPECT_TRUE(agent->IsAttached());
EXPECT_EQ(0, TestDevToolsClientHost::close_counter);
client_host.Close();
EXPECT_EQ(1, TestDevToolsClientHost::close_counter);
EXPECT_FALSE(agent->IsAttached());
}
TEST_F(DevToolsAgentHostImplTest, NoUnresponsiveDialogInInspectedContents) {
const GURL url("http://www.google.com");
contents()->NavigateAndCommit(url);
TestRenderViewHost* inspected_rvh = test_rvh();
EXPECT_TRUE(inspected_rvh->IsRenderViewLive());
EXPECT_FALSE(contents()->GetDelegate());
TestWebContentsDelegate delegate;
contents()->SetDelegate(&delegate);
TestDevToolsClientHost client_host;
scoped_refptr<DevToolsAgentHost> agent_host(DevToolsAgentHost::GetOrCreateFor(
WebContents::FromRenderViewHost(inspected_rvh)));
client_host.InspectAgentHost(agent_host.get());
// Start a timeout.
inspected_rvh->GetWidget()->StartInputEventAckTimeout();
task_environment()->FastForwardBy(input::kHungRendererDelay +
base::Milliseconds(10));
EXPECT_FALSE(delegate.renderer_unresponsive_received());
// Now close devtools and check that the notification is delivered.
client_host.Close();
// Start a timeout.
inspected_rvh->GetWidget()->StartInputEventAckTimeout();
task_environment()->FastForwardBy(input::kHungRendererDelay +
base::Milliseconds(10));
EXPECT_TRUE(delegate.renderer_unresponsive_received());
contents()->SetDelegate(nullptr);
}
class TestExternalAgentDelegate : public DevToolsExternalAgentProxyDelegate {
public:
TestExternalAgentDelegate() {}
~TestExternalAgentDelegate() override {
expectEvent(1, "Attach");
expectEvent(1, "Detach");
expectEvent(0, "SendMessageToBackend.message0");
expectEvent(1, "SendMessageToBackend.message1");
expectEvent(2, "SendMessageToBackend.message2");
}
private:
std::map<std::string, int> event_counter_;
void recordEvent(const std::string& name) {
if (!base::Contains(event_counter_, name)) {
event_counter_[name] = 0;
}
event_counter_[name] = event_counter_[name] + 1;
}
void expectEvent(int count, const std::string& name) {
EXPECT_EQ(count, event_counter_[name]);
}
void Attach(DevToolsExternalAgentProxy* proxy) override {
recordEvent("Attach");
}
void Detach(DevToolsExternalAgentProxy* proxy) override {
recordEvent("Detach");
}
std::string GetType() override { return std::string(); }
std::string GetTitle() override { return std::string(); }
std::string GetDescription() override { return std::string(); }
GURL GetURL() override { return GURL(); }
GURL GetFaviconURL() override { return GURL(); }
std::string GetFrontendURL() override { return std::string(); }
bool Activate() override { return false; }
void Reload() override {}
bool Close() override { return false; }
base::TimeTicks GetLastActivityTime() override { return base::TimeTicks(); }
void SendMessageToBackend(DevToolsExternalAgentProxy* proxy,
base::span<const uint8_t> message) override {
recordEvent(std::string("SendMessageToBackend.") +
std::string(message.begin(), message.end()));
}
};
TEST_F(DevToolsAgentHostImplTest, TestExternalProxy) {
std::unique_ptr<TestExternalAgentDelegate> delegate(
new TestExternalAgentDelegate());
scoped_refptr<DevToolsAgentHost> agent_host = DevToolsAgentHost::Forward(
base::Uuid::GenerateRandomV4().AsLowercaseString(), std::move(delegate));
EXPECT_EQ(agent_host, DevToolsAgentHost::GetForId(agent_host->GetId()));
TestDevToolsClientHost client_host;
client_host.InspectAgentHost(agent_host.get());
agent_host->DispatchProtocolMessage(&client_host,
base::byte_span_from_cstring("message1"));
agent_host->DispatchProtocolMessage(&client_host,
base::byte_span_from_cstring("message2"));
agent_host->DispatchProtocolMessage(&client_host,
base::byte_span_from_cstring("message2"));
client_host.Close();
}
} // namespace content
|