Resource Load Statistics: Report user interaction immediately, but only when needed
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadObserver.h
1 /*
2  * Copyright (C) 2016-2017 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "Timer.h"
29 #include <wtf/HashMap.h>
30 #include <wtf/NeverDestroyed.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WTF {
34 class Lock;
35 class WorkQueue;
36 class WallTime;
37 }
38
39 namespace WebCore {
40
41 class Document;
42 class Frame;
43 class Page;
44 class ResourceRequest;
45 class ResourceResponse;
46 class URL;
47
48 struct ResourceLoadStatistics;
49
50 class ResourceLoadObserver {
51     friend class WTF::NeverDestroyed<ResourceLoadObserver>;
52 public:
53     WEBCORE_EXPORT static ResourceLoadObserver& shared();
54
55     WEBCORE_EXPORT void setShouldThrottleObserverNotifications(bool);
56     
57     void logFrameNavigation(const Frame&, const Frame& topFrame, const ResourceRequest& newRequest);
58     void logSubresourceLoading(const Frame*, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
59     void logWebSocketLoading(const Frame*, const URL&);
60     void logUserInteractionWithReducedTimeResolution(const Document&);
61
62     WEBCORE_EXPORT String statisticsForOrigin(const String&);
63
64     WEBCORE_EXPORT void setNotificationCallback(WTF::Function<void (Vector<ResourceLoadStatistics>&&)>&&);
65
66     WEBCORE_EXPORT void clearState();
67 private:
68     ResourceLoadObserver();
69
70     bool shouldLog(Page*) const;
71     ResourceLoadStatistics& ensureResourceStatisticsForPrimaryDomain(const String&);
72
73     void scheduleNotificationIfNeeded();
74     void notifyObserver();
75     Vector<ResourceLoadStatistics> takeStatistics();
76
77     HashMap<String, ResourceLoadStatistics> m_resourceStatisticsMap;
78     HashMap<String, WTF::WallTime> m_lastReportedUserInteractionMap;
79     WTF::Function<void (Vector<ResourceLoadStatistics>&&)> m_notificationCallback;
80     Timer m_notificationTimer;
81 };
82     
83 } // namespace WebCore