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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/devtools/devtools_frontend_host_impl.h"
#include <memory>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/scoped_feature_list.h"
#include "components/crash/content/browser/error_reporting/javascript_error_report.h" // nogncheck
#include "components/crash/content/browser/error_reporting/js_error_report_processor.h" // nogncheck
#include "content/public/browser/devtools_frontend_host.h"
#include "content/public/browser/site_instance.h"
#include "content/public/test/navigation_simulator.h"
#include "content/public/test/test_renderer_host.h"
#include "content/test/test_web_contents.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
namespace content {
namespace {
using testing::Eq;
using testing::Optional;
class FakeJsErrorReportProcessor : public JsErrorReportProcessor {
public:
explicit FakeJsErrorReportProcessor(
scoped_refptr<base::SingleThreadTaskRunner> task_runner)
: task_runner_(std::move(task_runner)) {}
// After calling this, expect all SendErrorReport's to use this
// BrowserContext.
void SetExpectedBrowserContext(BrowserContext* browser_context) {
browser_context_ = browser_context;
}
void SendErrorReport(JavaScriptErrorReport error_report,
base::OnceClosure completion_callback,
BrowserContext* browser_context) override {
CHECK_EQ(browser_context, browser_context_);
last_error_report_ = std::move(error_report);
++error_report_count_;
task_runner_->PostTask(FROM_HERE, std::move(completion_callback));
}
const JavaScriptErrorReport& last_error_report() const {
return last_error_report_;
}
int error_report_count() const { return error_report_count_; }
// Make public for testing.
using JsErrorReportProcessor::SetDefault;
protected:
~FakeJsErrorReportProcessor() override = default;
private:
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
JavaScriptErrorReport last_error_report_;
int error_report_count_ = 0;
raw_ptr<BrowserContext> browser_context_ = nullptr;
};
} // namespace
class DevToolsFrontendHostImplTest : public RenderViewHostTestHarness {
public:
void SetUp() override {
RenderViewHostTestHarness::SetUp();
site_instance_ = SiteInstance::Create(browser_context());
SetContents(TestWebContents::Create(browser_context(), site_instance_));
// Since we just created the web_contents() pointer with
// TestWebContents::Create, the static_casts are safe.
devtools_frontend_host_impl_ = DevToolsFrontendHostImpl::CreateForTesting(
static_cast<TestWebContents*>(web_contents())->GetPrimaryMainFrame(),
base::RepeatingCallback<void(base::Value::Dict)>());
process()->Init();
previous_processor_ = JsErrorReportProcessor::Get();
processor_ = base::MakeRefCounted<FakeJsErrorReportProcessor>(
task_environment()->GetMainThreadTaskRunner());
FakeJsErrorReportProcessor::SetDefault(processor_);
processor_->SetExpectedBrowserContext(browser_context());
}
void TearDown() override {
FakeJsErrorReportProcessor::SetDefault(previous_processor_);
// We have to destroy the site_instance_ before
// RenderViewHostTestHarness::TearDown() destroys the
// BrowserTaskEnvironment. We've gotten a lot of things that depend directly
// or indirectly on BrowserTaskEnvironment, so just destroy everything we
// can.
previous_processor_.reset();
processor_.reset();
devtools_frontend_host_impl_.reset();
site_instance_.reset();
RenderViewHostTestHarness::TearDown();
}
// Calls the observer's OnDidAddMessageToConsole with the given arguments.
// This is just here so that we don't need to FRIEND_TEST_ALL_PREFIXES for
// each and every test.
void CallOnDidAddMessageToConsole(
RenderFrameHost* source_frame,
blink::mojom::ConsoleMessageLevel log_level,
const std::u16string& message,
int32_t line_no,
const std::u16string& source_id,
const std::optional<std::u16string>& stack_trace) {
devtools_frontend_host_impl_->OnDidAddMessageToConsole(
source_frame, log_level, message, line_no, source_id, stack_trace);
}
protected:
scoped_refptr<SiteInstance> site_instance_;
std::unique_ptr<DevToolsFrontendHostImpl> devtools_frontend_host_impl_;
scoped_refptr<FakeJsErrorReportProcessor> processor_;
scoped_refptr<JsErrorReportProcessor> previous_processor_;
base::test::ScopedFeatureList scoped_feature_list_;
static constexpr char kMessage8[] = "Uncaught exception";
static constexpr char16_t kMessage16[] = u"Uncaught exception";
static constexpr char kSourceURL8[] = "devtools://here.is.error/bad.js";
static constexpr char16_t kSourceURL16[] = u"devtools://here.is.error/bad.js";
static constexpr char kStackTrace8[] =
"at badFunction (devtools://page/my.js:20:30)\n"
"at poorCaller (devtools://page/my.js:50:10)\n";
static constexpr char16_t kStackTrace16[] =
u"at badFunction (devtools://page/my.js:20:30)\n"
u"at poorCaller (devtools://page/my.js:50:10)\n";
};
class DevToolsFrontendHostImplJsErrorReportingEnabledTest
: public DevToolsFrontendHostImplTest {
public:
void SetUp() override {
DevToolsFrontendHostImplTest::SetUp();
scoped_feature_list_.InitAndEnableFeature(
features::kEnableDevToolsJsErrorReporting);
}
};
constexpr char DevToolsFrontendHostImplTest::kMessage8[];
constexpr char16_t DevToolsFrontendHostImplTest::kMessage16[];
constexpr char DevToolsFrontendHostImplTest::kSourceURL8[];
constexpr char16_t DevToolsFrontendHostImplTest::kSourceURL16[];
constexpr char DevToolsFrontendHostImplTest::kStackTrace8[];
constexpr char16_t DevToolsFrontendHostImplTest::kStackTrace16[];
TEST_F(DevToolsFrontendHostImplTest, ErrorNotReportedWhenFeatureIsNotEnabled) {
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kError,
kMessage16, 5, kSourceURL16, kStackTrace16);
task_environment()->RunUntilIdle();
EXPECT_EQ(processor_->error_report_count(), 0);
}
TEST_F(DevToolsFrontendHostImplJsErrorReportingEnabledTest, Sent) {
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kError,
kMessage16, 5, kSourceURL16, kStackTrace16);
task_environment()->RunUntilIdle();
EXPECT_EQ(processor_->error_report_count(), 1);
EXPECT_EQ(processor_->last_error_report().message, kMessage8);
EXPECT_EQ(processor_->last_error_report().url, kSourceURL8);
EXPECT_EQ(processor_->last_error_report().source_system,
JavaScriptErrorReport::SourceSystem::kDevToolsObserver);
EXPECT_THAT(processor_->last_error_report().stack_trace,
Optional(Eq(kStackTrace8)));
// DevTools should use default product & version.
EXPECT_EQ(processor_->last_error_report().product, "");
EXPECT_EQ(processor_->last_error_report().version, "");
EXPECT_EQ(*processor_->last_error_report().line_number, 5);
EXPECT_FALSE(processor_->last_error_report().column_number);
EXPECT_FALSE(processor_->last_error_report().app_locale);
EXPECT_TRUE(processor_->last_error_report().send_to_production_servers);
}
TEST_F(DevToolsFrontendHostImplJsErrorReportingEnabledTest,
NotSentForNonErrors) {
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kWarning,
kMessage16, 5, kSourceURL16, kStackTrace16);
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kInfo,
kMessage16, 5, kSourceURL16, kStackTrace16);
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kVerbose,
kMessage16, 5, kSourceURL16, kStackTrace16);
task_environment()->RunUntilIdle();
EXPECT_EQ(processor_->error_report_count(), 0);
}
TEST_F(DevToolsFrontendHostImplJsErrorReportingEnabledTest,
NotSentIfInvalidURL) {
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kError,
kMessage16, 5, u"invalid URL", kStackTrace16);
task_environment()->RunUntilIdle();
EXPECT_EQ(processor_->error_report_count(), 0);
}
TEST_F(DevToolsFrontendHostImplJsErrorReportingEnabledTest,
NotSentIfNonDevToolsURL) {
const char16_t* const kNonChromeSourceURLs[] = {
u"chrome-untrusted://media-app",
u"chrome-error://chromewebdata/",
u"chrome-extension://abc123/",
u"chrome://settings",
u"about:blank",
};
for (const auto* url : kNonChromeSourceURLs) {
CallOnDidAddMessageToConsole(main_rfh(),
blink::mojom::ConsoleMessageLevel::kError,
kMessage16, 5, url, kStackTrace16);
task_environment()->RunUntilIdle();
EXPECT_EQ(processor_->error_report_count(), 0) << url;
}
}
} // namespace content
#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
|