First version of PerformanceObserver

Source/core/timing/PerformanceBase.cpp

 /*
  * Copyright (C) 2010 Google Inc. All rights reserved.
  * Copyright (C) 2012 Intel Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
@@ skipping 17 matching lines @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "core/timing/PerformanceBase.h"
 
 #include "core/dom/Document.h"
 #include "core/events/Event.h"
 #include "core/timing/PerformanceCompositeTiming.h"
+#include "core/timing/PerformanceObserver.h"
 #include "core/timing/PerformanceRenderTiming.h"
 #include "core/timing/PerformanceResourceTiming.h"
 #include "core/timing/PerformanceUserTiming.h"
 #include "platform/network/ResourceTimingInfo.h"
 #include "platform/weborigin/SecurityOrigin.h"
 #include "wtf/CurrentTime.h"
 
 namespace blink {
 
+using PerformanceObserverVector = HeapVector<Member<PerformanceObserver>>;
+
 static const size_t defaultResourceTimingBufferSize = 150;
 static const size_t defaultFrameTimingBufferSize = 150;
 
 PerformanceBase::PerformanceBase(double timeOrigin)
     : m_frameTimingBufferSize(defaultFrameTimingBufferSize)
     , m_resourceTimingBufferSize(defaultResourceTimingBufferSize)
     , m_timeOrigin(timeOrigin)
     , m_userTiming(nullptr)
+    , m_observerFilterOptions(PerformanceEntry::Invalid)
+    , m_deliverObservationsTimer(this, &PerformanceBase::deliverObservationsTimerFired)
 {
 }
 
 PerformanceBase::~PerformanceBase()
 {
 }
 
 const AtomicString& PerformanceBase::interfaceName() const
 {
     return EventTargetNames::Performance;
@@ skipping 16 matching lines @@
         entries.appendVector(m_userTiming->getMeasures());
     }
 
     std::sort(entries.begin(), entries.end(), PerformanceEntry::startTimeCompareLessThan);
     return entries;
 }
 
 PerformanceEntryVector PerformanceBase::getEntriesByType(const String& entryType)
 {
     PerformanceEntryVector entries;
+    PerformanceEntry::EntryType type = PerformanceEntry::toEntryTypeEnum(entryType);
 
-    if (equalIgnoringCase(entryType, "resource")) {
+    if (type == PerformanceEntry::Invalid)
+        return entries;
+
+    if (type == PerformanceEntry::Resource) {
         for (const auto& resource : m_resourceTimingBuffer)
             entries.append(resource);
     }
 
-    if (equalIgnoringCase(entryType, "composite")
-        || equalIgnoringCase(entryType, "render")) {
+    if (type == PerformanceEntry::Composite || type == PerformanceEntry::Render) {
         for (const auto& frame : m_frameTimingBuffer) {
-            if (equalIgnoringCase(entryType, frame->entryType())) {
+            if (type == frame->entryTypeEnum()) {
                 entries.append(frame);
             }
         }
     }
 
     if (m_userTiming) {
-        if (equalIgnoringCase(entryType, "mark"))
+        if (type == PerformanceEntry::Mark)
             entries.appendVector(m_userTiming->getMarks());
-        else if (equalIgnoringCase(entryType, "measure"))
+        else if (type == PerformanceEntry::Measure)
             entries.appendVector(m_userTiming->getMeasures());
     }
 
     std::sort(entries.begin(), entries.end(), PerformanceEntry::startTimeCompareLessThan);
     return entries;
 }
 
 PerformanceEntryVector PerformanceBase::getEntriesByName(const String& name, const String& entryType)
 {
     PerformanceEntryVector entries;
+    PerformanceEntry::EntryType type = PerformanceEntry::toEntryTypeEnum(entryType);
 
-    if (entryType.isNull() || equalIgnoringCase(entryType, "resource")) {
+    if (!entryType.isNull() && type == PerformanceEntry::Invalid)
+        return entries;
+
+    if (entryType.isNull() || type == PerformanceEntry::Resource) {
         for (const auto& resource : m_resourceTimingBuffer) {
             if (resource->name() == name)
                 entries.append(resource);
         }
     }
 
-    if (entryType.isNull() || equalIgnoringCase(entryType, "composite")
-        || equalIgnoringCase(entryType, "render")) {
+    if (entryType.isNull() || type == PerformanceEntry::Composite || type == PerformanceEntry::Render) {
         for (const auto& frame : m_frameTimingBuffer) {
             if (frame->name() == name && (entryType.isNull()
                 || equalIgnoringCase(entryType, frame->entryType()))) {
                 entries.append(frame);
             }
         }
     }
 
     if (m_userTiming) {
-        if (entryType.isNull() || equalIgnoringCase(entryType, "mark"))
+        if (entryType.isNull() || type == PerformanceEntry::Mark)
             entries.appendVector(m_userTiming->getMarks(name));
-        if (entryType.isNull() || equalIgnoringCase(entryType, "measure"))
+        if (entryType.isNull() || type == PerformanceEntry::Measure)
             entries.appendVector(m_userTiming->getMeasures(name));
     }
 
     std::sort(entries.begin(), entries.end(), PerformanceEntry::startTimeCompareLessThan);
     return entries;
 }
 
 void PerformanceBase::clearResourceTimings()
 {
     m_resourceTimingBuffer.clear();
@@ skipping 54 matching lines @@
     for (const ResourceResponse& response : redirectChain) {
         if (!passesTimingAllowCheck(response, initiatorSecurityOrigin, emptyAtom))
             return false;
     }
 
     return true;
 }
 
 void PerformanceBase::addResourceTiming(const ResourceTimingInfo& info)
 {
-    if (isResourceTimingBufferFull())
+    if (isResourceTimingBufferFull() && !hasObserverFor(PerformanceEntry::Resource))
         return;
     SecurityOrigin* securityOrigin = nullptr;
     if (ExecutionContext* context = executionContext())
         securityOrigin = context->securityOrigin();
     if (!securityOrigin)
         return;
 
     const ResourceResponse& finalResponse = info.finalResponse();
     bool allowTimingDetails = passesTimingAllowCheck(finalResponse, *securityOrigin, info.originalTimingAllowOrigin());
     double startTime = info.initialTime();
 
     if (info.redirectChain().isEmpty()) {
         PerformanceEntry* entry = PerformanceResourceTiming::create(info, timeOrigin(), startTime, allowTimingDetails);
-        addResourceTimingBuffer(entry);
+        addResourceTimingBuffer(*entry);
         return;
     }
 
     const Vector<ResourceResponse>& redirectChain = info.redirectChain();
     bool allowRedirectDetails = allowsTimingRedirect(redirectChain, finalResponse, *securityOrigin);
 
     if (!allowRedirectDetails) {
         ResourceLoadTiming* finalTiming = finalResponse.resourceLoadTiming();
         ASSERT(finalTiming);
         if (finalTiming)
             startTime = finalTiming->requestTime();
     }
 
     ResourceLoadTiming* lastRedirectTiming = redirectChain.last().resourceLoadTiming();
     ASSERT(lastRedirectTiming);
     double lastRedirectEndTime = lastRedirectTiming->receiveHeadersEnd();
 
     PerformanceEntry* entry = PerformanceResourceTiming::create(info, timeOrigin(), startTime, lastRedirectEndTime, allowTimingDetails, allowRedirectDetails);
-    addResourceTimingBuffer(entry);
+    notifyObserversOfEntry(*entry);
+    if (!isResourceTimingBufferFull())
+        addResourceTimingBuffer(*entry);
 }
 
-void PerformanceBase::addResourceTimingBuffer(PerformanceEntry* entry)
+void PerformanceBase::addResourceTimingBuffer(PerformanceEntry& entry)
 {
-    m_resourceTimingBuffer.append(entry);
+    m_resourceTimingBuffer.append(&entry);
 
     if (isResourceTimingBufferFull()) {
         dispatchEvent(Event::create(EventTypeNames::resourcetimingbufferfull));
         dispatchEvent(Event::create(EventTypeNames::webkitresourcetimingbufferfull));
     }
 }
 
 bool PerformanceBase::isResourceTimingBufferFull()
 {
     return m_resourceTimingBuffer.size() >= m_resourceTimingBufferSize;
 }
 
 void PerformanceBase::addRenderTiming(Document* initiatorDocument, unsigned sourceFrame, double startTime, double finishTime)
 {
-    if (isFrameTimingBufferFull())
+    if (isFrameTimingBufferFull() && !hasObserverFor(PerformanceEntry::Render))
         return;
 
     PerformanceEntry* entry = PerformanceRenderTiming::create(initiatorDocument, sourceFrame, startTime, finishTime);
-    addFrameTimingBuffer(entry);
+    notifyObserversOfEntry(*entry);
+    if (!isFrameTimingBufferFull())
+        addFrameTimingBuffer(*entry);
 }
 
 void PerformanceBase::addCompositeTiming(Document* initiatorDocument, unsigned sourceFrame, double startTime)
 {
-    if (isFrameTimingBufferFull())
+    if (isFrameTimingBufferFull() && !hasObserverFor(PerformanceEntry::Composite))
         return;
 
     PerformanceEntry* entry = PerformanceCompositeTiming::create(initiatorDocument, sourceFrame, startTime);
-    addFrameTimingBuffer(entry);
+    notifyObserversOfEntry(*entry);
+    if (!isFrameTimingBufferFull())
+        addFrameTimingBuffer(*entry);
 }
 
-void PerformanceBase::addFrameTimingBuffer(PerformanceEntry* entry)
+void PerformanceBase::addFrameTimingBuffer(PerformanceEntry& entry)
 {
-    m_frameTimingBuffer.append(entry);
+    m_frameTimingBuffer.append(&entry);
 
     if (isFrameTimingBufferFull())
         dispatchEvent(Event::create(EventTypeNames::frametimingbufferfull));
 }
 
 bool PerformanceBase::isFrameTimingBufferFull()
 {
     return m_frameTimingBuffer.size() >= m_frameTimingBufferSize;
 }
 
 void PerformanceBase::mark(const String& markName, ExceptionState& exceptionState)
 {
     if (!m_userTiming)
-        m_userTiming = UserTiming::create(this);
-    m_userTiming->mark(markName, exceptionState);
+        m_userTiming = UserTiming::create(*this);
+    PerformanceEntry* entry = m_userTiming->mark(markName, exceptionState);
+    if (entry)
+        notifyObserversOfEntry(*entry);
 }
 
 void PerformanceBase::clearMarks(const String& markName)
 {
     if (!m_userTiming)
-        m_userTiming = UserTiming::create(this);
+        m_userTiming = UserTiming::create(*this);
     m_userTiming->clearMarks(markName);
 }
 
 void PerformanceBase::measure(const String& measureName, const String& startMark, const String& endMark, ExceptionState& exceptionState)
 {
     if (!m_userTiming)
-        m_userTiming = UserTiming::create(this);
-    m_userTiming->measure(measureName, startMark, endMark, exceptionState);
+        m_userTiming = UserTiming::create(*this);
+    PerformanceEntry* entry = m_userTiming->measure(measureName, startMark, endMark, exceptionState);

[esprehn, 2015/08/20 08:33:48]

We usually combine the assignment into the if.

if (Type* thing = fn())
  use(thing)

[MikeB, 2015/08/25 19:42:42]

Done.

+    if (entry)
+        notifyObserversOfEntry(*entry);
 }
 
 void PerformanceBase::clearMeasures(const String& measureName)
 {
     if (!m_userTiming)
-        m_userTiming = UserTiming::create(this);
+        m_userTiming = UserTiming::create(*this);
     m_userTiming->clearMeasures(measureName);
 }
 
+void PerformanceBase::registerPerformanceObserver(PerformanceObserver& observer)
+{
+    m_observerFilterOptions |= observer.filterOptions();
+    m_observers.add(&observer);
+}
+
+void PerformanceBase::unregisterPerformanceObserver(PerformanceObserver& oldObserver)
+{
+    m_observers.remove(&oldObserver);
+    m_observerFilterOptions = PerformanceEntry::Invalid;
+    for (const auto& observer : m_observers) {
+        m_observerFilterOptions |= observer->filterOptions();
+    }
+}
+
+void PerformanceBase::notifyObserversOfEntry(PerformanceEntry& entry)
+{
+    for (auto& observer : m_observers) {
+        if (observer->filterOptions() & entry.entryTypeEnum())
+            observer->enqueuePerformanceEntry(entry);
+    }
+}
+
+bool PerformanceBase::hasObserverFor(PerformanceEntry::EntryType filterType)
+{
+    return m_observerFilterOptions & filterType;
+}
+
+void PerformanceBase::activateObserver(PerformanceObserver& observer)
+{
+    if (m_activeObservers.isEmpty())
+        m_deliverObservationsTimer.startOneShot(0, FROM_HERE);
+
+    m_activeObservers.add(&observer);
+}
+
+void PerformanceBase::resumeSuspendedObservers()
+{
+    ASSERT(isMainThread());
+    if (m_suspendedObservers.isEmpty())
+        return;
+
+    PerformanceObserverVector suspended;
+    copyToVector(m_suspendedObservers, suspended);
+    for (size_t i = 0; i < suspended.size(); ++i) {
+        if (!suspended[i]->shouldBeSuspended()) {
+            m_suspendedObservers.remove(suspended[i]);
+            activateObserver(*suspended[i]);
+        }
+    }
+}
+
+void PerformanceBase::deliverObservationsTimerFired(Timer<PerformanceBase>*)
+{
+    ASSERT(isMainThread());
+    PerformanceObserverVector observers;
+    copyToVector(m_activeObservers, observers);
+    m_activeObservers.clear();
+    for (size_t i = 0; i < observers.size(); ++i) {
+        if (observers[i]->shouldBeSuspended())
+            m_suspendedObservers.add(observers[i]);
+        else
+            observers[i]->deliver();
+    }
+}
+
 double PerformanceBase::now() const
 {
     double nowSeconds = monotonicallyIncreasingTime() - m_timeOrigin;
     const double resolutionSeconds = 0.000005;
     return 1000.0 * floor(nowSeconds / resolutionSeconds) * resolutionSeconds;
 }
 
 DEFINE_TRACE(PerformanceBase)
 {
     visitor->trace(m_frameTimingBuffer);
     visitor->trace(m_resourceTimingBuffer);
     visitor->trace(m_userTiming);
+    visitor->trace(m_observers);
+    visitor->trace(m_activeObservers);
+    visitor->trace(m_suspendedObservers);
     RefCountedGarbageCollectedEventTargetWithInlineData<PerformanceBase>::trace(visitor);
 }
 
 } // namespace blink