File: performance_intervention_button_controller.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 (354 lines) | stat: -rw-r--r-- 13,906 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
// Copyright 2024 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/ui/performance_controls/performance_intervention_button_controller.h"

#include <cmath>

#include "base/check.h"
#include "base/containers/contains.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/feature_engagement/tracker_factory.h"
#include "chrome/browser/performance_manager/public/user_tuning/performance_detection_manager.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_finder.h"
#include "chrome/browser/ui/performance_controls/performance_controls_metrics.h"
#include "chrome/browser/ui/performance_controls/performance_intervention_button_controller_delegate.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
#include "components/feature_engagement/public/feature_constants.h"
#include "components/feature_engagement/public/tracker.h"
#include "components/performance_manager/public/features.h"
#include "components/performance_manager/public/resource_attribution/page_context.h"
#include "components/performance_manager/public/user_tuning/prefs.h"
#include "components/prefs/pref_service.h"
#include "content/public/browser/web_contents.h"

namespace {

// This represents the duration that the performance intervention button
// should remain in the toolbar after the user dismisses the intervention
// dialog without taking the suggested action.
const base::TimeDelta kInterventionButtonTimeout = base::Seconds(10);

// Erase the oldest entries if the history size exceeds
// the max acceptance window.
void TrimAcceptHistory(PrefService* pref_service) {
  const base::Value::List& historical_acceptance = pref_service->GetList(
      performance_manager::user_tuning::prefs::
          kPerformanceInterventionNotificationAcceptHistory);
  const size_t current_size = historical_acceptance.size();
  const size_t max_acceptance = static_cast<size_t>(
      performance_manager::features::kAcceptanceRateWindowSize.Get());
  if (current_size > max_acceptance) {
    const size_t difference = current_size - max_acceptance;
    base::Value::List updated_acceptance = historical_acceptance.Clone();
    updated_acceptance.erase(updated_acceptance.begin(),
                             updated_acceptance.begin() + difference);
    pref_service->SetList(performance_manager::user_tuning::prefs::
                              kPerformanceInterventionNotificationAcceptHistory,
                          std::move(updated_acceptance));
  }
}
}  // namespace

PerformanceInterventionButtonController::
    PerformanceInterventionButtonController(
        PerformanceInterventionButtonControllerDelegate* delegate,
        Browser* browser)
    : delegate_(delegate), browser_(browser) {
  // The `PerformanceDetectionManager` is undefined in unit tests because it
  // is constructed in `ChromeContentBrowserClient::CreateBrowserMainParts`.
  if (PerformanceDetectionManager::HasInstance()) {
    const PerformanceDetectionManager::ResourceTypeSet resource_types = {
        PerformanceDetectionManager::ResourceType::kCpu};
    PerformanceDetectionManager::GetInstance()->AddActionableTabsObserver(
        resource_types, this);
    browser->tab_strip_model()->AddObserver(this);
  }

  if (base::FeatureList::IsEnabled(
          performance_manager::features::
              kPerformanceInterventionNotificationImprovements)) {
    TrimAcceptHistory(g_browser_process->local_state());
  }
}

PerformanceInterventionButtonController::
    ~PerformanceInterventionButtonController() {
  if (PerformanceDetectionManager::HasInstance()) {
    PerformanceDetectionManager* const detection_manager =
        PerformanceDetectionManager::GetInstance();
    detection_manager->RemoveActionableTabsObserver(this);
    browser_->tab_strip_model()->RemoveObserver(this);
  }
}

// static
int PerformanceInterventionButtonController::GetAcceptancePercentage() {
  PrefService* const pref_service = g_browser_process->local_state();
  const base::Value::List& historical_acceptance = pref_service->GetList(
      performance_manager::user_tuning::prefs::
          kPerformanceInterventionNotificationAcceptHistory);

  if (historical_acceptance.empty()) {
    return 100;
  }

  const size_t current_size = historical_acceptance.size();
  const size_t max_acceptance = static_cast<size_t>(
      performance_manager::features::kAcceptanceRateWindowSize.Get());
  size_t starting_index = 0;
  if (current_size > max_acceptance) {
    starting_index = current_size - max_acceptance;
  }

  int total_acceptance = 0;
  for (size_t i = starting_index; i < current_size; i++) {
    if (historical_acceptance[i].GetBool()) {
      total_acceptance++;
    }
  }

  return total_acceptance * 100.0 / std::min(current_size, max_acceptance);
}

void PerformanceInterventionButtonController::OnActionableTabListChanged(
    PerformanceDetectionManager::ResourceType type,
    PerformanceDetectionManager::ActionableTabsResult result) {
  actionable_cpu_tabs_ = result;

  if (!result.empty()) {
    MaybeShowUi(type, result);
  } else if (!delegate_->IsBubbleShowing()) {
    // Intervention button shouldn't hide while the dialog is being shown.
    HideToolbarButton(false);
  }
}

void PerformanceInterventionButtonController::OnTabStripModelChanged(
    TabStripModel* tab_strip_model,
    const TabStripModelChange& change,
    const TabStripSelectionChange& selection) {
  if (selection.active_tab_changed()) {
    std::optional<resource_attribution::PageContext> current_page_context =
        resource_attribution::PageContext::FromWebContents(
            selection.new_contents);

    if (!current_page_context.has_value()) {
      return;
    }

    // Invalidate the actionable tab list since one of the actionable tabs is no
    // longer eligible and taking action on the remaining tabs no longer improve
    // resource health.
    if (base::Contains(actionable_cpu_tabs_, current_page_context.value())) {
      actionable_cpu_tabs_.clear();
      HideToolbarButton(false);
      return;
    }
  }

  if (change.type() == TabStripModelChange::kRemoved) {
    for (const TabStripModelChange::RemovedTab& tab :
         change.GetRemove()->contents) {
      std::optional<resource_attribution::PageContext> removed_page_context =
          resource_attribution::PageContext::FromWebContents(tab.contents);
      CHECK(removed_page_context.has_value());
      std::erase(actionable_cpu_tabs_, removed_page_context);
    }

    if (actionable_cpu_tabs_.empty()) {
      HideToolbarButton(false);
    }
  }
}

void PerformanceInterventionButtonController::OnBubbleShown() {
  hide_button_timer_.Stop();
}

void PerformanceInterventionButtonController::OnBubbleHidden() {
  // Immediately hide the toolbar button since there is no longer
  // any actionable tabs.
  if (actionable_cpu_tabs_.empty()) {
    HideToolbarButton(false);
    return;
  }

  CHECK(!hide_button_timer_.IsRunning());
  // It is safe to use the base::Unretained(this) for the timer callback
  // as the controller owns the timer and will exist for the lifetime of
  // the timer.
  hide_button_timer_.Start(
      FROM_HERE, kInterventionButtonTimeout,
      base::BindRepeating(
          &PerformanceInterventionButtonController::HideToolbarButton,
          base::Unretained(this), false));
}

void PerformanceInterventionButtonController::OnDeactivateButtonClicked() {
  // Immediately hide the toolbar button since the user has taken the suggested
  // action.
  HideToolbarButton(true);
}

bool PerformanceInterventionButtonController::ShouldShowNotification(
    feature_engagement::Tracker* tracker) {
  if (!base::FeatureList::IsEnabled(
          performance_manager::features::
              kPerformanceInterventionNotificationImprovements)) {
    return true;
  }

  PrefService* const pref_service = g_browser_process->local_state();
  const base::TimeDelta time_since_intervention =
      base::Time::Now() -
      pref_service->GetTime(performance_manager::user_tuning::prefs::
                                kPerformanceInterventionNotificationLastShown);
  const int acceptance_percentage = GetAcceptancePercentage();
  // Wait until the minimum reshow time before showing another intervention.
  if (time_since_intervention <
      performance_manager::features::kMinimumTimeBetweenReshow.Get()) {
    return false;
  }

  if (acceptance_percentage == 0) {
    return time_since_intervention >=
           performance_manager::features::kNoAcceptanceBackOff.Get();
  }

  const double acceptance_rate = acceptance_percentage / 100.0;
  const int daily_max_count =
      std::ceil(performance_manager::features::kScaleMaxTimesPerDay.Get() *
                acceptance_rate);
  const int weekly_max_count =
      std::ceil(performance_manager::features::kScaleMaxTimesPerWeek.Get() *
                acceptance_rate);

  // Verify that performance detection did not hit the limit to show the
  // intervention per day and week.
  for (const auto& [config, count] : tracker->ListEvents(
           feature_engagement::kIPHPerformanceInterventionDialogFeature)) {
    if (config.window == 1 && (count >= daily_max_count)) {
      return false;
    } else if (config.window == 7 && (count >= weekly_max_count)) {
      return false;
    }
  }

  return true;
}

void PerformanceInterventionButtonController::HideToolbarButton(
    bool accept_intervention) {
  const bool was_showing = delegate_->IsButtonShowing();
  hide_button_timer_.Stop();
  delegate_->Hide();

  if (base::FeatureList::IsEnabled(
          performance_manager::features::
              kPerformanceInterventionNotificationImprovements) &&
      was_showing) {
    PrefService* const pref_service = g_browser_process->local_state();
    const base::Value::List& historical_acceptance = pref_service->GetList(
        performance_manager::user_tuning::prefs::
            kPerformanceInterventionNotificationAcceptHistory);

    base::Value::List updated_acceptance = historical_acceptance.Clone();
    updated_acceptance.Append(accept_intervention);

    if (updated_acceptance.size() >
        static_cast<size_t>(
            performance_manager::features::kAcceptanceRateWindowSize.Get())) {
      updated_acceptance.erase(updated_acceptance.begin());
    }

    pref_service->SetList(performance_manager::user_tuning::prefs::
                              kPerformanceInterventionNotificationAcceptHistory,
                          std::move(updated_acceptance));
  }
}

void PerformanceInterventionButtonController::MaybeShowUi(
    PerformanceDetectionManager::ResourceType type,
    const PerformanceDetectionManager::ActionableTabsResult& result) {
  PrefService* const pref_service = g_browser_process->local_state();
  CHECK(pref_service);
  // Only trigger performance detection UI for the active window and if we are
  // not already showing the UI.
  if (browser_ != chrome::FindLastActive() || delegate_->IsButtonShowing() ||
      !performance_manager::user_tuning::prefs::
          ShouldShowPerformanceInterventionNotification(pref_service)) {
    return;
  }

  Profile* const profile = browser_->profile();
  auto* const tracker =
      feature_engagement::TrackerFactory::GetForBrowserContext(profile);
  CHECK(tracker);

  InterventionMessageTriggerResult trigger_result =
      InterventionMessageTriggerResult::kShown;

  if (ContainsNonLastActiveProfile(result)) {
    trigger_result = InterventionMessageTriggerResult::kMixedProfile;
  } else if (base::FeatureList::IsEnabled(
                 performance_manager::features::
                     kPerformanceInterventionDemoMode)) {
    trigger_result = InterventionMessageTriggerResult::kShown;
  } else if (ShouldShowNotification(tracker) &&
             tracker->ShouldTriggerHelpUI(
                 feature_engagement::
                     kIPHPerformanceInterventionDialogFeature)) {
    // Immediately dismiss the feature engagement tracker because the
    // performance intervention UI shouldn't prevent other promos from
    // showing.
    tracker->Dismissed(
        feature_engagement::kIPHPerformanceInterventionDialogFeature);
    trigger_result = InterventionMessageTriggerResult::kShown;
    RecordInterventionMessageCount(type, pref_service);
  } else {
    trigger_result = InterventionMessageTriggerResult::kRateLimited;
    RecordInterventionRateLimitedCount(type, pref_service);
  }

  RecordInterventionTriggerResult(type, trigger_result);

  if (trigger_result == InterventionMessageTriggerResult::kShown) {
    delegate_->Show();
    if (base::FeatureList::IsEnabled(
            performance_manager::features::
                kPerformanceInterventionNotificationImprovements)) {
      pref_service->SetTime(performance_manager::user_tuning::prefs::
                                kPerformanceInterventionNotificationLastShown,
                            base::Time::Now());
    }
  }
}

bool PerformanceInterventionButtonController::ContainsNonLastActiveProfile(
    const PerformanceDetectionManager::ActionableTabsResult& result) {
  Profile* const profile = chrome::FindLastActive()->profile();
  for (const resource_attribution::PageContext& context : result) {
    content::WebContents* const web_content = context.GetWebContents();
    if (!web_content) {
      // Without a WebContents, we can't check if it's from a different profile.
      return true;
    }
    Profile* const content_profile =
        Profile::FromBrowserContext(web_content->GetBrowserContext());
    if (profile != content_profile) {
      return true;
    }
  }

  return false;
}