Files
bun.sh/src/bun.js/webcore/request.zig
Dylan Conway 08c2148000 fix(windows): console-iterator.test.ts fix (#8879)
* fix console iterator tests on windows

* rename and size only when bytes is active

* assert size > 0
2024-02-14 17:59:19 -08:00

805 lines
29 KiB
Zig

const std = @import("std");
const Api = @import("../../api/schema.zig").Api;
const bun = @import("root").bun;
const MimeType = bun.http.MimeType;
const ZigURL = @import("../../url.zig").URL;
const HTTPClient = @import("root").bun.http;
const JSC = @import("root").bun.JSC;
const js = JSC.C;
const Method = @import("../../http/method.zig").Method;
const FetchHeaders = JSC.FetchHeaders;
const AbortSignal = JSC.WebCore.AbortSignal;
const ObjectPool = @import("../../pool.zig").ObjectPool;
const SystemError = JSC.SystemError;
const Output = @import("root").bun.Output;
const MutableString = @import("root").bun.MutableString;
const strings = @import("root").bun.strings;
const string = @import("root").bun.string;
const default_allocator = @import("root").bun.default_allocator;
const FeatureFlags = @import("root").bun.FeatureFlags;
const ArrayBuffer = @import("../base.zig").ArrayBuffer;
const Properties = @import("../base.zig").Properties;
const castObj = @import("../base.zig").castObj;
const getAllocator = @import("../base.zig").getAllocator;
const GetJSPrivateData = @import("../base.zig").GetJSPrivateData;
const Environment = @import("../../env.zig");
const ZigString = JSC.ZigString;
const IdentityContext = @import("../../identity_context.zig").IdentityContext;
const JSPromise = JSC.JSPromise;
const JSValue = JSC.JSValue;
const JSError = JSC.JSError;
const JSGlobalObject = JSC.JSGlobalObject;
const NullableAllocator = @import("../../nullable_allocator.zig").NullableAllocator;
const VirtualMachine = JSC.VirtualMachine;
const Task = JSC.Task;
const JSPrinter = bun.js_printer;
const picohttp = @import("root").bun.picohttp;
const StringJoiner = @import("../../string_joiner.zig");
const uws = @import("root").bun.uws;
const InlineBlob = JSC.WebCore.InlineBlob;
const AnyBlob = JSC.WebCore.AnyBlob;
const InternalBlob = JSC.WebCore.InternalBlob;
const BodyMixin = JSC.WebCore.BodyMixin;
const Body = JSC.WebCore.Body;
const Blob = JSC.WebCore.Blob;
const Response = JSC.WebCore.Response;
const body_value_pool_size: u16 = 256;
pub const BodyValueRef = bun.HiveRef(Body.Value, body_value_pool_size);
const BodyValueHiveAllocator = bun.HiveArray(BodyValueRef, body_value_pool_size).Fallback;
var body_value_hive_allocator = BodyValueHiveAllocator.init(bun.default_allocator);
pub fn InitRequestBodyValue(value: Body.Value) !*BodyValueRef {
return try BodyValueRef.init(value, &body_value_hive_allocator);
}
// https://developer.mozilla.org/en-US/docs/Web/API/Request
pub const Request = struct {
url: bun.String = bun.String.empty,
headers: ?*FetchHeaders = null,
signal: ?*AbortSignal = null,
body: *BodyValueRef,
method: Method = Method.GET,
request_context: JSC.API.AnyRequestContext = JSC.API.AnyRequestContext.Null,
https: bool = false,
upgrader: ?*anyopaque = null,
// We must report a consistent value for this
reported_estimated_size: usize = 0,
const RequestMixin = BodyMixin(@This());
pub usingnamespace JSC.Codegen.JSRequest;
pub const getText = RequestMixin.getText;
pub const getBody = RequestMixin.getBody;
pub const getBodyUsed = RequestMixin.getBodyUsed;
pub const getJSON = RequestMixin.getJSON;
pub const getArrayBuffer = RequestMixin.getArrayBuffer;
pub const getBlob = RequestMixin.getBlob;
pub const getFormData = RequestMixin.getFormData;
pub const getBlobWithoutCallFrame = RequestMixin.getBlobWithoutCallFrame;
pub export fn Request__getUWSRequest(
this: *Request,
) ?*uws.Request {
return this.request_context.getRequest();
}
comptime {
if (!JSC.is_bindgen) {
_ = Request__getUWSRequest;
}
}
pub fn getContentType(
this: *Request,
) ?ZigString.Slice {
if (this.request_context.getRequest()) |req| {
if (req.header("content-type")) |value| {
return ZigString.Slice.fromUTF8NeverFree(value);
}
}
if (this.headers) |headers| {
if (headers.fastGet(.ContentType)) |value| {
return value.toSlice(bun.default_allocator);
}
}
if (this.body.value == .Blob) {
if (this.body.value.Blob.content_type.len > 0)
return ZigString.Slice.fromUTF8NeverFree(this.body.value.Blob.content_type);
}
return null;
}
pub fn getFormDataEncoding(this: *Request) ?*bun.FormData.AsyncFormData {
var content_type_slice: ZigString.Slice = this.getContentType() orelse return null;
defer content_type_slice.deinit();
const encoding = bun.FormData.Encoding.get(content_type_slice.slice()) orelse return null;
return bun.FormData.AsyncFormData.init(bun.default_allocator, encoding) catch unreachable;
}
pub fn estimatedSize(this: *Request) callconv(.C) usize {
return this.reported_estimated_size;
}
pub fn calculateEstimatedByteSize(this: *Request) void {
this.reported_estimated_size = this.body.value.estimatedSize() + this.sizeOfURL() + @sizeOf(Request);
}
pub fn toJS(this: *Request, globalObject: *JSGlobalObject) JSValue {
this.calculateEstimatedByteSize();
return Request.toJSUnchecked(globalObject, this);
}
pub fn writeFormat(this: *Request, comptime Formatter: type, formatter: *Formatter, writer: anytype, comptime enable_ansi_colors: bool) !void {
const Writer = @TypeOf(writer);
try writer.print("Request ({}) {{\n", .{bun.fmt.size(this.body.value.size())});
{
formatter.indent += 1;
defer formatter.indent -|= 1;
try formatter.writeIndent(Writer, writer);
try writer.writeAll(comptime Output.prettyFmt("<r>method<d>:<r> \"", enable_ansi_colors));
try writer.writeAll(bun.asByteSlice(@tagName(this.method)));
try writer.writeAll("\"");
formatter.printComma(Writer, writer, enable_ansi_colors) catch unreachable;
try writer.writeAll("\n");
try formatter.writeIndent(Writer, writer);
try writer.writeAll(comptime Output.prettyFmt("<r>url<d>:<r> ", enable_ansi_colors));
try this.ensureURL();
try writer.print(comptime Output.prettyFmt("\"<b>{}<r>\"", enable_ansi_colors), .{this.url});
formatter.printComma(Writer, writer, enable_ansi_colors) catch unreachable;
try writer.writeAll("\n");
try formatter.writeIndent(Writer, writer);
try writer.writeAll(comptime Output.prettyFmt("<r>headers<d>:<r> ", enable_ansi_colors));
formatter.printAs(.Private, Writer, writer, this.getHeaders(formatter.globalThis), .DOMWrapper, enable_ansi_colors);
if (this.body.value == .Blob) {
try writer.writeAll("\n");
try formatter.writeIndent(Writer, writer);
try this.body.value.Blob.writeFormat(Formatter, formatter, writer, enable_ansi_colors);
} else if (this.body.value == .InternalBlob or this.body.value == .WTFStringImpl) {
try writer.writeAll("\n");
try formatter.writeIndent(Writer, writer);
const size = this.body.value.size();
if (size == 0) {
try Blob.initEmpty(undefined).writeFormat(Formatter, formatter, writer, enable_ansi_colors);
} else {
try Blob.writeFormatForSize(size, writer, enable_ansi_colors);
}
} else if (this.body.value == .Locked) {
if (this.body.value.Locked.readable) |stream| {
try writer.writeAll("\n");
try formatter.writeIndent(Writer, writer);
formatter.printAs(.Object, Writer, writer, stream.value, stream.value.jsType(), enable_ansi_colors);
}
}
}
try writer.writeAll("\n");
try formatter.writeIndent(Writer, writer);
try writer.writeAll("}");
}
pub fn mimeType(this: *const Request) string {
if (this.headers) |headers| {
if (headers.fastGet(.ContentType)) |content_type| {
return content_type.slice();
}
}
switch (this.body.value) {
.Blob => |blob| {
if (blob.content_type.len > 0) {
return blob.content_type;
}
return MimeType.other.value;
},
.InternalBlob => return this.body.value.InternalBlob.contentType(),
.WTFStringImpl => return MimeType.text.value,
// .InlineBlob => return this.body.value.InlineBlob.contentType(),
.Null, .Error, .Used, .Locked, .Empty => return MimeType.other.value,
}
}
pub fn getCache(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.init(Properties.UTF8.default).toValueGC(globalThis);
}
pub fn getCredentials(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.init(Properties.UTF8.include).toValueGC(globalThis);
}
pub fn getDestination(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.init("").toValueGC(globalThis);
}
pub fn getIntegrity(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.Empty.toValueGC(globalThis);
}
pub fn getSignal(this: *Request, globalThis: *JSC.JSGlobalObject) callconv(.C) JSC.JSValue {
// Already have an C++ instance
if (this.signal) |signal| {
return signal.toJS(globalThis);
} else {
//Lazy create default signal
const js_signal = AbortSignal.create(globalThis);
js_signal.ensureStillAlive();
if (AbortSignal.fromJS(js_signal)) |signal| {
this.signal = signal.ref();
}
return js_signal;
}
}
pub fn getMethod(
this: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return bun.String.static(@tagName(this.method)).toJS(globalThis);
}
pub fn getMode(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.init(Properties.UTF8.navigate).toValue(globalThis);
}
pub fn finalizeWithoutDeinit(this: *Request) void {
if (this.headers) |headers| {
headers.deref();
this.headers = null;
}
this.url.deref();
this.url = bun.String.empty;
if (this.signal) |signal| {
_ = signal.unref();
this.signal = null;
}
}
pub fn finalize(this: *Request) callconv(.C) void {
this.finalizeWithoutDeinit();
_ = this.body.unref();
bun.default_allocator.destroy(this);
}
pub fn getRedirect(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.init(Properties.UTF8.follow).toValueGC(globalThis);
}
pub fn getReferrer(
this: *Request,
globalObject: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
if (this.headers) |headers_ref| {
if (headers_ref.get("referrer", globalObject)) |referrer| {
return ZigString.init(referrer).toValueGC(globalObject);
}
}
return ZigString.init("").toValueGC(globalObject);
}
pub fn getReferrerPolicy(
_: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
return ZigString.init("").toValueGC(globalThis);
}
pub fn getUrl(
this: *Request,
globalObject: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
this.ensureURL() catch {
globalObject.throw("Failed to join URL", .{});
return .zero;
};
return this.url.toJS(globalObject);
}
pub fn sizeOfURL(this: *const Request) usize {
if (this.url.length() > 0)
return this.url.byteSlice().len;
if (this.request_context.getRequest()) |req| {
const req_url = req.url();
if (req_url.len > 0 and req_url[0] == '/') {
if (req.header("host")) |host| {
const fmt = bun.fmt.HostFormatter{
.is_https = this.https,
.host = host,
};
return this.getProtocol().len + req_url.len + std.fmt.count("{any}", .{fmt});
}
}
return req_url.len;
}
return 0;
}
pub fn getProtocol(this: *const Request) []const u8 {
if (this.https)
return "https://";
return "http://";
}
pub fn ensureURL(this: *Request) !void {
if (!this.url.isEmpty()) return;
if (this.request_context.getRequest()) |req| {
const req_url = req.url();
if (req_url.len > 0 and req_url[0] == '/') {
if (req.header("host")) |host| {
const fmt = bun.fmt.HostFormatter{
.is_https = this.https,
.host = host,
};
const url_bytelength = std.fmt.count("{s}{any}{s}", .{
this.getProtocol(),
fmt,
req_url,
});
if (comptime Environment.allow_assert) {
std.debug.assert(this.sizeOfURL() == url_bytelength);
}
if (url_bytelength < 128) {
var buffer: [128]u8 = undefined;
const url = std.fmt.bufPrint(&buffer, "{s}{any}{s}", .{
this.getProtocol(),
fmt,
req_url,
}) catch @panic("Unexpected error while printing URL");
if (comptime Environment.allow_assert) {
std.debug.assert(this.sizeOfURL() == url.len);
}
var href = bun.JSC.URL.hrefFromString(bun.String.fromBytes(url));
if (!href.isEmpty()) {
if (href.byteSlice().ptr == url.ptr) {
this.url = bun.String.createLatin1(url[0..href.length()]);
href.deref();
} else {
this.url = href;
}
} else {
// TODO: what is the right thing to do for invalid URLS?
this.url = bun.String.createUTF8(url);
}
return;
}
if (strings.isAllASCII(host) and strings.isAllASCII(req_url)) {
this.url, const bytes = bun.String.createUninitialized(.latin1, url_bytelength);
_ = std.fmt.bufPrint(bytes, "{s}{any}{s}", .{
this.getProtocol(),
fmt,
req_url,
}) catch |err| switch (err) {
error.NoSpaceLeft => unreachable, // exact space should have been counted
};
} else {
// slow path
const temp_url = std.fmt.allocPrint(bun.default_allocator, "{s}{any}{s}", .{
this.getProtocol(),
fmt,
req_url,
}) catch bun.outOfMemory();
defer bun.default_allocator.free(temp_url);
this.url = bun.String.createUTF8(temp_url);
}
const href = bun.JSC.URL.hrefFromString(this.url);
// TODO: what is the right thing to do for invalid URLS?
if (!href.isEmpty()) {
this.url = href;
}
return;
}
}
if (comptime Environment.allow_assert) {
std.debug.assert(this.sizeOfURL() == req_url.len);
}
this.url = bun.String.createUTF8(req_url);
}
}
const Fields = enum {
method,
headers,
body,
// referrer,
// referrerPolicy,
// mode,
// credentials,
// redirect,
// integrity,
// keepalive,
signal,
// proxy,
// timeout,
url,
};
pub fn constructInto(
globalThis: *JSC.JSGlobalObject,
arguments: []const JSC.JSValue,
) ?Request {
var req = Request{
.body = InitRequestBodyValue(.{ .Null = {} }) catch {
return null;
},
};
if (arguments.len == 0) {
globalThis.throw("Failed to construct 'Request': 1 argument required, but only 0 present.", .{});
_ = req.body.unref();
return null;
} else if (arguments[0].isEmptyOrUndefinedOrNull() or !arguments[0].isCell()) {
globalThis.throw("Failed to construct 'Request': expected non-empty string or object, got undefined", .{});
_ = req.body.unref();
return null;
}
const url_or_object = arguments[0];
const url_or_object_type = url_or_object.jsType();
var fields = std.EnumSet(Fields).initEmpty();
const is_first_argument_a_url =
// fastest path:
url_or_object_type.isStringLike() or
// slower path:
url_or_object.as(JSC.DOMURL) != null;
if (is_first_argument_a_url) {
const str = bun.String.tryFromJS(arguments[0], globalThis) orelse {
req.finalizeWithoutDeinit();
_ = req.body.unref();
return null;
};
req.url = str;
if (!req.url.isEmpty())
fields.insert(.url);
} else if (!url_or_object_type.isObject()) {
globalThis.throw("Failed to construct 'Request': expected non-empty string or object", .{});
_ = req.body.unref();
return null;
}
const values_to_try_ = [_]JSValue{
if (arguments.len > 1 and arguments[1].isObject())
arguments[1]
else if (is_first_argument_a_url)
JSValue.undefined
else
url_or_object,
if (is_first_argument_a_url) JSValue.undefined else url_or_object,
};
const values_to_try = values_to_try_[0 .. @as(usize, @intFromBool(!is_first_argument_a_url)) +
@as(usize, @intFromBool(arguments.len > 1 and arguments[1].isObject()))];
for (values_to_try) |value| {
const value_type = value.jsType();
const explicit_check = values_to_try.len == 2 and value_type == .FinalObject and values_to_try[1].jsType() == .DOMWrapper;
if (value_type == .DOMWrapper) {
if (value.as(Request)) |request| {
if (values_to_try.len == 1) {
request.cloneInto(&req, globalThis.allocator(), globalThis, fields.contains(.url));
return req;
}
if (!fields.contains(.method)) {
req.method = request.method;
fields.insert(.method);
}
if (!fields.contains(.headers)) {
if (request.cloneHeaders(globalThis)) |headers| {
req.headers = headers;
fields.insert(.headers);
}
}
if (!fields.contains(.body)) {
switch (request.body.value) {
.Null, .Empty, .Used => {},
else => {
req.body.value = request.body.value.clone(globalThis);
fields.insert(.body);
},
}
}
}
if (value.as(JSC.WebCore.Response)) |response| {
if (!fields.contains(.method)) {
req.method = response.init.method;
fields.insert(.method);
}
if (!fields.contains(.headers)) {
if (response.init.headers) |headers| {
req.headers = headers.cloneThis(globalThis);
fields.insert(.headers);
}
}
if (!fields.contains(.url)) {
if (!response.url.isEmpty()) {
req.url = response.url.dupeRef();
fields.insert(.url);
}
}
if (!fields.contains(.body)) {
switch (response.body.value) {
.Null, .Empty, .Used => {},
else => {
req.body.value = response.body.value.clone(globalThis);
fields.insert(.body);
},
}
}
}
}
if (!fields.contains(.body)) {
if (value.fastGet(globalThis, .body)) |body_| {
fields.insert(.body);
if (Body.Value.fromJS(globalThis, body_)) |body| {
req.body.value = body;
} else {
req.finalizeWithoutDeinit();
_ = req.body.unref();
return null;
}
}
}
if (!fields.contains(.url)) {
if (value.fastGet(globalThis, .url)) |url| {
req.url = bun.String.fromJS(url, globalThis);
if (!req.url.isEmpty())
fields.insert(.url);
// first value
} else if (@intFromEnum(value) == @intFromEnum(values_to_try[values_to_try.len - 1]) and !is_first_argument_a_url and
value.implementsToString(globalThis))
{
const str = bun.String.tryFromJS(value, globalThis) orelse {
req.finalizeWithoutDeinit();
_ = req.body.unref();
return null;
};
req.url = str;
if (!req.url.isEmpty())
fields.insert(.url);
}
}
if (!fields.contains(.signal)) {
if (value.getTruthy(globalThis, "signal")) |signal_| {
fields.insert(.signal);
if (AbortSignal.fromJS(signal_)) |signal| {
//Keep it alive
signal_.ensureStillAlive();
req.signal = signal.ref();
} else {
globalThis.throw("Failed to construct 'Request': signal is not of type AbortSignal.", .{});
req.finalizeWithoutDeinit();
_ = req.body.unref();
return null;
}
}
}
if (!fields.contains(.method) or !fields.contains(.headers)) {
if (Response.Init.init(globalThis.allocator(), globalThis, value) catch null) |init| {
if (!explicit_check or (explicit_check and value.fastGet(globalThis, .method) != null)) {
if (!fields.contains(.method)) {
req.method = init.method;
fields.insert(.method);
}
}
if (!explicit_check or (explicit_check and value.fastGet(globalThis, .headers) != null)) {
if (init.headers) |headers| {
if (!fields.contains(.headers)) {
req.headers = headers;
fields.insert(.headers);
} else {
headers.deref();
}
}
}
}
}
}
if (req.url.isEmpty()) {
globalThis.throw("Failed to construct 'Request': url is required.", .{});
req.finalizeWithoutDeinit();
_ = req.body.unref();
return null;
}
const href = JSC.URL.hrefFromString(req.url);
if (href.isEmpty()) {
// globalThis.throw can cause GC, which could cause the above string to be freed.
// so we must increment the reference count before calling it.
globalThis.throw("Failed to construct 'Request': Invalid URL \"{}\"", .{
req.url,
});
req.finalizeWithoutDeinit();
_ = req.body.unref();
return null;
}
// hrefFromString increments the reference count if they end up being
// the same
//
// we increment the reference count on usage above, so we must
// decrement it to be perfectly balanced.
req.url.deref();
req.url = href;
if (req.body.value == .Blob and
req.headers != null and
req.body.value.Blob.content_type.len > 0 and
!req.headers.?.fastHas(.ContentType))
{
req.headers.?.put("content-type", req.body.value.Blob.content_type, globalThis);
}
req.calculateEstimatedByteSize();
return req;
}
pub fn constructor(
globalThis: *JSC.JSGlobalObject,
callframe: *JSC.CallFrame,
) callconv(.C) ?*Request {
const arguments_ = callframe.arguments(2);
const arguments = arguments_.ptr[0..arguments_.len];
const request = constructInto(globalThis, arguments) orelse {
return null;
};
const request_ = getAllocator(globalThis).create(Request) catch {
return null;
};
request_.* = request;
return request_;
}
pub fn getBodyValue(
this: *Request,
) *Body.Value {
return &this.body.value;
}
pub fn getFetchHeaders(
this: *Request,
) ?*FetchHeaders {
return this.headers;
}
pub fn doClone(
this: *Request,
globalThis: *JSC.JSGlobalObject,
_: *JSC.CallFrame,
) callconv(.C) JSC.JSValue {
var cloned = this.clone(getAllocator(globalThis), globalThis);
return cloned.toJS(globalThis);
}
pub fn getHeaders(
this: *Request,
globalThis: *JSC.JSGlobalObject,
) callconv(.C) JSC.JSValue {
if (this.headers == null) {
if (this.request_context.getRequest()) |req| {
this.headers = FetchHeaders.createFromUWS(globalThis, req);
} else {
this.headers = FetchHeaders.createEmpty();
if (this.body.value == .Blob) {
const content_type = this.body.value.Blob.content_type;
if (content_type.len > 0) {
this.headers.?.put("content-type", content_type, globalThis);
}
}
}
}
return this.headers.?.toJS(globalThis);
}
pub fn cloneHeaders(this: *Request, globalThis: *JSGlobalObject) ?*FetchHeaders {
if (this.headers == null) {
if (this.request_context.getRequest()) |uws_req| {
this.headers = FetchHeaders.createFromUWS(globalThis, uws_req);
}
}
if (this.headers) |head| {
if (head.isEmpty()) {
return null;
}
return head.cloneThis(globalThis);
}
return null;
}
pub fn cloneInto(
this: *Request,
req: *Request,
allocator: std.mem.Allocator,
globalThis: *JSGlobalObject,
preserve_url: bool,
) void {
_ = allocator;
this.ensureURL() catch {};
const body = InitRequestBodyValue(this.body.value.clone(globalThis)) catch {
globalThis.throw("Failed to clone request", .{});
return;
};
const original_url = req.url;
req.* = Request{
.body = body,
.url = if (preserve_url) original_url else this.url.dupeRef(),
.method = this.method,
.headers = this.cloneHeaders(globalThis),
};
if (this.signal) |signal| {
req.signal = signal.ref();
}
}
pub fn clone(this: *Request, allocator: std.mem.Allocator, globalThis: *JSGlobalObject) *Request {
const req = allocator.create(Request) catch unreachable;
this.cloneInto(req, allocator, globalThis, false);
return req;
}
};