Skip to content
Closed
1 change: 1 addition & 0 deletions src/workerd/api/r2-admin.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#pragma once

#include "r2-bucket.h"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessarily for this PR but I highlighted this as a file that needs to move into the internal repo as it was exposed accidentally (it's not now nor will it ever be a public-facing API).

#include "r2-multipart.h"
#include <workerd/jsg/jsg.h>
#include <workerd/api/http.h>

Expand Down
48 changes: 48 additions & 0 deletions src/workerd/api/r2-api.capnp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ struct R2BindingRequest {
createBucket @6 :R2CreateBucketRequest $Json.flatten();
listBucket @7 :R2ListBucketRequest $Json.flatten();
deleteBucket @8 :R2DeleteBucketRequest $Json.flatten();
createMultipartUpload @9 :R2CreateMultipartUploadRequest $Json.flatten();
uploadPart @10 :R2UploadPartRequest $Json.flatten();
completeMultipartUpload @11 :R2CompleteMultipartUploadRequest $Json.flatten();
abortMultipartUpload @12 :R2AbortMultipartUploadRequest $Json.flatten();
}
}

Expand Down Expand Up @@ -56,6 +60,11 @@ struct R2Checksums {
sha512 @4 :Data $Json.hex $Json.name("4");
}

struct R2PublishedPart {
etag @0 :Text;
part @1 :UInt32;
}

struct R2HttpFields {
contentType @0 :Text;
contentLanguage @1 :Text;
Expand Down Expand Up @@ -88,6 +97,29 @@ struct R2PutRequest {
sha512 @8 :Data $Json.hex;
}

struct R2CreateMultipartUploadRequest {
object @0 :Text;
customFields @1 :List(Record);
httpFields @2 :R2HttpFields;
}

struct R2UploadPartRequest {
object @0 :Text;
uploadId @1 :Text;
partNumber @2 :UInt32;
}

struct R2CompleteMultipartUploadRequest {
object @0 :Text;
uploadId @1 :Text;
parts @2 :List(R2PublishedPart);
}

struct R2AbortMultipartUploadRequest {
object @0 :Text;
uploadId @1 :Text;
}

struct R2ListRequest {
limit @0 :UInt32 = 0xffffffff;

Expand Down Expand Up @@ -178,6 +210,22 @@ using R2GetResponse = R2HeadResponse;

using R2PutResponse = R2HeadResponse;

struct R2CreateMultipartUploadResponse {
uploadId @0 :Text;
# The unique identifier of this object, required for subsequent operations on
# this multipart upload.
}

struct R2UploadPartResponse {
etag @0 :Text;
# The ETag the of the uploaded part.
# This ETag is required in order to complete the multipart upload.
}

using R2CompleteMultipartUploadResponse = R2PutResponse;

struct R2AbortMultipartUploadResponse {}

struct R2ListResponse {
objects @0 :List(R2HeadResponse);
truncated @1 :Bool;
Expand Down
99 changes: 98 additions & 1 deletion src/workerd/api/r2-bucket.c++
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the Apache 2.0 license found in the LICENSE file or at:
// https://opensource.org/licenses/Apache-2.0

#include "r2-multipart.h"
#include "r2-bucket.h"
#include "r2-rpc.h"
#include <array>
Expand Down Expand Up @@ -541,6 +542,98 @@ R2Bucket::put(jsg::Lock& js, kj::String name, kj::Maybe<R2PutValue> value,
});
}

jsg::Promise<jsg::Ref<R2MultipartUpload>> R2Bucket::createMultipartUpload(jsg::Lock& js, kj::String key,
jsg::Optional<MultipartOptions> options, const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType) {
return js.evalNow([&] {
auto& context = IoContext::current();
auto client = context.getHttpClient(
clientIndex, true, nullptr, "r2_createMultipartUpload"_kj);

capnp::JsonCodec json;
json.handleByAnnotation<R2BindingRequest>();
json.setHasMode(capnp::HasMode::NON_DEFAULT);
capnp::MallocMessageBuilder requestMessage;

auto requestBuilder = requestMessage.initRoot<R2BindingRequest>();
requestBuilder.setVersion(VERSION_PUBLIC_BETA);
auto payloadBuilder = requestBuilder.initPayload();
auto createMultipartUploadBuilder = payloadBuilder.initCreateMultipartUpload();
createMultipartUploadBuilder.setObject(key);

KJ_IF_MAYBE(o, options) {
KJ_IF_MAYBE(m, o->customMetadata) {
auto fields = createMultipartUploadBuilder.initCustomFields(m->fields.size());
for (size_t i = 0; i < m->fields.size(); i++) {
fields[i].setK(m->fields[i].name);
fields[i].setV(m->fields[i].value);
}
}
KJ_IF_MAYBE(m, o->httpMetadata) {
auto fields = createMultipartUploadBuilder.initHttpFields();
HttpMetadata httpMetadata = [&]() {
KJ_SWITCH_ONEOF(*m) {
KJ_CASE_ONEOF(m, HttpMetadata) {
return kj::mv(m);
}
KJ_CASE_ONEOF(h, jsg::Ref<Headers>) {
return HttpMetadata::fromRequestHeaders(js, *h);
}
}
KJ_UNREACHABLE;
}();

KJ_IF_MAYBE(ct, httpMetadata.contentType) {
fields.setContentType(*ct);
}
KJ_IF_MAYBE(ce, httpMetadata.contentEncoding) {
fields.setContentEncoding(*ce);
}
KJ_IF_MAYBE(cd, httpMetadata.contentDisposition) {
fields.setContentDisposition(*cd);
}
KJ_IF_MAYBE(cl, httpMetadata.contentLanguage) {
fields.setContentLanguage(*cl);
}
KJ_IF_MAYBE(cc, httpMetadata.cacheControl) {
fields.setCacheControl(*cc);
}
KJ_IF_MAYBE(ce, httpMetadata.cacheExpiry) {
fields.setCacheExpiry((*ce - kj::UNIX_EPOCH) / kj::MILLISECONDS);
}
}
}

auto requestJson = json.encode(requestBuilder);
auto bucket = adminBucket.map([](auto&& s) { return kj::str(s); });

auto promise = doR2HTTPPutRequest(js, kj::mv(client), nullptr, nullptr, kj::mv(requestJson),
kj::mv(bucket));

return context.awaitIo(js, kj::mv(promise),
[&errorType, key=kj::mv(key), this] (jsg::Lock& js, R2Result r2Result) mutable {
r2Result.throwIfError("createMultipartUpload", errorType);

capnp::MallocMessageBuilder responseMessage;
capnp::JsonCodec json;
json.handleByAnnotation<R2CreateMultipartUploadResponse>();
auto responseBuilder = responseMessage.initRoot<R2CreateMultipartUploadResponse>();

json.decode(KJ_ASSERT_NONNULL(r2Result.metadataPayload), responseBuilder);
kj::String uploadId = kj::str(responseBuilder.getUploadId());
return jsg::alloc<R2MultipartUpload>(kj::mv(key), kj::mv(uploadId), JSG_THIS);
});
});
}

jsg::Promise<jsg::Ref<R2MultipartUpload>> R2Bucket::resumeMultipartUpload(jsg::Lock& js,
kj::String key, kj::String uploadId, const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType) {
return js.evalNow([&] {
auto& context = IoContext::current();
auto promise = kj::Promise<jsg::Ref<R2MultipartUpload>>(jsg::alloc<R2MultipartUpload>(kj::mv(key), kj::mv(uploadId), JSG_THIS));
return context.awaitIo(js, kj::mv(promise));
Comment on lines +628 to +633

@Frederik-Baetens Frederik-Baetens Oct 12, 2022 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Returning a promise here instead of a straight R2MultipartUpload to allow us to add some checks later on. E.g. we might want to send a request to the gateway worker for example to check if this UploadId is valid.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That might mislead users into thinking that we actually do those checks though 🤔 I'll need to document explicitly that we don't do those checks.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're overthinking things here. A promise is out of place as there would never be any I/O that would be added under the hood.

});
}

jsg::Promise<void> R2Bucket::delete_(jsg::Lock& js, kj::OneOf<kj::String, kj::Array<kj::String>> keys,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType) {
return js.evalNow([&] {
Expand Down Expand Up @@ -782,7 +875,6 @@ R2Bucket::HttpMetadata R2Bucket::HttpMetadata::clone() const {
};
}


void R2Bucket::HeadResult::writeHttpMetadata(jsg::Lock& js, Headers& headers) {
JSG_REQUIRE(httpMetadata != nullptr, TypeError,
"HTTP metadata unknown for key `", name,
Expand Down Expand Up @@ -896,4 +988,9 @@ kj::Array<kj::byte> cloneByteArray(const kj::Array<kj::byte> &arr) {
return kj::heapArray(arr.asPtr());
}

kj::Maybe<jsg::Ref<R2Bucket::HeadResult>> parseHeadResultWrapper(
kj::StringPtr action, R2Result& r2Result, const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType) {
return parseObjectMetadata<R2Bucket::HeadResult>(action, r2Result, errorType);
}

} // namespace workerd::api::public_beta
68 changes: 44 additions & 24 deletions src/workerd/api/r2-bucket.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@

#include <workerd/jsg/jsg.h>
#include <workerd/api/http.h>
#include <workerd/api/r2-api.capnp.h>
#include <capnp/compat/json.h>
#include <workerd/util/http-util.h>

namespace workerd::api::public_beta {

kj::Array<kj::byte> cloneByteArray(const kj::Array<kj::byte>& arr);

class R2MultipartUpload;

class R2Bucket: public jsg::Object {
// A capability to an R2 Bucket.

Expand Down Expand Up @@ -137,6 +142,13 @@ class R2Bucket: public jsg::Object {
JSG_STRUCT(onlyIf, httpMetadata, customMetadata, md5, sha1, sha256, sha384, sha512);
};

struct MultipartOptions {
jsg::Optional<kj::OneOf<HttpMetadata, jsg::Ref<Headers>>> httpMetadata;
jsg::Optional<jsg::Dict<kj::String>> customMetadata;

JSG_STRUCT(httpMetadata, customMetadata);
};

class HeadResult: public jsg::Object {
public:
HeadResult(kj::String name, kj::String version, double size,
Expand Down Expand Up @@ -260,24 +272,41 @@ class R2Bucket: public jsg::Object {
JSG_STRUCT(limit, prefix, cursor, delimiter, startAfter, include);
};

jsg::Promise<kj::Maybe<jsg::Ref<HeadResult>>> head(jsg::Lock& js, kj::String key,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType);

jsg::Promise<kj::Maybe<jsg::Ref<HeadResult>>> head(
jsg::Lock& js, kj::String key,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);
jsg::Promise<kj::OneOf<kj::Maybe<jsg::Ref<GetResult>>, jsg::Ref<HeadResult>>> get(
jsg::Lock& js, kj::String key, jsg::Optional<GetOptions> options,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType);
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);
jsg::Promise<kj::Maybe<jsg::Ref<HeadResult>>> put(jsg::Lock& js,
kj::String key, kj::Maybe<R2PutValue> value, jsg::Optional<PutOptions> options,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType);
jsg::Promise<void> delete_(jsg::Lock& js, kj::OneOf<kj::String, kj::Array<kj::String>> keys,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType);
jsg::Promise<ListResult> list(jsg::Lock& js, jsg::Optional<ListOptions> options,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType);
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);
jsg::Promise<jsg::Ref<R2MultipartUpload>> createMultipartUpload(
jsg::Lock& js, kj::String key, jsg::Optional<MultipartOptions> options,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);
jsg::Promise<jsg::Ref<R2MultipartUpload>> resumeMultipartUpload(
jsg::Lock& js, kj::String key, kj::String uploadId,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);
jsg::Promise<void> delete_(
jsg::Lock& js, kj::OneOf<kj::String, kj::Array<kj::String>> keys,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);
jsg::Promise<ListResult> list(
jsg::Lock& js, jsg::Optional<ListOptions> options,
const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType
);

JSG_RESOURCE_TYPE(R2Bucket) {
JSG_METHOD(head);
JSG_METHOD(get);
JSG_METHOD(put);
JSG_METHOD(createMultipartUpload);
Comment thread
Frederik-Baetens marked this conversation as resolved.
Resolved
JSG_METHOD(resumeMultipartUpload);
JSG_METHOD_NAMED(delete, delete_);
JSG_METHOD(list);
}
Expand All @@ -304,22 +333,13 @@ class R2Bucket: public jsg::Object {
kj::Maybe<kj::String> adminBucket;

friend class R2Admin;
friend class R2MultipartUpload;
};

#define EW_R2_PUBLIC_BETA_ISOLATE_TYPES \
api::R2Error, \
api::public_beta::R2Bucket, \
api::public_beta::R2Bucket::HeadResult, \
api::public_beta::R2Bucket::GetResult, \
api::public_beta::R2Bucket::Range, \
api::public_beta::R2Bucket::Conditional, \
api::public_beta::R2Bucket::GetOptions, \
api::public_beta::R2Bucket::PutOptions, \
api::public_beta::R2Bucket::Checksums, \
api::public_beta::R2Bucket::StringChecksums, \
api::public_beta::R2Bucket::HttpMetadata, \
api::public_beta::R2Bucket::ListOptions, \
api::public_beta::R2Bucket::ListResult
// The list of r2-bucket.h types that are added to worker.c++'s JSG_DECLARE_ISOLATE_TYPE
kj::Maybe<jsg::Ref<R2Bucket::HeadResult>> parseHeadResultWrapper(
kj::StringPtr action, R2Result& r2Result, const jsg::TypeHandler<jsg::Ref<R2Error>>& errorType);
// Non-generic wrapper avoid moving the parseObjectMetadata implementation into this header file
// by making use of dynamic dispatch.

} // namespace workerd::api::public_beta

Loading