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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/page_load_metrics/browser/observers/page_load_metrics_observer_tester.h"
#include <memory>
#include <string>
#include <utility>
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "components/page_load_metrics/browser/metrics_web_contents_observer.h"
#include "components/page_load_metrics/browser/page_load_metrics_embedder_interface.h"
#include "components/page_load_metrics/common/page_load_metrics.mojom.h"
#include "components/page_load_metrics/common/page_load_timing.h"
#include "content/public/browser/cookie_access_details.h"
#include "content/public/browser/media_player_id.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/test/navigation_simulator.h"
#include "content/public/test/test_renderer_host.h"
#include "net/base/ip_endpoint.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/common/input/web_input_event.h"
#include "third_party/blink/public/mojom/loader/resource_load_info.mojom.h"
#include "url/gurl.h"
namespace content {
class BrowserContext;
} // namespace content
namespace page_load_metrics {
class PageLoadMetricsMemoryTracker;
namespace {
class TestPageLoadMetricsEmbedderInterface
: public PageLoadMetricsEmbedderInterface {
public:
explicit TestPageLoadMetricsEmbedderInterface(
PageLoadMetricsObserverTester* test)
: test_(test) {}
TestPageLoadMetricsEmbedderInterface(
const TestPageLoadMetricsEmbedderInterface&) = delete;
TestPageLoadMetricsEmbedderInterface& operator=(
const TestPageLoadMetricsEmbedderInterface&) = delete;
bool IsNewTabPageUrl(const GURL& url) override { return false; }
// Forward the registration logic to the test class so that derived classes
// can override the logic there without depending on the embedder interface.
void RegisterObservers(
PageLoadTracker* tracker,
content::NavigationHandle* navigation_handle) override {
test_->RegisterObservers(tracker);
}
std::unique_ptr<base::OneShotTimer> CreateTimer() override {
auto timer = std::make_unique<test::WeakMockTimer>();
test_->SetMockTimer(timer->AsWeakPtr());
return std::move(timer);
}
bool IsNoStatePrefetch(content::WebContents* web_contents) override {
return false;
}
bool IsExtensionUrl(const GURL& url) override { return false; }
bool IsNonTabWebUI(const GURL& url) override {
return test_->is_non_tab_webui();
}
bool ShouldObserveScheme(std::string_view scheme) override { return false; }
bool IsIncognito(content::WebContents* web_contents) override {
return false;
}
page_load_metrics::PageLoadMetricsMemoryTracker*
GetMemoryTrackerForBrowserContext(
content::BrowserContext* browser_context) override {
return nullptr;
}
private:
raw_ptr<PageLoadMetricsObserverTester> test_;
};
} // namespace
PageLoadMetricsObserverTester::PageLoadMetricsObserverTester(
content::WebContents* web_contents,
content::RenderViewHostTestHarness* rfh_test_harness,
const RegisterObserversCallback& callback,
bool is_non_tab_webui)
: register_callback_(callback),
web_contents_(web_contents),
rfh_test_harness_(rfh_test_harness),
metrics_web_contents_observer_(
MetricsWebContentsObserver::CreateForWebContents(
web_contents,
std::make_unique<TestPageLoadMetricsEmbedderInterface>(this))),
is_non_tab_webui_(is_non_tab_webui) {}
PageLoadMetricsObserverTester::~PageLoadMetricsObserverTester() = default;
void PageLoadMetricsObserverTester::StartNavigation(const GURL& gurl) {
std::unique_ptr<content::NavigationSimulator> navigation =
content::NavigationSimulator::CreateBrowserInitiated(gurl,
web_contents());
navigation->Start();
}
void PageLoadMetricsObserverTester::NavigateWithPageTransitionAndCommit(
const GURL& url,
ui::PageTransition transition) {
auto simulator = PageTransitionIsWebTriggerable(transition)
? content::NavigationSimulator::CreateRendererInitiated(
url, rfh_test_harness_->main_rfh())
: content::NavigationSimulator::CreateBrowserInitiated(
url, web_contents());
simulator->SetTransition(transition);
simulator->Commit();
}
void PageLoadMetricsObserverTester::NavigateToUntrackedUrl() {
rfh_test_harness_->NavigateAndCommit(GURL(url::kAboutBlankURL));
}
void PageLoadMetricsObserverTester::SimulateTimingUpdate(
const mojom::PageLoadTiming& timing) {
SimulateTimingUpdate(timing, web_contents()->GetPrimaryMainFrame());
}
void PageLoadMetricsObserverTester::SimulateTimingUpdate(
const mojom::PageLoadTiming& timing,
content::RenderFrameHost* rfh) {
SimulatePageLoadTimingUpdate(
timing, mojom::FrameMetadata(), /* new_features= */ {},
mojom::FrameRenderDataUpdate(), mojom::CpuTiming(), mojom::InputTiming(),
std::nullopt, rfh, *CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateCpuTimingUpdate(
const mojom::CpuTiming& cpu_timing) {
SimulateCpuTimingUpdate(cpu_timing, web_contents()->GetPrimaryMainFrame());
}
void PageLoadMetricsObserverTester::SimulateCpuTimingUpdate(
const mojom::CpuTiming& cpu_timing,
content::RenderFrameHost* rfh) {
auto timing = page_load_metrics::mojom::PageLoadTimingPtr(std::in_place);
page_load_metrics::InitPageLoadTimingForTest(timing.get());
SimulatePageLoadTimingUpdate(
*timing, mojom::FrameMetadata(),
/* new_features= */ {}, mojom::FrameRenderDataUpdate(), cpu_timing,
mojom::InputTiming(), std::nullopt, rfh, *CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateInputTimingUpdate(
const mojom::InputTiming& input_timing) {
SimulateInputTimingUpdate(input_timing,
web_contents()->GetPrimaryMainFrame());
}
void PageLoadMetricsObserverTester::SimulateInputTimingUpdate(
const mojom::InputTiming& input_timing,
content::RenderFrameHost* rfh) {
auto timing = page_load_metrics::mojom::PageLoadTimingPtr(std::in_place);
page_load_metrics::InitPageLoadTimingForTest(timing.get());
SimulatePageLoadTimingUpdate(
*timing, mojom::FrameMetadata(), /* new_features= */ {},
mojom::FrameRenderDataUpdate(), mojom::CpuTiming(), input_timing,
std::nullopt, rfh, *CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateTimingAndMetadataUpdate(
const mojom::PageLoadTiming& timing,
const mojom::FrameMetadata& metadata) {
SimulatePageLoadTimingUpdate(
timing, metadata, /* new_features= */ {}, mojom::FrameRenderDataUpdate(),
mojom::CpuTiming(), mojom::InputTiming(), std::nullopt,
web_contents()->GetPrimaryMainFrame(), *CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateMetadataUpdate(
const mojom::FrameMetadata& metadata,
content::RenderFrameHost* rfh) {
mojom::PageLoadTiming timing;
InitPageLoadTimingForTest(&timing);
SimulatePageLoadTimingUpdate(
timing, metadata, /* new_features= */ {}, mojom::FrameRenderDataUpdate(),
mojom::CpuTiming(), mojom::InputTiming(), std::nullopt, rfh,
*CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateFeaturesUpdate(
const std::vector<blink::UseCounterFeature>& new_features) {
SimulatePageLoadTimingUpdate(
mojom::PageLoadTiming(), mojom::FrameMetadata(), new_features,
mojom::FrameRenderDataUpdate(), mojom::CpuTiming(), mojom::InputTiming(),
std::nullopt, web_contents()->GetPrimaryMainFrame(),
*CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateRenderDataUpdate(
const mojom::FrameRenderDataUpdate& render_data) {
SimulateRenderDataUpdate(render_data, web_contents()->GetPrimaryMainFrame());
}
void PageLoadMetricsObserverTester::SimulateRenderDataUpdate(
const mojom::FrameRenderDataUpdate& render_data,
content::RenderFrameHost* rfh) {
mojom::PageLoadTiming timing;
InitPageLoadTimingForTest(&timing);
SimulatePageLoadTimingUpdate(
timing, mojom::FrameMetadata(),
/* new_features= */ {}, render_data, mojom::CpuTiming(),
mojom::InputTiming(), std::nullopt, rfh, *CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateSoftNavigation(
content::NavigationHandle* navigation_handle) {
SimulateDidFinishNavigation(navigation_handle);
}
void PageLoadMetricsObserverTester::SimulateDidFinishNavigation(
content::NavigationHandle* navigation_handle) {
metrics_web_contents_observer_->DidFinishNavigation(navigation_handle);
}
void PageLoadMetricsObserverTester::SimulateSoftNavigationCountUpdate(
const mojom::SoftNavigationMetrics& soft_navigation_metrics) {
SimulatePageLoadTimingUpdate(
mojom::PageLoadTiming(), mojom::FrameMetadata(),
/* new_features= */ {}, mojom::FrameRenderDataUpdate(),
mojom::CpuTiming(), mojom::InputTiming(), std::nullopt,
web_contents()->GetPrimaryMainFrame(), soft_navigation_metrics);
}
void PageLoadMetricsObserverTester::SimulatePageLoadTimingUpdate(
const mojom::PageLoadTiming& timing,
const mojom::FrameMetadata& metadata,
const std::vector<blink::UseCounterFeature>& new_features,
const mojom::FrameRenderDataUpdate& render_data,
const mojom::CpuTiming& cpu_timing,
const mojom::InputTiming& input_timing,
const std::optional<blink::SubresourceLoadMetrics>&
subresource_load_metrics,
content::RenderFrameHost* rfh,
const mojom::SoftNavigationMetrics& soft_navigation_metrics) {
metrics_web_contents_observer_->OnTimingUpdated(
rfh, timing.Clone(), metadata.Clone(), new_features,
std::vector<mojom::ResourceDataUpdatePtr>(), render_data.Clone(),
cpu_timing.Clone(), input_timing.Clone(), subresource_load_metrics,
soft_navigation_metrics.Clone());
// If sending the timing update caused the PageLoadMetricsUpdateDispatcher to
// schedule a buffering timer, then fire it now so metrics are dispatched to
// observers.
base::MockOneShotTimer* mock_timer = GetMockTimer();
if (mock_timer && mock_timer->IsRunning())
mock_timer->Fire();
}
void PageLoadMetricsObserverTester::SimulateResourceDataUseUpdate(
const std::vector<mojom::ResourceDataUpdatePtr>& resources) {
SimulateResourceDataUseUpdate(resources,
web_contents()->GetPrimaryMainFrame());
}
void PageLoadMetricsObserverTester::SimulateResourceDataUseUpdate(
const std::vector<mojom::ResourceDataUpdatePtr>& resources,
content::RenderFrameHost* render_frame_host) {
auto timing = mojom::PageLoadTimingPtr(std::in_place);
InitPageLoadTimingForTest(timing.get());
metrics_web_contents_observer_->OnTimingUpdated(
render_frame_host, std::move(timing),
mojom::FrameMetadataPtr(std::in_place),
std::vector<blink::UseCounterFeature>(), resources,
mojom::FrameRenderDataUpdatePtr(std::in_place),
mojom::CpuTimingPtr(std::in_place), mojom::InputTimingPtr(std::in_place),
std::nullopt, CreateSoftNavigationMetrics());
}
void PageLoadMetricsObserverTester::SimulateLoadedResource(
const ExtraRequestCompleteInfo& info) {
SimulateLoadedResource(info, content::GlobalRequestID());
}
void PageLoadMetricsObserverTester::SimulateLoadedResource(
const ExtraRequestCompleteInfo& info,
const content::GlobalRequestID& request_id) {
if (info.request_destination ==
network::mojom::RequestDestination::kDocument) {
ASSERT_NE(content::GlobalRequestID(), request_id)
<< "Main frame resources must have a GlobalRequestID.";
}
blink::mojom::ResourceLoadInfo resource_load_info;
resource_load_info.final_url = info.final_url.GetURL();
resource_load_info.was_cached = info.was_cached;
resource_load_info.raw_body_bytes = info.raw_body_bytes;
resource_load_info.total_received_bytes =
info.original_network_content_length;
resource_load_info.request_destination = info.request_destination;
resource_load_info.net_error = info.net_error;
resource_load_info.network_info = blink::mojom::CommonNetworkInfo::New();
resource_load_info.network_info->remote_endpoint = info.remote_endpoint;
if (info.load_timing_info)
resource_load_info.load_timing_info = *info.load_timing_info;
else
resource_load_info.load_timing_info.request_start = base::TimeTicks::Now();
metrics_web_contents_observer_->ResourceLoadComplete(
web_contents()->GetPrimaryMainFrame(), request_id, resource_load_info);
}
void PageLoadMetricsObserverTester::SimulateFrameReceivedUserActivation(
content::RenderFrameHost* render_frame_host) {
metrics_web_contents_observer_->FrameReceivedUserActivation(
render_frame_host);
}
void PageLoadMetricsObserverTester::SimulateInputEvent(
const blink::WebInputEvent& event) {
metrics_web_contents_observer_->OnInputEvent(
*web_contents()->GetPrimaryMainFrame()->GetRenderWidgetHost(), event);
}
void PageLoadMetricsObserverTester::SimulateAppEnterBackground() {
metrics_web_contents_observer_->FlushMetricsOnAppEnterBackground();
}
void PageLoadMetricsObserverTester::SimulateMediaPlayed() {
SimulateMediaPlayed(web_contents()->GetPrimaryMainFrame());
}
void PageLoadMetricsObserverTester::SimulateMediaPlayed(
content::RenderFrameHost* rfh) {
content::WebContentsObserver::MediaPlayerInfo video_type(
/*has_video=*/true, /*has_audio=*/true);
metrics_web_contents_observer_->MediaStartedPlaying(
video_type, content::MediaPlayerId(rfh->GetGlobalId(), 0));
}
void PageLoadMetricsObserverTester::SimulateCookieAccess(
const content::CookieAccessDetails& details) {
metrics_web_contents_observer_->OnCookiesAccessed(
metrics_web_contents_observer_->web_contents()->GetPrimaryMainFrame(),
details);
}
void PageLoadMetricsObserverTester::SimulateStorageAccess(
const GURL& url,
const GURL& first_party_url,
bool blocked_by_policy,
StorageType storage_type) {
metrics_web_contents_observer_->OnStorageAccessed(
metrics_web_contents_observer_->web_contents()->GetPrimaryMainFrame(),
url, first_party_url, blocked_by_policy, storage_type);
}
void PageLoadMetricsObserverTester::SimulateCustomUserTimingUpdate(
mojom::CustomUserTimingMarkPtr custom_timing) {
metrics_web_contents_observer_->OnCustomUserTimingUpdated(
web_contents()->GetPrimaryMainFrame(), std::move(custom_timing));
}
const PageLoadMetricsObserverDelegate&
PageLoadMetricsObserverTester::GetDelegateForCommittedLoad() const {
return metrics_web_contents_observer_->GetDelegateForCommittedLoad();
}
void PageLoadMetricsObserverTester::RegisterObservers(
PageLoadTracker* tracker) {
if (!register_callback_.is_null())
register_callback_.Run(tracker);
}
void PageLoadMetricsObserverTester::SimulateMemoryUpdate(
content::RenderFrameHost* render_frame_host,
int64_t delta_bytes) {
DCHECK(render_frame_host);
if (delta_bytes != 0) {
std::vector<MemoryUpdate> update(
{MemoryUpdate(render_frame_host->GetGlobalId(), delta_bytes)});
metrics_web_contents_observer_->OnV8MemoryChanged(update);
}
}
} // namespace page_load_metrics
|