Skip to content

Throw S3FileStorageException when something goes wrong and response is not as expected. #305

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
merged 8 commits into from
May 29, 2025
Merged

Throw S3FileStorageException when something goes wrong and response is not as expected. #305

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aab49bc
Throw S3FileStorageException when something goes wrong and response i…
frabe1579 Nov 7, 2022
3853945
Update src/Foundatio.AWS/Storage/S3FileStorage.cs
frabe1579 Nov 7, 2022
de7a5ef
Use exception filter when possible
frabe1579 Nov 7, 2022
6506e60
Merge branch 'master' of https://github.com/frabe1579/Foundatio.AWS
frabe1579 Nov 7, 2022
0907c28
Unified S3FileStorageException messages
frabe1579 Nov 7, 2022
b2744d4
Merge branch 'main' into s3-resolve
frabe1579 May 6, 2025
d86581e
Update S3FileStorage.cs
frabe1579 May 13, 2025
aa0be8a
Update S3FileStorage.cs, fixed typo
frabe1579 May 21, 2025
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
22 changes: 15 additions & 7 deletions src/Foundatio.AWS/Storage/S3FileStorage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
using Amazon.S3.Model;
using Amazon.S3.Util;
using Foundatio.AWS.Extensions;
using Foundatio.AWS.Storage;
using Foundatio.Extensions;
using Foundatio.Serializer;
using Microsoft.Extensions.Logging;
Expand Down Expand Up @@ -54,7 +55,7 @@ public S3FileStorage(Builder<S3FileStorageOptionsBuilder, S3FileStorageOptions>
: this(builder(new S3FileStorageOptionsBuilder()).Build()) { }

ISerializer IHaveSerializer.Serializer => _serializer;

public AmazonS3Client Client => _client;
public string Bucket => _bucket;
public S3CannedACL CannedACL => _cannedAcl;
Expand All @@ -69,9 +70,13 @@ public S3FileStorage(Builder<S3FileStorageOptionsBuilder, S3FileStorageOptions>
};

var res = await _client.GetObjectAsync(req, cancellationToken).AnyContext();
if (!res.HttpStatusCode.IsSuccessful())

if (res.HttpStatusCode == System.Net.HttpStatusCode.NotFound)
return null;

if (res.HttpStatusCode != System.Net.HttpStatusCode.OK)
throw new S3FileStorageException($"Invalid status code {res.HttpStatusCode} ({(int)res.HttpStatusCode}): Expected 200 OK");

return new ActionableStream(res.ResponseStream, () => {
res?.Dispose();
});
Expand All @@ -89,16 +94,19 @@ public async Task<FileSpec> GetFileInfoAsync(string path) {
try {
var res = await _client.GetObjectMetadataAsync(req).AnyContext();

if (!res.HttpStatusCode.IsSuccessful())
if (res.HttpStatusCode == System.Net.HttpStatusCode.NotFound)
return null;

if (res.HttpStatusCode != System.Net.HttpStatusCode.OK)
throw new S3FileStorageException($"Invalid status code {res.HttpStatusCode} ({(int)res.HttpStatusCode}): Expected 200 OK");

return new FileSpec {
Size = res.ContentLength,
Created = res.LastModified.ToUniversalTime(), // TODO: Need to fix this
Modified = res.LastModified.ToUniversalTime(),
Path = path
};
} catch (AmazonS3Exception) {
} catch (AmazonS3Exception ex) when (ex.StatusCode == System.Net.HttpStatusCode.NotFound) {
return null;
}
}
Expand Down Expand Up @@ -209,7 +217,7 @@ public async Task<bool> ExistsAsync(string path) {
continue;

deleteRequest.Objects.AddRange(keys);

var deleteResponse = await _client.DeleteObjectsAsync(deleteRequest, cancellationToken).AnyContext();
if (deleteResponse.DeleteErrors.Count > 0) {
// retry 1 time, continue on.
Expand Down Expand Up @@ -259,9 +267,9 @@ private async Task<NextPageResult> GetFiles(SearchCriteria criteria, int pageSiz
Files = response.S3Objects.MatchesPattern(criteria.Pattern).Select(blob => blob.ToFileInfo()).ToList(),
NextPageFunc = response.IsTruncated ? r => GetFiles(criteria, pageSize, cancellationToken, response.NextContinuationToken) : (Func<PagedFileListResult, Task<NextPageResult>>)null
};
}
}

private class SearchCriteria {
private class SearchCriteria {
public string Prefix { get; set; }
public Regex Pattern { get; set; }
}
Expand Down
16 changes: 16 additions & 0 deletions src/Foundatio.AWS/Storage/S3FileStorageException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
using System;
using System.Collections.Generic;
using System.Text;

namespace Foundatio.AWS.Storage {
Copy link
Contributor

Choose a reason for hiding this comment

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

We definitely don't want to have exceptions that are unique to each implementation where a user would need to check for different kinds of exceptions depending on which implementation they are using.

Copy link
Contributor

Choose a reason for hiding this comment

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

@frabe1579 I think this was the main concern with merging this PR. We don't want to have different exceptions being thrown per implementation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry I'm not comfortable with branches and pull-requests. I've removed S3FileStorageException and corrected code. Can you see it?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, thank you, we can delete this file.

Copy link
Member

@niemyjski niemyjski May 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'm going to work towards merging this pr then create a StorageException in the core library and update the core implementations and then update this line (post merge) to use this new exception type.

Thanks again for the pr!

Copy link
Member

Choose a reason for hiding this comment

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

FoundatioFx/Foundatio#385

public class S3FileStorageException : Exception {
public S3FileStorageException() : base() {
}

public S3FileStorageException(string message) : base(message) {
}

public S3FileStorageException(string message, Exception innerException) : base(message, innerException) {
}
}
}