File: glic_actor_controller.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 (272 lines) | stat: -rw-r--r-- 10,037 bytes parent folder | download | duplicates (2)
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
// Copyright 2025 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/glic/host/glic_actor_controller.h"

#include <memory>

#include "base/feature_list.h"
#include "base/location.h"
#include "base/metrics/histogram_macros.h"
#include "base/task/sequenced_task_runner.h"
#include "chrome/browser/actor/actor_coordinator.h"
#include "chrome/browser/actor/actor_keyed_service.h"
#include "chrome/browser/actor/actor_task.h"
#include "chrome/browser/glic/host/context/glic_page_context_fetcher.h"
#include "chrome/browser/glic/host/glic.mojom.h"
#include "chrome/common/actor.mojom.h"
#include "chrome/common/actor/action_result.h"
#include "chrome/common/chrome_features.h"
#include "components/optimization_guide/proto/features/actions_data.pb.h"
#include "components/tabs/public/tab_interface.h"

namespace glic {

namespace {

using optimization_guide::proto::ActionInformation;

mojom::ActInFocusedTabResultPtr MakeActErrorResult(
    mojom::ActInFocusedTabErrorReason error_reason) {
  mojom::ActInFocusedTabResultPtr result =
      mojom::ActInFocusedTabResult::NewErrorReason(error_reason);
  UMA_HISTOGRAM_ENUMERATION("Glic.Action.ActInFocusedTabErrorReason",
                            result->get_error_reason());
  return result;
}

void PostTaskForActCallback(
    mojom::WebClientHandler::ActInFocusedTabCallback callback,
    mojom::ActInFocusedTabErrorReason error_reason) {
  mojom::ActInFocusedTabResultPtr result = MakeActErrorResult(error_reason);

  base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
      FROM_HERE, base::BindOnce(std::move(callback), std::move(result)));
}

void PostTaskForActionResultCallback(
    actor::ActorCoordinator::ActionResultCallback callback,
    actor::mojom::ActionResultPtr result) {
  base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
      FROM_HERE, base::BindOnce(std::move(callback), std::move(result)));
}

void OnGetContextFromFocusedTab(
    mojom::WebClientHandler::ActInFocusedTabCallback callback,
    mojom::GetContextResultPtr tab_context_result) {
  if (tab_context_result->is_error_reason()) {
    mojom::ActInFocusedTabResultPtr result = MakeActErrorResult(
        mojom::ActInFocusedTabErrorReason::kGetContextFailed);
    std::move(callback).Run(std::move(result));
    return;
  }

  mojom::ActInFocusedTabResultPtr result =
      mojom::ActInFocusedTabResult::NewActInFocusedTabResponse(
          mojom::ActInFocusedTabResponse::New(
              std::move(tab_context_result->get_tab_context())));

  std::move(callback).Run(std::move(result));
}

void MaybeWarnMultiTaskNotImplemented(actor::TaskId task_id) {
  if (task_id) {
    NOTIMPLEMENTED() << "Multi-task not implemented.";
  }
}

}  // namespace

GlicActorController::GlicActorController(Profile* profile) : profile_(profile) {
  CHECK(profile_);
  actor::ActorCoordinator::RegisterWithProfile(profile_);
}

GlicActorController::~GlicActorController() = default;

void GlicActorController::Act(
    FocusedTabData focused_tab_data,
    const optimization_guide::proto::BrowserAction& action,
    const mojom::GetTabContextOptions& options,
    mojom::WebClientHandler::ActInFocusedTabCallback callback) {
  if (!actor_task_ ||
      actor_task_->GetState() == actor::ActorTask::State::kFinished) {
    auto task = std::make_unique<actor::ActorTask>(
        std::make_unique<actor::ActorCoordinator>(profile_));
    actor_task_ = task.get();
    actor::ActorKeyedService::Get(profile_.get())->AddTask(std::move(task));
  }

  if (!GetActorCoordinator() || !GetActorCoordinator()->HasTask()) {
    // Start of a new task, which must begin with a navigate action.
    // The OnTaskStarted callback will perform the action after the task is
    // setup by the coordinator.
    // TODO(https://crbug.com/407860715): Implement a separate host API to start
    // a task, and remove action handling here.
    GetActorCoordinator()->StartTask(
        action,
        base::BindOnce(&GlicActorController::OnTaskStarted, GetWeakPtr(),
                       action, options, std::move(callback)),
        /*tab_id=*/std::nullopt);
    return;
  }

  ActImpl(focused_tab_data, action, options, std::move(callback));
}

// TODO(mcnee): Determine if we need additional mechanisms, within the browser,
// to stop a task.
void GlicActorController::StopTask(actor::TaskId task_id) {
  MaybeWarnMultiTaskNotImplemented(task_id);
  if (!GetActorCoordinator() ||
      actor_task_->GetState() == actor::ActorTask::State::kFinished) {
    return;
  }
  GetActorCoordinator()->StopTask();
  actor_task_->SetState(actor::ActorTask::State::kFinished);
}

void GlicActorController::PauseTask(actor::TaskId task_id) {
  MaybeWarnMultiTaskNotImplemented(task_id);
  if (!GetActorCoordinator() ||
      actor_task_->GetState() == actor::ActorTask::State::kFinished) {
    return;
  }
  GetActorCoordinator()->PauseTask();
  actor_task_->SetState(actor::ActorTask::State::kPausedByClient);
}

void GlicActorController::ResumeTask(
    actor::TaskId task_id,
    const mojom::GetTabContextOptions& context_options,
    glic::mojom::WebClientHandler::ResumeActorTaskCallback callback) {
  MaybeWarnMultiTaskNotImplemented(task_id);
  if (!GetActorCoordinator() ||
      actor_task_->GetState() == actor::ActorTask::State::kFinished) {
    std::move(callback).Run(mojom::GetContextResult::NewErrorReason(
        std::string("task does not exist")));
    return;
  }

  if (!actor_task_->IsPaused()) {
    std::move(callback).Run(mojom::GetContextResult::NewErrorReason(
        std::string("task is not paused")));
    return;
  }

  tabs::TabInterface* tab_of_resumed_task =
      GetActorCoordinator()->GetTabOfCurrentTask();
  if (!tab_of_resumed_task) {
    std::move(callback).Run(mojom::GetContextResult::NewErrorReason(
        std::string("tab does not exist")));
    return;
  }

  actor_task_->SetState(actor::ActorTask::State::kReflecting);
  // TODO(mcnee): Refactor to make it clear we're specifying the tab to get the
  // context for, not glic's concept of a focused tab.
  GetContextFromFocusedTab(
      FocusedTabData{tab_of_resumed_task->GetContents()->GetWeakPtr()},
      context_options, std::move(callback));
}

bool GlicActorController::IsActorCoordinatorActingOnTab(
    const content::WebContents* tab) const {
  return GetActorCoordinator() && GetActorCoordinator()->HasTaskForTab(tab) &&
         actor_task_->GetState() != actor::ActorTask::State::kFinished;
}

actor::ActorCoordinator& GlicActorController::GetActorCoordinatorForTesting() {
  if (!actor_task_) {
    auto task = std::make_unique<actor::ActorTask>(
        std::make_unique<actor::ActorCoordinator>(profile_));
    actor_task_ = task.get();
    actor::ActorKeyedService::Get(profile_.get())->AddTask(std::move(task));
  }
  return *actor_task_->GetActorCoordinator();
}

void GlicActorController::OnTaskStarted(
    const optimization_guide::proto::BrowserAction& action,
    const mojom::GetTabContextOptions& options,
    mojom::WebClientHandler::ActInFocusedTabCallback act_callback,
    base::WeakPtr<tabs::TabInterface> tab) const {
  if (!tab) {
    PostTaskForActCallback(std::move(act_callback),
                           mojom::ActInFocusedTabErrorReason::kTargetNotFound);
    return;
  }
  // TODO(https://crbug.com/402086398): Check that the tab is valid for action,
  // maybe reusing the validation in GlicFocusedTabManager.
  FocusedTabData focused_tab_data{tab->GetContents()->GetWeakPtr()};

  ActImpl(focused_tab_data, action, options, std::move(act_callback));
}

void GlicActorController::ActImpl(
    FocusedTabData focused_tab_data,
    const optimization_guide::proto::BrowserAction& action,
    const mojom::GetTabContextOptions& options,
    mojom::WebClientHandler::ActInFocusedTabCallback callback) const {
  actor::ActorCoordinator::ActionResultCallback action_callback =
      base::BindOnce(&GlicActorController::OnActionFinished, GetWeakPtr(),
                     focused_tab_data, options, std::move(callback));

  if (actor_task_->IsPaused()) {
    VLOG(1) << "Unable to perform action: task is paused";
    PostTaskForActionResultCallback(
        std::move(action_callback),
        actor::MakeResult(actor::mojom::ActionResultCode::kError,
                          "Task is paused"));
    return;
  }

  GetActorCoordinator()->Act(action, std::move(action_callback));
}

void GlicActorController::OnActionFinished(
    FocusedTabData focused_tab_data,
    const mojom::GetTabContextOptions& options,
    mojom::WebClientHandler::ActInFocusedTabCallback callback,
    actor::mojom::ActionResultPtr result) const {
  if (!actor::IsOk(*result)) {
    PostTaskForActCallback(std::move(callback),
                           mojom::ActInFocusedTabErrorReason::kTargetNotFound);
    return;
  }

  // TODO(https://crbug.com/398271171): Remove when the actor coordinator
  // handles getting a new observation.
  GetContextFromFocusedTab(
      focused_tab_data, options,
      base::BindOnce(OnGetContextFromFocusedTab, std::move(callback)));
}

void GlicActorController::GetContextFromFocusedTab(
    FocusedTabData focused_tab_data,
    const mojom::GetTabContextOptions& options,
    mojom::WebClientHandler::GetContextFromFocusedTabCallback callback) const {
  // TODO(https://crbug.com/402086398): Figure out if/how this can be shared
  // with GlicKeyedService::GetContextFromFocusedTab(). It's not clear yet if
  // the same permission checks, etc. should apply here.

  FetchPageContext(focused_tab_data, options, std::move(callback));
}

base::WeakPtr<const GlicActorController> GlicActorController::GetWeakPtr()
    const {
  return weak_ptr_factory_.GetWeakPtr();
}

base::WeakPtr<GlicActorController> GlicActorController::GetWeakPtr() {
  return weak_ptr_factory_.GetWeakPtr();
}

actor::ActorCoordinator* GlicActorController::GetActorCoordinator() const {
  if (!actor_task_) {
    return nullptr;
  }
  return actor_task_->GetActorCoordinator();
}
}  // namespace glic