blob: 7c26960d98415d1d1b644d6fea00cbbf879d9644 [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stddef.h>
#include <memory>
#include <vector>
#include "base/callback.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 base {
class Value;
} // namespace base
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 {
typedef base::Callback<void(base::TimeDelta, base::TimeDelta)>
struct Params {
base::TimeDelta minimum_upload_delay;
base::TimeDelta maximum_upload_delay;
base::TimeDelta upload_retry_interval;
static Params GetFromFieldTrialsOrDefaults();
DomainReliabilityScheduler(MockableTime* time,
size_t num_collectors,
const Params& params,
const ScheduleUploadCallback& callback);
// 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);
std::unique_ptr<base::Value> GetWebUIData() const;
// Disables jitter in BackoffEntries to make scheduling deterministic for
// unit tests.
void MakeDeterministicForTesting();
// Gets the time of the first beacon that has not yet been successfully
// uploaded.
base::TimeTicks first_beacon_time() const { return first_beacon_time_; }
void MaybeScheduleUpload();
void GetNextUploadTimeAndCollector(base::TimeTicks now,
base::TimeTicks* upload_time_out,
size_t* collector_index_out);
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_;
// Extra bits to return in GetWebUIData.
base::TimeTicks scheduled_min_time_;
base::TimeTicks scheduled_max_time_;
// Whether the other last_upload_* fields are populated.
bool last_upload_finished_;
base::TimeTicks last_upload_start_time_;
base::TimeTicks last_upload_end_time_;
size_t last_upload_collector_index_;
bool last_upload_success_;
} // namespace domain_reliability