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
|
// Copyright 2017 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_FEATURE_ENGAGEMENT_INTERNAL_CONDITION_VALIDATOR_H_
#define COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_CONDITION_VALIDATOR_H_
#include <stdint.h>
#include <optional>
#include <ostream>
#include <string>
#include <vector>
#include "base/feature_list.h"
#include "components/feature_engagement/public/configuration.h"
#include "components/feature_engagement/public/feature_list.h"
namespace feature_engagement {
struct FeatureConfig;
class AvailabilityModel;
class DisplayLockController;
class EventModelReader;
class TimeProvider;
// A ConditionValidator checks the requred conditions for a given feature,
// and checks if all conditions are met.
class ConditionValidator {
public:
// The Result struct is used to categorize everything that could have the
// wrong state. By returning an instance of this where every value is true
// from MeetsConditions(...), it can be assumed that in-product help will
// be displayed.
struct Result {
explicit Result(bool initial_values);
Result(const Result& other);
Result& operator=(const Result& other);
// Whether the event model was ready.
bool event_model_ready_ok;
// Whether no other in-product helps were shown at the time.
bool currently_showing_ok;
// Whether the feature is enabled.
bool feature_enabled_ok;
// Whether the feature configuration was valid.
bool config_ok;
// Whether the used precondition was met.
bool used_ok;
// Whether the trigger precondition was met.
bool trigger_ok;
// Whether the other preconditions were met.
bool preconditions_ok;
// Whether the session rate precondition was met.
bool session_rate_ok;
// Whether the availability model was ready.
bool availability_model_ready_ok;
// Whether the availability precondition was met.
bool availability_ok;
// Whether there are currently held display locks.
bool display_lock_ok;
// Whether the current snooze timer has expired.
bool snooze_expiration_ok;
// Whether the given feature is a priority notification, or there are no
// other priority notifications.
bool priority_notification_ok;
// Whether the additional group-based preconditions were met.
bool groups_ok;
// Whether the snooze option should be shown.
// This value is excluded from the NoErrors() check.
bool should_show_snooze;
// Returns true if this result object has no errors, i.e. no values that
// are false.
bool NoErrors() const;
};
ConditionValidator(const ConditionValidator&) = delete;
ConditionValidator& operator=(const ConditionValidator&) = delete;
virtual ~ConditionValidator() = default;
// Returns a Result object that describes whether each condition has been met.
virtual Result MeetsConditions(
const base::Feature& feature,
const FeatureConfig& config,
const std::vector<GroupConfig>& group_configs,
const EventModelReader& event_model_reader,
const AvailabilityModel& availability_model,
const DisplayLockController& display_lock_controller,
const Configuration* configuration,
const TimeProvider& time_provider) const = 0;
// Must be called to notify that the |feature| is currently showing.
virtual void NotifyIsShowing(
const base::Feature& feature,
const FeatureConfig& config,
const std::vector<std::string>& all_feature_names) = 0;
// Must be called to notify that the |feature| is no longer showing.
virtual void NotifyDismissed(const base::Feature& feature) = 0;
// Called to notify that we have a priority notification to be shown next. All
// other IPHs will be blocked until then.
virtual void SetPriorityNotification(
const std::optional<std::string>& feature) = 0;
// Called to get if there is a pending priority notification to be shown next.
virtual std::optional<std::string> GetPendingPriorityNotification() = 0;
// Called to reset the session info, including the shown history.
virtual void ResetSession() = 0;
protected:
ConditionValidator() = default;
};
std::ostream& operator<<(std::ostream& os,
const ConditionValidator::Result& result);
} // namespace feature_engagement
#endif // COMPONENTS_FEATURE_ENGAGEMENT_INTERNAL_CONDITION_VALIDATOR_H_
|
