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
|
// 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.
#ifndef COMPONENTS_VISITED_URL_RANKING_INTERNAL_VISITED_URL_RANKING_SERVICE_IMPL_H_
#define COMPONENTS_VISITED_URL_RANKING_INTERNAL_VISITED_URL_RANKING_SERVICE_IMPL_H_
#include <map>
#include <memory>
#include <queue>
#include <string>
#include <utility>
#include <vector>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "components/segmentation_platform/public/database_client.h"
#include "components/segmentation_platform/public/model_provider.h"
#include "components/segmentation_platform/public/trigger.h"
#include "components/url_deduplication/deduplication_strategy.h"
#include "components/url_deduplication/url_deduplication_helper.h"
#include "components/visited_url_ranking/public/fetch_options.h"
#include "components/visited_url_ranking/public/fetch_result.h"
#include "components/visited_url_ranking/public/url_visit.h"
#include "components/visited_url_ranking/public/url_visit_aggregates_transformer.h"
#include "components/visited_url_ranking/public/url_visit_data_fetcher.h"
#include "components/visited_url_ranking/public/visited_url_ranking_service.h"
namespace segmentation_platform {
struct AnnotatedNumericResult;
class SegmentationPlatformService;
} // namespace segmentation_platform
namespace visited_url_ranking {
// The status of an execution step performed by the service when handling a
// request. These values are persisted to logs. Entries should not be
// renumbered and numeric values should never be reused.
// LINT.IfChange(URLVisitAggregatesTransformType)
enum class VisitedURLRankingRequestStepStatus {
kUnknown = 0,
kSuccess = 1,
kSuccessEmpty = 2,
kFailed = 3,
kFailedNotFound = 4,
kFailedMissingBackend = 5,
kMaxValue = kFailedMissingBackend
};
// LINT.ThenChange(/tools/metrics/histograms/visited_url_ranking/enums.xml:VisitedURLRankingRequestStepStatus)
enum class Status;
// The internal implementation of the VisitedURLRankingService.
class VisitedURLRankingServiceImpl : public VisitedURLRankingService {
public:
// Wait time before which we record kSeen events as feedback.
constexpr static int kSeenRecordDelaySec = 300;
VisitedURLRankingServiceImpl(
segmentation_platform::SegmentationPlatformService*
segmentation_platform_service,
std::map<Fetcher, std::unique_ptr<URLVisitDataFetcher>> data_fetchers,
std::map<URLVisitAggregatesTransformType,
std::unique_ptr<URLVisitAggregatesTransformer>> transformers,
std::unique_ptr<url_deduplication::URLDeduplicationHelper>
deduplication_helper =
std::make_unique<url_deduplication::URLDeduplicationHelper>(
url_deduplication::DeduplicationStrategy()));
~VisitedURLRankingServiceImpl() override;
// Disallow copy/assign.
VisitedURLRankingServiceImpl(const VisitedURLRankingServiceImpl&) = delete;
VisitedURLRankingServiceImpl& operator=(const VisitedURLRankingServiceImpl&) =
delete;
// VisitedURLRankingService:
void FetchURLVisitAggregates(const FetchOptions& options,
GetURLVisitAggregatesCallback callback) override;
void RankURLVisitAggregates(const Config& config,
std::vector<URLVisitAggregate> visits,
RankURLVisitAggregatesCallback callback) override;
void DecorateURLVisitAggregates(
const Config& config,
visited_url_ranking::URLVisitsMetadata url_visits_metadata,
std::vector<URLVisitAggregate> visit_aggregates,
DecorateURLVisitAggregatesCallback callback) override;
void RecordAction(
ScoredURLUserAction action,
const std::string& visit_id,
segmentation_platform::TrainingRequestId visit_request_id) override;
void RegisterTransformer(
URLVisitAggregatesTransformType type,
std::unique_ptr<URLVisitAggregatesTransformer> transformer) override;
private:
// Trigger training data collection with the user action.
void TriggerTrainingData(
ScoredURLUserAction action,
const std::string& visit_id,
segmentation_platform::TrainingRequestId visit_request_id);
// Callback invoked when the various fetcher instances have completed.
void MergeVisitsAndCallback(
GetURLVisitAggregatesCallback callback,
const FetchOptions& options,
const std::vector<URLVisitAggregatesTransformType>& ordered_transforms,
std::vector<std::pair<Fetcher, FetchResult>> fetcher_results);
// Callback invoked when the various transformers have completed.
void TransformVisitsAndCallback(
GetURLVisitAggregatesCallback callback,
const FetchOptions& options,
std::queue<URLVisitAggregatesTransformType> transform_type_queue,
URLVisitAggregatesTransformType transform_type,
size_t previous_aggregates_count,
URLVisitsMetadata url_visits_metadata,
base::Time start_time,
URLVisitAggregatesTransformer::Status status,
std::vector<URLVisitAggregate> aggregates);
// Returns true if the visit should be discarded from candidates based on
// threshold.
bool ShouldDiscardVisit(const URLVisitAggregate& visit);
// Invoked to get the score (i.e. numeric result) for a given URL visit
// aggregate.
void GetNextResult(const std::string& segmentation_key,
std::deque<URLVisitAggregate> visit_aggregates,
std::vector<URLVisitAggregate> scored_visits,
RankURLVisitAggregatesCallback callback);
// Callback invoked when a score (i.e. numeric result) has been obtained for a
// given URL visit aggregate.
void OnGetResult(const std::string& segmentation_key,
std::deque<URLVisitAggregate> visit_aggregates,
std::vector<URLVisitAggregate> scored_visits,
RankURLVisitAggregatesCallback callback,
const segmentation_platform::AnnotatedNumericResult& result);
// The service to use to execute URL visit score prediction.
raw_ptr<segmentation_platform::SegmentationPlatformService>
segmentation_platform_service_;
// A map of supported URL visit data fetchers that may participate in the
// computation of `URLVisitAggregate` objects.
std::map<Fetcher, std::unique_ptr<URLVisitDataFetcher>> data_fetchers_;
// A map of supported transformers for transform types.
std::map<URLVisitAggregatesTransformType,
std::unique_ptr<URLVisitAggregatesTransformer>>
transformers_;
// Time delay to record kSeen events in case kActivation events are recorded.
const base::TimeDelta seen_record_delay_;
// Sampling rate for kSeen events to balance training collection.
const int seen_records_sampling_rate_;
// Threshold for when the "You just visited" communication should be
// displayed instead of relative time.
const base::TimeDelta recently_visited_minutes_threshold_;
// Score thresholds for varying URL types.
std::map<URLVisitAggregate::URLType, double> score_thresholds_;
// The helper used by the fetchers to deduplicate URLs.
std::unique_ptr<url_deduplication::URLDeduplicationHelper>
deduplication_helper_;
base::WeakPtrFactory<VisitedURLRankingServiceImpl> weak_ptr_factory_{this};
};
} // namespace visited_url_ranking
#endif // COMPONENTS_VISITED_URL_RANKING_INTERNAL_VISITED_URL_RANKING_SERVICE_IMPL_H_
|
