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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
|
// Copyright 2024 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/ash/input_method/editor_panel_manager.h"
#include <optional>
#include "base/strings/strcat.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/test_future.h"
#include "chrome/browser/ash/input_method/editor_consent_enums.h"
#include "chrome/browser/ash/input_method/editor_context.h"
#include "chrome/browser/ash/input_method/editor_geolocation_mock_provider.h"
#include "chrome/browser/ash/input_method/editor_metrics_enums.h"
#include "chrome/test/base/testing_profile.h"
#include "chromeos/ash/components/editor_menu/public/cpp/editor_consent_status.h"
#include "content/public/test/browser_task_environment.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace ash::input_method {
namespace {
using ::chromeos::editor_menu::EditorMode;
constexpr std::string_view kAllowedCountryCode = "au";
class FakeContextObserver : public EditorContext::Observer {
public:
FakeContextObserver() = default;
~FakeContextObserver() override = default;
// EditorContext::Observer overrides
void OnContextUpdated() override {}
void OnImeChange(std::string_view engine_id) override {}
};
class FakeSystem : public EditorContext::System {
public:
FakeSystem() = default;
~FakeSystem() override = default;
// EditorContext::System overrides
std::optional<ukm::SourceId> GetUkmSourceId() override {
return std::nullopt;
}
};
class FakeEditorClient : public orca::mojom::EditorClient {
public:
FakeEditorClient() = default;
~FakeEditorClient() override = default;
void GetPresetTextQueries(GetPresetTextQueriesCallback callback) override {
std::move(callback).Run({});
}
void RequestPresetRewrite(const std::string& text_query_id,
const std::optional<std::string>& text_override,
RequestPresetRewriteCallback callback) override {}
void RequestFreeformRewrite(
const std::string& input,
const std::optional<std::string>& text_override,
RequestFreeformRewriteCallback callback) override {}
void RequestFreeformWrite(const std::string& input,
RequestFreeformWriteCallback callback) override {}
void InsertText(const std::string& text) override {}
void ApproveConsent() override {}
void DeclineConsent() override {}
void DismissConsent() override {}
void OpenUrlInNewWindow(const GURL& url) override {}
void ShowUI() override {}
void CloseUI() override {}
void AppendText(const std::string& text) override {}
void PreviewFeedback(const std::string& result_id,
PreviewFeedbackCallback callback) override {}
void SubmitFeedback(const std::string& result_id,
const std::string& user_description) override {}
void OnTrigger(orca::mojom::TriggerContextPtr trigger_context) override {}
void EmitMetricEvent(orca::mojom::MetricEvent metric_event) override {}
};
class EditorPanelManagerDelegateForTesting
: public EditorPanelManagerImpl::Delegate {
public:
EditorPanelManagerDelegateForTesting(
EditorOpportunityMode opportunity_mode,
chromeos::editor_menu::EditorConsentStatus consent_status,
const std::vector<EditorBlockedReason>& blocked_reasons)
: opportunity_mode_(opportunity_mode),
consent_status_(consent_status),
blocked_reasons_(blocked_reasons),
geolocation_provider_(kAllowedCountryCode),
context_(&context_observer_, &system_, &geolocation_provider_),
metrics_recorder_(&context_, opportunity_mode) {}
void BindEditorClient(mojo::PendingReceiver<orca::mojom::EditorClient>
pending_receiver) override {}
void OnPromoCardDeclined() override {}
void ProcessConsentAction(ConsentAction consent_action) override {}
void HandleTrigger(std::optional<std::string_view> preset_query_id,
std::optional<std::string_view> freeform_text) override {}
EditorOpportunityMode GetEditorOpportunityMode() const override {
return opportunity_mode_;
}
std::vector<EditorBlockedReason> GetBlockedReasons() const override {
return blocked_reasons_;
}
void CacheContext() override {}
EditorMetricsRecorder* GetMetricsRecorder() override {
return &metrics_recorder_;
}
EditorMode GetEditorMode() const override { return EditorMode::kSoftBlocked; }
chromeos::editor_menu::EditorTextSelectionMode GetEditorTextSelectionMode()
const override {
return chromeos::editor_menu::EditorTextSelectionMode::kNoSelection;
}
chromeos::editor_menu::EditorConsentStatus GetConsentStatus() const override {
return consent_status_;
}
private:
EditorOpportunityMode opportunity_mode_;
chromeos::editor_menu::EditorConsentStatus consent_status_;
std::vector<EditorBlockedReason> blocked_reasons_;
FakeSystem system_;
FakeContextObserver context_observer_;
EditorGeolocationMockProvider geolocation_provider_;
EditorContext context_;
EditorMetricsRecorder metrics_recorder_;
};
class EditorPanelManagerTest : public testing::Test {
public:
EditorPanelManagerTest() = default;
~EditorPanelManagerTest() override = default;
private:
content::BrowserTaskEnvironment task_environment_;
};
TEST_F(EditorPanelManagerTest,
EditorPanelContextCallbackShouldReturnConsentStatusSettled) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kWrite,
chromeos::editor_menu::EditorConsentStatus::kApproved, {});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
FakeEditorClient fake_editor_client;
mojo::Receiver<orca::mojom::EditorClient> receiver{&fake_editor_client};
manager.SetEditorClientForTesting(receiver.BindNewPipeAndPassRemote());
base::test::TestFuture<const chromeos::editor_menu::EditorContext&> future;
manager.GetEditorPanelContext(future.GetCallback());
EXPECT_TRUE(future.IsReady());
EXPECT_EQ(future.Get(),
chromeos::editor_menu::EditorContext(
EditorMode::kSoftBlocked,
chromeos::editor_menu::EditorTextSelectionMode::kNoSelection,
/*consent_status_settled=*/true, /*preset_queries=*/{}));
}
TEST_F(EditorPanelManagerTest,
GetEditorPanelContextCallbackShouldNotReturnConsentStatusSettled) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kWrite,
chromeos::editor_menu::EditorConsentStatus::kUnset, {});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
FakeEditorClient fake_editor_client;
mojo::Receiver<orca::mojom::EditorClient> receiver{&fake_editor_client};
manager.SetEditorClientForTesting(receiver.BindNewPipeAndPassRemote());
base::test::TestFuture<const chromeos::editor_menu::EditorContext&> future;
manager.GetEditorPanelContext(future.GetCallback());
EXPECT_TRUE(future.IsReady());
EXPECT_EQ(future.Get(),
chromeos::editor_menu::EditorContext(
EditorMode::kSoftBlocked,
chromeos::editor_menu::EditorTextSelectionMode::kNoSelection,
/*consent_status_settled=*/false, /*preset_queries=*/{}));
}
TEST_F(EditorPanelManagerTest, LogMetricsInWriteMode) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kWrite,
chromeos::editor_menu::EditorConsentStatus::kApproved, {});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
base::HistogramTester histogram_tester;
manager.LogEditorMode(EditorMode::kWrite);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kNativeUIShowOpportunity, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kNativeUIShown, 1);
histogram_tester.ExpectTotalCount("InputMethod.Manta.Orca.States.Write", 2);
}
TEST_F(EditorPanelManagerTest, LogMetricsInRewriteMode) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kRewrite,
chromeos::editor_menu::EditorConsentStatus::kApproved, {});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
base::HistogramTester histogram_tester;
manager.LogEditorMode(EditorMode::kRewrite);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kNativeUIShowOpportunity, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kNativeUIShown, 1);
histogram_tester.ExpectTotalCount("InputMethod.Manta.Orca.States.Rewrite", 2);
}
TEST_F(EditorPanelManagerTest, LogMetricsInBlockedWriteMode) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kWrite,
chromeos::editor_menu::EditorConsentStatus::kDeclined,
{
EditorBlockedReason::kBlockedByConsent,
EditorBlockedReason::kBlockedByInvalidFormFactor,
EditorBlockedReason::kBlockedByNetworkStatus,
EditorBlockedReason::kBlockedByTextLength,
EditorBlockedReason::kBlockedByUrl,
});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
base::HistogramTester histogram_tester;
manager.LogEditorMode(EditorMode::kSoftBlocked);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kNativeUIShowOpportunity, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kNativeUIShown, 0);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kBlocked, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kBlockedByConsent, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kBlockedByInvalidFormFactor,
1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kBlockedByNetworkStatus, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kBlockedByTextLength, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kBlockedByUrl, 1);
histogram_tester.ExpectTotalCount("InputMethod.Manta.Orca.States.Write", 7);
}
TEST_F(EditorPanelManagerTest, LogMetricsInBlockedMode) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kRewrite,
chromeos::editor_menu::EditorConsentStatus::kApproved,
{
EditorBlockedReason::kBlockedByApp,
EditorBlockedReason::kBlockedByInputMethod,
EditorBlockedReason::kBlockedBySetting,
});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
base::HistogramTester histogram_tester;
manager.LogEditorMode(EditorMode::kSoftBlocked);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kNativeUIShowOpportunity, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kNativeUIShown, 0);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kBlocked, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kBlockedByApp, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kBlockedByInputMethod, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kBlockedBySetting, 1);
histogram_tester.ExpectTotalCount("InputMethod.Manta.Orca.States.Rewrite", 5);
}
TEST_F(EditorPanelManagerTest, LogMetricWhenPromoCardIsExplicitlyDismissed) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kRewrite,
chromeos::editor_menu::EditorConsentStatus::kUnset, {});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
base::HistogramTester histogram_tester;
manager.OnPromoCardDeclined();
histogram_tester.ExpectUniqueSample("InputMethod.Manta.Orca.States.Rewrite",
EditorStates::kPromoCardExplicitDismissal,
1);
}
TEST_F(EditorPanelManagerTest, LogMetricWhenPromoCardIsShown) {
EditorPanelManagerDelegateForTesting editor_panel_manager_delegate(
EditorOpportunityMode::kWrite,
chromeos::editor_menu::EditorConsentStatus::kUnset, {});
EditorPanelManagerImpl manager(&editor_panel_manager_delegate);
base::HistogramTester histogram_tester;
manager.LogEditorMode(EditorMode::kConsentNeeded);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kPromoCardImpression, 1);
histogram_tester.ExpectBucketCount("InputMethod.Manta.Orca.States.Write",
EditorStates::kNativeUIShowOpportunity, 1);
histogram_tester.ExpectTotalCount("InputMethod.Manta.Orca.States.Write", 2);
}
} // namespace
} // namespace ash::input_method
|
