[Sensors] Align sensor reading updates and 'onchange' notification with rAF.

third_party/WebKit/Source/modules/sensor/SensorProxy.cpp

 // Copyright 2016 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 "modules/sensor/SensorProxy.h"
 
+#include "core/dom/Document.h"
+#include "core/dom/FrameRequestCallback.h"
 #include "core/frame/LocalFrame.h"
 #include "modules/sensor/SensorProviderProxy.h"
 #include "modules/sensor/SensorReading.h"
 #include "platform/mojo/MojoHelper.h"
 #include "public/platform/Platform.h"
+#include "wtf/CurrentTime.h"
 
 using namespace device::mojom::blink;
 
 namespace blink {
 
+class SensorFrameRequestCallback : public FrameRequestCallback {
+ public:
+  explicit SensorFrameRequestCallback(SensorProxy* sensorProxy)
+      : m_sensorProxy(sensorProxy) {}
+
+  void handleEvent(double highResTimeMs) override {
+    m_sensorProxy->onAnimationFrame(highResTimeMs * 0.001);
+  }
+
+  DEFINE_INLINE_VIRTUAL_TRACE() {
+    visitor->trace(m_sensorProxy);
+    FrameRequestCallback::trace(visitor);
+  }
+
+ private:
+  Member<SensorProxy> m_sensorProxy;
+};
+
 SensorProxy::SensorProxy(SensorType sensorType,
                          SensorProviderProxy* provider,
-                         Page* page,
+                         Document* document,
                          std::unique_ptr<SensorReadingFactory> readingFactory)
-    : PageVisibilityObserver(page),
+    : PageVisibilityObserver(document->page()),
       m_type(sensorType),
       m_mode(ReportingMode::CONTINUOUS),
       m_provider(provider),
       m_clientBinding(this),
       m_state(SensorProxy::Uninitialized),
       m_suspended(false),
+      m_document(document),
       m_readingFactory(std::move(readingFactory)),
       m_maximumFrequency(0.0),
-      m_timer(this, &SensorProxy::onTimerFired) {}
+      m_rafCallbackId(0),
+      m_lastRafTimestamp(0.0) {}
 
 SensorProxy::~SensorProxy() {}
 
 void SensorProxy::dispose() {
   m_clientBinding.Close();
 }
 
 DEFINE_TRACE(SensorProxy) {
+  visitor->trace(m_document);
+  visitor->trace(m_rafCallback);
   visitor->trace(m_reading);
   visitor->trace(m_observers);
   visitor->trace(m_provider);
   PageVisibilityObserver::trace(visitor);
 }
 
 void SensorProxy::addObserver(Observer* observer) {
   if (!m_observers.contains(observer))
     m_observers.add(observer);
 }
@@ skipping 38 matching lines @@
 }
 
 void SensorProxy::suspend() {
   DCHECK(isInitialized());
   if (m_suspended)
     return;
 
   m_sensor->Suspend();
   m_suspended = true;
 
-  if (usesPollingTimer())
-    updatePollingStatus();
+  if (isPollingBuffer())
+    processRAFQueue();
 
   for (Observer* observer : m_observers)
     observer->onSuspended();
 }
 
 void SensorProxy::resume() {
   DCHECK(isInitialized());
   if (!m_suspended)
     return;
 
   m_sensor->Resume();
   m_suspended = false;
 
-  if (usesPollingTimer())
-    updatePollingStatus();
+  if (isPollingBuffer())
+    processRAFQueue();
 }
 
 const SensorConfiguration* SensorProxy::defaultConfig() const {
   DCHECK(isInitialized());
   return m_defaultConfig.get();
 }
 
-bool SensorProxy::usesPollingTimer() const {
+bool SensorProxy::isPollingBuffer() const {
   return isInitialized() && (m_mode == ReportingMode::CONTINUOUS);
 }
 
-void SensorProxy::updateSensorReading() {
+void SensorProxy::updateSensorReading(double timestamp) {
   DCHECK(isInitialized());
   DCHECK(m_readingFactory);
   int readAttempts = 0;
   const int kMaxReadAttemptsCount = 10;
   device::SensorReading readingData;
   while (!tryReadFromBuffer(readingData)) {
     if (++readAttempts == kMaxReadAttemptsCount) {
       handleSensorError();
       return;
     }
   }
 
   m_reading = m_readingFactory->createSensorReading(readingData);
 
   for (Observer* observer : m_observers)
-    observer->onSensorReadingChanged();
+    observer->onSensorReadingChanged(timestamp);
 }
 
 void SensorProxy::RaiseError() {
   handleSensorError();
 }
 
 void SensorProxy::SensorReadingChanged() {
   DCHECK_EQ(ReportingMode::ON_CHANGE, m_mode);
-  updateSensorReading();
+  updateSensorReading(WTF::monotonicallyIncreasingTime());
 }
 
 void SensorProxy::pageVisibilityChanged() {
   if (!isInitialized())
     return;
 
   if (page()->visibilityState() != PageVisibilityStateVisible) {
     suspend();
   } else {
     resume();
   }
 }
 
 void SensorProxy::handleSensorError(ExceptionCode code,
                                     String sanitizedMessage,
                                     String unsanitizedMessage) {
   if (!Platform::current()) {
     // TODO(rockot): Remove this hack once renderer shutdown sequence is fixed.
     return;
   }
 
-  if (usesPollingTimer()) {  // Stop polling.
+  if (isPollingBuffer()) {  // Stop polling.
     m_frequenciesUsed.clear();
-    updatePollingStatus();
+    processRAFQueue();
   }
 
   m_state = Uninitialized;
   // The m_sensor.reset() will release all callbacks and its bound parameters,
   // therefore, handleSensorError accepts messages by value.
   m_sensor.reset();
   m_sharedBuffer.reset();
   m_sharedBufferHandle.reset();
   m_defaultConfig.reset();
   m_clientBinding.Close();
@@ skipping 37 matching lines @@
   m_maximumFrequency = params->maximum_frequency;
   DCHECK(m_maximumFrequency <= SensorConfiguration::kMaxAllowedFrequency);
 
   auto errorCallback =
       WTF::bind(&SensorProxy::handleSensorError, wrapWeakPersistent(this),
                 UnknownError, String("Internal error"), String());
   m_sensor.set_connection_error_handler(
       convertToBaseCallback(std::move(errorCallback)));
 
   m_state = Initialized;
+
+  if (isPollingBuffer())
+    m_rafCallback = new SensorFrameRequestCallback(this);
+
   for (Observer* observer : m_observers)
     observer->onSensorInitialized();
 }
 
 void SensorProxy::onAddConfigurationCompleted(
     double frequency,
     std::unique_ptr<Function<void(bool)>> callback,
     bool result) {
-  if (usesPollingTimer() && result) {
+  if (isPollingBuffer() && result) {
     m_frequenciesUsed.append(frequency);
-    updatePollingStatus();
+    std::sort(m_frequenciesUsed.begin(), m_frequenciesUsed.end());
+    processRAFQueue();
   }
 
   (*callback)(result);
 }
 
 void SensorProxy::onRemoveConfigurationCompleted(double frequency,
                                                  bool result) {
   if (!result)
     DVLOG(1) << "Failure at sensor configuration removal";
 
-  if (!usesPollingTimer())
+  if (!isPollingBuffer())
     return;
 
   size_t index = m_frequenciesUsed.find(frequency);
   if (index == kNotFound) {
     // Could happen e.g. if 'handleSensorError' was called before.
     return;
   }
 
   m_frequenciesUsed.remove(index);
-  updatePollingStatus();
+  processRAFQueue();
 }
 
 bool SensorProxy::tryReadFromBuffer(device::SensorReading& result) {
   DCHECK(isInitialized());
   const ReadingBuffer* buffer =
       static_cast<const ReadingBuffer*>(m_sharedBuffer.get());
   const device::OneWriterSeqLock& seqlock = buffer->seqlock.value();
   auto version = seqlock.ReadBegin();
   auto readingData = buffer->reading;
   if (seqlock.ReadRetry(version))
     return false;
   result = readingData;
   return true;
 }
 
-void SensorProxy::updatePollingStatus() {
-  DCHECK(usesPollingTimer());
+bool SensorProxy::processRAFQueue() {
+  DCHECK(isPollingBuffer());
+  if (m_rafCallbackId) {  // Cancel pending request.
+    m_document->cancelAnimationFrame(m_rafCallbackId);
+    m_rafCallbackId = 0;
+  }
 
-  if (m_suspended || m_frequenciesUsed.isEmpty()) {
-    m_timer.stop();
+  if (!m_suspended && !m_frequenciesUsed.isEmpty()) {
+    DCHECK(m_rafCallback);
+    m_rafCallbackId = m_document->requestAnimationFrame(m_rafCallback);
+    return true;
+  }
+
+  return false;
+}
+
+void SensorProxy::onAnimationFrame(double timestamp) {
+  DCHECK(isPollingBuffer());
+  m_rafCallbackId = 0;
+  if (!processRAFQueue())
     return;
-  }
-  // TODO(Mikhail): Consider using sorted queue instead of searching
-  // max element each time.
-  auto it =
-      std::max_element(m_frequenciesUsed.begin(), m_frequenciesUsed.end());
-  DCHECK_GT(*it, 0.0);
 
-  double repeatInterval = 1 / *it;
-  if (!m_timer.isActive() || m_timer.repeatInterval() != repeatInterval) {
-    updateSensorReading();
-    m_timer.startRepeating(repeatInterval, BLINK_FROM_HERE);
+  double minBufferPollingPeriod = 1 / m_frequenciesUsed.back();
+  if (timestamp - m_lastRafTimestamp >= minBufferPollingPeriod) {
+    m_lastRafTimestamp = timestamp;
+    updateSensorReading(timestamp);
   }
 }
 
-void SensorProxy::onTimerFired(TimerBase*) {
-  updateSensorReading();
-}
-
 }  // namespace blink