File: patch.cc

package info (click to toggle)
chromium 141.0.7390.107-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,254,812 kB
  • sloc: cpp: 35,264,957; ansic: 7,169,920; javascript: 4,250,185; python: 1,460,636; asm: 950,788; xml: 751,751; pascal: 187,972; sh: 89,459; perl: 88,691; objc: 79,953; sql: 53,924; cs: 44,622; fortran: 24,137; makefile: 22,319; tcl: 15,277; php: 14,018; yacc: 8,995; ruby: 7,553; awk: 3,720; lisp: 3,096; lex: 1,330; ada: 727; jsp: 228; sed: 36
file content (263 lines) | stat: -rw-r--r-- 9,636 bytes parent folder | download
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "third_party/blink/renderer/core/patching/patch.h"

#include "net/http/http_status_code.h"
#include "services/network/public/cpp/header_util.h"
#include "services/network/public/mojom/fetch_api.mojom-data-view.h"
#include "third_party/blink/renderer/bindings/core/v8/idl_types.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise.h"
#include "third_party/blink/renderer/bindings/core/v8/script_value.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_binding_for_core.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_throw_dom_exception.h"
#include "third_party/blink/renderer/core/dom/abstract_range.h"
#include "third_party/blink/renderer/core/dom/document_fragment.h"
#include "third_party/blink/renderer/core/dom/dom_exception.h"
#include "third_party/blink/renderer/core/dom/events/event.h"
#include "third_party/blink/renderer/core/dom/mutation_observer.h"
#include "third_party/blink/renderer/core/dom/parser_content_policy.h"
#include "third_party/blink/renderer/core/event_type_names.h"
#include "third_party/blink/renderer/core/html/html_template_element.h"
#include "third_party/blink/renderer/core/html/parser/html_document_parser.h"
#include "third_party/blink/renderer/core/html/parser/text_resource_decoder.h"
#include "third_party/blink/renderer/core/loader/threadable_loader.h"
#include "third_party/blink/renderer/core/loader/threadable_loader_client.h"
#include "third_party/blink/renderer/core/patching/patch_event.h"
#include "third_party/blink/renderer/core/patching/patch_supplement.h"
#include "third_party/blink/renderer/platform/bindings/exception_code.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/bindings/script_state.h"
#include "third_party/blink/renderer/platform/bindings/script_wrappable.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/visitor.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_request.h"
#include "third_party/blink/renderer/platform/loader/fetch/text_resource_decoder_options.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/wtf/text/atomic_string.h"
#include "v8-exception.h"
#include "v8-isolate.h"

namespace blink {
// static
Patch* Patch::Create(ContainerNode& target,
                     HTMLTemplateElement* source,
                     const KURL& source_url,
                     Node* previous_child,
                     Node* next_child) {
  return MakeGarbageCollected<Patch>(source, target, source_url, previous_child,
                                     next_child);
}

Patch::Patch(HTMLTemplateElement* source,
             ContainerNode& target,
             const KURL& source_url,
             Node* previous_child,
             Node* next_child)
    : source_(source),
      target_(target),
      previous_child_(previous_child),
      next_child_(next_child),
      finished_(
          MakeGarbageCollected<ScriptPromiseProperty<IDLUndefined, IDLAny>>(
              target.GetDocument().GetExecutionContext())),
      source_url_(source_url) {}

ScriptPromise<IDLUndefined> Patch::finished(ScriptState* script_state) {
  return finished_->Promise(script_state->World());
}

void Patch::Start() {
  if (state_ != State::kPending) {
    return;
  }
  // A patch replaces the existing children of the target.
  MutationObserver::EnqueuePatch(*this);
  PatchSupplement::From(GetDocument())->DidStart(*target_, this);
  Commit();
}

void Patch::Commit() {
  state_ = State::kActive;
  loader_.Clear();
  if (!next_child_ && !previous_child_) {
    target_->RemoveChildren();
  } else {
    while (true) {
      Node* next = previous_child_ ? previous_child_->nextSibling()
                                   : target_->firstChild();
      if (!next || next == next_child_) {
        break;
      }
      target_->RemoveChild(next);
    }
    if (next_child_) {
      buffer_fragment_ = DocumentFragment::Create(GetDocument());
    }
  }

  parser_ = MakeGarbageCollected<HTMLDocumentParser>(
      buffer_fragment_ ? buffer_fragment_ : target_,
      target_->IsElementNode() ? &To<Element>(*target_)
                               : target_->parentElement(),
      ParserContentPolicy::kDisallowScriptingAndPluginContent,
      ParserPrefetchPolicy::kDisallowPrefetching);
}

void Patch::DispatchPatchEvent() {
  Event* event =
      MakeGarbageCollected<PatchEvent>(event_type_names::kPatch, this);
  event->SetTarget(target_);
  target_->DispatchEvent(*event);
}

void Patch::Finish() {
  if (state_ == State::kTerminated) {
    return;
  }

  parser_->Finish();

  // TODO(nrosenthal): see if we can also stream between.
  if (buffer_fragment_) {
    CHECK(next_child_);

    // We need to check that this InsertBefore is still valid.
    // Since patching is an async operation, the child we use as the
    // insertBefore reference might no longer be connected or no longer the
    // child of this parent. In that case, we reject the patch's promise with
    // the error thrown by the DOM operation.
    v8::Isolate* isolate = GetDocument().GetExecutionContext()->GetIsolate();
    ExceptionState exception_state(isolate);
    TryRethrowScope rethrow(isolate, exception_state);
    target_->InsertBefore(buffer_fragment_.Release(), next_child_,
                          exception_state);
    if (rethrow.HasCaught()) {
      Terminate(ScriptValue(isolate, rethrow.GetException()));
      return;
    }
  }

  if (!source_url_.IsEmpty()) {
    state_ = State::kPending;
    // TODO(nrosenthal): start fetching earlier and buffer the response if
    // races with inline content
    Fetch();
    return;
  }

  state_ = State::kFinished;
  finished_->ResolveWithUndefined();
  PatchSupplement::From(GetDocument())->DidComplete(*target_);
}

void Patch::Terminate(ScriptValue reason) {
  if (state_ == State::kFinished || state_ == State::kTerminated) {
    return;
  }

  state_ = State::kTerminated;

  parser_->Finish();
  if (loader_) {
    loader_->Cancel();
    loader_.Release();
  }
  PatchSupplement::From(GetDocument())->DidComplete(*target_);
  finished_->Reject(reason);
}

void Patch::Append(const String& text) {
  if (state_ != State::kTerminated) {
    parser_->Append(text);
  }
}

void Patch::AppendBytes(base::span<uint8_t> bytes) {
  if (state_ == State::kTerminated) {
    return;
  }
  if (parser_->NeedsDecoder()) {
    parser_->SetDecoder(
        std::make_unique<TextResourceDecoder>(TextResourceDecoderOptions(
            TextResourceDecoderOptions::ContentType::kHTMLContent,
            GetDocument().Encoding())));
  }
  parser_->AppendBytes(bytes);
}

Document& Patch::GetDocument() {
  return target_->GetDocument();
}

void Patch::Fetch() {
  ResourceRequest request(source_url_);
  source_url_ = KURL();
  // TODO(nrosenthal): add actual patch request destination & context
  request.SetRequestDestination(network::mojom::RequestDestination::kScript);
  request.SetRequestContext(mojom::blink::RequestContextType::SUBRESOURCE);

  // TODO(nrosenthal): add a crossorigin property
  request.SetCredentialsMode(network::mojom::CredentialsMode::kSameOrigin);
  request.SetMode(network::mojom::RequestMode::kCors);
  // TODO(nrosenthal): change accept header based on target element
  request.SetHttpHeaderField(http_names::kAccept, AtomicString("text/html"));
  ResourceLoaderOptions resource_loader_options(
      GetDocument().GetExecutionContext()->GetCurrentWorld());
  resource_loader_options.data_buffering_policy = kDoNotBufferData;

  loader_ = MakeGarbageCollected<ThreadableLoader>(
      *GetDocument().GetExecutionContext(), this, resource_loader_options);
  loader_->Start(std::move(request));
}

void Patch::DidReceiveResponse(uint64_t, const ResourceResponse& response) {
  if (!network::IsSuccessfulStatus(response.HttpStatusCode())) {
    // TODO(nrosenthal): use different DOMExceptions for different statuses?
    // Or maybe using "network error" for all of them?
    if (response.HttpStatusCode() == net::HTTP_NOT_FOUND) {
      OnFetchError(DOMExceptionCode::kNotFoundError, response.HttpStatusText());
    } else {
      OnFetchError(DOMExceptionCode::kNetworkError, response.HttpStatusText());
    }
  } else {
    Commit();
  }
}

void Patch::DidReceiveData(base::span<const char> bytes) {
  AppendBytes(reinterpret_cast<const base::span<uint8_t>&>(bytes));
}

void Patch::DidFinishLoading(uint64_t /*identifier*/) {
  Finish();
}

void Patch::DidFail(uint64_t /*identifier*/, const ResourceError& error) {
  OnFetchError(DOMExceptionCode::kNetworkError,
               AtomicString("Failed to fetch resource"));
}

void Patch::OnFetchError(DOMExceptionCode code, const AtomicString& message) {
  ScriptState* script_state =
      ToScriptStateForMainWorld(GetDocument().GetExecutionContext());
  ScriptState::Scope scope(script_state);
  v8::Local<v8::Value> exception = V8ThrowDOMException::CreateOrEmpty(
      script_state->GetIsolate(), code, message);
  Terminate(ScriptValue(script_state->GetIsolate(), exception));
}

void Patch::Trace(Visitor* visitor) const {
  visitor->Trace(source_);
  visitor->Trace(target_);
  visitor->Trace(previous_child_);
  visitor->Trace(next_child_);
  visitor->Trace(finished_);
  visitor->Trace(parser_);
  visitor->Trace(buffer_fragment_);
  visitor->Trace(loader_);
  ScriptWrappable::Trace(visitor);
}

}  // namespace blink