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
|
// Copyright 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_PREVIEWS_CORE_PREVIEWS_LOGGER_H_
#define COMPONENTS_PREVIEWS_CORE_PREVIEWS_LOGGER_H_
#include <list>
#include <string>
#include <unordered_map>
#include "base/macros.h"
#include "base/observer_list.h"
#include "base/sequence_checker.h"
#include "base/time/time.h"
#include "components/previews/core/previews_black_list.h"
#include "components/previews/core/previews_experiments.h"
#include "url/gurl.h"
namespace previews {
// Get the human readable description of the log event for InfoBar messages
// based on the |type| of Previews.
std::string GetDescriptionForInfoBarDescription(previews::PreviewsType type);
class PreviewsLoggerObserver;
// Records information about previews and interventions events. The class only
// keeps the recent event logs.
class PreviewsLogger {
public:
// Information needed for a log message. This information will be used to
// display log messages on chrome://interventions-internals.
// TODO(thanhdle): Add PreviewType to this struct, and display that
// information on the page as a separate column. crbug.com/774252.
struct MessageLog {
MessageLog(const std::string& event_type,
const std::string& event_description,
const GURL& url,
base::Time time,
uint64_t page_id);
MessageLog(const MessageLog& other);
// The type of event associated with the log.
const std::string event_type;
// Human readable description of the event.
const std::string event_description;
// The url associated with the log.
const GURL url;
// The time of when the event happened.
const base::Time time;
// The ID associated with the request.
const uint64_t page_id;
};
PreviewsLogger();
virtual ~PreviewsLogger();
// Add a observer to the list. This observer will be notified when new a log
// message is added to the logger. Observers must remove themselves with
// RemoveObserver.
void AddAndNotifyObserver(PreviewsLoggerObserver* observer);
// Removes a observer from the observers list. Virtualized in testing.
virtual void RemoveObserver(PreviewsLoggerObserver* observer);
// Add MessageLog using the given information. Pop out the oldest log if the
// size of |log_messages_| grows larger than a threshold. Virtualized in
// testing. |page_id| generated by PreviewsIOData, used for grouping log
// messages together, messages that don't need to be grouped can pass in 0 as
// page_id.
virtual void LogMessage(const std::string& event_type,
const std::string& event_description,
const GURL& url,
base::Time time,
uint64_t page_id);
// Convert |navigation| to a MessageLog, and add that message to
// |log_messages_|. Virtualized in testing.
virtual void LogPreviewNavigation(const GURL& url,
PreviewsType type,
bool opt_out,
base::Time time,
uint64_t page_id);
// Add a MessageLog for the a decision that was made about the state of
// previews and blacklist. |passed_reasons| is an ordered list of
// PreviewsEligibilityReasons that got pass the decision. The method takes
// ownership of |passed_reasons|. |page_id| generated by PreviewsIOData, used
// for grouping log messages together, messages that don't need to be grouped
// can pass in 0 as page_id. Virtualized in testing.
virtual void LogPreviewDecisionMade(
PreviewsEligibilityReason reason,
const GURL& url,
base::Time time,
PreviewsType type,
std::vector<PreviewsEligibilityReason>&& passed_reasons,
uint64_t page_id);
// Notify observers that |host| is blacklisted at |time|. Virtualized in
// testing.
virtual void OnNewBlacklistedHost(const std::string& host, base::Time time);
// Notify observers that user blacklisted state has changed to |blacklisted|.
// Virtualized in testing.
virtual void OnUserBlacklistedStatusChange(bool blacklisted);
// Notify observers that the blacklist is cleared at |time|. Virtualized in
// testing.
virtual void OnBlacklistCleared(base::Time time);
// Notify observers that the status of whether blacklist decisions are ignored
// or not. Virtualized in testing.
virtual void OnIgnoreBlacklistDecisionStatusChanged(bool ignored);
private:
// Keeping track of all blacklisted host to notify new observers.
std::unordered_map<std::string, base::Time> blacklisted_hosts_;
// The current user blacklisted status.
bool user_blacklisted_status_;
// The current status of whether PreviewsBlackList decisions are ignored or
// not.
bool blacklist_ignored_;
// Collection of recorded navigation log messages.
std::list<MessageLog> navigations_logs_;
// Collection of recorded decision log messages.
std::list<MessageLog> decisions_logs_;
// A list of observers listening to the logger.
base::ObserverList<PreviewsLoggerObserver> observer_list_;
SEQUENCE_CHECKER(sequence_checker_);
DISALLOW_COPY_AND_ASSIGN(PreviewsLogger);
};
} // namespace previews
#endif // COMPONENTS_PREVIEWS_CORE_PREVIEWS_LOGGER_H_
|
