File: respond_with_observer.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (107 lines) | stat: -rw-r--r-- 4,383 bytes parent folder | download | duplicates (5)
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
// Copyright 2014 The Chromium Authors
// 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_RESPOND_WITH_OBSERVER_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_RESPOND_WITH_OBSERVER_H_

#include "base/time/time.h"
#include "third_party/blink/public/mojom/service_worker/service_worker_error_type.mojom-blink-forward.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise.h"
#include "third_party/blink/renderer/core/dom/events/event_target.h"
#include "third_party/blink/renderer/core/execution_context/execution_context_lifecycle_observer.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/modules/service_worker/wait_until_observer.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"

namespace blink {

class ExecutionContext;
class ScriptState;
class ScriptValue;

// This is a base class to implement respondWith. The respondWith has the three
// types of results: fulfilled, rejected and not called. Derived classes for
// each event should implement the procedure of the three behaviors by
// overriding onResponseFulfilled, onResponseRejected and onNoResponse.
class MODULES_EXPORT RespondWithObserver
    : public GarbageCollected<RespondWithObserver>,
      public ExecutionContextClient {
 public:
  virtual ~RespondWithObserver() = default;

  template <typename IDLType, typename Derived>
  void RespondWith(ScriptState* script_state,
                   const ScriptPromise<IDLType>& script_promise,
                   ThenCallable<IDLType, Derived>* on_fulfill,
                   ExceptionState& exception_state) {
    if (!StartRespondWith(exception_state)) {
      return;
    }
    has_started_ = true;
    auto next_promise =
        script_promise.Then(script_state, on_fulfill,
                            MakeGarbageCollected<RespondWithReject>(this));
    // 3. `Add r to the extend lifetime promises.`
    // 4. `Increment the pending promises count by one.`
    // This is accomplised by WaitUntil().
    bool will_wait =
        observer_->WaitUntil(script_state, next_promise, exception_state);
    // If the WaitUntilObserver won't observe the response promise, the event
    // can end before the response result is reported back to the
    // ServiceWorkerContextClient, which it doesn't expect (e.g., for fetch
    // events, RespondToFetchEvent*() must be called before
    // DidHandleFetchEvent()). So WaitUntilObserver must observe the promise and
    // call our callbacks before it determines the event is done.
    DCHECK(will_wait);
  }

  void WillDispatchEvent();
  void DidDispatchEvent(ScriptState*, DispatchEventResult dispatch_result);
  // Called when the respondWith() promise was rejected.
  virtual void OnResponseRejected(mojom::ServiceWorkerResponseError) = 0;

  // Called when the event handler finished without calling respondWith().
  virtual void OnNoResponse(ScriptState*) = 0;

  void Trace(Visitor*) const override;

 protected:
  RespondWithObserver(ExecutionContext*, int event_id, WaitUntilObserver*);

  class RespondWithReject final
      : public ThenCallable<IDLAny, RespondWithReject, IDLPromise<IDLAny>> {
   public:
    explicit RespondWithReject(RespondWithObserver* observer)
        : observer_(observer) {}
    void Trace(Visitor* visitor) const final;
    ScriptPromise<IDLAny> React(ScriptState*, ScriptValue);

   private:
    Member<RespondWithObserver> observer_;
  };

  bool WaitUntil(ScriptState*,
                 const ScriptPromise<IDLUndefined>&,
                 ExceptionState&);

  const int event_id_;
  base::TimeTicks event_dispatch_time_;

 private:
  bool has_started_ = false;

  bool StartRespondWith(ExceptionState&);

  // RespondWith should ensure the ExtendableEvent is alive until the promise
  // passed to RespondWith is resolved. The lifecycle of the ExtendableEvent
  // is controlled by WaitUntilObserver, so not only
  // WaitUntilObserver::ThenFunction but RespondWith needs to have a strong
  // reference to the WaitUntilObserver.
  Member<WaitUntilObserver> observer_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_SERVICE_WORKER_RESPOND_WITH_OBSERVER_H_