Unreviewed, rolling out r220268.
[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 }
37
38 namespace WebCore {
39
40 class Document;
41 class Frame;
42 class Page;
43 class ResourceRequest;
44 class ResourceResponse;
45 class URL;
46
47 struct ResourceLoadStatistics;
48
49 class ResourceLoadObserver {
50     friend class WTF::NeverDestroyed<ResourceLoadObserver>;
51 public:
52     WEBCORE_EXPORT static ResourceLoadObserver& shared();
53
54     WEBCORE_EXPORT void setShouldThrottleObserverNotifications(bool);
55     
56     void logFrameNavigation(const Frame&, const Frame& topFrame, const ResourceRequest& newRequest);
57     void logSubresourceLoading(const Frame*, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
58     void logWebSocketLoading(const Frame*, const URL&);
59     void logUserInteractionWithReducedTimeResolution(const Document&);
60
61     WEBCORE_EXPORT String statisticsForOrigin(const String&);
62
63     WEBCORE_EXPORT void setNotificationCallback(WTF::Function<void (Vector<ResourceLoadStatistics>&&)>&&);
64
65 private:
66     ResourceLoadObserver();
67
68     bool shouldLog(Page*) const;
69     ResourceLoadStatistics& ensureResourceStatisticsForPrimaryDomain(const String&);
70
71     void scheduleNotificationIfNeeded();
72     void notificationTimerFired();
73     Vector<ResourceLoadStatistics> takeStatistics();
74
75     HashMap<String, ResourceLoadStatistics> m_resourceStatisticsMap;
76     WTF::Function<void (Vector<ResourceLoadStatistics>&&)> m_notificationCallback;
77     Timer m_notificationTimer;
78     bool m_shouldThrottleNotifications { true };
79 };
80     
81 } // namespace WebCore