File: hats_office_trigger.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (226 lines) | stat: -rw-r--r-- 8,081 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
// 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/webui/ash/cloud_upload/hats_office_trigger.h"

#include <memory>

#include "base/check_op.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/notreached.h"
#include "base/time/time.h"
#include "base/unguessable_token.h"
#include "chrome/browser/apps/app_service/app_service_proxy.h"
#include "chrome/browser/apps/app_service/app_service_proxy_factory.h"
#include "chrome/browser/ash/hats/hats_config.h"
#include "chrome/browser/ash/hats/hats_notification_controller.h"
#include "chrome/browser/policy/profile_policy_connector.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "chromeos/ash/components/browser_context_helper/browser_context_helper.h"
#include "components/services/app_service/public/cpp/instance.h"
#include "components/session_manager/core/session_manager.h"
#include "components/user_manager/user_manager.h"

namespace ash::cloud_upload {
namespace {

constexpr char kHatsOfficeLaunchingApp[] = "Launching app";

const char* HatsOfficeLaunchingAppToString(HatsOfficeLaunchingApp app) {
  switch (app) {
    case HatsOfficeLaunchingApp::kDrive:
      return "Google Drive";
    case HatsOfficeLaunchingApp::kMS365:
      return "Microsoft 365";
    case HatsOfficeLaunchingApp::kQuickOffice:
      return "Quickoffice";
    case HatsOfficeLaunchingApp::kQuickOfficeClippyOff:
      return "Quickoffice (ChromeOS Office integration disabled)";
  }
}

}  // namespace

// static
HatsOfficeTrigger& HatsOfficeTrigger::Get() {
  static base::NoDestructor<HatsOfficeTrigger> instance;
  return *instance;
}

void HatsOfficeTrigger::SetShowSurveyCallbackForTesting(
    ShowSurveyCallbackForTesting callback) {
  show_survey_callback_for_testing_ = std::move(callback);
}

void HatsOfficeTrigger::ShowSurveyAfterDelay(HatsOfficeLaunchingApp app) {
  if (show_survey_callback_for_testing_) {
    // In tests, just check that this method has been called with the right
    // "Launching app" survey metadata.
    std::move(show_survey_callback_for_testing_).Run(std::string(), app);
    return;
  }
  if (!ShouldShowSurvey()) {
    return;
  }
  delay_trigger_ = std::make_unique<DelayTrigger>(
      base::BindOnce(&HatsOfficeTrigger::ShowSurveyIfSelected,
                     weak_ptr_factory_.GetWeakPtr(), std::move(app)));
}

void HatsOfficeTrigger::ShowSurveyAfterAppInactive(const std::string& app_id,
                                                   HatsOfficeLaunchingApp app) {
  if (show_survey_callback_for_testing_) {
    // In tests, just check that this method has been called with the right
    // "Launching app" survey metadata.
    std::move(show_survey_callback_for_testing_).Run(app_id, app);
    return;
  }
  if (!ShouldShowSurvey()) {
    return;
  }
  Profile* profile = GetProfile();
  if (!apps::AppServiceProxyFactory::IsAppServiceAvailableForProfile(profile)) {
    return;
  }
  app_state_trigger_ = std::make_unique<AppStateTrigger>(
      profile, app_id,
      base::BindOnce(&HatsOfficeTrigger::ShowSurveyIfSelected,
                     weak_ptr_factory_.GetWeakPtr(), std::move(app)),
      base::BindOnce(&HatsOfficeTrigger::CleanupTriggers,
                     weak_ptr_factory_.GetWeakPtr()));
}

HatsOfficeTrigger::DelayTrigger::DelayTrigger(base::OnceClosure callback) {
  notification_timer_.Start(FROM_HERE, kDelayTriggerTimeout,
                            std::move(callback));
}

HatsOfficeTrigger::AppStateTrigger::AppStateTrigger(
    Profile* profile,
    const std::string& app_id,
    base::OnceClosure success_callback,
    base::OnceClosure failure_callback)
    : app_id_(app_id),
      success_callback_(std::move(success_callback)),
      failure_callback_(std::move(failure_callback)) {
  apps::InstanceRegistry& registry =
      apps::AppServiceProxyFactory::GetForProfile(profile)->InstanceRegistry();
  observation_.Observe(&registry);
  // Start a timer to abandon the app state observation if the expected initial
  // event hasn't been received after a delay.
  first_app_state_event_timer_.Start(
      FROM_HERE, kFirstAppStateEventTimeout,
      base::BindOnce(&AppStateTrigger::StopTrackingAppState,
                     weak_ptr_factory_.GetWeakPtr()));
}
HatsOfficeTrigger::AppStateTrigger::~AppStateTrigger() = default;

void HatsOfficeTrigger::AppStateTrigger::OnInstanceUpdate(
    const apps::InstanceUpdate& update) {
  if (update.AppId() != app_id_) {
    return;
  }
  // Assume that the first "started and running" update is from the right
  // `app_id_` instance.
  if (instance_id_.is_empty() &&
      update.State() == apps::InstanceState(apps::kStarted | apps::kRunning)) {
    instance_id_ = update.InstanceId();
  } else if (instance_id_ != update.InstanceId()) {
    return;
  }
  // Only check the app state if it hasn't changed within the given delay.
  debounce_timer_.Start(
      FROM_HERE, kDebounceDelay,
      base::BindOnce(&AppStateTrigger::HandleObservedAppStateUpdate,
                     weak_ptr_factory_.GetWeakPtr(), update.State()));
}

void HatsOfficeTrigger::AppStateTrigger::OnInstanceRegistryWillBeDestroyed(
    apps::InstanceRegistry* cache) {
  std::move(failure_callback_).Run();
}

void HatsOfficeTrigger::AppStateTrigger::HandleObservedAppStateUpdate(
    apps::InstanceState state) {
  if (!(state & apps::kActive) || (state & apps::kDestroyed)) {
    std::move(success_callback_).Run();
  }
}

void HatsOfficeTrigger::AppStateTrigger::StopTrackingAppState() {
  if (instance_id_.is_empty()) {
    // The trigger is still listening for `app_id_` events, but none have been
    // received since `instance_id_` isn't set yet. Abort by calling the failure
    // callback (`this` is getting destroyed).
    std::move(failure_callback_).Run();
  }
}

HatsOfficeTrigger::HatsOfficeTrigger() = default;
HatsOfficeTrigger::~HatsOfficeTrigger() = default;

bool HatsOfficeTrigger::ShouldShowSurvey() const {
  // The user has already seen a survey or we're about to show them one.
  if (hats_notification_controller_ || delay_trigger_ || app_state_trigger_) {
    return false;
  }
  Profile* profile = GetProfile();
  if (!profile) {
    // This can happen in tests when there is no `ProfileManager` instance.
    return false;
  }
  // Disable survey for managed accounts.
  if (profile->GetProfilePolicyConnector()->IsManaged()) {
    return false;
  }
  return true;
}

const HatsNotificationController*
HatsOfficeTrigger::GetHatsNotificationControllerForTesting() const {
  return hats_notification_controller_.get();
}
bool HatsOfficeTrigger::IsDelayTriggerActiveForTesting() {
  return delay_trigger_.get() != nullptr;
}
bool HatsOfficeTrigger::IsAppStateTriggerActiveForTesting() {
  return app_state_trigger_.get() != nullptr;
}

Profile* HatsOfficeTrigger::GetProfile() const {
  auto* active_user = user_manager::UserManager::Get()->GetActiveUser();
  // Don't record UMA if there is no primary user.
  if (!active_user) {
    return nullptr;
  }

  return Profile::FromBrowserContext(
      ash::BrowserContextHelper::Get()->GetBrowserContextByUser(active_user));
}

void HatsOfficeTrigger::ShowSurveyIfSelected(HatsOfficeLaunchingApp app) {
  CleanupTriggers();
  // We only show the survey if the current session is still active.
  if (session_manager::SessionManager::Get()->IsUserSessionBlocked()) {
    return;
  }
  Profile* profile = GetProfile();
  if (!HatsNotificationController::ShouldShowSurveyToProfile(
          profile, kHatsOfficeSurvey)) {
    return;
  }
  const base::flat_map<std::string, std::string> product_specific_data = {
      {kHatsOfficeLaunchingApp, HatsOfficeLaunchingAppToString(app)}};
  hats_notification_controller_ =
      base::MakeRefCounted<ash::HatsNotificationController>(
          profile, kHatsOfficeSurvey, product_specific_data);
}

void HatsOfficeTrigger::CleanupTriggers() {
  delay_trigger_.reset();
  app_state_trigger_.reset();
}

}  // namespace ash::cloud_upload