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
|
// Copyright 2021 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_STARTER_H_
#define COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_STARTER_H_
#include <memory>
#include "base/containers/flat_set.h"
#include "base/containers/lru_cache.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/time/tick_clock.h"
#include "base/time/time.h"
#include "components/autofill_assistant/browser/common_dependencies.h"
#include "components/autofill_assistant/browser/controller.h"
#include "components/autofill_assistant/browser/metrics.h"
#include "components/autofill_assistant/browser/platform_dependencies.h"
#include "components/autofill_assistant/browser/public/runtime_manager.h"
#include "components/autofill_assistant/browser/service.pb.h"
#include "components/autofill_assistant/browser/starter_heuristic.h"
#include "components/autofill_assistant/browser/starter_platform_delegate.h"
#include "components/autofill_assistant/browser/startup_util.h"
#include "components/autofill_assistant/browser/trigger_scripts/trigger_script_coordinator.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
namespace autofill_assistant {
// Starts autofill-assistant flows. Uses a platform delegate to show UI and
// access platform-dependent features.
class Starter : public content::WebContentsObserver,
public content::WebContentsUserData<Starter> {
public:
explicit Starter(content::WebContents* web_contents,
base::WeakPtr<StarterPlatformDelegate> platform_delegate,
ukm::UkmRecorder* ukm_recorder,
base::WeakPtr<RuntimeManager> runtime_manager,
const base::TickClock* tick_clock);
~Starter() override;
Starter(const Starter&) = delete;
Starter& operator=(const Starter&) = delete;
// Entry-point for all non-direct-action flows. This method will perform the
// overall startup procedure, which is roughly as follows:
// - Check parameters/features/settings and determine startup mode
// - Install feature module if necessary
// - Run and wait for trigger script to finish if necessary
// - Show onboarding if necessary
// - Request the platform_delegate to start the regular script.
// TODO(mcarlen): client startup should also be handled here, rather than in
// the platform_delegate.
//
// Only one call to |Start| can be processed at any time. If this method is
// called before the previous call has finished, the previous call is
// cancelled.
void Start(std::unique_ptr<TriggerContext> trigger_context);
// Runs the same checks as |Start| but instead of starting the regular script
// at the end, it calls |preconditions_checked_callback|.
void CanStart(
std::unique_ptr<TriggerContext> trigger_context,
base::OnceCallback<void(bool success,
absl::optional<GURL> url,
std::unique_ptr<TriggerContext> trigger_contexts)>
preconditions_checked_callback);
// content::WebContentsObserver:
void PrimaryPageChanged(content::Page& page) override;
// Invoked when the tab interactability has changed.
void OnTabInteractabilityChanged(bool is_interactable);
// Re-check settings. This may cancel ongoing startup requests if the required
// settings are no longer enabled.
void Init();
// Records the invalidation of platform-specific depencendies. For example:
// When the activity is changed on Android.
void OnDependenciesInvalidated();
const CommonDependencies* GetCommonDependencies();
const PlatformDependencies* GetPlatformDependencies();
base::WeakPtr<Starter> GetWeakPtr();
private:
friend class StarterTest;
friend class content::WebContentsUserData<Starter>;
// Starts a flow for |url| if possible. Will fail (do nothing) if the feature
// is disabled or if there is already a pending startup.
void MaybeStartImplicitlyForUrl(const GURL& url,
const ukm::SourceId source_id);
// Cancels the currently pending startup request, if any. If a trigger script
// is currently running, this will record |state| as the reason for stopping.
// This will also hide any currently shown UI (such as a trigger script or the
// onboarding).
void CancelPendingStartup(
absl::optional<Metrics::TriggerScriptFinishedState> state);
// Installs the feature module if necessary, otherwise directly invokes
// |OnFeatureModuleInstalled|.
void MaybeInstallFeatureModule(StartupMode startup_mode);
// Stops the startup if the installation failed. Otherwise, proceeds with the
// next step of the startup process.
void OnFeatureModuleInstalled(StartupMode startup_mode,
Metrics::FeatureModuleInstallation result);
// Starts a trigger script and waits for it to finish in
// |OnTriggerScriptFinished|.
void StartTriggerScript();
// Stops the startup if the trigger script failed or was user-cancelled.
// Otherwise, proceeds with the start of the regular script.
void OnTriggerScriptFinished(
Metrics::TriggerScriptFinishedState state,
std::unique_ptr<TriggerContext> trigger_context,
absl::optional<TriggerScriptProto> trigger_script);
// Shows the onboarding if necessary, otherwise directly invokes
// |OnOnboardingFinished|.
void MaybeShowOnboarding(
absl::optional<TriggerScriptProto> trigger_script = absl::nullopt);
// Starts the regular script if onboarding was accepted. Stops the startup
// process if onboarding was rejected.
void OnOnboardingFinished(absl::optional<TriggerScriptProto> trigger_script,
bool shown,
OnboardingResult result);
// Called at the end of each |Start| invocation.
void OnStartDone(
bool start_script,
absl::optional<TriggerScriptProto> trigger_script = absl::nullopt);
// Called when the heuristic result for |url| is available.
void OnHeuristicMatch(const GURL& url,
const ukm::SourceId source_id,
const base::flat_set<std::string>& intents);
// Returns whether there is a currently pending call to |Start| or not.
bool IsStartupPending() const;
// Deletes the trigger script coordinator.
void DeleteTriggerScriptCoordinator();
// Records metrics when the dependencies get invalidated.
void RecordDependenciesInvalidated() const;
// Returns a pointer to the currently pending trigger context, or nullptr.
// Use this method instead of directly accessing |pending_trigger_context_| in
// cases where the context could be temporarily owned by
// |trigger_script_coordinator_|.
TriggerContext* GetPendingTriggerContext() const;
// Registers the synthetic field trials for triggering and experiments.
void RegisterSyntheticFieldTrials(
const TriggerContext& trigger_context) const;
// Calls |preconditions_checked_callback_| to notify whether the checks were
// successful.
void ReportPreconditionsChecked(bool start_script);
WEB_CONTENTS_USER_DATA_KEY_DECL();
// The UKM source id to use for UKM metrics.
ukm::SourceId current_ukm_source_id_ = ukm::kInvalidSourceId;
// Pointer to the global cache of trigger script requests that failed (one
// entry per organization-identifying domain), along with the time of entry.
// This is used to limit network traffic incurred for in-chrome triggering
// only. This cache does not affect explicit startup requests.
//
// This cache is shared across all tabs. It is size-limited and entries only
// last for a limited amount of time before they go stale. Made available in
// the header for easier unit-testing.
raw_ptr<base::HashingLRUCache<std::string, base::TimeTicks>>
cached_failed_trigger_script_fetches_;
// The list of organization-identifying domains that a user has temporarily
// opted out of for receiving implicit autofill-assistant prompts, along
// with the time of entry.
//
// This is a per-tab cache. This cache does not affect explicit startup
// requests. The cache is size-limited and entries only last for a limited
// amount of time before they go stale.
base::HashingLRUCache<std::string, base::TimeTicks> user_denylisted_domains_;
// Debug parameters for in-CCT and in-Tab trigger scenarios. This is populated
// from the command line and intended only for debugging and testing.
ImplicitTriggeringDebugParametersProto implicit_triggering_debug_parameters_;
bool waiting_for_onboarding_ = false;
bool waiting_for_deeplink_navigation_ = false;
bool is_custom_tab_ = false;
base::WeakPtr<StarterPlatformDelegate> platform_delegate_;
raw_ptr<ukm::UkmRecorder> ukm_recorder_ = nullptr;
base::WeakPtr<RuntimeManager> runtime_manager_;
bool fetch_trigger_scripts_on_navigation_ = false;
std::unique_ptr<TriggerContext> pending_trigger_context_;
std::unique_ptr<TriggerScriptCoordinator> trigger_script_coordinator_;
const scoped_refptr<StarterHeuristic> starter_heuristic_;
const raw_ptr<const base::TickClock> tick_clock_;
base::OnceCallback<void(bool success,
absl::optional<GURL> url,
std::unique_ptr<TriggerContext> trigger_contexts)>
preconditions_checked_callback_;
base::WeakPtrFactory<Starter> weak_ptr_factory_{this};
};
} // namespace autofill_assistant
#endif // COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_STARTER_H_
|
