Feature/enable cancellation of get evidence (#28)

* Added timeout to evidence code model and corrected a random typo #26 * moved default value to settings, added same timeout setuå for harvest of open data #26
data-altinn-no · Jan 19, 2023 · a955755 · a955755
1 parent aca6f1c
commit a955755
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 11 deletions.
diff --git a/Dan.Common/Models/EvidenceCode.cs b/Dan.Common/Models/EvidenceCode.cs
@@ -131,4 +131,11 @@ public class EvidenceCode
     [DataMember(Name = "deprecationWarning")]
     [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public string? DeprecationWarning { get; set; }
+
+    /// <summary>
+    /// Optional setting for custom timeout (in seconds) in evidencecodes when harvesting data
+    /// </summary>
+    [DataMember(Name = "timeout")]
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+    public int? Timeout { get; set; }
 }
diff --git a/Dan.Core/Config/Settings.cs b/Dan.Core/Config/Settings.cs
@@ -368,6 +368,8 @@ public static string GetConsentRedirectUrl(string accreditationId, string hmac)
 
     public const int MaxReferenceLength = 50;
 
+    public static int DefaultHarvestTaskCancellation = 35;
+
     private static string GetSetting(string settingKey)
     {
         var value = ConfigurationHelper.ConfigurationRoot[settingKey];

diff --git a/Dan.Core/FuncEvidenceHarvester.cs b/Dan.Core/FuncEvidenceHarvester.cs
@@ -93,7 +93,7 @@ public async Task<HttpResponseData> RunAsync(
                 using (var t = _logger.Timer("consent-log-usage"))
                 {
                     _logger.LogInformation(
-                        "Start logging consent based harvest aid={accreditaionId} evidenceCode={evidenceCode}",
+                        "Start logging consent based harvest aid={accreditationId} evidenceCode={evidenceCode}",
                         accreditation.AccreditationId, evidenceCode.EvidenceCodeName);
                     await LogConsentBasedHarvest(evidenceCode, accreditation);
                     _logger.LogInformation(

diff --git a/Dan.Core/Services/EvidenceHarvesterService.cs b/Dan.Core/Services/EvidenceHarvesterService.cs
@@ -65,8 +65,11 @@ public async Task<Evidence> HarvestOpenData(EvidenceCode evidenceCode, string id
 
         var request = new HttpRequestMessage(HttpMethod.Post, url);
         request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
+
+        var timeoutSeconds = evidenceCode.Timeout ??= Settings.DefaultHarvestTaskCancellation;
+
         using var cts = new CancellationTokenSource();
-        cts.CancelAfter(TimeSpan.FromSeconds(60));
+        cts.CancelAfter(TimeSpan.FromSeconds(timeoutSeconds));
 
         var evidenceHarvesterRequest = new EvidenceHarvesterRequest()
         {
@@ -81,10 +84,19 @@ public async Task<Evidence> HarvestOpenData(EvidenceCode evidenceCode, string id
             _log.LogInformation("Start harvesting evidence values for open data evidenceCode={evidenceCodeName} and identifier {identifier}", evidenceCode.EvidenceCodeName, identifier == "" ? "(empty)" : identifier);
             request.JsonContent(evidenceHarvesterRequest);
             request.SetPolicyExecutionContext(new Context(request.Key(CacheArea.Absolute)));
-            var client = _httpClientFactory.CreateClient("SafeHttpClient");
-            harvestedEvidence = (await EvidenceSourceHelper.DoRequest<List<EvidenceValue>>(
-                request,
-                () => client.SendAsync(request, cts.Token)))!;
+
+            try
+            {
+                var client = _httpClientFactory.CreateClient("SafeHttpClient");
+                harvestedEvidence = (await EvidenceSourceHelper.DoRequest<List<EvidenceValue>>(
+                    request,
+                    () => client.SendAsync(request, cts.Token)))!;
+            }
+            catch (TaskCanceledException)
+            {
+                _log.LogError("Harvesting evidence values for open data evidenceCode={evidenceCodeName} and identifier {identifier} was cancelled", evidenceCode.EvidenceCodeName, identifier == "" ? "(empty)" : identifier);
+                throw new ServiceNotAvailableException($"The request was cancelled after exceeding max duration ({timeoutSeconds} seconds)");
+            }
 
             _log.LogInformation("Completed harvesting evidence values for open data evidenceCode={evidenceCodeName} and identifier {identifier}", evidenceCode.EvidenceCodeName, identifier == "" ? "(empty)" : identifier);
         }
@@ -104,8 +116,11 @@ private async Task<List<EvidenceValue>> HarvestEvidenceValues(EvidenceCode evide
 
         var request = new HttpRequestMessage(HttpMethod.Post, url);
         request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
+
+        var timeoutSeconds = evidenceCode.Timeout ??= Settings.DefaultHarvestTaskCancellation;
+
         using var cts = new CancellationTokenSource();
-        cts.CancelAfter(TimeSpan.FromSeconds(30));
+        cts.CancelAfter(TimeSpan.FromSeconds(timeoutSeconds));
 
         var evidenceHarvesterRequest = new EvidenceHarvesterRequest()
         {
@@ -137,10 +152,19 @@ private async Task<List<EvidenceValue>> HarvestEvidenceValues(EvidenceCode evide
         request.JsonContent(evidenceHarvesterRequest);
 
         request.SetPolicyExecutionContext(new Context(request.Key(CacheArea.Absolute)));
-        var client = _httpClientFactory.CreateClient("SafeHttpClient");
-        return (await EvidenceSourceHelper.DoRequest<List<EvidenceValue>>(
-            request,
-            () => client.SendAsync(request, cts.Token)))!;
+
+        try
+        {
+            var client = _httpClientFactory.CreateClient("SafeHttpClient");
+            return (await EvidenceSourceHelper.DoRequest<List<EvidenceValue>>(
+                request,
+                () => client.SendAsync(request, cts.Token)))!;
+        }
+        catch (TaskCanceledException)
+        {
+            _log.LogError("Harvesting evidence values for open data evidenceCode={evidenceCodeName} and subject {subject} was cancelled", evidenceCode.EvidenceCodeName, accreditation.SubjectParty.GetAsString(true));
+            throw new ServiceNotAvailableException($"The request was cancelled after exceeding max duration of {timeoutSeconds} seconds)");
+        }
     }
 
     private async Task<string> GetAccessToken(EvidenceCode evidenceCode, Accreditation accreditation, EvidenceHarvesterOptions evidenceHarvesterOptions)