Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add batch protocol layer #3580

Merged
merged 2 commits into from
Apr 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sdk/core/azure-core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

### Features Added

- Add `Azure::Core::Http::Request` constructor overload to support payload and non-buffered response.

### Breaking Changes

### Bugs Fixed
Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-core/inc/azure/core/http/http.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ namespace Azure { namespace Core { namespace Http {
// previously called
void StartTry();

public:
/**
* @brief Construct an #Azure::Core::Http::Request.
*
Expand All @@ -229,7 +230,6 @@ namespace Azure { namespace Core { namespace Http {
AZURE_ASSERT_MSG(bodyStream, "The bodyStream pointer cannot be null.");
}

public:
/**
* @brief Constructs a `%Request`.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -807,6 +807,18 @@ namespace Azure { namespace Storage { namespace Blobs {
struct RenameBlobContainerResult final
{
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobContainerClient::SubmitBatch.
*/
struct SubmitBatchResult final
{
std::unique_ptr<Core::IO::BodyStream> BodyStream;
/**
* The media type of the body of the response. For batch requests, this is multipart/mixed;
* boundary=batchresponse_GUID.
*/
std::string ContentType;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobContainerClient::AcquireLease.
*/
Expand Down Expand Up @@ -2971,6 +2983,16 @@ namespace Azure { namespace Storage { namespace Blobs {
const Core::Url& url,
const GetServiceAccountInfoOptions& options,
const Core::Context& context);
struct SubmitServiceBatchOptions final
{
std::string MultipartContentType;
};
static Response<Models::_detail::SubmitBatchResult> SubmitBatch(
Core::Http::_internal::HttpPipeline& pipeline,
const Core::Url& url,
Core::IO::BodyStream& requestBody,
const SubmitServiceBatchOptions& options,
const Core::Context& context);
struct FindServiceBlobsByTagsOptions final
{
Nullable<std::string> Where;
Expand Down Expand Up @@ -3070,6 +3092,16 @@ namespace Azure { namespace Storage { namespace Blobs {
const Core::Url& url,
const RenameBlobContainerOptions& options,
const Core::Context& context);
struct SubmitBlobContainerBatchOptions final
{
std::string MultipartContentType;
};
static Response<Models::_detail::SubmitBatchResult> SubmitBatch(
Core::Http::_internal::HttpPipeline& pipeline,
const Core::Url& url,
Core::IO::BodyStream& requestBody,
const SubmitBlobContainerBatchOptions& options,
const Core::Context& context);
struct AcquireBlobContainerLeaseOptions final
{
Nullable<int32_t> Duration;
Expand Down
55 changes: 55 additions & 0 deletions sdk/storage/azure-storage-blobs/src/rest_client.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1188,6 +1188,33 @@ namespace Azure { namespace Storage { namespace Blobs {
= pRawResponse->GetHeaders().at("x-ms-is-hns-enabled") == std::string("true");
return Response<Models::AccountInfo>(std::move(response), std::move(pRawResponse));
}
Response<Models::_detail::SubmitBatchResult> ServiceClient::SubmitBatch(
Core::Http::_internal::HttpPipeline& pipeline,
const Core::Url& url,
Core::IO::BodyStream& requestBody,
const SubmitServiceBatchOptions& options,
const Core::Context& context)
{
auto request = Core::Http::Request(Core::Http::HttpMethod::Post, url, &requestBody, false);
request.GetUrl().AppendQueryParameter("comp", "batch");
request.SetHeader("Content-Length", std::to_string(requestBody.Length()));
if (!options.MultipartContentType.empty())
{
request.SetHeader("Content-Type", options.MultipartContentType);
}
request.SetHeader("x-ms-version", "2020-08-04");
auto pRawResponse = pipeline.Send(request, context);
auto httpStatusCode = pRawResponse->GetStatusCode();
if (httpStatusCode != Core::Http::HttpStatusCode::Accepted)
{
throw StorageException::CreateFromResponse(std::move(pRawResponse));
}
Models::_detail::SubmitBatchResult response;
response.BodyStream = pRawResponse->ExtractBodyStream();
response.ContentType = pRawResponse->GetHeaders().at("Content-Type");
return Response<Models::_detail::SubmitBatchResult>(
std::move(response), std::move(pRawResponse));
}
Response<Models::_detail::FindBlobsByTagsResult> ServiceClient::FindBlobsByTags(
Core::Http::_internal::HttpPipeline& pipeline,
const Core::Url& url,
Expand Down Expand Up @@ -1769,6 +1796,34 @@ namespace Azure { namespace Storage { namespace Blobs {
return Response<Models::_detail::RenameBlobContainerResult>(
std::move(response), std::move(pRawResponse));
}
Response<Models::_detail::SubmitBatchResult> BlobContainerClient::SubmitBatch(
Core::Http::_internal::HttpPipeline& pipeline,
const Core::Url& url,
Core::IO::BodyStream& requestBody,
const SubmitBlobContainerBatchOptions& options,
const Core::Context& context)
{
auto request = Core::Http::Request(Core::Http::HttpMethod::Post, url, &requestBody, false);
request.GetUrl().AppendQueryParameter("restype", "container");
request.GetUrl().AppendQueryParameter("comp", "batch");
request.SetHeader("Content-Length", std::to_string(requestBody.Length()));
if (!options.MultipartContentType.empty())
{
request.SetHeader("Content-Type", options.MultipartContentType);
}
request.SetHeader("x-ms-version", "2020-08-04");
auto pRawResponse = pipeline.Send(request, context);
auto httpStatusCode = pRawResponse->GetStatusCode();
if (httpStatusCode != Core::Http::HttpStatusCode::Accepted)
{
throw StorageException::CreateFromResponse(std::move(pRawResponse));
}
Models::_detail::SubmitBatchResult response;
response.BodyStream = pRawResponse->ExtractBodyStream();
response.ContentType = pRawResponse->GetHeaders().at("Content-Type");
return Response<Models::_detail::SubmitBatchResult>(
std::move(response), std::move(pRawResponse));
}
Response<Models::_detail::AcquireBlobContainerLeaseResult> BlobContainerClient::AcquireLease(
Core::Http::_internal::HttpPipeline& pipeline,
const Core::Url& url,
Expand Down
30 changes: 28 additions & 2 deletions sdk/storage/azure-storage-blobs/swagger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ directive:
transform: >
delete $["/{containerName}?restype=account&comp=properties"];
delete $["/{containerName}/{blob}?restype=account&comp=properties"];
delete $["/?comp=batch"];
delete $["/{containerName}?restype=container&comp=batch"];
delete $["/{filesystem}/{path}?action=setAccessControl&blob"];
delete $["/{filesystem}/{path}?action=getAccessControl&blob"];
delete $["/{filesystem}/{path}?FileRename"];
Expand Down Expand Up @@ -1574,4 +1572,32 @@ directive:
where: $["x-ms-paths"]["/{containerName}/{blob}?comp=legalhold"].put.responses["200"].headers
transform: >
$["x-ms-legal-hold"]["x-ms-client-name"] = "HasLegalHold";
```


### SubmitBatch

```yaml
directive:
- from: swagger-document
where: $.definitions
transform: >
$.SubmitBatchResult = {
"type": "object",
"x-ms-sealed": false,
"x-namespace": "_detail",
"properties": {
"BodyStream": {"type": "object", "format": "file"}
}
};
- from: swagger-document
where: $["x-ms-paths"]["/?comp=batch"].post.responses
transform: >
$["202"] = $["200"];
delete $["200"];
$["202"].schema = {"$ref": "#/definitions/SubmitBatchResult"};
- from: swagger-document
where: $["x-ms-paths"]["/{containerName}?restype=container&comp=batch"].post.responses["202"]
transform: >
$.schema = {"$ref": "#/definitions/SubmitBatchResult"};
```