blob: 0ce7c36b96df94690a9e3cd612587315338e0971 (
plain)
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
|
// Copyright (c) 2017 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.
#ifndef COMPONENTS_SAFE_BROWSING_TRIGGERS_TRIGGER_THROTTLER_H_
#define COMPONENTS_SAFE_BROWSING_TRIGGERS_TRIGGER_THROTTLER_H_
#include <memory>
#include <unordered_map>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/time/clock.h"
class PrefService;
namespace safe_browsing {
// Default quota for ad sampler trigger.
extern const size_t kAdSamplerTriggerDefaultQuota;
// Param name of the finch param containing the quota for the suspicious site
// trigger.
extern const char kSuspiciousSiteTriggerQuotaParam[];
// Param name of the finch param containing the comma-separated list of trigger
// types and daily quotas.
// TODO(crbug.com/744869): This param should be deprecated after ad sampler
// launch in favour of having a unique quota feature and param per trigger.
// Having a single shared feature makes it impossible to run multiple trigger
// trials simultaneously.
extern const char kTriggerTypeAndQuotaParam[];
enum class TriggerType {
SECURITY_INTERSTITIAL = 1,
AD_SAMPLE = 2,
GAIA_PASSWORD_REUSE = 3,
SUSPICIOUS_SITE = 4,
kMinTriggerType = SECURITY_INTERSTITIAL,
kMaxTriggerType = SUSPICIOUS_SITE,
};
struct TriggerTypeHash {
std::size_t operator()(TriggerType trigger_type) const {
return static_cast<std::size_t>(trigger_type);
};
};
// A map for storing a list of event timestamps for different trigger types.
using TriggerTimestampMap =
std::unordered_map<TriggerType, std::vector<base::Time>, TriggerTypeHash>;
// A pair containing a TriggerType and its associated daily report quota.
using TriggerTypeAndQuotaItem = std::pair<TriggerType, int>;
// TriggerThrottler keeps track of how often each type of trigger gets fired
// and throttles them if they fire too often.
class TriggerThrottler {
public:
TriggerThrottler(PrefService* local_state_prefs);
virtual ~TriggerThrottler();
// Check if the the specified |trigger_type| has quota available and is
// allowed to fire at this time.
virtual bool TriggerCanFire(TriggerType trigger_type) const;
// Called to notify the throttler that a trigger has just fired and quota
// should be updated.
void TriggerFired(TriggerType trigger_type);
protected:
void SetClockForTesting(base::Clock* test_clock);
private:
friend class TriggerThrottlerTest;
friend class TriggerThrottlerTestFinch;
// Called to periodically clean-up the list of event timestamps.
void CleanupOldEvents();
// Loads trigger events that have been stored in preferences and adds them
// to |trigger_events_|.
void LoadTriggerEventsFromPref();
// Updates preferences with current contents of |trigger_events_|.
void WriteTriggerEventsToPref();
// Returns the daily quota for the specified trigger.
size_t GetDailyQuotaForTrigger(const TriggerType trigger_type) const;
// Resets |local_state_prefs_|. For testing.
void ResetPrefsForTesting(PrefService* local_state_prefs);
// Pref service for accessing local state prefs (ie: unsynced, tied to the
// browser not to a profile). Used to persist quota.
PrefService* local_state_prefs_;
// Can be set for testing.
base::Clock* clock_;
// Stores each trigger type that fired along with the timestamps of when it
// fired.
TriggerTimestampMap trigger_events_;
// List of trigger types and their quotas, controlled by Finch feature
// |kTriggerThrottlerDailyQuotaFeature|.
std::vector<TriggerTypeAndQuotaItem> trigger_type_and_quota_list_;
DISALLOW_COPY_AND_ASSIGN(TriggerThrottler);
};
} // namespace safe_browsing
#endif // COMPONENTS_SAFE_BROWSING_TRIGGERS_TRIGGER_THROTTLER_H_
|
