Changeset 215044 in webkit

Timestamp:

Apr 6, 2017 11:32:47 AM (7 years ago)

Author:

Antti Koivisto

Message:

Implement testing mode for disk cache
​https://bugs.webkit.org/show_bug.cgi?id=170547

Reviewed by Andreas Kling.

Source/WebKit2:

Disable read timeouts and cache shrinking in TestRunner to eliminate potential sources of randomness.

Cache directories are deleted by TestRunner so lack of shrinking does not consume the disk.

This is enabled by the existing WKContextUseTestingNetworkSession SPI.

• NetworkProcess/cache/NetworkCache.cpp:

(WebKit::NetworkCache::Cache::initialize):

• NetworkProcess/cache/NetworkCache.h:
• NetworkProcess/cache/NetworkCacheStorage.cpp:

(WebKit::NetworkCache::Storage::open):
(WebKit::NetworkCache::Storage::Storage):
(WebKit::NetworkCache::Storage::dispatchReadOperation):
(WebKit::NetworkCache::Storage::shrinkIfNeeded):

• NetworkProcess/cache/NetworkCacheStorage.h:
• NetworkProcess/cocoa/NetworkProcessCocoa.mm:

(WebKit::NetworkProcess::platformInitializeNetworkProcessCocoa):

LayoutTests:

Enable a few disabled tests to see how it goes.

• platform/mac-wk2/TestExpectations:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/platform/mac-wk2/TestExpectations (modified) (1 diff)
• Source/WebKit2/ChangeLog (modified) (1 diff)
• Source/WebKit2/NetworkProcess/cache/NetworkCache.cpp (modified) (2 diffs)
• Source/WebKit2/NetworkProcess/cache/NetworkCache.h (modified) (2 diffs)
• Source/WebKit2/NetworkProcess/cache/NetworkCacheStorage.cpp (modified) (5 diffs)
• Source/WebKit2/NetworkProcess/cache/NetworkCacheStorage.h (modified) (3 diffs)
• Source/WebKit2/NetworkProcess/cocoa/NetworkProcessCocoa.mm (modified) (1 diff)
• Source/WebKit2/NetworkProcess/soup/NetworkProcessSoup.cpp (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2017-04-06  Antti Koivisto  <antti@apple.com>
+
+        Implement testing mode for disk cache
+        https://bugs.webkit.org/show_bug.cgi?id=170547
+
+        Reviewed by Andreas Kling.
+
+        Enable a few disabled tests to see how it goes.
+
+        * platform/mac-wk2/TestExpectations:
+
 2017-04-06  Romain Bellessort  <romain.bellessort@crf.canon.fr>
 

trunk/LayoutTests/platform/mac-wk2/TestExpectations

@@ -309 +309 @@
 webkit.org/b/151455 [ Release ] http/tests/xmlhttprequest/workers/methods-async.html [ Pass Timeout ]
 
-webkit.org/b/162945 http/tests/cache/disk-cache/disk-cache-request-max-stale.html [ Pass Failure ]
-
-webkit.org/b/162946 http/tests/cache/disk-cache/disk-cache-media.html [ Pass Failure ]
-
 webkit.org/b/150542 fast/forms/state-restore-per-form.html [ Pass Timeout ]
 

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2017-04-06  Antti Koivisto  <antti@apple.com>
+
+        Implement testing mode for disk cache
+        https://bugs.webkit.org/show_bug.cgi?id=170547
+
+        Reviewed by Andreas Kling.
+
+        Disable read timeouts and cache shrinking in TestRunner to eliminate potential sources of randomness.
+
+        Cache directories are deleted by TestRunner so lack of shrinking does not consume the disk.
+
+        This is enabled by the existing WKContextUseTestingNetworkSession SPI.
+
+        * NetworkProcess/cache/NetworkCache.cpp:
+        (WebKit::NetworkCache::Cache::initialize):
+        * NetworkProcess/cache/NetworkCache.h:
+        * NetworkProcess/cache/NetworkCacheStorage.cpp:
+        (WebKit::NetworkCache::Storage::open):
+        (WebKit::NetworkCache::Storage::Storage):
+        (WebKit::NetworkCache::Storage::dispatchReadOperation):
+        (WebKit::NetworkCache::Storage::shrinkIfNeeded):
+        * NetworkProcess/cache/NetworkCacheStorage.h:
+        * NetworkProcess/cocoa/NetworkProcessCocoa.mm:
+        (WebKit::NetworkProcess::platformInitializeNetworkProcessCocoa):
+
 2017-04-06  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebKit2/NetworkProcess/cache/NetworkCache.cpp

@@ -74 +74 @@
 #endif
 
-bool Cache::initialize(const String& cachePath, const Parameters& parameters)
-{
-    m_storage = Storage::open(cachePath);
+bool Cache::initialize(const String& cachePath, OptionSet<Option> options)
+{
+    m_storage = Storage::open(cachePath, options.contains(Option::TestingMode) ? Storage::Mode::Testing : Storage::Mode::Normal);
 
 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
-    if (parameters.enableNetworkCacheSpeculativeRevalidation) {
+    if (options.contains(Option::SpeculativeRevalidation)) {
         m_lowPowerModeNotifier = std::make_unique<WebCore::LowPowerModeNotifier>([this](bool isLowPowerModeEnabled) {
             ASSERT(WTF::isMainThread());
@@ -94 +94 @@
 #endif
 
-    if (parameters.enableEfficacyLogging)
+    if (options.contains(Option::EfficacyLogging))
         m_statistics = Statistics::open(cachePath);
 

trunk/Source/WebKit2/NetworkProcess/cache/NetworkCache.h

@@ -34 +34 @@
 #include <WebCore/ResourceResponse.h>
 #include <wtf/Function.h>
+#include <wtf/OptionSet.h>
 #include <wtf/text/WTFString.h>
 
@@ -95 +96 @@
     friend class WTF::NeverDestroyed<Cache>;
 public:
-    struct Parameters {
-        bool enableEfficacyLogging;
+    enum class Option {
+        EfficacyLogging,
+        // In testing mode we try to eliminate sources of randomness. Cache does not shrink and there are no read timeouts.
+        TestingMode,
 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
-        bool enableNetworkCacheSpeculativeRevalidation;
+        SpeculativeRevalidation,
 #endif
     };
-    bool initialize(const String& cachePath, const Parameters&);
+    bool initialize(const String& cachePath, OptionSet<Option>);
     void setCapacity(size_t);
 

trunk/Source/WebKit2/NetworkProcess/cache/NetworkCacheStorage.cpp

@@ -150 +150 @@
 }
 
-std::unique_ptr<Storage> Storage::open(const String& cachePath)
+std::unique_ptr<Storage> Storage::open(const String& cachePath, Mode mode)
 {
     ASSERT(RunLoop::isMain());
@@ -159 +159 @@
     if (!salt)
         return nullptr;
-    return std::unique_ptr<Storage>(new Storage(cachePath, *salt));
+    return std::unique_ptr<Storage>(new Storage(cachePath, mode, *salt));
 }
 
@@ -208 +208 @@
 }
 
-Storage::Storage(const String& baseDirectoryPath, Salt salt)
+Storage::Storage(const String& baseDirectoryPath, Mode mode, Salt salt)
     : m_basePath(baseDirectoryPath)
     , m_recordsPath(makeRecordsDirectoryPath(baseDirectoryPath))
+    , m_mode(mode)
     , m_salt(salt)
     , m_canUseSharedMemoryForBodyData(canUseSharedMemoryForPath(baseDirectoryPath))
@@ -574 +575 @@
     m_activeReadOperations.add(WTFMove(readOperationPtr));
 
-    // I/O pressure may make disk operations slow. If they start taking very long time we rather go to network.
-    const auto readTimeout = 1500ms;
-    m_readOperationTimeoutTimer.startOneShot(readTimeout);
+    // Avoid randomness during testing.
+    if (m_mode != Mode::Testing) {
+        // I/O pressure may make disk operations slow. If they start taking very long time we rather go to network.
+        const auto readTimeout = 1500ms;
+        m_readOperationTimeoutTimer.startOneShot(readTimeout);
+    }
 
     bool shouldGetBodyBlob = mayContainBlob(readOperation.key);
@@ -966 +970 @@
     ASSERT(RunLoop::isMain());
 
+    // Avoid randomness caused by cache shrinks.
+    if (m_mode == Mode::Testing)
+        return;
+
     if (approximateSize() > m_capacity)
         shrink();

trunk/Source/WebKit2/NetworkProcess/cache/NetworkCacheStorage.h

@@ -49 +49 @@
     WTF_MAKE_NONCOPYABLE(Storage);
 public:
-    static std::unique_ptr<Storage> open(const String& cachePath);
+    enum class Mode { Normal, Testing };
+    static std::unique_ptr<Storage> open(const String& cachePath, Mode);
 
     struct Record {
@@ -106 +107 @@
 
 private:
-    Storage(const String& directoryPath, Salt);
+    Storage(const String& directoryPath, Mode, Salt);
 
     String recordDirectoryPathForKey(const Key&) const;
@@ -146 +147 @@
     const String m_basePath;
     const String m_recordsPath;
-
+    
+    const Mode m_mode;
     const Salt m_salt;
-
     const bool m_canUseSharedMemoryForBodyData;
 

trunk/Source/WebKit2/NetworkProcess/cocoa/NetworkProcessCocoa.mm

@@ -113 +113 @@
 #if ENABLE(NETWORK_CACHE)
         if (parameters.shouldEnableNetworkCache) {
-            NetworkCache::Cache::Parameters cacheParameters = {
-                parameters.shouldEnableNetworkCacheEfficacyLogging
+            OptionSet<NetworkCache::Cache::Option> cacheOptions;
+            if (parameters.shouldEnableNetworkCacheEfficacyLogging)
+                cacheOptions |= NetworkCache::Cache::Option::EfficacyLogging;
+            if (parameters.shouldUseTestingNetworkSession)
+                cacheOptions |= NetworkCache::Cache::Option::TestingMode;
 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
-                , parameters.shouldEnableNetworkCacheSpeculativeRevalidation
-#endif
-            };
-            if (NetworkCache::singleton().initialize(m_diskCacheDirectory, cacheParameters)) {
+            if (parameters.shouldEnableNetworkCacheSpeculativeRevalidation)
+                cacheOptions |= NetworkCache::Cache::Option::SpeculativeRevalidation;
+#endif
+            if (NetworkCache::singleton().initialize(m_diskCacheDirectory, cacheOptions)) {
                 auto urlCache(adoptNS([[NSURLCache alloc] initWithMemoryCapacity:0 diskCapacity:0 diskPath:nil]));
                 [NSURLCache setSharedURLCache:urlCache.get()];

trunk/Source/WebKit2/NetworkProcess/soup/NetworkProcessSoup.cpp

@@ -113 +113 @@
     SoupNetworkSession::clearOldSoupCache(WebCore::directoryName(m_diskCacheDirectory));
 
-    NetworkCache::Cache::Parameters cacheParameters {
-        parameters.shouldEnableNetworkCacheEfficacyLogging
+    OptionSet<NetworkCache::Cache::Option> cacheOptions;
+    if (parameters.shouldEnableNetworkCacheEfficacyLogging)
+        cacheOptions |= NetworkCache::Cache::Option::EfficacyLogging;
 #if ENABLE(NETWORK_CACHE_SPECULATIVE_REVALIDATION)
-        , parameters.shouldEnableNetworkCacheSpeculativeRevalidation
+    if (parameters.shouldEnableNetworkCacheSpeculativeRevalidation)
+        cacheOptions |= NetworkCache::Cache::Option::SpeculativeRevalidation;
 #endif
-    };
-    NetworkCache::singleton().initialize(m_diskCacheDirectory, cacheParameters);
+
+    NetworkCache::singleton().initialize(m_diskCacheDirectory, cacheOptions);
 
     if (!parameters.cookiePersistentStoragePath.isEmpty()) {