Support updating a service worker registration's updateViaCache flag
[WebKit-https.git] / Source / WebCore / workers / service / ServiceWorkerRegistration.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 "ActiveDOMObject.h"
31 #include "EventTarget.h"
32 #include "JSDOMPromiseDeferred.h"
33 #include "SWClientConnection.h"
34 #include "ServiceWorkerRegistrationData.h"
35
36 namespace WebCore {
37
38 class ScriptExecutionContext;
39 class ServiceWorker;
40 class ServiceWorkerContainer;
41
42 class ServiceWorkerRegistration final : public RefCounted<ServiceWorkerRegistration>, public EventTargetWithInlineData, public ActiveDOMObject {
43 public:
44     static Ref<ServiceWorkerRegistration> getOrCreate(ScriptExecutionContext&, Ref<ServiceWorkerContainer>&&, ServiceWorkerRegistrationData&&);
45
46     ~ServiceWorkerRegistration();
47
48     ServiceWorkerRegistrationIdentifier identifier() const { return m_registrationData.identifier; }
49
50     ServiceWorker* installing();
51     ServiceWorker* waiting();
52     ServiceWorker* active();
53
54     ServiceWorker* getNewestWorker();
55
56     const String& scope() const;
57
58     ServiceWorkerUpdateViaCache updateViaCache() const;
59     void setUpdateViaCache(ServiceWorkerUpdateViaCache);
60
61     WallTime lastUpdateTime() const;
62     void setLastUpdateTime(WallTime);
63
64     void update(Ref<DeferredPromise>&&);
65     void unregister(Ref<DeferredPromise>&&);
66
67     using RefCounted::ref;
68     using RefCounted::deref;
69     
70     const ServiceWorkerRegistrationData& data() const { return m_registrationData; }
71
72     void updateStateFromServer(ServiceWorkerRegistrationState, RefPtr<ServiceWorker>&&);
73     void scheduleTaskToFireUpdateFoundEvent();
74
75 private:
76     ServiceWorkerRegistration(ScriptExecutionContext&, Ref<ServiceWorkerContainer>&&, ServiceWorkerRegistrationData&&);
77     void updatePendingActivityForEventDispatch();
78
79     EventTargetInterface eventTargetInterface() const final;
80     ScriptExecutionContext* scriptExecutionContext() const final;
81     void refEventTarget() final { ref(); }
82     void derefEventTarget() final { deref(); }
83
84     // ActiveDOMObject.
85     const char* activeDOMObjectName() const final;
86     bool canSuspendForDocumentSuspension() const final;
87     void stop() final;
88
89     ServiceWorkerRegistrationData m_registrationData;
90     Ref<ServiceWorkerContainer> m_container;
91
92     RefPtr<ServiceWorker> m_installingWorker;
93     RefPtr<ServiceWorker> m_waitingWorker;
94     RefPtr<ServiceWorker> m_activeWorker;
95
96     bool m_isStopped { false };
97     RefPtr<PendingActivity<ServiceWorkerRegistration>> m_pendingActivityForEventDispatch;
98 };
99
100 } // namespace WebCore
101
102 #endif // ENABLE(SERVICE_WORKER)