[Fetch API] Response should keep all ResourceResponse information
[WebKit-https.git] / Source / WebCore / Modules / fetch / FetchResponse.h
1 /*
2  * Copyright (C) 2016 Canon Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted, provided that the following conditions
6  * are required to be met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Canon Inc. nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
24  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "FetchBodyOwner.h"
32 #include "FetchHeaders.h"
33 #include "ResourceResponse.h"
34 #include <runtime/TypedArrays.h>
35
36 namespace JSC {
37 class ExecState;
38 class JSValue;
39 };
40
41 namespace WebCore {
42
43 class FetchRequest;
44 class ReadableStreamSource;
45
46 class FetchResponse final : public FetchBodyOwner {
47 public:
48     using Type = ResourceResponse::Type;
49
50     struct Init {
51         unsigned short status { 200 };
52         String statusText { ASCIILiteral("OK") };
53         std::optional<FetchHeaders::Init> headers;
54     };
55
56     static Ref<FetchResponse> create(ScriptExecutionContext& context) { return adoptRef(*new FetchResponse(context, std::nullopt, FetchHeaders::create(FetchHeaders::Guard::Response), ResourceResponse())); }
57     static Ref<FetchResponse> error(ScriptExecutionContext&);
58     static ExceptionOr<Ref<FetchResponse>> redirect(ScriptExecutionContext&, const String& url, int status);
59
60     using FetchPromise = DOMPromiseDeferred<IDLInterface<FetchResponse>>;
61     static void fetch(ScriptExecutionContext&, FetchRequest&, FetchPromise&&);
62
63     void consume(unsigned, Ref<DeferredPromise>&&);
64 #if ENABLE(STREAMS_API)
65     void startConsumingStream(unsigned);
66     void consumeChunk(Ref<JSC::Uint8Array>&&);
67     void finishConsumingStream(Ref<DeferredPromise>&&);
68 #endif
69
70     ExceptionOr<void> setStatus(int status, const String& statusText);
71     void initializeWith(FetchBody::Init&&);
72     void setBodyAsReadableStream();
73
74     Type type() const { return m_response.type(); }
75     const String& url() const;
76     bool redirected() const { return m_response.isRedirected(); }
77     int status() const { return m_response.httpStatusCode(); }
78     bool ok() const { return m_response.isSuccessful(); }
79     const String& statusText() const { return m_response.httpStatusText(); }
80
81     FetchHeaders& headers() { return m_headers; }
82     Ref<FetchResponse> cloneForJS();
83
84 #if ENABLE(STREAMS_API)
85     ReadableStreamSource* createReadableStreamSource();
86     void consumeBodyAsStream();
87     void feedStream();
88     void cancel();
89 #endif
90
91     bool isLoading() const { return !!m_bodyLoader; }
92
93 private:
94     FetchResponse(ScriptExecutionContext&, std::optional<FetchBody>&&, Ref<FetchHeaders>&&, ResourceResponse&&);
95
96     static void startFetching(ScriptExecutionContext&, const FetchRequest&, FetchPromise&&);
97
98     void stop() final;
99     const char* activeDOMObjectName() const final;
100     bool canSuspendForDocumentSuspension() const final;
101
102 #if ENABLE(STREAMS_API)
103     void closeStream();
104 #endif
105
106     class BodyLoader final : public FetchLoaderClient {
107     public:
108         BodyLoader(FetchResponse&, FetchPromise&&);
109         ~BodyLoader();
110
111         bool start(ScriptExecutionContext&, const FetchRequest&);
112         void stop();
113
114 #if ENABLE(STREAMS_API)
115         RefPtr<SharedBuffer> startStreaming();
116 #endif
117
118     private:
119         // FetchLoaderClient API
120         void didSucceed() final;
121         void didFail() final;
122         void didReceiveResponse(const ResourceResponse&) final;
123         void didReceiveData(const char*, size_t) final;
124
125         FetchResponse& m_response;
126         std::optional<FetchPromise> m_promise;
127         std::unique_ptr<FetchLoader> m_loader;
128     };
129
130     ResourceResponse m_response;
131     std::optional<BodyLoader> m_bodyLoader;
132     mutable String m_responseURL;
133     bool m_shouldExposeBody { true };
134
135     FetchBodyConsumer m_consumer { FetchBodyConsumer::Type::ArrayBuffer  };
136 };
137
138 } // namespace WebCore