ResourceLoadStatistics grandfathering happens much too often.
[WebKit-https.git] / Source / WebKit / UIProcess / Storage / ResourceLoadStatisticsPersistentStorage.h
1 /*
2  * Copyright (C) 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/Forward.h>
29 #include <wtf/MonotonicTime.h>
30 #include <wtf/RunLoop.h>
31 #include <wtf/WallTime.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35 class FileMonitor;
36 }
37
38 namespace WebKit {
39
40 class WebResourceLoadStatisticsStore;
41
42 class ResourceLoadStatisticsPersistentStorage {
43 public:
44     ResourceLoadStatisticsPersistentStorage(WebResourceLoadStatisticsStore&, const String& storageDirectoryPath);
45     ~ResourceLoadStatisticsPersistentStorage();
46
47     void initialize();
48     void clear();
49
50     void finishAllPendingWorkSynchronously();
51
52     void ref();
53     void deref();
54
55     enum class ForceImmediateWrite {
56         No,
57         Yes,
58     };
59     void scheduleOrWriteMemoryStore(ForceImmediateWrite);
60
61 private:
62     String storageDirectoryPath() const;
63     String resourceLogFilePath() const;
64
65     void startMonitoringDisk();
66     void stopMonitoringDisk();
67     void monitorDirectoryForNewStatistics();
68
69     void writeMemoryStoreToDisk();
70     void populateMemoryStoreFromDisk();
71     void excludeFromBackup() const;
72     void refreshMemoryStoreFromDisk();
73     void asyncWriteTimerFired();
74
75     WebResourceLoadStatisticsStore& m_memoryStore;
76     const String m_storageDirectoryPath;
77     RunLoop::Timer<ResourceLoadStatisticsPersistentStorage> m_asyncWriteTimer;
78     std::unique_ptr<WebCore::FileMonitor> m_fileMonitor;
79     WallTime m_lastStatisticsFileSyncTime;
80     MonotonicTime m_lastStatisticsWriteTime;
81     bool m_hasPendingWrite { false };
82 };
83
84 }