File: experimental_actor_api.h

package info (click to toggle)
chromium 140.0.7339.80-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,201,348 kB
  • sloc: cpp: 35,092,378; ansic: 7,161,671; javascript: 4,199,703; python: 1,441,798; asm: 949,904; xml: 747,409; pascal: 187,748; perl: 88,691; sh: 88,248; objc: 79,953; sql: 52,714; cs: 44,599; fortran: 24,137; makefile: 22,119; tcl: 15,277; php: 13,980; yacc: 9,000; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (152 lines) | stat: -rw-r--r-- 5,623 bytes parent folder | download | duplicates (4)
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
// 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.

#ifndef CHROME_BROWSER_EXTENSIONS_API_EXPERIMENTAL_ACTOR_EXPERIMENTAL_ACTOR_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_EXPERIMENTAL_ACTOR_EXPERIMENTAL_ACTOR_API_H_

#include "base/memory/weak_ptr.h"
#include "chrome/browser/actor/actor_keyed_service.h"
#include "chrome/browser/actor/task_id.h"
#include "chrome/common/actor.mojom-forward.h"
#include "components/optimization_guide/proto/features/actions_data.pb.h"
#include "extensions/browser/extension_function.h"

class Browser;

namespace extensions {

// Base class for all experimental actor functions. See idl for more details.
class ExperimentalActorApiFunction : public ExtensionFunction {
 public:
  ExperimentalActorApiFunction();

  ExperimentalActorApiFunction(const ExperimentalActorApiFunction&) = delete;
  ExperimentalActorApiFunction& operator=(const ExperimentalActorApiFunction&) =
      delete;

 protected:
  ~ExperimentalActorApiFunction() override;
  bool PreRunValidation(std::string* error) override;
};

// Starts an actor task.
class ExperimentalActorStartTaskFunction : public ExperimentalActorApiFunction {
 public:
  ExperimentalActorStartTaskFunction();

  ExperimentalActorStartTaskFunction(
      const ExperimentalActorStartTaskFunction&) = delete;
  ExperimentalActorStartTaskFunction& operator=(
      const ExperimentalActorStartTaskFunction&) = delete;

 protected:
  ~ExperimentalActorStartTaskFunction() override;
  ResponseAction Run() override;
  void OnTaskStarted(actor::TaskId task_id, int32_t tab_id);
  void OnTabCreated(base::WeakPtr<Browser> browser,
                    actor::TaskId task_id,
                    actor::mojom::ActionResultCode result_code,
                    std::optional<size_t> index_of_failed_action);

  DECLARE_EXTENSION_FUNCTION("experimentalActor.startTask",
                             EXPERIMENTALACTOR_STARTTASK)
};

// Stops an actor task.
class ExperimentalActorStopTaskFunction : public ExperimentalActorApiFunction {
 public:
  ExperimentalActorStopTaskFunction();

  ExperimentalActorStopTaskFunction(const ExperimentalActorStopTaskFunction&) =
      delete;
  ExperimentalActorStopTaskFunction& operator=(
      const ExperimentalActorStopTaskFunction&) = delete;

 protected:
  ~ExperimentalActorStopTaskFunction() override;
  ResponseAction Run() override;

  DECLARE_EXTENSION_FUNCTION("experimentalActor.stopTask",
                             EXPERIMENTALACTOR_STOPTASK)
};

// Executes an actor action.
class ExperimentalActorExecuteActionFunction
    : public ExperimentalActorApiFunction {
 public:
  ExperimentalActorExecuteActionFunction();

  ExperimentalActorExecuteActionFunction(
      const ExperimentalActorExecuteActionFunction&) = delete;
  ExperimentalActorExecuteActionFunction& operator=(
      const ExperimentalActorExecuteActionFunction&) = delete;

 protected:
  ~ExperimentalActorExecuteActionFunction() override;
  ResponseAction Run() override;
  void OnResponseReceived(
      optimization_guide::proto::BrowserActionResult response);

  DECLARE_EXTENSION_FUNCTION("experimentalActor.executeAction",
                             EXPERIMENTALACTOR_EXECUTEACTION)
};

class ExperimentalActorCreateTaskFunction
    : public ExperimentalActorApiFunction {
 public:
  ExperimentalActorCreateTaskFunction();
  ExperimentalActorCreateTaskFunction(
      const ExperimentalActorCreateTaskFunction&) = delete;
  ExperimentalActorCreateTaskFunction& operator=(
      const ExperimentalActorCreateTaskFunction&) = delete;

 protected:
  ~ExperimentalActorCreateTaskFunction() override;
  ResponseAction Run() override;
  DECLARE_EXTENSION_FUNCTION("experimentalActor.createTask",
                             EXPERIMENTALACTOR_CREATETASK)
};

class ExperimentalActorPerformActionsFunction
    : public ExperimentalActorApiFunction {
 public:
  ExperimentalActorPerformActionsFunction();
  ExperimentalActorPerformActionsFunction(
      const ExperimentalActorPerformActionsFunction&) = delete;
  ExperimentalActorPerformActionsFunction& operator=(
      const ExperimentalActorPerformActionsFunction&) = delete;

 protected:
  ~ExperimentalActorPerformActionsFunction() override;
  ResponseAction Run() override;
  void OnActionsFinished(actor::TaskId task_id,
                         actor::mojom::ActionResultCode result_code,
                         std::optional<size_t> index_of_failed_action);
  void OnObservationResult(
      std::unique_ptr<optimization_guide::proto::ActionsResult> response);
  DECLARE_EXTENSION_FUNCTION("experimentalActor.performActions",
                             EXPERIMENTALACTOR_PERFORMACTIONS)
};

class ExperimentalActorRequestTabObservationFunction
    : public ExperimentalActorApiFunction {
 public:
  ExperimentalActorRequestTabObservationFunction();
  ExperimentalActorRequestTabObservationFunction(
      const ExperimentalActorRequestTabObservationFunction&) = delete;
  ExperimentalActorRequestTabObservationFunction& operator=(
      const ExperimentalActorRequestTabObservationFunction&) = delete;

 protected:
  ~ExperimentalActorRequestTabObservationFunction() override;
  ResponseAction Run() override;
  void OnObservationFinished(
      actor::ActorKeyedService::TabObservationResult observation_result);
  DECLARE_EXTENSION_FUNCTION("experimentalActor.requestTabObservation",
                             EXPERIMENTALACTOR_REQUESTTABOBSERVATION)
};

}  //  namespace extensions

#endif  // CHROME_BROWSER_EXTENSIONS_API_EXPERIMENTAL_ACTOR_EXPERIMENTAL_ACTOR_API_H_