c026b2f89fe883299bd77830e8abf8fdafb8e7d9
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadObserver.h
1 /*
2  * Copyright (C) 2016-2019 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 "CanvasActivityRecord.h"
29 #include "ResourceLoadStatistics.h"
30 #include "Timer.h"
31 #include <wtf/HashMap.h>
32 #include <wtf/HashSet.h>
33 #include <wtf/NeverDestroyed.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WTF {
37 class Lock;
38 class WorkQueue;
39 class WallTime;
40 }
41
42 namespace PAL {
43 class SessionID;
44 }
45
46 namespace WebCore {
47
48 class Document;
49 class Frame;
50 class Page;
51 class ResourceRequest;
52 class ResourceResponse;
53 class ScriptExecutionContext;
54
55 struct ResourceLoadStatistics;
56
57 class ResourceLoadObserver {
58     friend class WTF::NeverDestroyed<ResourceLoadObserver>;
59 public:
60     WEBCORE_EXPORT static ResourceLoadObserver& shared();
61
62     void logSubresourceLoading(const Frame*, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
63     void logWebSocketLoading(const URL& targetURL, const URL& mainFrameURL, PAL::SessionID);
64     void logUserInteractionWithReducedTimeResolution(const Document&);
65     
66     void logFontLoad(const Document&, const String& familyName, bool loadStatus);
67     void logCanvasRead(const Document&);
68     void logCanvasWriteOrMeasure(const Document&, const String& textWritten);
69     void logNavigatorAPIAccessed(const Document&, const ResourceLoadStatistics::NavigatorAPI);
70     void logScreenAPIAccessed(const Document&, const ResourceLoadStatistics::ScreenAPI);
71
72     WEBCORE_EXPORT String statisticsForOrigin(const String&);
73
74     WEBCORE_EXPORT void setNotificationCallback(WTF::Function<void (Vector<ResourceLoadStatistics>&&)>&&);
75     WEBCORE_EXPORT void setRequestStorageAccessUnderOpenerCallback(WTF::Function<void(const String&, uint64_t, const String&)>&&);
76     WEBCORE_EXPORT void setLogUserInteractionNotificationCallback(WTF::Function<void(PAL::SessionID, const String&)>&&);
77     WEBCORE_EXPORT void setLogWebSocketLoadingNotificationCallback(WTF::Function<void(PAL::SessionID, const String&, const String&, WallTime)>&&);
78     WEBCORE_EXPORT void setLogSubresourceLoadingNotificationCallback(WTF::Function<void(PAL::SessionID, const String&, const String&, WallTime)>&&);
79     WEBCORE_EXPORT void setLogSubresourceRedirectNotificationCallback(WTF::Function<void(PAL::SessionID, const String&, const String&)>&&);
80
81     WEBCORE_EXPORT void notifyObserver();
82     WEBCORE_EXPORT void clearState();
83
84 #if ENABLE(RESOURCE_LOAD_STATISTICS) && !RELEASE_LOG_DISABLED
85     bool shouldLogUserInteraction() const { return m_shouldLogUserInteraction; }
86     void setShouldLogUserInteraction(bool shouldLogUserInteraction) { m_shouldLogUserInteraction = shouldLogUserInteraction; }
87 #endif
88
89 private:
90     ResourceLoadObserver();
91
92     bool shouldLog(bool usesEphemeralSession) const;
93     ResourceLoadStatistics& ensureResourceStatisticsForPrimaryDomain(const String&);
94
95     void scheduleNotificationIfNeeded();
96     Vector<ResourceLoadStatistics> takeStatistics();
97
98 #if ENABLE(RESOURCE_LOAD_STATISTICS)
99     void requestStorageAccessUnderOpener(const String& domainInNeedOfStorageAccess, uint64_t openerPageID, Document& openerDocument);
100 #endif
101
102     HashMap<String, ResourceLoadStatistics> m_resourceStatisticsMap;
103     HashMap<String, WTF::WallTime> m_lastReportedUserInteractionMap;
104     Function<void(Vector<ResourceLoadStatistics>&&)> m_notificationCallback;
105     Function<void(const String&, uint64_t, const String&)> m_requestStorageAccessUnderOpenerCallback;
106     Function<void(PAL::SessionID, const String&)> m_logUserInteractionNotificationCallback;
107     Function<void(PAL::SessionID, const String&, const String&, WallTime)> m_logWebSocketLoadingNotificationCallback;
108     Function<void(PAL::SessionID, const String&, const String&, WallTime)> m_logSubresourceLoadingNotificationCallback;
109     Function<void(PAL::SessionID, const String&, const String&)> m_logSubresourceRedirectNotificationCallback;
110
111     Timer m_notificationTimer;
112 #if ENABLE(RESOURCE_LOAD_STATISTICS) && !RELEASE_LOG_DISABLED
113     uint64_t m_loggingCounter { 0 };
114     bool m_shouldLogUserInteraction { false };
115 #endif
116
117     URL nonNullOwnerURL(const Document&) const;
118 };
119     
120 } // namespace WebCore