Changeset 229201 in webkit

Timestamp:

Mar 3, 2018 3:27:18 PM (6 years ago)

Author:

Brent Fulgham

Message:

Notify the NetworkProcess when a session is servicing an automation client
​https://bugs.webkit.org/show_bug.cgi?id=183306
<rdar://problem/37835783>

Reviewed by Brian Burg.

Network loads servicing WebDriver are done through an ephemeral session. While this is great
for protecting a developer's machine from sharing state with test runs, it has the unintended
effect of blocking certain logging operations.

We do not log content in ephemeral sessions to protect user privacy. However, ephemeral sessions
generated by WebDriver should participate in logging so that proper testing (with logging) can
be done.

This patch signals the NetworkProcess when an ephemeral session (created for automation purposes)
is created, so that it can allow logging.

• NetworkProcess/NetworkProcess.cpp:

(WebKit::NetworkProcess::destroySession): Remove controlled-by-automation entry.
(WebKit::NetworkProcess::sessionIsControlledByAutomation const): Added.
(WebKit::NetworkProcess::setSessionIsControlledByAutomation): Added.

• NetworkProcess/NetworkProcess.h:
• NetworkProcess/NetworkProcess.messages.in:
• NetworkProcess/NetworkResourceLoader.cpp:

(WebKit::NetworkResourceLoader::isAlwaysOnLoggingAllowed const): Checks if the relevant session
is servicing an automation client, and returns true if it is.

• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::WebPageProxy): Signal the network process if this page is being created
for an automation client.

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• NetworkProcess/NetworkProcess.cpp (modified) (2 diffs)
• NetworkProcess/NetworkProcess.h (modified) (3 diffs)
• NetworkProcess/NetworkProcess.messages.in (modified) (1 diff)
• NetworkProcess/NetworkResourceLoader.cpp (modified) (1 diff)
• UIProcess/WebPageProxy.cpp (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2018-03-03  Brent Fulgham  <bfulgham@apple.com>
+
+        Notify the NetworkProcess when a session is servicing an automation client
+        https://bugs.webkit.org/show_bug.cgi?id=183306
+        <rdar://problem/37835783>
+
+        Reviewed by Brian Burg.
+
+        Network loads servicing WebDriver are done through an ephemeral session. While this is great
+        for protecting a developer's machine from sharing state with test runs, it has the unintended
+        effect of blocking certain logging operations.
+
+        We do not log content in ephemeral sessions to protect user privacy. However, ephemeral sessions
+        generated by WebDriver should participate in logging so that proper testing (with logging) can
+        be done.
+
+        This patch signals the NetworkProcess when an ephemeral session (created for automation purposes)
+        is created, so that it can allow logging.
+
+        * NetworkProcess/NetworkProcess.cpp:
+        (WebKit::NetworkProcess::destroySession): Remove controlled-by-automation entry.
+        (WebKit::NetworkProcess::sessionIsControlledByAutomation const): Added.
+        (WebKit::NetworkProcess::setSessionIsControlledByAutomation): Added.
+        * NetworkProcess/NetworkProcess.h:
+        * NetworkProcess/NetworkProcess.messages.in:
+        * NetworkProcess/NetworkResourceLoader.cpp:
+        (WebKit::NetworkResourceLoader::isAlwaysOnLoggingAllowed const): Checks if the relevant session
+        is servicing an automation client, and returns true if it is.
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::WebPageProxy): Signal the network process if this page is being created
+        for an automation client.
+
 2018-03-02  Yusuke Suzuki  <utatane.tea@gmail.com>
 

trunk/Source/WebKit/NetworkProcess/NetworkProcess.cpp

@@ -326 +326 @@
 {
     SessionTracker::destroySession(sessionID);
+    m_sessionsControlledByAutomation.remove(sessionID);
 }
 
@@ -400 +401 @@
 }
 #endif
+
+bool NetworkProcess::sessionIsControlledByAutomation(PAL::SessionID sessionID) const
+{
+    return m_sessionsControlledByAutomation.contains(sessionID);
+}
+
+void NetworkProcess::setSessionIsControlledByAutomation(PAL::SessionID sessionID, bool controlled)
+{
+    if (controlled)
+        m_sessionsControlledByAutomation.add(sessionID);
+    else
+        m_sessionsControlledByAutomation.remove(sessionID);
+}
 
 static void fetchDiskCacheEntries(PAL::SessionID sessionID, OptionSet<WebsiteDataFetchOption> fetchOptions, Function<void (Vector<WebsiteData::Entry>)>&& completionHandler)

trunk/Source/WebKit/NetworkProcess/NetworkProcess.h

@@ -35 +35 @@
 #include <wtf/Forward.h>
 #include <wtf/Function.h>
+#include <wtf/HashSet.h>
 #include <wtf/MemoryPressureHandler.h>
 #include <wtf/NeverDestroyed.h>
@@ -152 +153 @@
     bool shouldLogCookieInformation() const { return m_logCookieInformation; }
 #endif
+
+    void setSessionIsControlledByAutomation(PAL::SessionID, bool);
+    bool sessionIsControlledByAutomation(PAL::SessionID) const;
 
 private:
@@ -259 +263 @@
     HashMap<uint64_t, WeakPtr<PreconnectTask>> m_waitingPreconnectTasks;
 #endif
+    HashSet<PAL::SessionID> m_sessionsControlledByAutomation;
 
 #if PLATFORM(COCOA)

trunk/Source/WebKit/NetworkProcess/NetworkProcess.messages.in

@@ -89 +89 @@
     RemovePrevalentDomains(PAL::SessionID sessionID, Vector<String> domainsWithInteraction);
 #endif
+
+    SetSessionIsControlledByAutomation(PAL::SessionID sessionID, bool controlled);
 }

trunk/Source/WebKit/NetworkProcess/NetworkResourceLoader.cpp

@@ -707 +707 @@
 bool NetworkResourceLoader::isAlwaysOnLoggingAllowed() const
 {
+    if (NetworkProcess::singleton().sessionIsControlledByAutomation(sessionID()))
+        return true;
+
     return sessionID().isAlwaysOnLoggingAllowed();
 }

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -1282 +1282 @@
     m_controlledByAutomation = controlled;
 
-    if (isValid())
-        m_process->send(Messages::WebPage::SetControlledByAutomation(controlled), m_pageID);
+    if (!isValid())
+        return;
+
+    m_process->send(Messages::WebPage::SetControlledByAutomation(controlled), m_pageID);
+    m_process->processPool().sendToNetworkingProcess(Messages::NetworkProcess::SetSessionIsControlledByAutomation(m_websiteDataStore->sessionID(), m_controlledByAutomation));
 }