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 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 "components/segmentation_platform/embedder/home_modules/tab_group_promo.h"
#include "base/metrics/field_trial_params.h"
#include "components/commerce/core/commerce_feature_list.h"
#include "components/segmentation_platform/embedder/home_modules/constants.h"
#include "components/segmentation_platform/embedder/home_modules/ephemeral_module_utils.h"
#include "components/segmentation_platform/embedder/home_modules/home_modules_card_registry.h"
#include "components/segmentation_platform/public/features.h"
#include "components/segmentation_platform/public/proto/model_metadata.pb.h"
namespace {
// The number of tabs required to make the tab group promo card visible to
// users.
const int kTabCountLimit = 10;
const char kEducationalTipModuleHistogramName[] =
"MagicStack.Clank.NewTabPage.Module.TopImpressionV2";
// TODO(crbug.com/382803396): The enum id of the tab group promo card. Could be
// referenced after refactor.
const int kTabGroupPromoId = 7;
constexpr std::array<int32_t, 0> kEducationalTipModuleHistogramEnumValues{};
} // namespace
namespace segmentation_platform::home_modules {
TabGroupPromo::TabGroupPromo(PrefService* profile_prefs)
: CardSelectionInfo(kTabGroupPromo), profile_prefs_(profile_prefs) {}
std::map<SignalKey, FeatureQuery> TabGroupPromo::GetInputs() {
std::map<SignalKey, FeatureQuery> map = {
{kIsUserSignedIn,
FeatureQuery::FromCustomInput(MetadataWriter::CustomInput{
.tensor_length = 1,
.fill_policy = proto::CustomInput::FILL_FROM_INPUT_CONTEXT,
.name = kIsUserSignedIn})},
{kNumberOfTabs,
FeatureQuery::FromCustomInput(MetadataWriter::CustomInput{
.tensor_length = 1,
.fill_policy = proto::CustomInput::FILL_FROM_INPUT_CONTEXT,
.name = kNumberOfTabs})},
{kTabGroupExists,
FeatureQuery::FromCustomInput(MetadataWriter::CustomInput{
.tensor_length = 1,
.fill_policy = proto::CustomInput::FILL_FROM_INPUT_CONTEXT,
.name = kTabGroupExists})},
};
int days_to_show_ephemeral_card_once =
features::KDaysToShowEphemeralCardOnce.Get();
// Define signal for number of times all educational tip card has shown to the
// user in limited days.
DEFINE_UMA_FEATURE_ENUM_COUNT(countOfEducationalTipCardShownTimes,
kEducationalTipModuleHistogramName,
kEducationalTipModuleHistogramEnumValues.data(),
kEducationalTipModuleHistogramEnumValues.size(),
/* days= */ days_to_show_ephemeral_card_once);
map.emplace(kEducationalTipShownCount,
std::move(countOfEducationalTipCardShownTimes));
int days_to_show_tab_group_card_once =
features::KDaysToShowEachEphemeralCardOnce.Get();
// Define signal for number of times tab group promo card has shown to the
// user in limited days.
DEFINE_UMA_FEATURE_ENUM_COUNT(countOfTabGroupPromoShownTimes,
kEducationalTipModuleHistogramName,
&kTabGroupPromoId, /* enum_size= */ 1,
/* days= */ days_to_show_tab_group_card_once);
map.emplace(kTabGroupPromoShownCount,
std::move(countOfTabGroupPromoShownTimes));
return map;
}
CardSelectionInfo::ShowResult TabGroupPromo::ComputeCardResult(
const CardSelectionSignals& signals) const {
// Check for a forced `ShowResult`.
std::optional<CardSelectionInfo::ShowResult> forced_result =
GetForcedEphemeralModuleShowResult();
if (forced_result.has_value() &&
forced_result.value().result_label.has_value() &&
kTabGroupPromo == forced_result.value().result_label.value()) {
return forced_result.value();
}
CardSelectionInfo::ShowResult result;
result.result_label = kTabGroupPromo;
bool has_been_interacted_with =
profile_prefs_->GetBoolean(kTabGroupPromoInteractedPref);
if (has_been_interacted_with) {
result.position = EphemeralHomeModuleRank::kNotShown;
return result;
}
std::optional<float> result_for_is_user_signed_in =
signals.GetSignal(kIsUserSignedIn);
std::optional<float> result_for_tab_group_exists =
signals.GetSignal(kTabGroupExists);
std::optional<float> result_for_number_of_tabs =
signals.GetSignal(kNumberOfTabs);
std::optional<float> result_for_tab_group_promo_shown_count =
signals.GetSignal(kTabGroupPromoShownCount);
std::optional<float>
result_for_educational_tip_shown_count_for_tab_group_signal =
signals.GetSignal(kEducationalTipShownCount);
if (!result_for_is_user_signed_in.has_value() ||
!result_for_tab_group_exists.has_value() ||
!result_for_number_of_tabs.has_value() ||
!result_for_tab_group_promo_shown_count.has_value() ||
!result_for_educational_tip_shown_count_for_tab_group_signal
.has_value()) {
result.position = EphemeralHomeModuleRank::kNotShown;
return result;
}
if (*result_for_is_user_signed_in && !*result_for_tab_group_exists &&
result_for_number_of_tabs.value() > kTabCountLimit &&
result_for_tab_group_promo_shown_count.value() < 1 &&
result_for_educational_tip_shown_count_for_tab_group_signal.value() < 1) {
result.position = EphemeralHomeModuleRank::kLast;
return result;
}
result.position = EphemeralHomeModuleRank::kNotShown;
return result;
}
bool TabGroupPromo::IsEnabled(bool is_in_enabled_cards_set,
int impression_count) {
std::optional<CardSelectionInfo::ShowResult> forced_result =
GetForcedEphemeralModuleShowResult();
if (forced_result.has_value() &&
forced_result.value().result_label.has_value() &&
kTabGroupPromo == forced_result.value().result_label.value()) {
return true;
}
if (!base::FeatureList::IsEnabled(features::kEducationalTipModule) ||
!is_in_enabled_cards_set) {
return false;
}
if (impression_count >= features::kMaxTabGroupCardImpressions.Get()) {
return false;
}
return true;
}
} // namespace segmentation_platform::home_modules
|
