Add support for unregistering a service worker
[WebKit-https.git] / Source / WebCore / workers / service / server / SWServerRegistration.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 #if ENABLE(SERVICE_WORKER)
29
30 #include "SWServer.h"
31 #include "ServiceWorkerJobData.h"
32 #include "ServiceWorkerRegistrationData.h"
33 #include "Timer.h"
34 #include <wtf/Deque.h>
35 #include <wtf/Identified.h>
36
37 namespace WebCore {
38
39 class SWServer;
40 class SWServerWorker;
41 struct ExceptionData;
42 struct ServiceWorkerFetchResult;
43
44 class SWServerRegistration : public ThreadSafeIdentified<SWServerRegistration> {
45 public:
46     explicit SWServerRegistration(SWServer&, const ServiceWorkerRegistrationKey&);
47     SWServerRegistration(const SWServerRegistration&) = delete;
48     ~SWServerRegistration();
49
50     void enqueueJob(const ServiceWorkerJobData&);
51     void scriptFetchFinished(SWServer::Connection&, const ServiceWorkerFetchResult&);
52     void scriptContextFailedToStart(SWServer::Connection&, const String& workerID, const String& message);
53     void scriptContextStarted(SWServer::Connection&, uint64_t identifier, const String& workerID);
54     
55     ServiceWorkerRegistrationData data() const;
56
57 private:
58     void jobTimerFired();
59     void startNextJob();
60     void rejectCurrentJob(const ExceptionData&);
61     void resolveCurrentRegistrationJob(const ServiceWorkerRegistrationData&);
62     void resolveCurrentUnregistrationJob(bool unregistrationResult);
63     void startScriptFetchForCurrentJob();
64     void finishCurrentJob();
65
66     void runRegisterJob(const ServiceWorkerJobData&);
67     void runUnregisterJob(const ServiceWorkerJobData&);
68     void runUpdateJob(const ServiceWorkerJobData&);
69
70     void rejectWithExceptionOnMainThread(const ExceptionData&);
71     void resolveWithRegistrationOnMainThread();
72     void resolveWithUnregistrationResultOnMainThread(bool);
73     void startScriptFetchFromMainThread();
74     bool isEmpty();
75     SWServerWorker* getNewestWorker();
76
77     Deque<ServiceWorkerJobData> m_jobQueue;
78     std::unique_ptr<ServiceWorkerJobData> m_currentJob;
79
80     bool m_uninstalling { false };
81     std::unique_ptr<SWServerWorker> m_installingWorker;
82     std::unique_ptr<SWServerWorker> m_waitingWorker;
83     std::unique_ptr<SWServerWorker> m_activeWorker;
84     URL m_scopeURL;
85     std::optional<ServiceWorkerUpdateViaCache> m_updateViaCache;
86     
87     double m_lastUpdateTime { 0 };
88
89     Timer m_jobTimer;
90     SWServer& m_server;
91     ServiceWorkerRegistrationKey m_registrationKey;
92 };
93
94 } // namespace WebCore
95
96 #endif // ENABLE(SERVICE_WORKER)