File: metrics_provider_desktop_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 (301 lines) | stat: -rw-r--r-- 11,348 bytes parent folder | download | duplicates (6)
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
// 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 "chrome/browser/performance_manager/metrics/metrics_provider_desktop.h"

#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "chrome/browser/performance_manager/public/user_tuning/user_performance_tuning_manager.h"
#include "chrome/browser/performance_manager/test_support/fake_frame_throttling_delegate.h"
#include "chrome/browser/performance_manager/test_support/test_user_performance_tuning_manager_environment.h"
#include "components/performance_manager/public/features.h"
#include "components/performance_manager/public/user_tuning/prefs.h"
#include "components/prefs/testing_pref_service.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"

class PerformanceManagerMetricsProviderDesktopTest : public testing::Test {
 protected:
  PrefService* local_state() { return &local_state_; }

  void SetMemorySaverEnabled(bool enabled) {
    local_state()->SetInteger(
        performance_manager::user_tuning::prefs::kMemorySaverModeState,
        static_cast<int>(enabled ? performance_manager::user_tuning::prefs::
                                       MemorySaverModeState::kEnabled
                                 : performance_manager::user_tuning::prefs::
                                       MemorySaverModeState::kDisabled));
  }

  void SetBatterySaverEnabled(bool enabled) {
    performance_manager::user_tuning::
        TestUserPerformanceTuningManagerEnvironment::SetBatterySaverMode(
            &local_state_, enabled);
  }

  void ExpectSingleUniqueSample(
      const base::HistogramTester& tester,
      performance_manager::MetricsProviderDesktop::EfficiencyMode sample,
      int battery_saver_percent,
      int memory_saver_percent) {
    tester.ExpectUniqueSample("PerformanceManager.UserTuning.EfficiencyMode",
                              sample, 1);
    tester.ExpectUniqueSample(
        "PerformanceManager.UserTuning.BatterySaverModeEnabledPercent",
        battery_saver_percent, 1);
    tester.ExpectUniqueSample(
        "PerformanceManager.UserTuning.MemorySaverModeEnabledPercent",
        memory_saver_percent, 1);
  }

  void InitProvider() { provider_->Initialize(); }

  performance_manager::MetricsProviderDesktop* provider() {
    return provider_.get();
  }

  void ShutdownUserPerformanceTuningManager() {
    user_performance_tuning_env_->TearDown();
    user_performance_tuning_env_.reset();
  }

  void FastForwardBy(base::TimeDelta delta) {
    task_environment_.FastForwardBy(delta);
  }

 private:
  void SetUp() override {
    performance_manager::user_tuning::prefs::RegisterLocalStatePrefs(
        local_state_.registry());

    user_performance_tuning_env_ =
        std::make_unique<performance_manager::user_tuning::
                             TestUserPerformanceTuningManagerEnvironment>();
    user_performance_tuning_env_->SetUp(&local_state_);

    provider_.reset(
        new performance_manager::MetricsProviderDesktop(local_state()));
  }

  void TearDown() override {
    // Tests may teardown the environment before this is called to make some
    // assertions.
    if (user_performance_tuning_env_) {
      user_performance_tuning_env_->TearDown();
    }
  }

  content::BrowserTaskEnvironment task_environment_{
      base::test::TaskEnvironment::TimeSource::MOCK_TIME};

  TestingPrefServiceSimple local_state_;

  std::unique_ptr<performance_manager::user_tuning::
                      TestUserPerformanceTuningManagerEnvironment>
      user_performance_tuning_env_;
  std::unique_ptr<performance_manager::MetricsProviderDesktop> provider_;
};

TEST_F(PerformanceManagerMetricsProviderDesktopTest, TestNormalMode) {
  SetMemorySaverEnabled(false);

  InitProvider();
  base::HistogramTester tester;

  provider()->ProvideCurrentSessionData(nullptr);

  ExpectSingleUniqueSample(
      tester,
      performance_manager::MetricsProviderDesktop::EfficiencyMode::kNormal,
      /*battery_saver_percent=*/0, /*memory_saver_percent=*/0);
}

TEST_F(PerformanceManagerMetricsProviderDesktopTest, TestMixedMode) {
  // Start in normal mode
  SetMemorySaverEnabled(false);

  InitProvider();
  {
    base::HistogramTester tester;
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kNormal,
        /*battery_saver_percent=*/0, /*memory_saver_percent=*/0);
  }

  {
    base::HistogramTester tester;
    // Enable High-Efficiency Mode, the next reported value should be "mixed"
    // because we transitioned from normal to High-Efficiency during the
    // interval. Simulate 10 minutes elapsing before and after the change, which
    // should result in memory saver being reported as enabled for 50% of the
    // interval
    FastForwardBy(base::Minutes(10));
    SetMemorySaverEnabled(true);
    FastForwardBy(base::Minutes(10));
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kMixed,
        /*battery_saver_percent=*/0, /*memory_saver_percent=*/50);
  }

  {
    base::HistogramTester tester;
    // If another UMA upload happens without mode changes, this one will report
    // High-Efficiency Mode. Memory Saver is considered on for 100% of the
    // interval.
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(tester,
                             performance_manager::MetricsProviderDesktop::
                                 EfficiencyMode::kMemorySaver,
                             /*battery_saver_percent=*/0,
                             /*memory_saver_percent=*/100);
  }

  {
    base::HistogramTester tester;
    // Advance time, change battery saver state, then advance time again. The
    // Battery Saver Percent histogram should report the correct percentage.
    FastForwardBy(base::Minutes(40));
    SetBatterySaverEnabled(true);
    FastForwardBy(base::Minutes(10));
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kMixed,
        /*battery_saver_percent=*/20, /*memory_saver_percent=*/100);
  }
}

TEST_F(PerformanceManagerMetricsProviderDesktopTest, TestBothModes) {
  SetMemorySaverEnabled(true);
  SetBatterySaverEnabled(true);

  InitProvider();

  {
    base::HistogramTester tester;
    // Start with both modes enabled (such as a Chrome startup after having
    // enabled both modes in a previous session).
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kBoth,
        /*battery_saver_percent=*/100, /*memory_saver_percent=*/100);
  }

  {
    base::HistogramTester tester;
    // Disabling High-Efficiency Mode will cause the next report to be "mixed".
    // Since the time didn't advance, memory saver was off for the entire
    // interval and battery saver was on for it.
    SetMemorySaverEnabled(false);
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kMixed,
        /*battery_saver_percent=*/100, /*memory_saver_percent=*/0);
  }

  {
    base::HistogramTester tester;
    // No changes until the following report, "Battery saver" is reported
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(tester,
                             performance_manager::MetricsProviderDesktop::
                                 EfficiencyMode::kBatterySaver,
                             /*battery_saver_percent=*/100,
                             /*memory_saver_percent=*/0);
  }

  {
    base::HistogramTester tester;
    // Re-enabling High-Efficiency Mode will cause the next report to indicate
    // "mixed".
    FastForwardBy(base::Minutes(10));
    SetMemorySaverEnabled(true);
    FastForwardBy(base::Minutes(30));
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kMixed,
        /*battery_saver_percent=*/100, /*memory_saver_percent=*/75);
  }

  {
    base::HistogramTester tester;
    // One more report with no changes, this one reports "both" again.
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(
        tester,
        performance_manager::MetricsProviderDesktop::EfficiencyMode::kBoth,
        /*battery_saver_percent=*/100, /*memory_saver_percent=*/100);
  }
}

TEST_F(PerformanceManagerMetricsProviderDesktopTest,
       TestCorrectlyLoggedDuringShutdown) {
  SetMemorySaverEnabled(false);
  SetBatterySaverEnabled(true);

  InitProvider();

  {
    base::HistogramTester tester;
    // No changes until the following report, "Battery saver" is reported
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(tester,
                             performance_manager::MetricsProviderDesktop::
                                 EfficiencyMode::kBatterySaver,
                             /*battery_saver_percent=*/100,
                             /*memory_saver_percent=*/0);
  }

  ShutdownUserPerformanceTuningManager();

  // During shutdown, the MetricsProviderDesktop will attempt to record session
  // data one last time. This happens after the UserPerformanceTuningManager is
  // destroyed, which can cause a crash if the manager is accessed to compute
  // the current mode.
  {
    base::HistogramTester tester;
    // No changes until the following report, "Battery saver" is reported
    provider()->ProvideCurrentSessionData(nullptr);
    ExpectSingleUniqueSample(tester,
                             performance_manager::MetricsProviderDesktop::
                                 EfficiencyMode::kBatterySaver,
                             /*battery_saver_percent=*/100,
                             /*memory_saver_percent=*/0);
  }
}

TEST_F(PerformanceManagerMetricsProviderDesktopTest,
       TestCpuThrottlingMetricRecordedWhereAvailable) {
  InitProvider();
  base::HistogramTester tester;

  FastForwardBy(base::Minutes(5));
  tester.ExpectTotalCount(
      "CPU.Experimental.EstimatedFrequencyAsPercentOfMax.Performance",
      SHOULD_COLLECT_CPU_FREQUENCY_METRICS() ? 1 : 0);

  tester.ExpectTotalCount(
      "CPU.Experimental.EstimatedFrequencyAsPercentOfLimit.Performance",
      SHOULD_COLLECT_CPU_FREQUENCY_METRICS() ? 1 : 0);

  tester.ExpectTotalCount(
      "CPU.Experimental.CpuEstimationTaskQueuedTime.Performance",
      SHOULD_COLLECT_CPU_FREQUENCY_METRICS() ? 1 : 0);
  tester.ExpectTotalCount(
      "CPU.Experimental.CpuEstimationTaskTotalTime.Performance",
      SHOULD_COLLECT_CPU_FREQUENCY_METRICS() ? 1 : 0);
  tester.ExpectTotalCount(
      "CPU.Experimental.CpuEstimationTaskThreadTime.Performance",
      SHOULD_COLLECT_CPU_FREQUENCY_METRICS() ? 1 : 0);
  tester.ExpectTotalCount(
      "CPU.Experimental.CpuEstimationTaskWallTime.Performance",
      SHOULD_COLLECT_CPU_FREQUENCY_METRICS() ? 1 : 0);
}