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
|
// Copyright 2014 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_DOMAIN_RELIABILITY_SCHEDULER_H_
#define COMPONENTS_DOMAIN_RELIABILITY_SCHEDULER_H_
#include <stddef.h>
#include <memory>
#include <vector>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "components/domain_reliability/domain_reliability_export.h"
#include "components/domain_reliability/uploader.h"
#include "net/base/backoff_entry.h"
namespace domain_reliability {
class MockableTime;
// Determines when an upload should be scheduled. A domain's config will
// specify minimum and maximum upload delays; the minimum upload delay ensures
// that Chrome will not send too many upload requests to a site by waiting at
// least that long after the first beacon, while the maximum upload delay makes
// sure the server receives the reports while they are still fresh.
//
// When everything is working fine, the scheduler will return precisely that
// interval. If all uploaders have failed, then the beginning or ending points
// of the interval may be pushed later to accomodate the retry with exponential
// backoff.
//
// See dispatcher.h for an explanation of what happens with the scheduled
// interval.
class DOMAIN_RELIABILITY_EXPORT DomainReliabilityScheduler {
public:
typedef base::RepeatingCallback<void(base::TimeDelta, base::TimeDelta)>
ScheduleUploadCallback;
struct Params {
public:
base::TimeDelta minimum_upload_delay;
base::TimeDelta maximum_upload_delay;
base::TimeDelta upload_retry_interval;
static Params GetFromFieldTrialsOrDefaults();
};
DomainReliabilityScheduler(const MockableTime* time,
size_t num_collectors,
const Params& params,
const ScheduleUploadCallback& callback);
DomainReliabilityScheduler(const DomainReliabilityScheduler&) = delete;
DomainReliabilityScheduler& operator=(const DomainReliabilityScheduler&) =
delete;
~DomainReliabilityScheduler();
// If there is no upload pending, schedules an upload based on the provided
// parameters (some time between the minimum and maximum delay from now).
// May call the ScheduleUploadCallback.
void OnBeaconAdded();
// Returns which collector to use for an upload that is about to start. Must
// be called exactly once during or after the ScheduleUploadCallback but
// before OnUploadComplete is called. (Also records the upload start time for
// future retries, if the upload ends up failing.)
size_t OnUploadStart();
// Updates the scheduler state based on the result of an upload. Must be
// called exactly once after |OnUploadStart|. |result| should be the result
// passed to the upload callback by the Uploader.
void OnUploadComplete(const DomainReliabilityUploader::UploadResult& result);
// Disables jitter in BackoffEntries to make scheduling deterministic for
// unit tests.
void MakeDeterministicForTesting();
private:
void MaybeScheduleUpload();
void GetNextUploadTimeAndCollector(base::TimeTicks now,
base::TimeTicks* upload_time_out,
size_t* collector_index_out);
raw_ptr<const MockableTime> time_;
Params params_;
ScheduleUploadCallback callback_;
net::BackoffEntry::Policy backoff_policy_;
std::vector<std::unique_ptr<net::BackoffEntry>> collectors_;
// Whether there are beacons that have not yet been uploaded. Set when a
// beacon arrives or an upload fails, and cleared when an upload starts.
bool upload_pending_;
// Whether the scheduler has called the ScheduleUploadCallback to schedule
// the next upload. Set when an upload is scheduled and cleared when the
// upload starts.
bool upload_scheduled_;
// Whether the last scheduled upload is in progress. Set when the upload
// starts and cleared when the upload completes (successfully or not).
bool upload_running_;
// Index of the collector selected for the next upload. (Set in
// |OnUploadStart| and cleared in |OnUploadComplete|.)
size_t collector_index_;
// Time of the first beacon that was not included in the last successful
// upload.
base::TimeTicks first_beacon_time_;
// first_beacon_time_ saved during uploads. Restored if upload fails.
base::TimeTicks old_first_beacon_time_;
};
} // namespace domain_reliability
#endif // COMPONENTS_DOMAIN_RELIABILITY_SCHEDULER_H_
|
