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
|
// Copyright 2018 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_OPTIMIZATION_GUIDE_CORE_HINTS_COMPONENT_UTIL_H_
#define COMPONENTS_OPTIMIZATION_GUIDE_CORE_HINTS_COMPONENT_UTIL_H_
#include <memory>
#include "components/optimization_guide/proto/hints.pb.h"
namespace optimization_guide {
struct HintsComponentInfo;
class OptimizationFilter;
// The local histogram used to record that the component hints are stored in
// the cache and are ready for use.
extern const char kComponentHintsUpdatedResultHistogramString[];
// Enumerates the possible outcomes of processing the hints component.
//
// Used in UMA histograms, so the order of enumerators should not be changed.
// Keep in sync with OptimizationGuideProcessHintsResult in
// tools/metrics/histograms/enums.xml.
enum class ProcessHintsComponentResult {
kSuccess = 0,
kFailedInvalidParameters = 1,
kFailedReadingFile = 2,
kFailedInvalidConfiguration = 3,
kDeprecatedFailedFinishProcessing = 4,
kSkippedProcessingHints = 5,
kProcessedNoHints = 6,
kFailedPreviouslyAttemptedVersionInvalid = 7,
// Insert new values before this line.
kMaxValue = kFailedPreviouslyAttemptedVersionInvalid,
};
// Records the ProcessHintsComponentResult to UMA.
void RecordProcessHintsComponentResult(ProcessHintsComponentResult result);
// Processes the specified hints component.
//
// If successful, returns the component's Configuration protobuf. Otherwise,
// returns a nullptr.
//
// If |out_result| provided, it will be populated with the result up to that
// point.
std::unique_ptr<proto::Configuration> ProcessHintsComponent(
const HintsComponentInfo& info,
ProcessHintsComponentResult* out_result);
// Enumerates status event of processing optimization filters. Used in UMA
// histograms, so the order of enumerators should not be changed.
//
// Keep in sync with OptimizationGuideOptimizationFilterStatus in
// tools/metrics/histograms/enums.xml.
enum class OptimizationFilterStatus {
kFoundServerFilterConfig,
kCreatedServerFilter,
kFailedServerFilterBadConfig,
kFailedServerFilterTooBig,
kFailedServerFilterDuplicateConfig,
kInvalidRegexp,
// Insert new values before this line.
kMaxValue = kInvalidRegexp,
};
// Records the OptimizationFilterStatus to UMA.
void RecordOptimizationFilterStatus(proto::OptimizationType optimization_type,
OptimizationFilterStatus status);
// Validates and parses |optimization_filter_proto| and creates one that is
// intended to be queried to make decisions for whether an optimization type
// should be applied on a navigation.
std::unique_ptr<OptimizationFilter> ProcessOptimizationFilter(
const proto::OptimizationFilter& optimization_filter_proto,
OptimizationFilterStatus* out_status);
} // namespace optimization_guide
#endif // COMPONENTS_OPTIMIZATION_GUIDE_CORE_HINTS_COMPONENT_UTIL_H_
|
