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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright (C) 2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION) || ENABLE(NETWORK_CACHE_STALE_WHILE_REVALIDATE)
#include "NetworkCacheSpeculativeLoad.h"
#include "Logging.h"
#include "NetworkCache.h"
#include "NetworkLoad.h"
#include "NetworkProcess.h"
#include "NetworkSession.h"
#include <WebCore/HTTPStatusCodes.h>
#include <WebCore/NetworkStorageSession.h>
#include <pal/SessionID.h>
#include <wtf/RunLoop.h>
#include <wtf/TZoneMallocInlines.h>
namespace WebKit {
namespace NetworkCache {
using namespace WebCore;
WTF_MAKE_TZONE_ALLOCATED_IMPL(SpeculativeLoad);
SpeculativeLoad::SpeculativeLoad(Cache& cache, const GlobalFrameID& globalFrameID, const ResourceRequest& request, std::unique_ptr<NetworkCache::Entry> cacheEntryForValidation, std::optional<NavigatingToAppBoundDomain> isNavigatingToAppBoundDomain, bool allowPrivacyProxy, OptionSet<AdvancedPrivacyProtections> advancedPrivacyProtections, RevalidationCompletionHandler&& completionHandler)
: m_cache(cache)
, m_completionHandler(WTFMove(completionHandler))
, m_originalRequest(request)
, m_bufferedDataForCache(FragmentedSharedBuffer::create())
, m_cacheEntry(WTFMove(cacheEntryForValidation))
{
ASSERT(!m_cacheEntry || m_cacheEntry->needsValidation());
auto* networkSession = m_cache->networkProcess().networkSession(m_cache->sessionID());
if (!networkSession) {
RunLoop::protectedMain()->dispatch([completionHandler = WTFMove(m_completionHandler)]() mutable {
completionHandler(nullptr);
});
return;
}
NetworkLoadParameters parameters;
parameters.webPageProxyID = globalFrameID.webPageProxyID;
parameters.webPageID = globalFrameID.webPageID;
parameters.webFrameID = globalFrameID.frameID;
parameters.storedCredentialsPolicy = StoredCredentialsPolicy::Use;
parameters.contentSniffingPolicy = ContentSniffingPolicy::DoNotSniffContent;
parameters.contentEncodingSniffingPolicy = ContentEncodingSniffingPolicy::Default;
parameters.request = m_originalRequest;
parameters.isNavigatingToAppBoundDomain = isNavigatingToAppBoundDomain;
parameters.allowPrivacyProxy = allowPrivacyProxy;
parameters.advancedPrivacyProtections = advancedPrivacyProtections;
m_networkLoad = NetworkLoad::create(*this, WTFMove(parameters), *networkSession);
m_networkLoad->startWithScheduling();
}
SpeculativeLoad::~SpeculativeLoad()
{
ASSERT(!m_networkLoad);
}
void SpeculativeLoad::cancel()
{
if (!m_networkLoad)
return;
m_networkLoad->cancel();
m_networkLoad = nullptr;
m_completionHandler(nullptr);
}
void SpeculativeLoad::willSendRedirectedRequest(ResourceRequest&& request, ResourceRequest&& redirectRequest, ResourceResponse&& redirectResponse, CompletionHandler<void(WebCore::ResourceRequest&&)>&& completionHandler)
{
LOG(NetworkCacheSpeculativePreloading, "Speculative redirect %s -> %s", request.url().string().utf8().data(), redirectRequest.url().string().utf8().data());
std::optional<Seconds> maxAgeCap;
if (auto* networkStorageSession = m_cache->networkProcess().storageSession(m_cache->sessionID()))
maxAgeCap = networkStorageSession->maxAgeCacheCap(request);
m_cacheEntry = m_cache->storeRedirect(request, redirectResponse, redirectRequest, maxAgeCap);
// Create a synthetic cache entry if we can't store.
if (!m_cacheEntry)
m_cacheEntry = m_cache->makeRedirectEntry(request, redirectResponse, redirectRequest);
// Don't follow the redirect. The redirect target will be registered for speculative load when it is loaded.
didComplete();
completionHandler({ });
}
void SpeculativeLoad::didReceiveResponse(ResourceResponse&& receivedResponse, PrivateRelayed privateRelayed, ResponseCompletionHandler&& completionHandler)
{
m_response = receivedResponse;
m_privateRelayed = privateRelayed;
if (m_response.isMultipart())
m_bufferedDataForCache.reset();
bool validationSucceeded = m_response.httpStatusCode() == httpStatus304NotModified;
if (validationSucceeded && m_cacheEntry)
m_cacheEntry = m_cache->update(m_originalRequest, *m_cacheEntry, m_response, privateRelayed);
else
m_cacheEntry = nullptr;
completionHandler(PolicyAction::Use);
}
void SpeculativeLoad::didReceiveBuffer(const WebCore::FragmentedSharedBuffer& buffer, uint64_t reportedEncodedDataLength)
{
ASSERT(!m_cacheEntry);
if (m_bufferedDataForCache) {
// Prevent memory growth in case of streaming data.
const size_t maximumCacheBufferSize = 10 * 1024 * 1024;
if (m_bufferedDataForCache.size() + buffer.size() <= maximumCacheBufferSize)
m_bufferedDataForCache.append(buffer);
else
m_bufferedDataForCache.reset();
}
}
void SpeculativeLoad::didFinishLoading(const WebCore::NetworkLoadMetrics&)
{
if (m_didComplete)
return;
if (!m_cacheEntry && m_bufferedDataForCache) {
m_cacheEntry = m_cache->store(m_originalRequest, m_response, m_privateRelayed, m_bufferedDataForCache.get(), [](auto&& mappedBody) { });
// Create a synthetic cache entry if we can't store.
if (!m_cacheEntry && isStatusCodeCacheableByDefault(m_response.httpStatusCode()))
m_cacheEntry = m_cache->makeEntry(m_originalRequest, m_response, m_privateRelayed, m_bufferedDataForCache.take());
}
didComplete();
}
void SpeculativeLoad::didFailLoading(const ResourceError&)
{
if (m_didComplete)
return;
m_cacheEntry = nullptr;
didComplete();
}
void SpeculativeLoad::didComplete()
{
RELEASE_ASSERT(RunLoop::isMain());
if (m_didComplete)
return;
m_didComplete = true;
m_networkLoad = nullptr;
// Make sure speculatively revalidated resources do not get validated by the NetworkResourceLoader again.
if (m_cacheEntry)
m_cacheEntry->setNeedsValidation(false);
m_completionHandler(WTFMove(m_cacheEntry));
}
#if !LOG_DISABLED
static void dumpHTTPHeadersDiff(const HTTPHeaderMap& headersA, const HTTPHeaderMap& headersB)
{
auto aEnd = headersA.end();
for (auto it = headersA.begin(); it != aEnd; ++it) {
String valueB = headersB.get(it->key);
if (valueB.isNull())
LOG(NetworkCacheSpeculativePreloading, "* '%s' HTTP header is only in first request (value: %s)", it->key.utf8().data(), it->value.utf8().data());
else if (it->value != valueB)
LOG(NetworkCacheSpeculativePreloading, "* '%s' HTTP header differs in both requests: %s != %s", it->key.utf8().data(), it->value.utf8().data(), valueB.utf8().data());
}
auto bEnd = headersB.end();
for (auto it = headersB.begin(); it != bEnd; ++it) {
if (!headersA.contains(it->key))
LOG(NetworkCacheSpeculativePreloading, "* '%s' HTTP header is only in second request (value: %s)", it->key.utf8().data(), it->value.utf8().data());
}
}
#endif
bool requestsHeadersMatch(const ResourceRequest& speculativeValidationRequest, const ResourceRequest& actualRequest)
{
ASSERT(!actualRequest.isConditional());
ResourceRequest speculativeRequest = speculativeValidationRequest;
speculativeRequest.makeUnconditional();
if (speculativeRequest.httpHeaderFields() != actualRequest.httpHeaderFields()) {
LOG(NetworkCacheSpeculativePreloading, "Cannot reuse speculatively validated entry because HTTP headers used for validation do not match");
#if !LOG_DISABLED
dumpHTTPHeadersDiff(speculativeRequest.httpHeaderFields(), actualRequest.httpHeaderFields());
#endif
return false;
}
return true;
}
} // namespace NetworkCache
} // namespace WebKit
#endif // ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION) || ENABLE(NETWORK_CACHE_STALE_WHILE_REVALIDATE)
|
