File: metrics_render_frame_observer_unittest.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 (331 lines) | stat: -rw-r--r-- 12,362 bytes parent folder | download | duplicates (9)
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
// Copyright 2015 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/renderer/metrics_render_frame_observer.h"

#include <memory>
#include <utility>

#include "base/memory/ptr_util.h"
#include "base/time/time.h"
#include "base/timer/mock_timer.h"
#include "components/page_load_metrics/common/page_load_metrics.mojom-forward.h"
#include "components/page_load_metrics/common/page_load_timing.h"
#include "components/page_load_metrics/common/test/weak_mock_timer.h"
#include "components/page_load_metrics/renderer/fake_page_timing_sender.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "url/gurl.h"

namespace page_load_metrics {

// Implementation of the MetricsRenderFrameObserver class we're testing, with
// the GetTiming() method stubbed out to make the rest of the class more
// testable.
class TestMetricsRenderFrameObserver : public MetricsRenderFrameObserver,
                                       public test::WeakMockTimerProvider {
 public:
  TestMetricsRenderFrameObserver() : MetricsRenderFrameObserver(nullptr) {}

  std::unique_ptr<base::OneShotTimer> CreateTimer() override {
    auto timer = std::make_unique<test::WeakMockTimer>();
    SetMockTimer(timer->AsWeakPtr());
    return std::move(timer);
  }

  std::unique_ptr<PageTimingSender> CreatePageTimingSender(
      bool limited_sending_mode) override {
    return base::WrapUnique<PageTimingSender>(
        new FakePageTimingSender(&validator_));
  }

  void ExpectPageLoadTiming(const mojom::PageLoadTiming& timing) {
    SetFakePageLoadTiming(timing);
    validator_.ExpectPageLoadTiming(timing);
  }

  void ExpectCpuTiming(const base::TimeDelta& timing) {
    validator_.ExpectCpuTiming(timing);
  }

  void SetFakePageLoadTiming(const mojom::PageLoadTiming& timing) {
    EXPECT_EQ(nullptr, fake_timing_.get());
    fake_timing_ = timing.Clone();
  }

  void ExpectMainFrameIntersectionRect(
      const gfx::Rect& main_frame_intersection_rect) {
    validator_.UpdateExpectedMainFrameIntersectionRect(
        main_frame_intersection_rect);
  }

  Timing GetTiming() const override {
    EXPECT_NE(nullptr, fake_timing_.get());
    return Timing(std::move(fake_timing_),
                  PageTimingMetadataRecorder::MonotonicTiming());
  }

  mojom::CustomUserTimingMarkPtr GetCustomUserTimingMark() const override {
    return mojom::CustomUserTimingMark::New("fake_user_timing_mark",
                                            base::Milliseconds(100));
  }

  void ExpectSoftNavigationMetrics(
      const mojom::SoftNavigationMetrics& soft_navigation_metrics) {
    fake_soft_navigation_metrics_ = soft_navigation_metrics.Clone();
    validator_.ExpectSoftNavigationMetrics(soft_navigation_metrics);
  }

  void ExpectSoftNavigationMetrics() {
    validator_.ExpectSoftNavigationMetrics(
        *fake_soft_navigation_metrics_->Clone());
  }

  void VerifyExpectedSoftNavigationMetrics() const {
    validator_.VerifyExpectedSoftNavigationMetrics();
  }

  mojom::SoftNavigationMetricsPtr GetSoftNavigationMetrics() const override {
    return fake_soft_navigation_metrics_->Clone();
  }

  void VerifyExpectedTimings() const {
    EXPECT_EQ(nullptr, fake_timing_.get());
    validator_.VerifyExpectedTimings();
  }

  bool HasNoRenderFrame() const override { return false; }

  bool IsMainFrame() const override { return true; }

 private:
  FakePageTimingSender::PageTimingValidator validator_;
  mutable mojom::PageLoadTimingPtr fake_timing_;
  mojom::SoftNavigationMetricsPtr fake_soft_navigation_metrics_ =
      mojom::SoftNavigationMetrics::New(blink::kSoftNavigationCountDefaultValue,
                                        base::Milliseconds(0),
                                        std::string(),
                                        CreateLargestContentfulPaintTiming());
};

typedef testing::Test MetricsRenderFrameObserverTest;

TEST_F(MetricsRenderFrameObserverTest, NoMetrics) {
  TestMetricsRenderFrameObserver observer;
  observer.DidChangePerformanceTiming();
  ASSERT_EQ(nullptr, observer.GetMockTimer());
}

TEST_F(MetricsRenderFrameObserverTest, SingleMetric) {
  base::Time nav_start = base::Time::FromSecondsSinceUnixEpoch(10);

  TestMetricsRenderFrameObserver observer;

  mojom::PageLoadTiming timing;
  page_load_metrics::InitPageLoadTimingForTest(&timing);
  timing.navigation_start = nav_start;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics();

  observer.DidStartNavigation(GURL(), std::nullopt);
  observer.ReadyToCommitNavigation(nullptr);
  observer.DidCommitProvisionalLoad(ui::PAGE_TRANSITION_LINK);
  observer.GetMockTimer()->Fire();

  timing.parse_timing->parse_start = base::Milliseconds(10);
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics();

  observer.DidChangePerformanceTiming();
  observer.GetMockTimer()->Fire();
}

TEST_F(MetricsRenderFrameObserverTest,
       MainFrameIntersectionUpdateBeforeMetricsSenderCreated) {
  base::Time nav_start = base::Time::FromSecondsSinceUnixEpoch(10);

  TestMetricsRenderFrameObserver observer;
  observer.OnMainFrameIntersectionChanged(gfx::Rect(1, 2, 3, 4));

  mojom::PageLoadTiming timing;
  page_load_metrics::InitPageLoadTimingForTest(&timing);
  timing.navigation_start = nav_start;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics();
  observer.DidStartNavigation(GURL(), std::nullopt);
  observer.ReadyToCommitNavigation(nullptr);
  observer.DidCommitProvisionalLoad(ui::PAGE_TRANSITION_LINK);

  observer.ExpectMainFrameIntersectionRect(gfx::Rect(1, 2, 3, 4));

  observer.GetMockTimer()->Fire();
}

// Verify that when two CpuTimings come in, they're grouped into a single
// Message with the total being the sum of the two.
TEST_F(MetricsRenderFrameObserverTest, SingleCpuMetric) {
  base::Time nav_start = base::Time::FromSecondsSinceUnixEpoch(10);
  TestMetricsRenderFrameObserver observer;
  mojom::PageLoadTiming timing;

  // Initialize the page and add the initial timing info to the expected.
  page_load_metrics::InitPageLoadTimingForTest(&timing);
  timing.navigation_start = nav_start;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics();
  observer.DidStartNavigation(GURL(), std::nullopt);
  observer.ReadyToCommitNavigation(nullptr);
  observer.DidCommitProvisionalLoad(ui::PAGE_TRANSITION_LINK);

  // Send cpu timing updates and verify the expected result.
  observer.DidChangeCpuTiming(base::Milliseconds(110));
  observer.DidChangeCpuTiming(base::Milliseconds(50));
  observer.ExpectCpuTiming(base::Milliseconds(160));
  observer.GetMockTimer()->Fire();
}

TEST_F(MetricsRenderFrameObserverTest, MultipleMetrics) {
  base::Time nav_start = base::Time::FromSecondsSinceUnixEpoch(10);
  base::TimeDelta dom_event = base::Milliseconds(2);
  base::TimeDelta load_event = base::Milliseconds(2);

  TestMetricsRenderFrameObserver observer;

  mojom::PageLoadTiming timing;
  page_load_metrics::InitPageLoadTimingForTest(&timing);
  mojom::SoftNavigationMetricsPtr soft_navigation_metrics =
      mojom::SoftNavigationMetrics::New(blink::kSoftNavigationCountDefaultValue,
                                        base::Milliseconds(0), std::string(),
                                        CreateLargestContentfulPaintTiming());
  timing.navigation_start = nav_start;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics(*soft_navigation_metrics);

  observer.DidStartNavigation(GURL(), std::nullopt);
  observer.ReadyToCommitNavigation(nullptr);
  observer.DidCommitProvisionalLoad(ui::PAGE_TRANSITION_LINK);
  observer.GetMockTimer()->Fire();

  timing.document_timing->dom_content_loaded_event_start = dom_event;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics(*soft_navigation_metrics);

  observer.DidChangePerformanceTiming();
  observer.GetMockTimer()->Fire();

  // At this point, we should have triggered the generation of two metrics.
  // Verify and reset the observer's expectations before moving on to the next
  // part of the test.
  observer.VerifyExpectedTimings();

  timing.document_timing->load_event_start = load_event;
  observer.ExpectPageLoadTiming(timing);
  // Expect a soft navigation metrics being sent because of soft navigation
  // detection.
  soft_navigation_metrics->count = 1;

  soft_navigation_metrics->start_time =
      base::TimeDelta() + base::Milliseconds(221.1);

  soft_navigation_metrics->navigation_id =
      "94befe01-5108-43f2-9ec9-936dd0f36e02";

  observer.ExpectSoftNavigationMetrics(*soft_navigation_metrics);

  observer.DidChangePerformanceTiming();
  observer.GetMockTimer()->Fire();

  // Verify and reset the observer's expectations before moving on to the next
  // part of the test.
  observer.VerifyExpectedTimings();
  observer.VerifyExpectedSoftNavigationMetrics();

  // The PageLoadTiming above includes timing information for the first layout,
  // dom content, and load metrics. However, since we've already generated
  // timing information for all of these metrics previously, we do not expect
  // this invocation to generate any additional metrics.
  observer.SetFakePageLoadTiming(timing);
  observer.DidChangePerformanceTiming();
  ASSERT_FALSE(observer.GetMockTimer()->IsRunning());

  // Expect a non-empty soft navigation metric being sent because of largest
  // contentful paint update.

  // This page load timing is the same as the previous one, but as the soft
  // navigation metric is being sent, this timing is also sent along with the
  // soft navigation metric. Therefore we should expect 1 more page load
  // timing.
  observer.ExpectPageLoadTiming(timing);

  soft_navigation_metrics->largest_contentful_paint =
      CreateLargestContentfulPaintTiming();

  soft_navigation_metrics->largest_contentful_paint->largest_image_paint_size =
      1;

  observer.ExpectSoftNavigationMetrics(*soft_navigation_metrics);

  observer.DidChangePerformanceTiming();

  observer.GetMockTimer()->Fire();

  observer.VerifyExpectedSoftNavigationMetrics();

  ASSERT_FALSE(observer.GetMockTimer()->IsRunning());
}

TEST_F(MetricsRenderFrameObserverTest, MultipleNavigations) {
  base::Time nav_start = base::Time::FromSecondsSinceUnixEpoch(10);
  base::TimeDelta dom_event = base::Milliseconds(2);
  base::TimeDelta load_event = base::Milliseconds(2);

  TestMetricsRenderFrameObserver observer;

  mojom::PageLoadTiming timing;
  page_load_metrics::InitPageLoadTimingForTest(&timing);
  timing.navigation_start = nav_start;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics();
  observer.DidStartNavigation(GURL(), std::nullopt);
  observer.ReadyToCommitNavigation(nullptr);
  observer.DidCommitProvisionalLoad(ui::PAGE_TRANSITION_LINK);
  observer.GetMockTimer()->Fire();

  timing.document_timing->dom_content_loaded_event_start = dom_event;
  timing.document_timing->load_event_start = load_event;
  observer.ExpectPageLoadTiming(timing);
  observer.ExpectSoftNavigationMetrics();
  observer.DidChangePerformanceTiming();
  observer.GetMockTimer()->Fire();

  // At this point, we should have triggered the generation of two metrics.
  // Verify and reset the observer's expectations before moving on to the next
  // part of the test.
  observer.VerifyExpectedTimings();

  base::Time nav_start_2 = base::Time::FromSecondsSinceUnixEpoch(100);
  base::TimeDelta dom_event_2 = base::Milliseconds(20);
  base::TimeDelta load_event_2 = base::Milliseconds(20);
  mojom::PageLoadTiming timing_2;
  page_load_metrics::InitPageLoadTimingForTest(&timing_2);
  timing_2.navigation_start = nav_start_2;

  observer.SetMockTimer(nullptr);

  observer.ExpectPageLoadTiming(timing_2);
  observer.ExpectSoftNavigationMetrics();
  observer.DidStartNavigation(GURL(), std::nullopt);
  observer.ReadyToCommitNavigation(nullptr);
  observer.DidCommitProvisionalLoad(ui::PAGE_TRANSITION_LINK);
  observer.GetMockTimer()->Fire();

  timing_2.document_timing->dom_content_loaded_event_start = dom_event_2;
  timing_2.document_timing->load_event_start = load_event_2;
  observer.ExpectPageLoadTiming(timing_2);
  observer.ExpectSoftNavigationMetrics();

  observer.DidChangePerformanceTiming();
  observer.GetMockTimer()->Fire();
}

}  // namespace page_load_metrics