fix VFS metadata cancellation and provider absence semantics

Author: KSemenenko

Directory.Build.props

@@ -29,8 +29,8 @@
         <RepositoryUrl>https://github.com/managedcode/Storage</RepositoryUrl>
         <PackageProjectUrl>https://github.com/managedcode/Storage</PackageProjectUrl>
         <Product>Managed Code - Storage</Product>
-        <Version>10.1.6</Version>
-        <PackageVersion>10.1.6</PackageVersion>
+        <Version>10.1.7</Version>
+        <PackageVersion>10.1.7</PackageVersion>
 
     </PropertyGroup>
 

ManagedCode.Storage.VirtualFileSystem/Extensions/ServiceCollectionExtensions.cs

@@ -146,64 +146,35 @@ public override async Task SetVfsMetadataAsync(
         string blobName,
         CancellationToken cancellationToken = default)
     {
-        _logger.LogDebug("Getting VFS metadata for: {BlobName}", blobName);
-
-        try
-        {
-            var blobMetadata = await _storage.GetBlobMetadataAsync(blobName, cancellationToken);
-            if (blobMetadata.IsFailed || blobMetadata.Value.Metadata == null)
-            {
-                return null;
-            }
-
-            return ParseVfsMetadata(blobMetadata.Value.Metadata);
-        }
-        catch (Exception ex)
-        {
-            _logger.LogError(ex, "Error getting VFS metadata for: {BlobName}", blobName);
-            return null;
-        }
+        var metadata = await GetBlobInfoAsync(blobName, cancellationToken);
+        return metadata?.Metadata is { } values ? ParseVfsMetadata(values) : null;
     }
 
     public override async Task<IReadOnlyDictionary<string, string>> GetCustomMetadataAsync(
         string blobName,
         CancellationToken cancellationToken = default)
     {
-        _logger.LogDebug("Getting custom metadata for: {BlobName}", blobName);
-
-        try
-        {
-            var blobMetadata = await _storage.GetBlobMetadataAsync(blobName, cancellationToken);
-            if (blobMetadata.IsFailed || blobMetadata.Value.Metadata == null)
-            {
-                return new Dictionary<string, string>();
-            }
-
-            return ExtractCustomMetadata(blobMetadata.Value.Metadata);
-        }
-        catch (Exception ex)
-        {
-            _logger.LogError(ex, "Error getting custom metadata for: {BlobName}", blobName);
-            return new Dictionary<string, string>();
-        }
+        var metadata = await GetBlobInfoAsync(blobName, cancellationToken);
+        return metadata?.Metadata is { } values
+            ? ExtractCustomMetadata(values)
+            : new Dictionary<string, string>();
     }
 
     public override async Task<BlobMetadata?> GetBlobInfoAsync(
         string blobName,
         CancellationToken cancellationToken = default)
     {
-        _logger.LogDebug("Getting blob info for: {BlobName}", blobName);
-
-        try
-        {
-            var result = await _storage.GetBlobMetadataAsync(blobName, cancellationToken);
-            return result.IsSuccess ? result.Value : null;
-        }
-        catch (Exception ex)
+        cancellationToken.ThrowIfCancellationRequested();
+        var result = await _storage.GetBlobMetadataAsync(blobName, cancellationToken);
+        // Portable providers may return cancellation as a failed Result. It must
+        // neither become a missing file nor populate the VFS metadata cache.
+        cancellationToken.ThrowIfCancellationRequested();
+        if (result.IsFailed && result.Problem.StatusCode == 404)
         {
-            _logger.LogDebug(ex, "Blob not found or error getting blob info: {BlobName}", blobName);
             return null;
         }
+        result.ThrowIfProblem();
+        return result.Value;
     }
 }
 

Storages/ManagedCode.Storage.Aws/AWSStorage.cs

@@ -312,6 +312,10 @@ protected override async Task<Result<BlobMetadata>> GetBlobMetadataInternalAsync
 
             return Result<BlobMetadata>.Succeed(metadata);
         }
+        catch (AmazonS3Exception ex) when (ex.StatusCode == HttpStatusCode.NotFound)
+        {
+            return Result<BlobMetadata>.Fail(Problem.FromException(ex, 404));
+        }
         catch (Exception ex)
         {
             _logger.LogException(ex);

Storages/ManagedCode.Storage.Azure.DataLake/AzureDataLakeStorage.cs

@@ -1,3 +1,4 @@
+using Azure;
 using System;
 using System.Collections.Generic;
 using System.IO;
@@ -265,6 +266,10 @@ protected override async Task<Result<BlobMetadata>> GetBlobMetadataInternalAsync
                 MimeType = properties.Value.ContentType
             });
         }
+        catch (RequestFailedException ex) when (ex.Status == 404)
+        {
+            return Result<BlobMetadata>.Fail(Problem.FromException(ex, 404));
+        }
         catch (Exception ex)
         {
             _logger.LogException(ex);

Storages/ManagedCode.Storage.Browser/BrowserStorage.cs

@@ -230,7 +230,7 @@ protected override async Task<Result<BlobMetadata>> GetBlobMetadataInternalAsync
         {
             var storedBlob = await ReadStoredBlobAsync(options, cancellationToken);
             return storedBlob is null
-                ? Result<BlobMetadata>.Fail("File not found")
+                ? Result<BlobMetadata>.FailNotFound("File not found")
                 : Result<BlobMetadata>.Succeed(ToBlobMetadata(storedBlob));
         }
         catch (Exception ex)

Storages/ManagedCode.Storage.FileSystem/FileSystemStorage.cs

@@ -294,7 +294,7 @@ protected override async Task<Result<BlobMetadata>> GetBlobMetadataInternalAsync
 
             var fileInfo = new FileInfo(filePath);
             if (!fileInfo.Exists)
-                return Result<BlobMetadata>.Fail("File not found");
+                return Result<BlobMetadata>.FailNotFound("File not found");
 
             var relativePath = Path.GetRelativePath(StorageClient, filePath)
                 .Replace('\\', '/');

Storages/ManagedCode.Storage.Google/GCPStorage.cs

@@ -325,6 +325,10 @@ protected override async Task<Result<BlobMetadata>> GetBlobMetadataInternalAsync
                 Length = obj.Size ?? 0
             });
         }
+        catch (GoogleApiException ex) when (ex.HttpStatusCode == HttpStatusCode.NotFound)
+        {
+            return Result<BlobMetadata>.Fail(Problem.FromException(ex, 404));
+        }
         catch (Exception ex)
         {
             _logger.LogException(ex);

Storages/ManagedCode.Storage.Sftp/SftpStorage.cs

@@ -400,7 +400,7 @@ protected override async Task<Result<BlobMetadata>> GetBlobMetadataInternalAsync
             var remotePath = BuildPath(options.FullPath);
             if (!StorageClient.Exists(remotePath))
             {
-                return Result<BlobMetadata>.Fail("File not found");
+                return Result<BlobMetadata>.FailNotFound("File not found");
             }
 
             var attributes = StorageClient.GetAttributes(remotePath);

Tests/ManagedCode.Storage.Tests/Storages/Abstracts/BlobTests.cs

@@ -11,6 +11,17 @@ namespace ManagedCode.Storage.Tests.Storages.Abstracts;
 
 public abstract class BlobTests<T> : BaseContainer<T> where T : IContainer
 {
+    [Fact]
+    public async Task MissingBlobMetadata_PreservesNotFoundAfterARealWriteAndDelete()
+    {
+        var file = await UploadTestFileAsync();
+        (await Storage.GetBlobMetadataAsync(file.Name, TestContext.Current.CancellationToken)).IsSuccess.ShouldBeTrue();
+        (await Storage.DeleteAsync(file.Name, TestContext.Current.CancellationToken)).IsSuccess.ShouldBeTrue();
+        var missing = await Storage.GetBlobMetadataAsync(file.Name, TestContext.Current.CancellationToken);
+        missing.IsFailed.ShouldBeTrue();
+        missing.Problem.StatusCode.ShouldBe(404);
+    }
+
     [Fact]
     public async Task GetBlobListAsync_WithoutOptions()
     {

Tests/ManagedCode.Storage.Tests/Storages/DataLake/AzureDataLakeProtocolTests.cs

@@ -73,6 +73,9 @@ public async Task FilesAndStreams_RoundTripThroughRealAzureSdk(string? directory
         }
         (await storage.DeleteAsync(key, token)).IsSuccess.ShouldBeTrue();
         (await storage.ExistsAsync(key, token)).Value.ShouldBeFalse();
+        var missingMetadata = await storage.GetBlobMetadataAsync(key, token);
+        missingMetadata.IsFailed.ShouldBeTrue();
+        missingMetadata.Problem.StatusCode.ShouldBe(404);
         (await storage.RemoveContainerAsync(token)).IsSuccess.ShouldBeTrue();
     }