Include the response/variation key in the stored json files for easier debugging

Author: rmja

src/HttpClient.Cache/Files/FileCache.cs

@@ -256,7 +256,7 @@ TimeProvider timeProvider
             );
             var variationFile = VariationFile.CreateTemp(_tempDirectory);
 
-            await variationFile.WriteAsync(variation);
+            await variationFile.WriteAsync(variationKey, variation);
 
             // Let the variation file have the same (possibly updated) expiration as the response
             variationFileName.SetExpiration(variationFile.Info, expiration);
@@ -276,8 +276,9 @@ CancellationToken cancellationToken
     {
         var modified = response.GetModified() ?? now;
         var expiration = response.GetExpiration(now) ?? (now + DefaultInitialExpiration);
-        var metadata = new Metadata()
+        var metadata = new MetadataModel()
         {
+            Key = responseKey,
             Url = response.RequestMessage!.RequestUri!,
             Version = response.Version,
             StatusCode = response.StatusCode,
@@ -300,8 +301,6 @@ CancellationToken cancellationToken
                     x.Value.ToList()
                 ))
                 .ToList(),
-            Etag = response.Headers.ETag?.ToString(),
-            LastModified = response.Content.Headers.LastModified,
         };
 
         var metadataFileName = FileName.Metadata(responseKey, modified, response.Headers.ETag);

src/HttpClient.Cache/Files/FileCacheSerializerContext.cs

@@ -2,8 +2,8 @@
 
 namespace HttpClientCache.Files;
 
-[JsonSerializable(typeof(Metadata))]
-[JsonSerializable(typeof(Variation))]
+[JsonSerializable(typeof(MetadataModel))]
+[JsonSerializable(typeof(VariationModel))]
 [JsonSourceGenerationOptions(
     PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
     WriteIndented = true,

src/HttpClient.Cache/Files/Metadata.cs …/HttpClient.Cache/Files/MetadataModel.cssrc/HttpClient.Cache/Files/Metadata.cs renamed to src/HttpClient.Cache/Files/MetadataModel.cs src/HttpClient.Cache/Files/Metadata.cs renamed to src/HttpClient.Cache/Files/MetadataModel.cs

@@ -2,15 +2,14 @@
 
 namespace HttpClientCache.Files;
 
-public record Metadata
+public record MetadataModel
 {
+    public required string Key { get; init; }
     public required Uri Url { get; init; }
     public required Version Version { get; init; }
     public required HttpStatusCode StatusCode { get; init; }
     public required string? ReasonPhrase { get; init; }
     public required List<KeyValuePair<string, List<string>>> ResponseHeaders { get; init; }
     public required List<KeyValuePair<string, List<string>>> ContentHeaders { get; init; }
     public required List<KeyValuePair<string, List<string>>>? TrailingHeaders { get; init; }
-    public required string? Etag { get; init; }
-    public required DateTimeOffset? LastModified { get; init; }
 }

src/HttpClient.Cache/Files/ResponseFilePair.cs

@@ -113,23 +113,23 @@ public readonly bool TryMakePermanent(DirectoryInfo rootDirectory, FileName meta
         return response;
     }
 
-    public readonly async ValueTask<Metadata> ReadMetadataAsync()
+    public readonly async ValueTask<MetadataModel> ReadMetadataAsync()
     {
         await using var stream = MetadataInfo.OpenRead();
         var metadata = await JsonSerializer.DeserializeAsync(
             stream,
-            FileCacheSerializerContext.Default.Metadata
+            FileCacheSerializerContext.Default.MetadataModel
         );
         return metadata!;
     }
 
-    public readonly async ValueTask WriteMetadataAsync(Metadata metadata)
+    public readonly async ValueTask WriteMetadataAsync(MetadataModel metadata)
     {
         await using var stream = MetadataInfo.OpenWrite();
         await JsonSerializer.SerializeAsync(
             stream,
             metadata,
-            FileCacheSerializerContext.Default.Metadata
+            FileCacheSerializerContext.Default.MetadataModel
         );
     }
 

src/HttpClient.Cache/Files/VariationFile.cs

@@ -38,20 +38,29 @@ public readonly bool TryMakePermanent(DirectoryInfo rootDirectory, FileName vari
         }
 
         await using var stream = Info.OpenRead();
-        var variation = await JsonSerializer.DeserializeAsync(
+        var model = await JsonSerializer.DeserializeAsync(
             stream,
-            FileCacheSerializerContext.Default.Variation
+            FileCacheSerializerContext.Default.VariationModel
         );
-        return variation!;
+        return new Variation(model!.CacheType)
+        {
+            NormalizedVaryHeaders = model.NormalizedVaryHeaders,
+        };
     }
 
-    public readonly async ValueTask WriteAsync(Variation variation)
+    public readonly async ValueTask WriteAsync(string key, Variation variation)
     {
+        var model = new VariationModel
+        {
+            Key = key,
+            CacheType = variation.CacheType,
+            NormalizedVaryHeaders = variation.NormalizedVaryHeaders,
+        };
         using var stream = Info.OpenWrite();
         await JsonSerializer.SerializeAsync(
             stream,
-            variation,
-            FileCacheSerializerContext.Default.Variation
+            model,
+            FileCacheSerializerContext.Default.VariationModel
         );
     }
 

src/HttpClient.Cache/Files/VariationModel.cs

@@ -0,0 +1,8 @@
+namespace HttpClientCache.Files;
+
+internal class VariationModel
+{
+    public required string Key { get; init; } = string.Empty;
+    public required CacheType CacheType { get; init; }
+    public required List<string> NormalizedVaryHeaders { get; init; }
+}