File: anchor_element_preloader_browsertest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (433 lines) | stat: -rw-r--r-- 17,980 bytes parent folder | download | duplicates (5)
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "base/metrics/field_trial_params.h"
#include "base/run_loop.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "chrome/browser/navigation_predictor/anchor_element_preloader.h"
#include "chrome/browser/predictors/loading_predictor.h"
#include "chrome/browser/predictors/loading_predictor_factory.h"
#include "chrome/browser/predictors/preconnect_manager.h"
#include "chrome/browser/preloading/chrome_preloading.h"
#include "chrome/browser/preloading/preloading_prefs.h"
#include "chrome/browser/subresource_filter/subresource_filter_browser_test_harness.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/ui_test_utils.h"
#include "components/ukm/test_ukm_recorder.h"
#include "content/public/browser/preloading.h"
#include "content/public/common/content_features.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/preloading_test_util.h"
#include "net/base/features.h"
#include "net/dns/mock_host_resolver.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/input/web_mouse_event.h"
#include "ui/gfx/geometry/point_conversions.h"

namespace {

using UkmEntry = ukm::TestUkmRecorder::HumanReadableUkmEntry;
using ukm::builders::Preloading_Attempt;

class AnchorElementPreloaderBrowserTest
    : public subresource_filter::SubresourceFilterBrowserTest,
      public predictors::PreconnectManager::Observer {
 public:
  static constexpr char kOrigin1[] = "https://www.origin1.com/";
  static constexpr char kOrigin2[] = "https://www.origin2.com/";

  virtual base::FieldTrialParams GetNavigationPredictorFieldTrialParams() {
    return {};
  }

  void SetUp() override {
    feature_list_.InitWithFeaturesAndParameters(
        {{blink::features::kNavigationPredictor,
          GetNavigationPredictorFieldTrialParams()}},
        {});
    https_server_ = std::make_unique<net::EmbeddedTestServer>(
        net::EmbeddedTestServer::TYPE_HTTPS);
    https_server_->ServeFilesFromSourceDirectory("chrome/test/data/preload");
    EXPECT_TRUE(https_server_->Start());
    preresolve_count_ = 0;
    subresource_filter::SubresourceFilterBrowserTest::SetUp();
  }

  void SetUpCommandLine(base::CommandLine* command_line) override {
    // Without this flag, mouse events are suppressed in these tests.
    command_line->AppendSwitch("allow-pre-commit-input");
  }

  void SetUpOnMainThread() override {
    subresource_filter::SubresourceFilterBrowserTest::SetUpOnMainThread();
    host_resolver()->ClearRules();
    auto* loading_predictor =
        predictors::LoadingPredictorFactory::GetForProfile(
            browser()->profile());
    histogram_tester_ = std::make_unique<base::HistogramTester>();
    test_ukm_recorder_ = std::make_unique<ukm::TestAutoSetUkmRecorder>();
    ukm_entry_builder_ =
        std::make_unique<content::test::PreloadingAttemptUkmEntryBuilder>(
            chrome_preloading_predictor::kPointerDownOnAnchor);
    ASSERT_TRUE(loading_predictor);
    loading_predictor->preconnect_manager()->SetObserverForTesting(this);
  }

  void SimulateMouseDownElementWithId(const std::string& id) {
    content::WebContents* web_contents =
        browser()->tab_strip_model()->GetActiveWebContents();
    gfx::Point point = gfx::ToFlooredPoint(
        GetCenterCoordinatesOfElementWithId(web_contents, id));

    content::SimulateMouseEvent(web_contents,
                                blink::WebMouseEvent::Type::kMouseDown,
                                blink::WebMouseEvent::Button::kLeft, point);
  }

  const GURL GetTestURL(const char* file) const {
    return https_server_->GetURL(file);
  }

  void WaitForPreresolveCountForURL(int expected_count) {
    while (preresolve_count_ < expected_count) {
      run_loop_ = std::make_unique<base::RunLoop>();
      run_loop_->Run();
      run_loop_.reset();
    }
  }

  void GiveItSomeTime(const base::TimeDelta& t) {
    base::RunLoop run_loop;
    base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
        FROM_HERE, run_loop.QuitClosure(), t);
    run_loop.Run();
  }

  // predictors::PreconnectManager::Observer
  // We observe DNS preresolution instead of preconnect, because test
  // servers all resolve to localhost and Chrome won't preconnect
  // given it already has a warm connection.
  void OnPreresolveFinished(
      const GURL& url,
      const net::NetworkAnonymizationKey& network_anonymization_key,
      mojo::PendingRemote<network::mojom::ConnectionChangeObserverClient>&
          observer,
      bool success) override {
    if (url != GURL(kOrigin1) && url != GURL(kOrigin2)) {
      return;
    }

    ++preresolve_count_;
    if (run_loop_)
      run_loop_->Quit();
  }

  ukm::TestAutoSetUkmRecorder* test_ukm_recorder() {
    return test_ukm_recorder_.get();
  }

  content::RenderFrameHost* GetPrimaryMainFrame() {
    return browser()
        ->tab_strip_model()
        ->GetActiveWebContents()
        ->GetPrimaryMainFrame();
  }

  const content::test::PreloadingAttemptUkmEntryBuilder& ukm_entry_builder() {
    return *ukm_entry_builder_;
  }

  base::HistogramTester* histogram_tester() { return histogram_tester_.get(); }

 protected:
  int preresolve_count_;
  base::test::ScopedFeatureList feature_list_;
  // Disable sampling of UKM preloading logs.
  content::test::PreloadingConfigOverride preloading_config_override_;

 private:
  base::ScopedMockElapsedTimersForTest test_timer_;
  std::unique_ptr<net::EmbeddedTestServer> https_server_;
  std::unique_ptr<base::RunLoop> run_loop_;
  std::unique_ptr<ukm::TestAutoSetUkmRecorder> test_ukm_recorder_;
  std::unique_ptr<base::HistogramTester> histogram_tester_;
  std::unique_ptr<content::test::PreloadingAttemptUkmEntryBuilder>
      ukm_entry_builder_;
};

IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderBrowserTest, OneAnchor) {
  const GURL& url = GetTestURL("/one_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  SimulateMouseDownElementWithId("anchor1");

  WaitForPreresolveCountForURL(1);
  EXPECT_EQ(1, preresolve_count_);

  // Navigate away to the same origin that was preconnected. This should flush
  // the Preloading UKM logs.
  EXPECT_TRUE(ui_test_utils::NavigateToURL(
      browser(), GURL(std::string(kOrigin1) + "foo")));
  ukm::SourceId ukm_source_id = GetPrimaryMainFrame()->GetPageUkmSourceId();
  auto ukm_entries = test_ukm_recorder()->GetEntries(
      Preloading_Attempt::kEntryName,
      content::test::kPreloadingAttemptUkmMetrics);
  EXPECT_EQ(ukm_entries.size(), 1u);
  UkmEntry expected_entry = ukm_entry_builder().BuildEntry(
      ukm_source_id, content::PreloadingType::kPreconnect,
      content::PreloadingEligibility::kEligible,
      content::PreloadingHoldbackStatus::kAllowed,
      content::PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown,
      content::PreloadingFailureReason::kUnspecified,
      /*accurate=*/true);
  EXPECT_EQ(ukm_entries[0], expected_entry)
      << content::test::ActualVsExpectedUkmEntryToString(ukm_entries[0],
                                                         expected_entry);
}

IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderBrowserTest, OneAnchorInaccurate) {
  const GURL& url = GetTestURL("/one_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  SimulateMouseDownElementWithId("anchor1");

  WaitForPreresolveCountForURL(1);
  EXPECT_EQ(1, preresolve_count_);

  // Navigate away to an origin that was not preconnected. This should flush
  // the Preloading UKM logs.
  EXPECT_TRUE(ui_test_utils::NavigateToURL(
      browser(), GURL(std::string(kOrigin2) + "foo")));
  ukm::SourceId ukm_source_id = GetPrimaryMainFrame()->GetPageUkmSourceId();
  auto ukm_entries = test_ukm_recorder()->GetEntries(
      Preloading_Attempt::kEntryName,
      content::test::kPreloadingAttemptUkmMetrics);
  EXPECT_EQ(ukm_entries.size(), 1u);
  UkmEntry expected_entry = ukm_entry_builder().BuildEntry(
      ukm_source_id, content::PreloadingType::kPreconnect,
      content::PreloadingEligibility::kEligible,
      content::PreloadingHoldbackStatus::kAllowed,
      content::PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown,
      content::PreloadingFailureReason::kUnspecified,
      /*accurate=*/false);
  EXPECT_EQ(ukm_entries[0], expected_entry)
      << content::test::ActualVsExpectedUkmEntryToString(ukm_entries[0],
                                                         expected_entry);
}

// TODO(crbug.com/40255727): Flaky on Win10
#if BUILDFLAG(IS_WIN)
#define MAYBE_Duplicates DISABLED_Duplicates
#else
#define MAYBE_Duplicates Duplicates
#endif
IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderBrowserTest, MAYBE_Duplicates) {
  const GURL& url = GetTestURL("/many_anchors.html");

  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));

  // First link with mousedown event should get preconnected.
  SimulateMouseDownElementWithId("anchor1_origin1");
  WaitForPreresolveCountForURL(1);

  // Second mousedown event to same origin: should not trigger a preconnect.
  SimulateMouseDownElementWithId("anchor2_origin1");

  // Third mousedown event to a different origin: should trigger a preconnect.
  SimulateMouseDownElementWithId("anchor1_origin2");
  WaitForPreresolveCountForURL(2);

  // Navigate away to the first origin that was preconnected. This should flush
  // the Preloading UKM logs.
  EXPECT_TRUE(ui_test_utils::NavigateToURL(
      browser(), GURL(std::string(kOrigin1) + "foo")));
  ukm::SourceId ukm_source_id = GetPrimaryMainFrame()->GetPageUkmSourceId();
  auto ukm_entries = test_ukm_recorder()->GetEntries(
      Preloading_Attempt::kEntryName,
      content::test::kPreloadingAttemptUkmMetrics);
  EXPECT_EQ(ukm_entries.size(), 3u);
  std::vector<UkmEntry> expected_entries = {
      // Successful preconnect to first origin.
      ukm_entry_builder().BuildEntry(
          ukm_source_id, content::PreloadingType::kPreconnect,
          content::PreloadingEligibility::kEligible,
          content::PreloadingHoldbackStatus::kAllowed,
          content::PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown,
          content::PreloadingFailureReason::kUnspecified,
          /*accurate=*/true),
      // Duplicate preconnect to first origin.
      ukm_entry_builder().BuildEntry(
          ukm_source_id, content::PreloadingType::kPreconnect,
          content::PreloadingEligibility::kEligible,
          content::PreloadingHoldbackStatus::kAllowed,
          content::PreloadingTriggeringOutcome::kDuplicate,
          content::PreloadingFailureReason::kUnspecified,
          /*accurate=*/true),
      // Preconnect to first second origin.
      ukm_entry_builder().BuildEntry(
          ukm_source_id, content::PreloadingType::kPreconnect,
          content::PreloadingEligibility::kEligible,
          content::PreloadingHoldbackStatus::kAllowed,
          content::PreloadingTriggeringOutcome::kTriggeredButOutcomeUnknown,
          content::PreloadingFailureReason::kUnspecified,
          /*accurate=*/false),
  };
  EXPECT_THAT(ukm_entries, testing::UnorderedElementsAreArray(expected_entries))
      << content::test::ActualVsExpectedUkmEntriesToString(ukm_entries,
                                                           expected_entries);
}

IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderBrowserTest, InvalidHref) {
  const GURL& url = GetTestURL("/invalid_href_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  SimulateMouseDownElementWithId("anchor2");
  EXPECT_EQ(0, preresolve_count_);

  // Navigate away. This should flush the Preloading UKM logs.
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  auto ukm_entries = test_ukm_recorder()->GetEntries(
      Preloading_Attempt::kEntryName,
      content::test::kPreloadingAttemptUkmMetrics);
  EXPECT_EQ(ukm_entries.size(), 0u);
}

// TODO(crbug.com/40835708): Re-enable this test
IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderBrowserTest, DISABLED_IframeTest) {
  const GURL& url = GetTestURL("/iframe_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  content::SimulateMouseEvent(
      browser()->tab_strip_model()->GetActiveWebContents(),
      blink::WebMouseEvent::Type::kMouseDown,
      blink::WebMouseEvent::Button::kLeft, gfx::Point(200, 200));
  WaitForPreresolveCountForURL(1);
  EXPECT_EQ(1, preresolve_count_);
}

IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderBrowserTest,
                       UserSettingDisabledTest) {
  prefetch::SetPreloadPagesState(browser()->profile()->GetPrefs(),
                                 prefetch::PreloadPagesState::kNoPreloading);
  const GURL& url = GetTestURL("/one_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  SimulateMouseDownElementWithId("anchor1");
  EXPECT_EQ(0, preresolve_count_);

  // Give some time for Preloading APIs creation.
  GiveItSomeTime(base::Milliseconds(100));

  // Navigate away to the same origin that was preconnected. This should flush
  // the Preloading UKM logs.
  EXPECT_TRUE(ui_test_utils::NavigateToURL(
      browser(), GURL(std::string(kOrigin1) + "foo")));
  ukm::SourceId ukm_source_id = GetPrimaryMainFrame()->GetPageUkmSourceId();
  auto ukm_entries = test_ukm_recorder()->GetEntries(
      Preloading_Attempt::kEntryName,
      content::test::kPreloadingAttemptUkmMetrics);
  EXPECT_EQ(ukm_entries.size(), 1u);
  UkmEntry expected_entry = ukm_entry_builder().BuildEntry(
      ukm_source_id, content::PreloadingType::kPreconnect,
      content::PreloadingEligibility::kPreloadingDisabled,
      content::PreloadingHoldbackStatus::kUnspecified,
      content::PreloadingTriggeringOutcome::kUnspecified,
      content::PreloadingFailureReason::kUnspecified,
      /*accurate=*/true);
  EXPECT_EQ(ukm_entries[0], expected_entry)
      << content::test::ActualVsExpectedUkmEntryToString(ukm_entries[0],
                                                         expected_entry);
}

class AnchorElementPreloaderHoldbackBrowserTest
    : public AnchorElementPreloaderBrowserTest {
  void SetUp() override {
    preloading_config_override_.SetHoldback(
        content::PreloadingType::kPreconnect,
        chrome_preloading_predictor::kPointerDownOnAnchor, true);
    AnchorElementPreloaderBrowserTest::SetUp();
  }
};

IN_PROC_BROWSER_TEST_F(AnchorElementPreloaderHoldbackBrowserTest,
                       PreconnectHoldbackTest) {
  const GURL& url = GetTestURL("/one_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));

  SimulateMouseDownElementWithId("anchor1");
  EXPECT_EQ(0, preresolve_count_);

  // Give some time for Preloading APIs creation.
  GiveItSomeTime(base::Milliseconds(100));

  // Navigate away to the same origin that was preconnected. This should flush
  // the Preloading UKM logs.
  EXPECT_TRUE(ui_test_utils::NavigateToURL(
      browser(), GURL(std::string(kOrigin1) + "foo")));
  ukm::SourceId ukm_source_id = GetPrimaryMainFrame()->GetPageUkmSourceId();
  auto ukm_entries = test_ukm_recorder()->GetEntries(
      Preloading_Attempt::kEntryName,
      content::test::kPreloadingAttemptUkmMetrics);
  EXPECT_EQ(ukm_entries.size(), 1u);
  UkmEntry expected_entry = ukm_entry_builder().BuildEntry(
      ukm_source_id, content::PreloadingType::kPreconnect,
      content::PreloadingEligibility::kEligible,
      content::PreloadingHoldbackStatus::kHoldback,
      content::PreloadingTriggeringOutcome::kUnspecified,
      content::PreloadingFailureReason::kUnspecified,
      /*accurate=*/true);
  EXPECT_EQ(ukm_entries[0], expected_entry)
      << content::test::ActualVsExpectedUkmEntryToString(ukm_entries[0],
                                                         expected_entry);
}

class AnchorElementSetIsNavigationInDomainBrowserTest
    : public AnchorElementPreloaderBrowserTest {
 public:
  base::FieldTrialParams GetNavigationPredictorFieldTrialParams() override {
    return {{"random_anchor_sampling_period", "1"}};
  }
};

IN_PROC_BROWSER_TEST_F(AnchorElementSetIsNavigationInDomainBrowserTest,
                       TestPointerDownOnAnchor) {
  base::HistogramTester histogram_tester;
  GURL url = GetTestURL("/one_anchor.html");
  EXPECT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
  // Add a new link and trigger a mouse down event.
  EXPECT_TRUE(content::ExecJs(web_contents(),
                              R"(
    let a = document.createElement("a");
    a.id = "link";
    a.href = "https://www.example.com";
    a.innerHTML = '<div style="width:100vw;height:100vh;">Example<div>';
    document.body.appendChild(a);
    )"));
  base::RunLoop().RunUntilIdle();
  content::InputEventAckWaiter waiter(
      web_contents()->GetPrimaryMainFrame()->GetRenderWidgetHost(),
      blink::WebInputEvent::Type::kMouseDown);
  SimulateMouseEvent(web_contents(), blink::WebInputEvent::Type::kMouseDown,
                     blink::WebPointerProperties::Button::kLeft,
                     gfx::Point(150, 150));
  waiter.Wait();
  // Add another link and click on it.
  EXPECT_TRUE(content::ExecJs(web_contents(),
                              R"(
    let google = document.createElement("a");
    google.id = "link";
    google.href = "https://www.google.com";
    google.innerHTML = "google";
    document.body.appendChild(google);
    google.click();
    )"));
  base::RunLoop().RunUntilIdle();
  histogram_tester.ExpectBucketCount(
      "Preloading.Predictor.PointerDownOnAnchor.Recall",
      /*content::PredictorConfusionMatrix::kFalseNegative*/ 3, 1);
}

}  // namespace