Better logging

Author: Porges

src/ApiService/ApiService/Functions/QueueFileChanges.cs

@@ -99,14 +99,16 @@ private async Async.Task<bool> ApplyRetentionPolicy(ResourceIdentifier storageAc
             var containerClient = account.GetBlobContainerClient(container.String);
             var containerProps = await containerClient.GetPropertiesAsync();
             var retentionPeriod = RetentionPolicyUtils.GetContainerRetentionPeriodFromMetadata(containerProps.Value.Metadata);
-            if (retentionPeriod.HasValue) {
+            if (!retentionPeriod.IsOk) {
+                _log.LogError("invalid retention period: {Error}", retentionPeriod.ErrorV);
+            } else if (retentionPeriod.OkV is TimeSpan period) {
                 var blobClient = containerClient.GetBlobClient(path);
                 var tags = (await blobClient.GetTagsAsync()).Value.Tags;
-                var expiryDate = DateTime.UtcNow + retentionPeriod.Value;
+                var expiryDate = DateTime.UtcNow + period;
                 var tag = RetentionPolicyUtils.CreateExpiryDateTag(DateOnly.FromDateTime(expiryDate));
                 if (tags.TryAdd(tag.Key, tag.Value)) {
                     _ = await blobClient.SetTagsAsync(tags);
-                    _log.LogInformation("applied container retention policy ({Policy}) to {Path}", retentionPeriod.Value, path);
+                    _log.LogInformation("applied container retention policy ({Policy}) to {Path}", period, path);
                     return true;
                 }
             }

src/ApiService/ApiService/OneFuzzTypes/Enums.cs

@@ -50,6 +50,7 @@ public enum ErrorCode {
     ADO_WORKITEM_PROCESSING_DISABLED = 494,
     ADO_VALIDATION_INVALID_PATH = 495,
     ADO_VALIDATION_INVALID_PROJECT = 496,
+    INVALID_RETENTION_PERIOD = 497,
     // NB: if you update this enum, also update enums.py
 }
 

src/ApiService/ApiService/onefuzzlib/RetentionPolicy.cs

@@ -27,18 +27,17 @@ public static KeyValuePair<string, string> CreateExpiryDateTag(DateOnly expiryDa
     // NB: this must match the value used on the CLI side
     public const string CONTAINER_RETENTION_KEY = "onefuzz_retentionperiod";
 
-    public static TimeSpan? GetContainerRetentionPeriodFromMetadata(IDictionary<string, string>? containerMetadata) {
+    public static OneFuzzResult<TimeSpan?> GetContainerRetentionPeriodFromMetadata(IDictionary<string, string>? containerMetadata) {
         if (containerMetadata is not null &&
             containerMetadata.TryGetValue(CONTAINER_RETENTION_KEY, out var retentionString) &&
             !string.IsNullOrWhiteSpace(retentionString)) {
             try {
-                return XmlConvert.ToTimeSpan(retentionString);
-            } catch {
-                // Log error: unable to convert xxx 
-                return null;
+                return Result.Ok<TimeSpan?>(XmlConvert.ToTimeSpan(retentionString));
+            } catch (Exception ex) {
+                return Error.Create(ErrorCode.INVALID_RETENTION_PERIOD, ex.Message);
             }
         }
 
-        return null;
+        return Result.Ok<TimeSpan?>(null);
     }
 }

src/pytypes/onefuzztypes/enums.py

@@ -304,6 +304,7 @@ class ErrorCode(Enum):
     ADO_VALIDATION_MISSING_PAT_SCOPES = 492
     ADO_VALIDATION_INVALID_PATH = 495
     ADO_VALIDATION_INVALID_PROJECT = 496
+    INVALID_RETENTION_PERIOD = 497
     # NB: if you update this enum, also update Enums.cs