FormDataElement::lengthInBytes should use ThreadableBlobRegistry
[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     WEBCORE_EXPORT static Ref<FetchResponse> create(ScriptExecutionContext&, std::optional<FetchBody>&&, Ref<FetchHeaders>&&, ResourceResponse&&);
57
58     static ExceptionOr<Ref<FetchResponse>> create(ScriptExecutionContext&, std::optional<FetchBody::Init>&&, Init&&);
59     static Ref<FetchResponse> error(ScriptExecutionContext&);
60     static ExceptionOr<Ref<FetchResponse>> redirect(ScriptExecutionContext&, const String& url, int status);
61
62     using NotificationCallback = WTF::Function<void(ExceptionOr<FetchResponse&>&&)>;
63     static void fetch(ScriptExecutionContext&, FetchRequest&, NotificationCallback&&);
64
65 #if ENABLE(STREAMS_API)
66     void startConsumingStream(unsigned);
67     void consumeChunk(Ref<JSC::Uint8Array>&&);
68     void finishConsumingStream(Ref<DeferredPromise>&&);
69 #endif
70
71     Type type() const { return filteredResponse().type(); }
72     const String& url() const;
73     bool redirected() const { return filteredResponse().isRedirected(); }
74     int status() const { return filteredResponse().httpStatusCode(); }
75     bool ok() const { return filteredResponse().isSuccessful(); }
76     const String& statusText() const { return filteredResponse().httpStatusText(); }
77
78     const FetchHeaders& headers() const { return m_headers; }
79     FetchHeaders& headers() { return m_headers; }
80     ExceptionOr<Ref<FetchResponse>> clone(ScriptExecutionContext&);
81
82 #if ENABLE(STREAMS_API)
83     void consumeBodyAsStream() final;
84     void feedStream() final;
85     void cancel() final;
86 #endif
87
88     using ResponseData = Variant<std::nullptr_t, Ref<FormData>, Ref<SharedBuffer>>;
89     ResponseData consumeBody();
90     void setBodyData(ResponseData&&, uint64_t bodySizeWithPadding);
91
92     bool isLoading() const { return !!m_bodyLoader; }
93
94     using ConsumeDataCallback = WTF::Function<void(ExceptionOr<RefPtr<SharedBuffer>>&&)>;
95     void consumeBodyWhenLoaded(ConsumeDataCallback&&);
96     void consumeBodyFromReadableStream(ConsumeDataCallback&&);
97
98     WEBCORE_EXPORT ResourceResponse resourceResponse() const;
99
100     uint64_t bodySizeWithPadding() const { return m_bodySizeWithPadding; }
101     void setBodySizeWithPadding(uint64_t size) { m_bodySizeWithPadding = size; }
102     uint64_t opaqueLoadIdentifier() const { return m_opaqueLoadIdentifier; }
103
104     void initializeOpaqueLoadIdentifierForTesting() { m_opaqueLoadIdentifier = 1; }
105
106 private:
107     FetchResponse(ScriptExecutionContext&, std::optional<FetchBody>&&, Ref<FetchHeaders>&&, ResourceResponse&&);
108
109     void stop() final;
110     const char* activeDOMObjectName() const final;
111     bool canSuspendForDocumentSuspension() const final;
112
113     const ResourceResponse& filteredResponse() const;
114
115 #if ENABLE(STREAMS_API)
116     void closeStream();
117 #endif
118
119     class BodyLoader final : public FetchLoaderClient {
120     public:
121         BodyLoader(FetchResponse&, NotificationCallback&&);
122         ~BodyLoader();
123
124         bool start(ScriptExecutionContext&, const FetchRequest&);
125         void stop();
126
127         void setConsumeDataCallback(ConsumeDataCallback&& consumeDataCallback) { m_consumeDataCallback = WTFMove(consumeDataCallback); }
128
129 #if ENABLE(STREAMS_API)
130         RefPtr<SharedBuffer> startStreaming();
131 #endif
132
133     private:
134         // FetchLoaderClient API
135         void didSucceed() final;
136         void didFail(const ResourceError&) final;
137         void didReceiveResponse(const ResourceResponse&) final;
138         void didReceiveData(const char*, size_t) final;
139
140         FetchResponse& m_response;
141         NotificationCallback m_responseCallback;
142         ConsumeDataCallback m_consumeDataCallback;
143         std::unique_ptr<FetchLoader> m_loader;
144     };
145
146     mutable std::optional<ResourceResponse> m_filteredResponse;
147     ResourceResponse m_internalResponse;
148     std::optional<BodyLoader> m_bodyLoader;
149     mutable String m_responseURL;
150     // Opaque responses will padd their body size when used with Cache API.
151     uint64_t m_bodySizeWithPadding { 0 };
152     uint64_t m_opaqueLoadIdentifier { 0 };
153 };
154
155 } // namespace WebCore