[WTF] Import std::optional reference implementation as WTF::Optional
[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 #if ENABLE(FETCH_API)
32
33 #include "FetchBodyOwner.h"
34 #include "ResourceResponse.h"
35 #include <runtime/TypedArrays.h>
36
37 namespace JSC {
38 class ExecState;
39 class JSValue;
40 };
41
42 namespace WebCore {
43
44 class Dictionary;
45 class FetchRequest;
46 class ReadableStreamSource;
47
48 class FetchResponse final : public FetchBodyOwner {
49 public:
50     using Type = ResourceResponse::Type;
51
52     static Ref<FetchResponse> create(ScriptExecutionContext& context) { return adoptRef(*new FetchResponse(context, std::nullopt, FetchHeaders::create(FetchHeaders::Guard::Response), ResourceResponse())); }
53     static Ref<FetchResponse> error(ScriptExecutionContext&);
54     static ExceptionOr<Ref<FetchResponse>> redirect(ScriptExecutionContext&, const String& url, int status);
55
56     using FetchPromise = DOMPromise<FetchResponse>;
57     static void fetch(ScriptExecutionContext&, FetchRequest&, FetchPromise&&);
58
59     void consume(unsigned, Ref<DeferredPromise>&&);
60 #if ENABLE(READABLE_STREAM_API)
61     void startConsumingStream(unsigned);
62     void consumeChunk(Ref<JSC::Uint8Array>&&);
63     void finishConsumingStream(Ref<DeferredPromise>&&);
64 #endif
65
66     ExceptionOr<void> setStatus(int status, const String& statusText);
67     void initializeWith(JSC::ExecState&, JSC::JSValue);
68
69     Type type() const { return m_response.type(); }
70     const String& url() const;
71     bool redirected() const { return m_response.isRedirected(); }
72     int status() const { return m_response.httpStatusCode(); }
73     bool ok() const { return m_response.isSuccessful(); }
74     const String& statusText() const { return m_response.httpStatusText(); }
75
76     FetchHeaders& headers() { return m_headers; }
77     Ref<FetchResponse> cloneForJS();
78
79 #if ENABLE(READABLE_STREAM_API)
80     ReadableStreamSource* createReadableStreamSource();
81     void consumeBodyAsStream();
82     void feedStream();
83     void cancel();
84 #endif
85
86     bool isLoading() const { return !!m_bodyLoader; }
87
88 private:
89     FetchResponse(ScriptExecutionContext&, std::optional<FetchBody>&&, Ref<FetchHeaders>&&, ResourceResponse&&);
90
91     static void startFetching(ScriptExecutionContext&, const FetchRequest&, FetchPromise&&);
92
93     void stop() final;
94     const char* activeDOMObjectName() const final;
95     bool canSuspendForDocumentSuspension() const final;
96
97 #if ENABLE(READABLE_STREAM_API)
98     void closeStream();
99 #endif
100
101     class BodyLoader final : public FetchLoaderClient {
102     public:
103         BodyLoader(FetchResponse&, FetchPromise&&);
104
105         bool start(ScriptExecutionContext&, const FetchRequest&);
106         void stop();
107
108 #if ENABLE(READABLE_STREAM_API)
109         RefPtr<SharedBuffer> startStreaming();
110 #endif
111
112     private:
113         // FetchLoaderClient API
114         void didSucceed() final;
115         void didFail() final;
116         void didReceiveResponse(const ResourceResponse&) final;
117         void didReceiveData(const char*, size_t) final;
118
119         FetchResponse& m_response;
120         std::optional<FetchPromise> m_promise;
121         std::unique_ptr<FetchLoader> m_loader;
122     };
123
124     ResourceResponse m_response;
125     std::optional<BodyLoader> m_bodyLoader;
126     mutable String m_responseURL;
127
128     FetchBodyConsumer m_consumer { FetchBodyConsumer::Type::ArrayBuffer  };
129 };
130
131 } // namespace WebCore
132
133 #endif // ENABLE(FETCH_API)