blob: 46942601ee9847f317c29d66fee1bfa50f23c3a9 (
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
115
116
117
118
119
120
121
122
123
124
125
126
|
// Copyright 2020 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_OPTIMIZATION_GUIDE_OPTIMIZATION_METADATA_H_
#define COMPONENTS_OPTIMIZATION_GUIDE_OPTIMIZATION_METADATA_H_
#include "base/logging.h"
#include "base/optional.h"
#include "base/strings/string_split.h"
#include "components/optimization_guide/proto/hints.pb.h"
namespace optimization_guide {
// Contains metadata that could be attached to an optimization provided by the
// Optimization Guide.
//
// Note: If a new optimization metadata is added,
// |OptimizationGuideHintsManager::AddHintsForTesting| should be updated
// to handle it.
class OptimizationMetadata {
public:
OptimizationMetadata();
OptimizationMetadata(const OptimizationMetadata&);
~OptimizationMetadata();
// Validates that the metadata stored in |any_metadata_| is of the same type
// and is parseable as |T|. Will return metadata if all checks pass.
template <
class T,
class = typename std::enable_if<
std::is_convertible<T*, google::protobuf::MessageLite*>{}>::type>
base::Optional<T> ParsedMetadata() const {
if (!any_metadata_)
return base::nullopt;
// Verify type is the same - the Any type URL should be wrapped as:
// "type.googleapis.com/com.foo.Name".
std::vector<std::string> any_type_parts =
base::SplitString(any_metadata_->type_url(), ".", base::TRIM_WHITESPACE,
base::SPLIT_WANT_NONEMPTY);
if (any_type_parts.empty())
return base::nullopt;
T metadata;
std::vector<std::string> type_parts =
base::SplitString(metadata.GetTypeName(), ".", base::TRIM_WHITESPACE,
base::SPLIT_WANT_NONEMPTY);
if (type_parts.empty())
return base::nullopt;
std::string any_type_name = any_type_parts.back();
std::string type_name = type_parts.back();
if (type_name != any_type_name)
return base::nullopt;
// Return metadata if parseable.
if (metadata.ParseFromString(any_metadata_->value()))
return metadata;
return base::nullopt;
}
const base::Optional<proto::Any>& any_metadata() const {
return any_metadata_;
}
void set_any_metadata(const proto::Any& any_metadata) {
any_metadata_ = any_metadata;
}
// Sets |any_metadata_| to be validly parsed as |metadata|. Should only be
// used for testing purposes.
void SetAnyMetadataForTesting(const google::protobuf::MessageLite& metadata);
const base::Optional<proto::PreviewsMetadata>& previews_metadata() const {
return previews_metadata_;
}
void set_previews_metadata(const proto::PreviewsMetadata& previews_metadata) {
previews_metadata_ = previews_metadata;
}
const base::Optional<proto::PerformanceHintsMetadata>&
performance_hints_metadata() const {
return performance_hints_metadata_;
}
void set_performance_hints_metadata(
const proto::PerformanceHintsMetadata& performance_hints_metadata) {
performance_hints_metadata_ = performance_hints_metadata;
}
const base::Optional<proto::PublicImageMetadata>& public_image_metadata()
const {
return public_image_metadata_;
}
void set_public_image_metadata(
const proto::PublicImageMetadata& public_image_metadata) {
public_image_metadata_ = public_image_metadata;
}
const base::Optional<proto::LoadingPredictorMetadata>&
loading_predictor_metadata() const {
return loading_predictor_metadata_;
}
void set_loading_predictor_metadata(
const proto::LoadingPredictorMetadata& loading_predictor_metadata) {
loading_predictor_metadata_ = loading_predictor_metadata;
}
private:
// Metadata applicable to the optimization type.
//
// Optimization types that are not specifically specified below will have
// metadata populated with this field.
base::Optional<proto::Any> any_metadata_;
// Only applicable for NOSCRIPT and RESOURCE_LOADING optimization types.
base::Optional<proto::PreviewsMetadata> previews_metadata_;
// Only applicable for the PERFORMANCE_HINTS optimization type.
base::Optional<proto::PerformanceHintsMetadata> performance_hints_metadata_;
// Only applicable for the COMPRESS_PUBLIC_IMAGES optimization type.
base::Optional<proto::PublicImageMetadata> public_image_metadata_;
// Only applicable for the LOADING_PREDICTOR optimization type.
base::Optional<proto::LoadingPredictorMetadata> loading_predictor_metadata_;
};
} // namespace optimization_guide
#endif // COMPONENTS_OPTIMIZATION_GUIDE_OPTIMIZATION_METADATA_H_
|
