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
|
// 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 "components/segmentation_platform/embedder/home_modules/history_sync_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"
#include "components/signin/public/base/signin_switches.h"
namespace {
const char kEducationalTipModuleHistogramName[] =
"MagicStack.Clank.NewTabPage.Module.TopImpressionV2";
constexpr int kHistorySyncPromoId = 10;
constexpr std::array<int32_t, 0> kEducationalTipModuleHistogramEnumValues{};
} // namespace
namespace segmentation_platform::home_modules {
HistorySyncPromo::HistorySyncPromo(PrefService* profile_prefs)
: CardSelectionInfo(kHistorySyncPromo), profile_prefs_(profile_prefs) {}
std::map<SignalKey, FeatureQuery> HistorySyncPromo::GetInputs() {
std::map<SignalKey, FeatureQuery> map = {
{kIsEligibleToHistoryOptIn,
FeatureQuery::FromCustomInput(MetadataWriter::CustomInput{
.tensor_length = 1,
.fill_policy = proto::CustomInput::FILL_FROM_INPUT_CONTEXT,
.name = kIsEligibleToHistoryOptIn})}};
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_history_sync_card_once =
features::KDaysToShowEachEphemeralCardOnce.Get();
// Define signal for number of times history sync promo card has shown to the
// user in limited days.
DEFINE_UMA_FEATURE_ENUM_COUNT(
countOfHistorySyncPromoShownTimes, kEducationalTipModuleHistogramName,
&kHistorySyncPromoId, /* enum_size= */ 1,
/* days= */ days_to_show_history_sync_card_once);
map.emplace(kHistorySyncPromoShownCount,
std::move(countOfHistorySyncPromoShownTimes));
return map;
}
// When not forced to be shown by flags and has less than 10 impressions, the
// history sync promo will be shown to users if
// 1. The user has not already interacted with the card.
// 2. The number of impressions in 24 hours doesn't exceed the cap
// (kDailyShownCountLimit)
// 3. kIsEligibleToHistoryOptIn returns true
CardSelectionInfo::ShowResult HistorySyncPromo::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() &&
kHistorySyncPromo == forced_result.value().result_label.value()) {
return forced_result.value();
}
CardSelectionInfo::ShowResult result;
result.result_label = kHistorySyncPromo;
bool has_been_interacted_with =
profile_prefs_->GetBoolean(kHistorySyncPromoInteractedPref);
if (has_been_interacted_with) {
result.position = EphemeralHomeModuleRank::kNotShown;
return result;
}
std::optional<float> result_for_history_sync_promo_shown_count =
signals.GetSignal(kHistorySyncPromoShownCount);
std::optional<float> result_for_is_eligible_to_history_opt_in =
signals.GetSignal(kIsEligibleToHistoryOptIn);
std::optional<float>
result_for_educational_tip_shown_count_for_history_sync_signal =
signals.GetSignal(kEducationalTipShownCount);
if (!result_for_history_sync_promo_shown_count.has_value() ||
!result_for_is_eligible_to_history_opt_in.has_value() ||
!result_for_educational_tip_shown_count_for_history_sync_signal
.has_value()) {
result.position = EphemeralHomeModuleRank::kNotShown;
return result;
}
if (result_for_is_eligible_to_history_opt_in.value() &&
result_for_history_sync_promo_shown_count.value() < 1 &&
result_for_educational_tip_shown_count_for_history_sync_signal.value() <
1) {
result.position = EphemeralHomeModuleRank::kLast;
return result;
}
result.position = EphemeralHomeModuleRank::kNotShown;
return result;
}
bool HistorySyncPromo::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() &&
kHistorySyncPromo == forced_result.value().result_label.value()) {
return true;
}
if (!base::FeatureList::IsEnabled(features::kEducationalTipModule) ||
!base::FeatureList::IsEnabled(switches::kHistoryOptInEducationalTip) ||
!is_in_enabled_cards_set) {
return false;
}
if (impression_count >= features::kMaxHistorySyncCardImpressions.Get()) {
return false;
}
return true;
}
} // namespace segmentation_platform::home_modules
|
