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 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_HTTP_HTTP_NO_VARY_SEARCH_DATA_H_
#define NET_HTTP_HTTP_NO_VARY_SEARCH_DATA_H_
#include <stdint.h>
#include <string>
#include <vector>
#include "base/containers/flat_set.h"
#include "base/types/expected.h"
#include "net/base/net_export.h"
#include "net/base/pickle_traits.h"
#include "net/http/structured_headers.h"
#include "url/gurl.h"
namespace net {
class HttpResponseHeaders;
// Data extracted from No-Vary-Search header.
//
// This data can be used to determine which parts of the URL search
// can be ignored when comparing a request with a cached response.
class NET_EXPORT_PRIVATE HttpNoVarySearchData {
public:
enum class ParseErrorEnum {
kOk, // There is no No-Vary-Search header.
kDefaultValue, // Parsing is correct but led to default value - the header
// could be removed.
kNotDictionary, // Header value is not a dictionary.
kUnknownDictionaryKey, // Header value contains unknown dictionary keys.
kNonBooleanKeyOrder, // `key-order` is non-boolean.
kParamsNotStringList, // `params` is not a string list.
kExceptNotStringList, // `expect` is not a string list.
kExceptWithoutTrueParams, // `expect` specified without params set to true.
};
HttpNoVarySearchData(const HttpNoVarySearchData&);
HttpNoVarySearchData(HttpNoVarySearchData&&);
~HttpNoVarySearchData();
HttpNoVarySearchData& operator=(const HttpNoVarySearchData&);
HttpNoVarySearchData& operator=(HttpNoVarySearchData&&);
static HttpNoVarySearchData CreateFromNoVaryParams(
const std::vector<std::string>& no_vary_params,
bool vary_on_key_order);
static HttpNoVarySearchData CreateFromVaryParams(
const std::vector<std::string>& vary_params,
bool vary_on_key_order);
// Parse No-Vary-Search from response headers.
//
// Returns HttpNoVarySearchData if a correct No-Vary-Search header is present
// in the response headers or a ParseErrorEnum if the No-Vary-Search header is
// incorrect. If no No-Vary-Search is found, returns ParseErrorEnum::kOk.
static base::expected<HttpNoVarySearchData,
HttpNoVarySearchData::ParseErrorEnum>
ParseFromHeaders(const HttpResponseHeaders& response_headers);
bool operator==(const HttpNoVarySearchData& rhs) const;
// HttpNoVarySearchData objects can be used as a key in a map.
std::strong_ordering operator<=>(const HttpNoVarySearchData& rhs) const;
bool AreEquivalent(const GURL& a, const GURL& b) const;
const base::flat_set<std::string>& no_vary_params() const;
const base::flat_set<std::string>& vary_params() const;
bool vary_on_key_order() const;
bool vary_by_default() const;
private:
friend struct PickleTraits<HttpNoVarySearchData>;
HttpNoVarySearchData();
static base::expected<HttpNoVarySearchData,
HttpNoVarySearchData::ParseErrorEnum>
ParseNoVarySearchDictionary(const structured_headers::Dictionary& dict);
// LINT.IfChange(MagicNumber)
// Magic number for serialization. This should be updated whenever the number
// or types of member variables are changed. This will prevent accidental
// misinterpretation of data from a previous version.
//
// Generated by the command:
// echo "HttpNoVarySearchData version 1" | md5sum | cut -b 1-8
static constexpr uint32_t kMagicNumber = 0x652a610e;
// Query parameters which should be ignored when comparing a request
// to a cached response. This is empty if |vary_by_default_| is false.
base::flat_set<std::string> no_vary_params_;
// Query parameters which should be respected when comparing a request
// to a cached response, even if |vary_by_default_| is false. This is empty
// if |vary_by_default_| is true.
base::flat_set<std::string> vary_params_;
// If false, parameters with distinct keys can be reordered in order to find a
// cache hit.
bool vary_on_key_order_ = true;
// If true, all parameters are significant except those in |no_vary_params_|.
// If false, only parameters in |vary_params_| are significant.
bool vary_by_default_ = true;
// LINT.ThenChange(//net/http/http_no_vary_search_data.cc:Serialization)
};
// Permit WriteToPickle() and ReadValueFromPickle() to be used with
// HttpNoVarySearchData objects.
template <>
struct NET_EXPORT_PRIVATE PickleTraits<HttpNoVarySearchData> {
static void Serialize(base::Pickle& pickle,
const HttpNoVarySearchData& value);
static std::optional<HttpNoVarySearchData> Deserialize(
base::PickleIterator& iter);
static size_t PickleSize(const HttpNoVarySearchData& value);
};
} // namespace net
#endif // NET_HTTP_HTTP_NO_VARY_SEARCH_DATA_H_
|
