Emulation.setVirtualTimePolicy to have an optional virtual time budge

third_party/WebKit/Source/web/InspectorEmulationAgent.cpp

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "web/InspectorEmulationAgent.h"
 
 #include "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/Settings.h"
 #include "core/page/Page.h"
 #include "platform/geometry/DoubleRect.h"
+#include "public/platform/Platform.h"
+#include "public/platform/WebThread.h"
 #include "public/platform/WebViewScheduler.h"
 #include "web/DevToolsEmulator.h"
 #include "web/WebLocalFrameImpl.h"
 #include "web/WebViewImpl.h"
 
 namespace blink {
 
 namespace EmulationAgentState {
 static const char scriptExecutionDisabled[] = "scriptExecutionDisabled";
 static const char touchEventEmulationEnabled[] = "touchEventEmulationEnabled";
 static const char emulatedMedia[] = "emulatedMedia";
 }
 
 InspectorEmulationAgent* InspectorEmulationAgent::create(WebLocalFrameImpl* webLocalFrameImpl, Client* client)
 {
     return new InspectorEmulationAgent(webLocalFrameImpl, client);
 }
 
 InspectorEmulationAgent::InspectorEmulationAgent(WebLocalFrameImpl* webLocalFrameImpl, Client* client)
     : m_webLocalFrameImpl(webLocalFrameImpl)
+    , m_virtualTimeEnabled(false)
     , m_client(client)
 {
 }
 
 InspectorEmulationAgent::~InspectorEmulationAgent()
 {
 }
 
 WebViewImpl* InspectorEmulationAgent::webViewImpl()
 {
@@ skipping 44 matching lines @@
 {
     m_state->setString(EmulationAgentState::emulatedMedia, media);
     webViewImpl()->page()->settings().setMediaTypeOverride(media);
 }
 
 void InspectorEmulationAgent::setCPUThrottlingRate(ErrorString*, double throttlingRate)
 {
     m_client->setCPUThrottlingRate(throttlingRate);
 }
 
-void InspectorEmulationAgent::setVirtualTimePolicy(ErrorString*, const String& in_policy)
+void InspectorEmulationAgent::setVirtualTimePolicy(ErrorString*, const String& in_policy, const Maybe<double>& in_virtualTimeBudgetSeconds)
 {
     if (protocol::Emulation::VirtualTimePolicyEnum::Advance == in_policy) {
-        m_webLocalFrameImpl->view()->scheduler()->enableVirtualTime();
         m_webLocalFrameImpl->view()->scheduler()->setVirtualTimePolicy(WebViewScheduler::VirtualTimePolicy::ADVANCE);
     } else if (protocol::Emulation::VirtualTimePolicyEnum::Pause == in_policy) {
-        m_webLocalFrameImpl->view()->scheduler()->enableVirtualTime();
         m_webLocalFrameImpl->view()->scheduler()->setVirtualTimePolicy(WebViewScheduler::VirtualTimePolicy::PAUSE);
     } else if (protocol::Emulation::VirtualTimePolicyEnum::PauseIfNetworkFetchesPending == in_policy) {
+        m_webLocalFrameImpl->view()->scheduler()->setVirtualTimePolicy(WebViewScheduler::VirtualTimePolicy::DETERMINISTIC_LOADING);
+    }
+    if (!m_virtualTimeEnabled) {
         m_webLocalFrameImpl->view()->scheduler()->enableVirtualTime();
-        m_webLocalFrameImpl->view()->scheduler()->setVirtualTimePolicy(WebViewScheduler::VirtualTimePolicy::DETERMINISTIC_LOADING);
+        m_virtualTimeEnabled = true;

[dgozman, 2016/08/01 16:03:31]

Should we instead make enableVirtualTime() idempotent and remove this flag?

[alex clarke (OOO till 29th), 2016/08/01 16:45:24]

Actually it is idempotent already. We can remove the flag :)

+    }
+
+    if (in_virtualTimeBudgetSeconds.isJust()) {

[dgozman, 2016/08/01 16:03:31]

What happens if client calls setVirtualTimePolicy twice, with different budgets
or policies? Let's maybe cancel previous timer?

[alex clarke (OOO till 29th), 2016/08/01 16:45:23]

Canceling the previous timer seems like the best approach.

+        WebTaskRunner* taskRunner = Platform::current()->currentThread()->getWebTaskRunner();
+        long long delayMillis = static_cast<long long>(in_virtualTimeBudgetSeconds.fromJust() * 1000.0);

[dgozman, 2016/08/01 16:03:31]

Let's make it milliseconds in protocol.

[alex clarke (OOO till 29th), 2016/08/01 16:45:24]

Done.

+        taskRunner->postDelayedTask(BLINK_FROM_HERE, WTF::bind(&InspectorEmulationAgent::virtualTimeBudgetExpired, wrapPersistent(this)), delayMillis);

[dgozman, 2016/08/01 16:03:31]

Can we use weak pointer here? If client detaches before this fires, we will have
a bunch of null pointer dereferences.

[alex clarke (OOO till 29th), 2016/08/01 16:45:23]

Good point.  Using CancellableTaskFactory here does that (it's based on
WeakPtr).

     }
 }
 
+void InspectorEmulationAgent::virtualTimeBudgetExpired()
+{
+    m_webLocalFrameImpl->view()->scheduler()->setVirtualTimePolicy(WebViewScheduler::VirtualTimePolicy::PAUSE);
+    frontend()->virtualTimeBudgetExpired();
+}
+
 DEFINE_TRACE(InspectorEmulationAgent)
 {
     visitor->trace(m_webLocalFrameImpl);
     InspectorBaseAgent::trace(visitor);
 }
 
 } // namespace blink