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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/webapps/browser/installable/ml_install_result_reporter.h"
#include <optional>
#include "base/memory/weak_ptr.h"
#include "base/metrics/field_trial_params.h"
#include "base/metrics/histogram_base.h"
#include "base/metrics/histogram_functions.h"
#include "base/rand_util.h"
#include "components/segmentation_platform/public/segmentation_platform_service.h"
#include "components/segmentation_platform/public/trigger.h"
#include "components/webapps/browser/banners/app_banner_manager.h"
#include "components/webapps/browser/features.h"
#include "components/webapps/browser/installable/installable_metrics.h"
#include "components/webapps/browser/installable/ml_install_operation_tracker.h"
#include "components/webapps/browser/installable/ml_installability_promoter.h"
#include "components/webapps/browser/webapps_client.h"
namespace webapps {
MlInstallResultReporter::MlInstallResultReporter(
base::WeakPtr<content::BrowserContext> browser_context,
segmentation_platform::TrainingRequestId training_request,
std::string ml_output_label,
const GURL& manifest_id,
bool ml_promotion_blocked_by_guardrail)
: browser_context_(browser_context),
training_request_(training_request),
ml_output_label_(ml_output_label),
manifest_id_(manifest_id),
ml_promotion_blocked_by_guardrail_(ml_promotion_blocked_by_guardrail) {
CHECK(browser_context_);
CHECK(manifest_id_.is_valid());
}
MlInstallResultReporter::~MlInstallResultReporter() {
if (ml_promotion_blocked_by_guardrail_) {
ReportResultInternal(install_source_attached_,
MlInstallResponse::kBlockedGuardrails);
} else {
ReportResultInternal(install_source_attached_,
MlInstallResponse::kReporterDestroyed);
}
}
void MlInstallResultReporter::OnInstallTrackerAttached(
WebappInstallSource install_source) {
// If attached to an install tracker, destruction of this tracker means that
// the user ignored the install UX, so we will not be reporting the guardrail
// result.
ml_promotion_blocked_by_guardrail_ = false;
install_source_attached_ = install_source;
}
const std::string& MlInstallResultReporter::output_label() const {
return ml_output_label_;
}
bool MlInstallResultReporter::ml_promotion_blocked_by_guardrail() const {
return ml_promotion_blocked_by_guardrail_;
}
void MlInstallResultReporter::ReportResult(
WebappInstallSource source,
MlInstallUserResponse user_response) {
MlInstallResponse response;
switch (user_response) {
case MlInstallUserResponse::kAccepted:
response = MlInstallResponse::kAccepted;
break;
case MlInstallUserResponse::kCancelled:
response = MlInstallResponse::kCancelled;
break;
case MlInstallUserResponse::kIgnored:
response = MlInstallResponse::kIgnored;
break;
}
ReportResultInternal(source, response);
}
void MlInstallResultReporter::ReportResultInternal(
std::optional<WebappInstallSource> source,
MlInstallResponse response) {
WebappsClient* client = WebappsClient::Get();
CHECK(client);
if (reported_ || !browser_context_ ||
!client->GetSegmentationPlatformService(browser_context_.get())) {
return;
}
// This training request can only be reported once.
reported_ = true;
if (source) {
base::UmaHistogramEnumeration("WebApp.MlInstall.InstallSource",
source.value(), WebappInstallSource::COUNT);
}
base::UmaHistogramEnumeration("WebApp.MlInstall.DialogResponse", response);
bool ml_promoted =
ml_output_label_ == MLInstallabilityPromoter::kShowInstallPromptLabel;
if (ml_promoted) {
switch (response) {
case MlInstallResponse::kAccepted:
client->SaveInstallationAcceptedForMl(browser_context_.get(),
manifest_id_);
break;
case MlInstallResponse::kReporterDestroyed:
case MlInstallResponse::kIgnored:
client->SaveInstallationIgnoredForMl(browser_context_.get(),
manifest_id_);
break;
case MlInstallResponse::kCancelled:
client->SaveInstallationDismissedForMl(browser_context_.get(),
manifest_id_);
break;
case MlInstallResponse::kBlockedGuardrails:
break;
}
}
// If promition occurred but we were destroyed, then consider that an
// 'ignore'.
if (ml_promoted && response == MlInstallResponse::kReporterDestroyed) {
response = MlInstallResponse::kIgnored;
}
// Exit early to avoid over-sampling in a few cases.
if (!ml_promoted && response == MlInstallResponse::kReporterDestroyed &&
base::RandDouble() >
features::kWebAppsMLModelUserDeclineReportProb.Get()) {
// If the UX is never shown, then this reporter will simply be destroyed. Do
// not bother reporting this result.
return;
}
if (response == MlInstallResponse::kBlockedGuardrails &&
base::RandDouble() >
features::kWebAppsMLGuardrailResultReportProb.Get()) {
return;
}
if (ml_promoted) {
base::UmaHistogramEnumeration("WebApp.MLInstallPromo.UserResponse",
response);
}
segmentation_platform::SegmentationPlatformService* segmentation =
client->GetSegmentationPlatformService(browser_context_.get());
segmentation_platform::TrainingLabels training_labels;
training_labels.output_metric =
std::make_pair("WebApps.MlInstall.DialogResponse",
static_cast<base::HistogramBase::Sample32>(response));
segmentation->CollectTrainingData(
segmentation_platform::proto::SegmentId::
OPTIMIZATION_TARGET_WEB_APP_INSTALLATION_PROMO,
training_request_, training_labels, base::DoNothing());
}
} // namespace webapps
|
