Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKit / UIProcess / SuspendedPageProxy.cpp
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "SuspendedPageProxy.h"
28
29 #include "Logging.h"
30 #include "WebPageMessages.h"
31 #include "WebPageProxy.h"
32 #include "WebPageProxyMessages.h"
33 #include "WebProcessMessages.h"
34 #include "WebProcessPool.h"
35 #include "WebProcessProxy.h"
36 #include <wtf/DebugUtilities.h>
37 #include <wtf/URL.h>
38
39 namespace WebKit {
40 using namespace WebCore;
41
42 #if !LOG_DISABLED
43 static const HashSet<IPC::StringReference>& messageNamesToIgnoreWhileSuspended()
44 {
45     static NeverDestroyed<HashSet<IPC::StringReference>> messageNames;
46     static std::once_flag onceFlag;
47     std::call_once(onceFlag, [] {
48         messageNames.get().add("BackForwardAddItem");
49         messageNames.get().add("ClearAllEditCommands");
50         messageNames.get().add("DidChangeContentSize");
51         messageNames.get().add("DidChangeMainDocument");
52         messageNames.get().add("DidChangeProgress");
53         messageNames.get().add("DidCommitLoadForFrame");
54         messageNames.get().add("DidDestroyNavigation");
55         messageNames.get().add("DidFinishDocumentLoadForFrame");
56         messageNames.get().add("DidFinishProgress");
57         messageNames.get().add("DidCompletePageTransition");
58         messageNames.get().add("DidFirstLayoutForFrame");
59         messageNames.get().add("DidFirstVisuallyNonEmptyLayoutForFrame");
60         messageNames.get().add("DidNavigateWithNavigationData");
61         messageNames.get().add("DidReachLayoutMilestone");
62         messageNames.get().add("DidRestoreScrollPosition");
63         messageNames.get().add("DidSaveToPageCache");
64         messageNames.get().add("DidStartProgress");
65         messageNames.get().add("DidStartProvisionalLoadForFrame");
66         messageNames.get().add("EditorStateChanged");
67         messageNames.get().add("PageExtendedBackgroundColorDidChange");
68         messageNames.get().add("SetRenderTreeSize");
69         messageNames.get().add("SetStatusText");
70         messageNames.get().add("SetNetworkRequestsInProgress");
71     });
72
73     return messageNames;
74 }
75 #endif
76
77 SuspendedPageProxy::SuspendedPageProxy(WebPageProxy& page, Ref<WebProcessProxy>&& process, WebBackForwardListItem& item, uint64_t mainFrameID)
78     : m_page(page)
79     , m_process(WTFMove(process))
80     , m_mainFrameID(mainFrameID)
81     , m_registrableDomain(toRegistrableDomain(URL(URL(), item.url())))
82 {
83     item.setSuspendedPage(this);
84     m_process->addMessageReceiver(Messages::WebPageProxy::messageReceiverName(), m_page.pageID(), *this);
85
86     m_process->send(Messages::WebPage::SetIsSuspended(true), m_page.pageID());
87 }
88
89 SuspendedPageProxy::~SuspendedPageProxy()
90 {
91     if (!m_isSuspended)
92         return;
93
94     // If the suspended page was not consumed before getting destroyed, then close the corresponding page
95     // on the WebProcess side.
96     m_process->send(Messages::WebPage::Close(), m_page.pageID());
97     m_process->removeMessageReceiver(Messages::WebPageProxy::messageReceiverName(), m_page.pageID());
98
99     // We call maybeShutDown() asynchronously since the SuspendedPage is currently being removed from the WebProcessPool
100     // and we want to avoid re-entering WebProcessPool methods.
101     RunLoop::main().dispatch([process = m_process.copyRef()] {
102         process->maybeShutDown();
103     });
104 }
105
106 void SuspendedPageProxy::unsuspend(CompletionHandler<void()>&& completionHandler)
107 {
108     ASSERT(m_isSuspended);
109
110     auto doUnsuspend = [this, completionHandler = WTFMove(completionHandler)]() mutable {
111         m_isSuspended = false;
112         m_process->removeMessageReceiver(Messages::WebPageProxy::messageReceiverName(), m_page.pageID());
113         m_process->send(Messages::WebPage::SetIsSuspended(false), m_page.pageID());
114         completionHandler();
115     };
116
117     if (!m_finishedSuspending) {
118         ASSERT(!m_finishedSuspendingHandler);
119         m_finishedSuspendingHandler = WTFMove(doUnsuspend);
120     } else
121         doUnsuspend();
122 }
123
124 void SuspendedPageProxy::didFinishLoad()
125 {
126     LOG(ProcessSwapping, "SuspendedPageProxy %s from process %i finished transition to suspended", loggingString(), m_process->processIdentifier());
127
128     m_finishedSuspending = true;
129
130     m_process->send(Messages::WebProcess::UpdateActivePages(), 0);
131
132     if (auto finishedSuspendingHandler = WTFMove(m_finishedSuspendingHandler))
133         finishedSuspendingHandler();
134 }
135
136 void SuspendedPageProxy::didReceiveMessage(IPC::Connection&, IPC::Decoder& decoder)
137 {
138     ASSERT(decoder.messageReceiverName() == Messages::WebPageProxy::messageReceiverName());
139
140     if (decoder.messageName() == Messages::WebPageProxy::DidFinishLoadForFrame::name()) {
141         didFinishLoad();
142         return;
143     }
144 #if !LOG_DISABLED
145     if (!messageNamesToIgnoreWhileSuspended().contains(decoder.messageName()))
146         LOG(ProcessSwapping, "SuspendedPageProxy received unexpected WebPageProxy message '%s'", decoder.messageName().toString().data());
147 #endif
148 }
149
150 void SuspendedPageProxy::didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&)
151 {
152 }
153
154 #if !LOG_DISABLED
155 const char* SuspendedPageProxy::loggingString() const
156 {
157     return debugString("(", String::format("%p", this), " page ID ", String::number(m_page.pageID()), ", m_finishedSuspending ", String::number(m_finishedSuspending), ")");
158 }
159 #endif
160
161 } // namespace WebKit