Skip to content

fix(storage): forward metadata and custom headers in UploadToSignedUrl #423

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.

Sign up for GitHub

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

Merged
Tr00d merged 1 commit into from
Sep 10, 2026
+63 −0
Merged

fix(storage): forward metadata and custom headers in UploadToSignedUrl #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
56 changes: 56 additions & 0 deletions packages/Storage/Storage.Tests/Files/StorageFileApiContractTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,62 @@ public async Task List_ShouldSurfaceStorageException_GivenNonJsonError()
}
}

[TestMethod]
public async Task UploadToSignedUrl_ShouldForwardMetadataAndCustomHeaders_GivenFileOptions()
{
var signedUrl = new UploadSignedUrl(
new Uri($"{this.server.Url}/storage/v1/object/upload/sign/{Bucket}/file.bin?token=abc"),
"abc",
"file.bin");
this.Respond($"/storage/v1/object/upload/sign/{Bucket}/file.bin", "POST", 200, "{\"Key\":\"x\"}");
var options = new FileOptions
{
ContentType = "image/png",
Metadata = new Dictionary<string, string> { ["k"] = "v" },
Headers = new Dictionary<string, string> { ["x-version"] = "123" }
};
await this.client.From(Bucket).UploadToSignedUrl(Encoding.UTF8.GetBytes("data"), signedUrl, options, inferContentType: false);
var request = this.SingleRequest();
using (new AssertionScope())
{
this.HeaderOf(request, "x-metadata").Should().NotBeNullOrEmpty("metadata must ride the signed-URL upload (issue #252)");
this.HeaderOf(request, "x-version").Should().Be("123", "custom headers must merge into the signed-URL upload (issue #252)");
}
}

[TestMethod]
public async Task UploadToSignedUrlFromDisk_ShouldForwardMetadataAndCustomHeaders_GivenFileOptions()
{
var signedUrl = new UploadSignedUrl(
new Uri($"{this.server.Url}/storage/v1/object/upload/sign/{Bucket}/file.bin?token=abc"),
"abc",
"file.bin");
this.Respond($"/storage/v1/object/upload/sign/{Bucket}/file.bin", "POST", 200, "{\"Key\":\"x\"}");
var localPath = Path.Combine(Path.GetTempPath(), $"{Guid.NewGuid()}.bin");
await File.WriteAllBytesAsync(localPath, new byte[] { 0x1, 0x2 });
try
{
var options = new FileOptions
{
ContentType = "image/png",
Metadata = new Dictionary<string, string> { ["k"] = "v" },
Headers = new Dictionary<string, string> { ["x-version"] = "123" }
};
await this.client.From(Bucket).UploadToSignedUrl(localPath, signedUrl, options, inferContentType: false);
var request = this.SingleRequest();
using (new AssertionScope())
{
this.HeaderOf(request, "x-metadata").Should().NotBeNullOrEmpty("metadata must ride the from-disk signed-URL upload (issue #252)");
this.HeaderOf(request, "x-version").Should().Be("123", "custom headers must merge into the from-disk signed-URL upload (issue #252)");
}
}
finally
{
if (File.Exists(localPath))
File.Delete(localPath);
}
}

private void Respond(string path, string method, int statusCode, string body) =>
this.server.Given(Request.Create().WithPath(path).UsingMethod(method))
.RespondWith(Response.Create().WithStatusCode(statusCode)
Expand Down
7 changes: 7 additions & 0 deletions packages/Storage/Storage/StorageFileApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,11 @@ public async Task<string> UploadToSignedUrl(
if (options.Upsert)
this.StorageHeader.Add("x-upsert", options.Upsert.ToString().ToLower());

if (options.Metadata != null)
this.StorageHeader.Add("x-metadata", ParseMetadata(options.Metadata));

options.Headers?.ToList().ForEach(x => this.StorageHeader.Add(x.Key, x.Value));

var progress = new Progress<float>();

if (onProgress != null)
Expand Down Expand Up @@ -446,6 +451,8 @@ public async Task<string> UploadToSignedUrl(
if (options.Metadata != null)
this.StorageHeader.Add("x-metadata", ParseMetadata(options.Metadata));

options.Headers?.ToList().ForEach(x => this.StorageHeader.Add(x.Key, x.Value));

var progress = new Progress<float>();

if (onProgress != null)
Expand Down
Loading