fbf1a1f1f878d149ba73f0b00d024578d4c185e0
[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/HashSet.h>
31 #include <wtf/NeverDestroyed.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WTF {
35 class Lock;
36 class WorkQueue;
37 class WallTime;
38 }
39
40 namespace WebCore {
41
42 class Document;
43 class Frame;
44 class Page;
45 class ResourceRequest;
46 class ResourceResponse;
47 class URL;
48
49 struct ResourceLoadStatistics;
50
51 class ResourceLoadObserver {
52     friend class WTF::NeverDestroyed<ResourceLoadObserver>;
53 public:
54     WEBCORE_EXPORT static ResourceLoadObserver& shared();
55
56     WEBCORE_EXPORT void setShouldThrottleObserverNotifications(bool);
57     
58     void logFrameNavigation(const Frame&, const Frame& topFrame, const ResourceRequest& newRequest, const URL& redirectUrl);
59     void logSubresourceLoading(const Frame*, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
60     void logWebSocketLoading(const Frame*, const URL&);
61     void logUserInteractionWithReducedTimeResolution(const Document&);
62
63     WEBCORE_EXPORT String statisticsForOrigin(const String&);
64
65     WEBCORE_EXPORT void setNotificationCallback(WTF::Function<void (Vector<ResourceLoadStatistics>&&)>&&);
66
67     WEBCORE_EXPORT void clearState();
68 private:
69     ResourceLoadObserver();
70
71     bool shouldLog(Page*) const;
72     ResourceLoadStatistics& ensureResourceStatisticsForPrimaryDomain(const String&);
73
74     void scheduleNotificationIfNeeded();
75     void notifyObserver();
76     Vector<ResourceLoadStatistics> takeStatistics();
77
78     HashMap<String, ResourceLoadStatistics> m_resourceStatisticsMap;
79     HashMap<String, WTF::WallTime> m_lastReportedUserInteractionMap;
80     WTF::Function<void (Vector<ResourceLoadStatistics>&&)> m_notificationCallback;
81     Timer m_notificationTimer;
82
83     URL nonNullOwnerURL(const Document&) const;
84 };
85     
86 } // namespace WebCore