File: diagnostic_routine_manager.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 (282 lines) | stat: -rw-r--r-- 10,057 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
// 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/chromeos/extensions/telemetry/api/routines/diagnostic_routine_manager.h"

#include <algorithm>
#include <memory>
#include <tuple>
#include <utility>
#include <vector>

#include "base/check_is_test.h"
#include "base/containers/flat_tree.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/no_destructor.h"
#include "base/types/expected.h"
#include "base/uuid.h"
#include "base/values.h"
#include "chrome/browser/chromeos/extensions/telemetry/api/common/app_ui_observer.h"
#include "chrome/browser/chromeos/extensions/telemetry/api/common/util.h"
#include "chrome/browser/chromeos/extensions/telemetry/api/routines/diagnostic_routine.h"
#include "chrome/browser/chromeos/extensions/telemetry/api/routines/diagnostic_routine_info.h"
#include "chrome/browser/chromeos/extensions/telemetry/api/routines/remote_diagnostic_routines_service_strategy.h"
#include "chrome/common/chromeos/extensions/api/diagnostics.h"
#include "chromeos/crosapi/mojom/telemetry_diagnostic_routine_service.mojom.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/web_contents.h"
#include "extensions/browser/browser_context_keyed_api_factory.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/unloaded_extension_reason.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_id.h"
#include "extensions/common/manifest_handlers/externally_connectable.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/remote.h"

namespace chromeos {

namespace {

namespace crosapi = ::crosapi::mojom;
namespace cx_diag = api::os_diagnostics;

void NotifyExtensionAppUiClosed(
    extensions::ExtensionId extension_id,
    raw_ptr<content::BrowserContext> browser_context) {
  cx_diag::ExceptionInfo exception;
  exception.reason = cx_diag::ExceptionReason::kAppUiClosed;

  auto event = std::make_unique<extensions::Event>(
      extensions::events::OS_DIAGNOSTICS_ON_ROUTINE_EXCEPTION,
      cx_diag::OnRoutineException::kEventName,
      base::Value::List().Append(exception.ToValue()), browser_context);

  // The `EventRouter` might be unavailable in unittests.
  if (!extensions::EventRouter::Get(browser_context)) {
    CHECK_IS_TEST();
  } else {
    extensions::EventRouter::Get(browser_context)
        ->DispatchEventToExtension(extension_id, std::move(event));
  }
}

}  // namespace

// static
extensions::BrowserContextKeyedAPIFactory<DiagnosticRoutineManager>*
DiagnosticRoutineManager::GetFactoryInstance() {
  static base::NoDestructor<
      extensions::BrowserContextKeyedAPIFactory<DiagnosticRoutineManager>>
      instance;
  return instance.get();
}

// static
DiagnosticRoutineManager* DiagnosticRoutineManager::Get(
    content::BrowserContext* browser_context) {
  return extensions::BrowserContextKeyedAPIFactory<
      DiagnosticRoutineManager>::Get(browser_context);
}

DiagnosticRoutineManager::DiagnosticRoutineManager(
    content::BrowserContext* context)
    : browser_context_(context) {
  extensions::ExtensionRegistry::Get(context)->AddObserver(this);
}

DiagnosticRoutineManager::~DiagnosticRoutineManager() = default;

base::expected<base::Uuid, DiagnosticRoutineManager::Error>
DiagnosticRoutineManager::CreateRoutine(
    extensions::ExtensionId extension_id,
    crosapi::TelemetryDiagnosticRoutineArgumentPtr routine_argument) {
  if (app_ui_observers_.find(extension_id) == app_ui_observers_.end()) {
    auto observer = CreateAppUiObserver(extension_id);
    if (!observer.has_value()) {
      return base::unexpected(observer.error());
    }

    app_ui_observers_.emplace(extension_id, std::move(observer.value()));
  }

  crosapi::TelemetryDiagnosticRoutineArgument::Tag routine_argument_tag =
      routine_argument->which();

  mojo::PendingRemote<crosapi::TelemetryDiagnosticRoutineControl>
      control_remote;
  mojo::PendingReceiver<crosapi::TelemetryDiagnosticRoutineObserver>
      observer_receiver;

  GetRemoteService()->CreateRoutine(
      std::move(routine_argument),
      control_remote.InitWithNewPipeAndPassReceiver(),
      observer_receiver.InitWithNewPipeAndPassRemote());

  auto uuid = base::Uuid::GenerateRandomV4();
  DiagnosticRoutineInfo routine_info(extension_id, uuid, browser_context_,
                                     routine_argument_tag);

  auto it = routines_per_extension_.find(extension_id);
  if (it == routines_per_extension_.end()) {
    std::tie(it, std::ignore) = routines_per_extension_.emplace(
        std::piecewise_construct, std::forward_as_tuple(extension_id),
        std::forward_as_tuple());
  }
  // SAFETY: We can use `Unretained` here since `DiagnosticRoutine` is a member
  // of `this`.
  it->second.push_back(std::make_unique<DiagnosticRoutine>(
      std::move(control_remote), std::move(observer_receiver), routine_info,
      base::BindOnce(&DiagnosticRoutineManager::OnRoutineExceptionOrFinished,
                     base::Unretained(this))));

  return base::ok(uuid);
}

bool DiagnosticRoutineManager::StartRoutineForExtension(
    extensions::ExtensionId extension_id,
    base::Uuid routine_id) {
  auto it = routines_per_extension_.find(extension_id);
  if (it == routines_per_extension_.end()) {
    return false;
  }

  auto routine = std::find_if(
      it->second.begin(), it->second.end(),
      [routine_id](const std::unique_ptr<DiagnosticRoutine>& routine) {
        return routine->uuid() == routine_id;
      });

  if (routine == it->second.end()) {
    return false;
  }

  routine->get()->GetRemote()->Start();
  return true;
}

void DiagnosticRoutineManager::CancelRoutineForExtension(
    extensions::ExtensionId extension_id,
    base::Uuid routine_id) {
  auto it = routines_per_extension_.find(extension_id);
  if (it == routines_per_extension_.end()) {
    return;
  }

  // We can just remove the corresponding routine object, this will cut the
  // `RoutineControl` connection signalling to stop the routine.
  std::erase_if(
      it->second,
      [routine_id](const std::unique_ptr<DiagnosticRoutine>& routine) {
        return routine->uuid() == routine_id;
      });
}

bool DiagnosticRoutineManager::ReplyToRoutineInquiryForExtension(
    const extensions::ExtensionId& extension_id,
    const base::Uuid& routine_id,
    crosapi::TelemetryDiagnosticRoutineInquiryReplyPtr reply) {
  auto it = routines_per_extension_.find(extension_id);
  if (it == routines_per_extension_.end()) {
    return false;
  }

  auto routine = std::find_if(
      it->second.begin(), it->second.end(),
      [routine_id](const std::unique_ptr<DiagnosticRoutine>& routine) {
        return routine->uuid() == routine_id;
      });

  if (routine == it->second.end()) {
    return false;
  }

  routine->get()->GetRemote()->ReplyToInquiry(std::move(reply));
  return true;
}

void DiagnosticRoutineManager::IsRoutineArgumentSupported(
    crosapi::TelemetryDiagnosticRoutineArgumentPtr arg,
    base::OnceCallback<void(crosapi::TelemetryExtensionSupportStatusPtr)>
        callback) {
  GetRemoteService()->IsRoutineArgumentSupported(std::move(arg),
                                                 std::move(callback));
}

void DiagnosticRoutineManager::OnExtensionUnloaded(
    content::BrowserContext* browser_context,
    const extensions::Extension* extension,
    extensions::UnloadedExtensionReason reason) {
  routines_per_extension_.erase(extension->id());
  app_ui_observers_.erase(extension->id());
}

mojo::Remote<crosapi::TelemetryDiagnosticRoutinesService>&
DiagnosticRoutineManager::GetRemoteService() {
  if (!remote_strategy_) {
    remote_strategy_ = RemoteDiagnosticRoutineServiceStrategy::Create();
  }
  return remote_strategy_->GetRemoteService();
}

void DiagnosticRoutineManager::OnAppUiClosed(
    extensions::ExtensionId extension_id) {
  // Try to find another open UI.
  auto observer = CreateAppUiObserver(extension_id);
  if (observer.has_value()) {
    app_ui_observers_.insert_or_assign(extension_id,
                                       std::move(observer.value()));
    return;
  }

  app_ui_observers_.erase(extension_id);
  routines_per_extension_.erase(extension_id);
  NotifyExtensionAppUiClosed(extension_id, browser_context_);
}

base::expected<std::unique_ptr<AppUiObserver>, DiagnosticRoutineManager::Error>
DiagnosticRoutineManager::CreateAppUiObserver(
    extensions::ExtensionId extension_id) {
  const extensions::Extension* extension =
      extensions::ExtensionRegistry::Get(browser_context_)
          ->GetExtensionById(extension_id,
                             extensions::ExtensionRegistry::EVERYTHING);
  if (!extension) {
    // If the extension has been unloaded from the registry, there
    // won't be any related app UI.
    return base::unexpected(kExtensionUnloaded);
  }
  content::WebContents* contents =
      FindTelemetryExtensionOpenAndSecureAppUi(browser_context_, extension);
  if (!contents) {
    return base::unexpected(kAppUiClosed);
  }

  return std::make_unique<AppUiObserver>(
      contents,
      extensions::ExternallyConnectableInfo::Get(extension)->matches.Clone(),
      // Unretained is safe here because `this` will own the observer.
      base::BindOnce(&DiagnosticRoutineManager::OnAppUiClosed,
                     base::Unretained(this), extension_id),
      base::NullCallback());
}

void DiagnosticRoutineManager::OnRoutineExceptionOrFinished(
    DiagnosticRoutineInfo info) {
  auto it = routines_per_extension_.find(info.extension_id);
  if (it == routines_per_extension_.end()) {
    return;
  }

  std::erase_if(it->second,
                [info](const std::unique_ptr<DiagnosticRoutine>& ptr) {
                  return ptr->uuid() == info.uuid;
                });
}

}  // namespace chromeos