File: RespondWithObserver.cpp

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (385 lines) | stat: -rw-r--r-- 14,504 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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
// 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.

#include "modules/serviceworkers/RespondWithObserver.h"

#include "bindings/core/v8/ScriptFunction.h"
#include "bindings/core/v8/ScriptPromise.h"
#include "bindings/core/v8/ScriptValue.h"
#include "bindings/core/v8/V8Binding.h"
#include "bindings/modules/v8/V8Response.h"
#include "core/dom/ExceptionCode.h"
#include "core/dom/ExecutionContext.h"
#include "core/inspector/ConsoleMessage.h"
#include "core/streams/Stream.h"
#include "modules/fetch/BodyStreamBuffer.h"
#include "modules/fetch/BytesConsumer.h"
#include "modules/serviceworkers/ServiceWorkerGlobalScopeClient.h"
#include "platform/RuntimeEnabledFeatures.h"
#include "public/platform/modules/serviceworker/WebServiceWorkerResponse.h"
#include "wtf/Assertions.h"
#include "wtf/RefPtr.h"
#include <v8.h>

namespace blink {
namespace {

// Returns the error message to let the developer know about the reason of the
// unusual failures.
const String getMessageForResponseError(WebServiceWorkerResponseError error,
                                        const KURL& requestURL) {
  String errorMessage = "The FetchEvent for \"" + requestURL.getString() +
                        "\" resulted in a network error response: ";
  switch (error) {
    case WebServiceWorkerResponseErrorPromiseRejected:
      errorMessage = errorMessage + "the promise was rejected.";
      break;
    case WebServiceWorkerResponseErrorDefaultPrevented:
      errorMessage =
          errorMessage +
          "preventDefault() was called without calling respondWith().";
      break;
    case WebServiceWorkerResponseErrorNoV8Instance:
      errorMessage =
          errorMessage +
          "an object that was not a Response was passed to respondWith().";
      break;
    case WebServiceWorkerResponseErrorResponseTypeError:
      errorMessage = errorMessage +
                     "the promise was resolved with an error response object.";
      break;
    case WebServiceWorkerResponseErrorResponseTypeOpaque:
      errorMessage = errorMessage +
                     "an \"opaque\" response was used for a request whose type "
                     "is not no-cors";
      break;
    case WebServiceWorkerResponseErrorResponseTypeNotBasicOrDefault:
      ASSERT_NOT_REACHED();
      break;
    case WebServiceWorkerResponseErrorBodyUsed:
      errorMessage = errorMessage +
                     "a Response whose \"bodyUsed\" is \"true\" cannot be used "
                     "to respond to a request.";
      break;
    case WebServiceWorkerResponseErrorResponseTypeOpaqueForClientRequest:
      errorMessage = errorMessage +
                     "an \"opaque\" response was used for a client request.";
      break;
    case WebServiceWorkerResponseErrorResponseTypeOpaqueRedirect:
      errorMessage = errorMessage +
                     "an \"opaqueredirect\" type response was used for a "
                     "request whose redirect mode is not \"manual\".";
      break;
    case WebServiceWorkerResponseErrorBodyLocked:
      errorMessage = errorMessage +
                     "a Response whose \"body\" is locked cannot be used to "
                     "respond to a request.";
      break;
    case WebServiceWorkerResponseErrorNoForeignFetchResponse:
      errorMessage = errorMessage +
                     "an object that was not a ForeignFetchResponse was passed "
                     "to respondWith().";
      break;
    case WebServiceWorkerResponseErrorForeignFetchHeadersWithoutOrigin:
      errorMessage =
          errorMessage +
          "headers were specified for a response without an explicit origin.";
      break;
    case WebServiceWorkerResponseErrorForeignFetchMismatchedOrigin:
      errorMessage =
          errorMessage + "origin in response does not match origin of request.";
      break;
    case WebServiceWorkerResponseErrorRedirectedResponseForNotFollowRequest:
      errorMessage = errorMessage +
                     "a redirected response was used for a request whose "
                     "redirect mode is not \"follow\".";
      break;
    case WebServiceWorkerResponseErrorUnknown:
    default:
      errorMessage = errorMessage + "an unexpected error occurred.";
      break;
  }
  return errorMessage;
}

const String getErrorMessageForRedirectedResponseForNavigationRequest(
    const KURL& requestURL,
    const Vector<KURL>& responseURLList) {
  String errorMessage =
      "In Chrome 59, the navigation to \"" + requestURL.getString() + "\" " +
      "will result in a network error, because FetchEvent.respondWith() was " +
      "called with a redirected response. See https://crbug.com/658249. The " +
      "url list of the response was: [\"" + responseURLList[0].getString() +
      "\"";
  for (size_t i = 1; i < responseURLList.size(); ++i) {
    errorMessage =
        errorMessage + ", \"" + responseURLList[i].getString() + "\"";
  }
  return errorMessage + "]";
}

bool isNavigationRequest(WebURLRequest::FrameType frameType) {
  return frameType != WebURLRequest::FrameTypeNone;
}

bool isClientRequest(WebURLRequest::FrameType frameType,
                     WebURLRequest::RequestContext requestContext) {
  return isNavigationRequest(frameType) ||
         requestContext == WebURLRequest::RequestContextSharedWorker ||
         requestContext == WebURLRequest::RequestContextWorker;
}

class NoopLoaderClient final
    : public GarbageCollectedFinalized<NoopLoaderClient>,
      public FetchDataLoader::Client {
  WTF_MAKE_NONCOPYABLE(NoopLoaderClient);
  USING_GARBAGE_COLLECTED_MIXIN(NoopLoaderClient);

 public:
  NoopLoaderClient() = default;
  void didFetchDataLoadedStream() override {}
  void didFetchDataLoadFailed() override {}
  DEFINE_INLINE_TRACE() { FetchDataLoader::Client::trace(visitor); }
};

}  // namespace

class RespondWithObserver::ThenFunction final : public ScriptFunction {
 public:
  enum ResolveType {
    Fulfilled,
    Rejected,
  };

  static v8::Local<v8::Function> createFunction(ScriptState* scriptState,
                                                RespondWithObserver* observer,
                                                ResolveType type) {
    ThenFunction* self = new ThenFunction(scriptState, observer, type);
    return self->bindToV8Function();
  }

  DEFINE_INLINE_VIRTUAL_TRACE() {
    visitor->trace(m_observer);
    ScriptFunction::trace(visitor);
  }

 private:
  ThenFunction(ScriptState* scriptState,
               RespondWithObserver* observer,
               ResolveType type)
      : ScriptFunction(scriptState),
        m_observer(observer),
        m_resolveType(type) {}

  ScriptValue call(ScriptValue value) override {
    ASSERT(m_observer);
    ASSERT(m_resolveType == Fulfilled || m_resolveType == Rejected);
    if (m_resolveType == Rejected) {
      m_observer->responseWasRejected(
          WebServiceWorkerResponseErrorPromiseRejected);
      value =
          ScriptPromise::reject(value.getScriptState(), value).getScriptValue();
    } else {
      m_observer->responseWasFulfilled(value);
    }
    m_observer = nullptr;
    return value;
  }

  Member<RespondWithObserver> m_observer;
  ResolveType m_resolveType;
};

RespondWithObserver::~RespondWithObserver() {}

RespondWithObserver* RespondWithObserver::create(
    ExecutionContext* context,
    int fetchEventID,
    const KURL& requestURL,
    WebURLRequest::FetchRequestMode requestMode,
    WebURLRequest::FetchRedirectMode redirectMode,
    WebURLRequest::FrameType frameType,
    WebURLRequest::RequestContext requestContext,
    WaitUntilObserver* observer) {
  return new RespondWithObserver(context, fetchEventID, requestURL, requestMode,
                                 redirectMode, frameType, requestContext,
                                 observer);
}

void RespondWithObserver::contextDestroyed(ExecutionContext*) {
  if (m_observer) {
    DCHECK_EQ(Pending, m_state);
    m_observer.clear();
  }
  m_state = Done;
}

void RespondWithObserver::willDispatchEvent() {
  m_eventDispatchTime = WTF::currentTime();
}

void RespondWithObserver::didDispatchEvent(DispatchEventResult dispatchResult) {
  ASSERT(getExecutionContext());
  if (m_state != Initial)
    return;

  if (dispatchResult != DispatchEventResult::NotCanceled) {
    m_observer->incrementPendingActivity();
    responseWasRejected(WebServiceWorkerResponseErrorDefaultPrevented);
    return;
  }

  ServiceWorkerGlobalScopeClient::from(getExecutionContext())
      ->respondToFetchEvent(m_fetchEventID, m_eventDispatchTime);
  m_state = Done;
  m_observer.clear();
}

void RespondWithObserver::respondWith(ScriptState* scriptState,
                                      ScriptPromise scriptPromise,
                                      ExceptionState& exceptionState) {
  if (m_state != Initial) {
    exceptionState.throwDOMException(
        InvalidStateError, "The fetch event has already been responded to.");
    return;
  }

  m_state = Pending;
  m_observer->incrementPendingActivity();
  scriptPromise.then(
      ThenFunction::createFunction(scriptState, this, ThenFunction::Fulfilled),
      ThenFunction::createFunction(scriptState, this, ThenFunction::Rejected));
}

void RespondWithObserver::responseWasRejected(
    WebServiceWorkerResponseError error) {
  ASSERT(getExecutionContext());
  getExecutionContext()->addConsoleMessage(
      ConsoleMessage::create(JSMessageSource, WarningMessageLevel,
                             getMessageForResponseError(error, m_requestURL)));

  // The default value of WebServiceWorkerResponse's status is 0, which maps
  // to a network error.
  WebServiceWorkerResponse webResponse;
  webResponse.setError(error);
  ServiceWorkerGlobalScopeClient::from(getExecutionContext())
      ->respondToFetchEvent(m_fetchEventID, webResponse, m_eventDispatchTime);
  m_state = Done;
  m_observer->decrementPendingActivity();
  m_observer.clear();
}

void RespondWithObserver::responseWasFulfilled(const ScriptValue& value) {
  ASSERT(getExecutionContext());
  if (!V8Response::hasInstance(value.v8Value(),
                               toIsolate(getExecutionContext()))) {
    responseWasRejected(WebServiceWorkerResponseErrorNoV8Instance);
    return;
  }
  Response* response = V8Response::toImplWithTypeCheck(
      toIsolate(getExecutionContext()), value.v8Value());
  // "If one of the following conditions is true, return a network error:
  //   - |response|'s type is |error|.
  //   - |request|'s mode is not |no-cors| and response's type is |opaque|.
  //   - |request| is a client request and |response|'s type is neither
  //     |basic| nor |default|."
  const FetchResponseData::Type responseType = response->response()->getType();
  if (responseType == FetchResponseData::ErrorType) {
    responseWasRejected(WebServiceWorkerResponseErrorResponseTypeError);
    return;
  }
  if (responseType == FetchResponseData::OpaqueType) {
    if (m_requestMode != WebURLRequest::FetchRequestModeNoCORS) {
      responseWasRejected(WebServiceWorkerResponseErrorResponseTypeOpaque);
      return;
    }

    // The request mode of client requests should be "same-origin" but it is
    // not explicitly stated in the spec yet. So we need to check here.
    // FIXME: Set the request mode of client requests to "same-origin" and
    // remove this check when the spec will be updated.
    // Spec issue: https://github.com/whatwg/fetch/issues/101
    if (isClientRequest(m_frameType, m_requestContext)) {
      responseWasRejected(
          WebServiceWorkerResponseErrorResponseTypeOpaqueForClientRequest);
      return;
    }
  }
  if (m_redirectMode != WebURLRequest::FetchRedirectModeManual &&
      responseType == FetchResponseData::OpaqueRedirectType) {
    responseWasRejected(
        WebServiceWorkerResponseErrorResponseTypeOpaqueRedirect);
    return;
  }
  if (m_redirectMode != WebURLRequest::FetchRedirectModeFollow &&
      response->redirected()) {
    if (!isNavigationRequest(m_frameType)) {
      responseWasRejected(
          WebServiceWorkerResponseErrorRedirectedResponseForNotFollowRequest);
      return;
    }
    // TODO(horo): We should just reject even if the request was a navigation.
    // Currently we measure the impact of the restriction with the use counter
    // in DocumentLoader.
    getExecutionContext()->addConsoleMessage(ConsoleMessage::create(
        JSMessageSource, ErrorMessageLevel,
        getErrorMessageForRedirectedResponseForNavigationRequest(
            m_requestURL, response->internalURLList())));
  }
  if (response->isBodyLocked()) {
    responseWasRejected(WebServiceWorkerResponseErrorBodyLocked);
    return;
  }
  if (response->bodyUsed()) {
    responseWasRejected(WebServiceWorkerResponseErrorBodyUsed);
    return;
  }

  WebServiceWorkerResponse webResponse;
  response->populateWebServiceWorkerResponse(webResponse);
  BodyStreamBuffer* buffer = response->internalBodyBuffer();
  if (buffer) {
    RefPtr<BlobDataHandle> blobDataHandle = buffer->drainAsBlobDataHandle(
        BytesConsumer::BlobSizePolicy::AllowBlobWithInvalidSize);
    if (blobDataHandle) {
      webResponse.setBlobDataHandle(blobDataHandle);
    } else {
      Stream* outStream = Stream::create(getExecutionContext(), "");
      webResponse.setStreamURL(outStream->url());
      buffer->startLoading(FetchDataLoader::createLoaderAsStream(outStream),
                           new NoopLoaderClient);
    }
  }
  ServiceWorkerGlobalScopeClient::from(getExecutionContext())
      ->respondToFetchEvent(m_fetchEventID, webResponse, m_eventDispatchTime);
  m_state = Done;
  m_observer->decrementPendingActivity();
  m_observer.clear();
}

RespondWithObserver::RespondWithObserver(
    ExecutionContext* context,
    int fetchEventID,
    const KURL& requestURL,
    WebURLRequest::FetchRequestMode requestMode,
    WebURLRequest::FetchRedirectMode redirectMode,
    WebURLRequest::FrameType frameType,
    WebURLRequest::RequestContext requestContext,
    WaitUntilObserver* observer)
    : ContextLifecycleObserver(context),
      m_fetchEventID(fetchEventID),
      m_requestURL(requestURL),
      m_requestMode(requestMode),
      m_redirectMode(redirectMode),
      m_frameType(frameType),
      m_requestContext(requestContext),
      m_state(Initial),
      m_observer(observer) {}

DEFINE_TRACE(RespondWithObserver) {
  visitor->trace(m_observer);
  ContextLifecycleObserver::trace(visitor);
}

}  // namespace blink