1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_WAIT_UNTIL_OBSERVER_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_WAIT_UNTIL_OBSERVER_H_
#include "base/callback.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/modules/service_worker/service_worker_global_scope_client.h"
#include "third_party/blink/renderer/platform/timer.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
namespace blink {
class ExceptionState;
class ExecutionContext;
class ScriptPromise;
class ScriptState;
class ScriptValue;
// Created for each ExtendableEvent instance.
class MODULES_EXPORT WaitUntilObserver final
: public GarbageCollectedFinalized<WaitUntilObserver> {
public:
using PromiseSettledCallback =
base::RepeatingCallback<void(const ScriptValue&)>;
enum EventType {
kAbortPayment,
kActivate,
kCanMakePayment,
kCookieChange,
kFetch,
kInstall,
kMessage,
kNotificationClick,
kNotificationClose,
kPaymentRequest,
kPush,
kSync,
kBackgroundFetchAbort,
kBackgroundFetchClick,
kBackgroundFetchFail,
kBackgroundFetched
};
static WaitUntilObserver* Create(ExecutionContext*, EventType, int event_id);
// Must be called before dispatching the event.
void WillDispatchEvent();
// Must be called after dispatching the event. If |event_dispatch_failed| is
// true, then DidDispatchEvent() immediately reports to
// ServiceWorkerGlobalScopeClient that the event finished, without waiting for
// all waitUntil promises to settle.
void DidDispatchEvent(bool event_dispatch_failed);
// Observes the promise and delays reporting to ServiceWorkerGlobalScopeClient
// that the event completed until the given promise is resolved or rejected.
// WaitUntil may be called multiple times. The event is extended until all
// promises have settled.
// If provided, |on_promise_fulfilled| or |on_promise_rejected| is invoked
// once |script_promise| fulfills or rejects. This enables the caller to do
// custom handling.
void WaitUntil(
ScriptState*,
ScriptPromise /* script_promise */,
ExceptionState&,
PromiseSettledCallback on_promise_fulfilled = PromiseSettledCallback(),
PromiseSettledCallback on_promise_rejected = PromiseSettledCallback());
virtual void Trace(blink::Visitor*);
private:
friend class InternalsServiceWorker;
class ThenFunction;
enum class EventDispatchState {
// Event dispatch has not yet started.
kInitial,
// Event dispatch has started but not yet finished.
kDispatching,
// Event dispatch completed. There may still be outstanding waitUntil
// promises that must settle before notifying ServiceWorkerGlobalScopeClient
// that the event finished.
kDispatched,
// Event dispatch failed. Any outstanding waitUntil promises are ignored.
kFailed
};
WaitUntilObserver(ExecutionContext*, EventType, int event_id);
void IncrementPendingPromiseCount();
void DecrementPendingPromiseCount();
// Enqueued as a microtask when a promise passed to a waitUntil() call that is
// associated with this observer was fulfilled.
void OnPromiseFulfilled();
// Enqueued as a microtask when a promise passed to a waitUntil() call that is
// associated with this observer was rejected.
void OnPromiseRejected();
void ConsumeWindowInteraction(TimerBase*);
void MaybeCompleteEvent();
Member<ExecutionContext> execution_context_;
EventType type_;
int event_id_;
int pending_promises_ = 0;
EventDispatchState event_dispatch_state_ = EventDispatchState::kInitial;
bool has_rejected_promise_ = false;
double event_dispatch_time_ = 0;
TaskRunnerTimer<WaitUntilObserver> consume_window_interaction_timer_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_WAIT_UNTIL_OBSERVER_H_
|
