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
|
// 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/actor/tools/history_tool.h"
#include "base/time/time.h"
#include "chrome/browser/actor/tools/observation_delay_controller.h"
#include "chrome/browser/actor/tools/tool_callbacks.h"
#include "chrome/common/actor.mojom.h"
#include "chrome/common/actor/action_result.h"
#include "components/tabs/public/tab_interface.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/web_contents.h"
#include "net/base/net_errors.h"
#include "third_party/abseil-cpp/absl/strings/str_format.h"
namespace {
// The polling interval used to update the pending_navigations_ list.
constexpr base::TimeDelta kPendingNavigationPollingInterval =
base::Milliseconds(100);
} // namespace
namespace actor {
using ::content::NavigationController;
using ::content::NavigationHandle;
using ::content::WebContents;
using ::tabs::TabHandle;
using ::tabs::TabInterface;
HistoryTool::HistoryTool(TaskId task_id,
AggregatedJournal& journal,
WebContents& web_contents,
HistoryToolRequest::Direction direction)
: Tool(task_id, journal),
WebContentsObserver(&web_contents),
direction_(direction) {}
HistoryTool::~HistoryTool() = default;
void HistoryTool::Validate(ValidateCallback callback) {
NavigationController& controller = web_contents()->GetController();
mojom::ActionResultPtr result;
if (direction_ == HistoryToolRequest::Direction::kBack &&
!controller.CanGoBack()) {
result = MakeResult(mojom::ActionResultCode::kHistoryNoBackEntries);
} else if (direction_ == HistoryToolRequest::Direction::kForward &&
!controller.CanGoForward()) {
result = MakeResult(mojom::ActionResultCode::kHistoryNoForwardEntries);
} else {
result = MakeOkResult();
}
// TODO(crbug.com/402731599): Additional validation here (e.g. is URL in
// allowlist).
PostResponseTask(std::move(callback), std::move(result));
}
void HistoryTool::Invoke(InvokeCallback callback) {
CHECK(web_contents());
CHECK(!IsInvokeInProgress());
CHECK(pending_navigations_.empty());
invoke_callback_ = std::move(callback);
CHECK(IsInvokeInProgress());
// TODO(crbug.com/417521502): A navigation may need to send a BeforeUnload
// event which could result in a modal dialog being presented the the user and
// the navigation is deferred until this dialog is confirmed (navigation
// proceeds) or canceled. The current approach here will wait until the dialog
// is manually dismissed by the user but we may want to provide automatic
// resolution here.
if (direction_ == HistoryToolRequest::Direction::kBack) {
pending_navigations_ = web_contents()->GetController().GoBack();
} else {
CHECK_EQ(direction_, HistoryToolRequest::Direction::kForward);
pending_navigations_ = web_contents()->GetController().GoForward();
}
if (pending_navigations_.empty()) {
PostResponseTask(
std::move(invoke_callback_),
MakeResult(mojom::ActionResultCode::kHistoryNoNavigationsCreated));
return;
}
// Ensure navigations that were started synchronously are moved to the
// in-flight list and start polling for navigation cancellation.
PurgePendingNavigations();
}
std::string HistoryTool::DebugString() const {
return absl::StrFormat("HistoryTool[%s]", JournalEvent());
}
std::string HistoryTool::JournalEvent() const {
return direction_ == HistoryToolRequest::Direction::kBack ? "Back"
: "Forward";
}
std::unique_ptr<ObservationDelayController> HistoryTool::GetObservationDelayer()
const {
return std::make_unique<ObservationDelayController>(
*web_contents()->GetPrimaryMainFrame());
}
void HistoryTool::DidStartNavigation(NavigationHandle* navigation_handle) {
if (!IsInvokeInProgress() || !navigation_handle->IsHistory()) {
return;
}
size_t matching_navigations = std::erase_if(
pending_navigations_,
[navigation_handle](const base::WeakPtr<NavigationHandle>& other) {
return other &&
navigation_handle->GetNavigationId() == other->GetNavigationId();
});
CHECK_LE(matching_navigations, 1ul);
// Navigations can sometimes be started synchronously from GoBack/GoForward
// which means this point will be reached before pending_navigations_ is
// written (since it's written when GoBack/GoForward return) so add them
// unconditionally in that case. Invoke calls PurgePendingNavigations which
// will clear these entries from `pending_navigations_`. This only catches
// synchronously started navigations since Invoke will return failure
// immediately if no navigations were created.
if (pending_navigations_.empty() || matching_navigations > 0) {
in_flight_navigation_ids_.insert(navigation_handle->GetNavigationId());
}
}
void HistoryTool::DidFinishNavigation(NavigationHandle* navigation_handle) {
if (!IsInvokeInProgress()) {
return;
}
if (in_flight_navigation_ids_.erase(navigation_handle->GetNavigationId())) {
mojom::ActionResultPtr result;
auto details_msg = [](NavigationHandle* handle) {
std::string msg;
if (handle->GetNavigationDiscardReason()) {
msg = absl::StrFormat("DiscardReason[%d] ",
handle->GetNavigationDiscardReason().value());
}
if (handle->GetNetErrorCode() != net::OK) {
msg +=
absl::StrFormat("ErrorCode[%s]",
net::ErrorToShortString(handle->GetNetErrorCode()));
}
return msg;
};
if (!navigation_handle->HasCommitted()) {
result = MakeResult(mojom::ActionResultCode::kHistoryFailedBeforeCommit,
details_msg(navigation_handle));
} else if (navigation_handle->IsErrorPage()) {
result = MakeResult(mojom::ActionResultCode::kHistoryErrorPage,
details_msg(navigation_handle));
} else {
result = MakeOkResult();
}
FinishToolInvocationIfNeeded(std::move(result));
}
}
void HistoryTool::FinishToolInvocationIfNeeded(mojom::ActionResultPtr result) {
CHECK(IsInvokeInProgress());
// This responds with failure if any navigations fails.
if ((in_flight_navigation_ids_.empty() && pending_navigations_.empty()) ||
!IsOk(*result)) {
PostResponseTask(std::move(invoke_callback_), std::move(result));
}
}
void HistoryTool::PurgePendingNavigations() {
if (!IsInvokeInProgress()) {
return;
}
std::erase_if(
pending_navigations_, [this](base::WeakPtr<NavigationHandle>& handle) {
// Also remove navigations that have been started. This typically
// happens in DidStartNavigation but navigations started synchronously
// will happen before this list is populated.
return !handle ||
in_flight_navigation_ids_.contains(handle->GetNavigationId());
});
if (pending_navigations_.empty() && in_flight_navigation_ids_.empty()) {
// If no navigations were started and all handles were destroyed, the tool
// has completed without navigating.
FinishToolInvocationIfNeeded(
MakeResult(mojom::ActionResultCode::kHistoryCancelledBeforeStart));
} else if (!pending_navigations_.empty()) {
// If there are still unstarted navigations, poll this method again.
// TODO(crbug.com/417756996): Ideally the content API would have a signal
// for when a navigation was canceled before starting so we wouldn't have to
// poll.
content::GetUIThreadTaskRunner()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&HistoryTool::PurgePendingNavigations,
weak_ptr_factory_.GetWeakPtr()),
kPendingNavigationPollingInterval);
}
}
bool HistoryTool::IsInvokeInProgress() const {
return !invoke_callback_.is_null();
}
} // namespace actor
|
