Resource Load Statistics: Classify resources as prevalent based on redirects to other...
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadStatistics.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 "URL.h"
29 #include <wtf/HashCountedSet.h>
30 #include <wtf/HashSet.h>
31 #include <wtf/WallTime.h>
32 #include <wtf/text/StringHash.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace WebCore {
36
37 class KeyedDecoder;
38 class KeyedEncoder;
39
40 struct ResourceLoadStatistics {
41     explicit ResourceLoadStatistics(const String& primaryDomain)
42         : highLevelDomain(primaryDomain)
43     {
44     }
45
46     ResourceLoadStatistics() = default;
47
48     ResourceLoadStatistics(const ResourceLoadStatistics&) = delete;
49     ResourceLoadStatistics& operator=(const ResourceLoadStatistics&) = delete;
50     ResourceLoadStatistics(ResourceLoadStatistics&&) = default;
51     ResourceLoadStatistics& operator=(ResourceLoadStatistics&&) = default;
52
53     WEBCORE_EXPORT static String primaryDomain(const URL&);
54     WEBCORE_EXPORT static String primaryDomain(const String& host);
55
56     WEBCORE_EXPORT void encode(KeyedEncoder&) const;
57     WEBCORE_EXPORT bool decode(KeyedDecoder&);
58
59     String toString() const;
60
61     WEBCORE_EXPORT void merge(const ResourceLoadStatistics&);
62
63     String highLevelDomain;
64
65     WallTime lastSeen;
66     
67     // User interaction
68     bool hadUserInteraction { false };
69     // Timestamp. Default value is negative, 0 means it was reset.
70     WallTime mostRecentUserInteractionTime { WallTime::fromRawSeconds(-1) };
71     bool grandfathered { false };
72
73     // Storage access
74     HashSet<String> storageAccessUnderTopFrameOrigins;
75
76     // Top frame stats
77     HashCountedSet<String> topFrameUniqueRedirectsTo;
78     HashCountedSet<String> topFrameUniqueRedirectsFrom;
79
80     // Subframe stats
81     HashCountedSet<String> subframeUnderTopFrameOrigins;
82     
83     // Subresource stats
84     HashCountedSet<String> subresourceUnderTopFrameOrigins;
85     HashCountedSet<String> subresourceUniqueRedirectsTo;
86     HashCountedSet<String> subresourceUniqueRedirectsFrom;
87
88     // Prevalent resource stats
89     bool isPrevalentResource { false };
90     unsigned dataRecordsRemoved { 0 };
91     unsigned timesAccessedAsFirstPartyDueToUserInteraction { 0 };
92     unsigned timesAccessedAsFirstPartyDueToStorageAccessAPI { 0 };
93
94     // In-memory only
95     bool isMarkedForCookiePartitioning { false };
96     bool isMarkedForCookieBlocking { false };
97 };
98
99 } // namespace WebCore