Updated requested code changes

ragavareddychalapala · ragavareddychalapala · commit 7c072a216049 · 2025-02-24T17:04:43.000+05:30
diff --git a/src/LCT.APICommunications/ApiConstant.cs b/src/LCT.APICommunications/ApiConstant.cs
@@ -4,6 +4,8 @@
 //  SPDX-License-Identifier: MIT
 // -------------------------------------------------------------------------------------------------------------------- 
 
+using System.Collections.Generic;
+
 namespace LCT.APICommunications
 {
     /// <summary>
@@ -74,8 +76,6 @@ public static class ApiConstant
         public const string ArtifactoryRepoName = "ArtifactoryRepoName";
         public const string JfrogArtifactoryApiSearchAql = $"/api/search/aql";
         public const int APIRetryCount = 3;
-        public const int APIRetryIntervalFirst = 5; // in seconds
-        public const int APIRetryIntervalSecond = 10; // in seconds
-        public const int APIRetryIntervalThird = 30; // in seconds
+        public static readonly List<int> APIRetryIntervals = [5, 10, 30]; // in seconds
     }
 }
diff --git a/src/LCT.APICommunications/RetryHttpClientHandler.cs b/src/LCT.APICommunications/RetryHttpClientHandler.cs
@@ -1,6 +1,7 @@
 ﻿using log4net;
 using Polly;
 using System;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Reflection;
@@ -12,6 +13,7 @@ public class RetryHttpClientHandler : DelegatingHandler
     {
         private readonly AsyncPolicy<HttpResponseMessage> _retryPolicy;
         private static readonly ILog Logger = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        private bool _initialRetryLogged = false;
         public RetryHttpClientHandler()
         {
             // Define the retry policy (retry on 5xx, 408, and transient errors)
@@ -28,15 +30,35 @@ public RetryHttpClientHandler()
                     onRetry: (outcome, timespan, attempt, context) =>
                     {
                         Logger.Debug($"Retry attempt {attempt} due to: {(outcome.Exception != null ? outcome.Exception.Message : $"{outcome.Result.StatusCode}")}");
-                        Logger.Warn($"Retry attempt {attempt} will be triggered in {timespan.TotalSeconds} seconds due to: {(outcome.Exception != null ? outcome.Exception.Message : $"{outcome.Result.StatusCode}")}");
+                        if (!_initialRetryLogged && context["LogWarnings"] as bool? != false)
+                        {                           
+                            Logger.Warn($"Retry attempt triggered due to: {(outcome.Exception != null ? outcome.Exception.Message : $"{outcome.Result.StatusCode}")}");                            
+                        }
+                        context["RetryAttempt"] = attempt;
+                        _initialRetryLogged = true;
+
                     });
         }
         protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
         {
-            return await _retryPolicy.ExecuteAsync(async () =>
+            var context = new Context
+            {
+                ["LogWarnings"] = !request.Headers.TryGetValues("LogWarnings", out var logWarningsValues) || !bool.TryParse(logWarningsValues.FirstOrDefault(), out var logWarnings) || logWarnings
+            };
+
+            var response = await _retryPolicy.ExecuteAsync(async (ctx) =>
             {
                 return await base.SendAsync(request, cancellationToken); // Pass the request to the next handler (HttpClient)
-            });
+            }, context);
+
+            if (_initialRetryLogged)
+            {
+                var attempt = context.ContainsKey("RetryAttempt") ? context["RetryAttempt"] : 0;
+                Logger.Debug($"Retry attempt successful after {attempt} attempts.");
+                _initialRetryLogged = false;
+            }
+
+            return response;
         }
         public static async Task ExecuteWithRetryAsync(Func<Task> action)
         {
@@ -53,11 +75,10 @@ public static async Task ExecuteWithRetryAsync(Func<Task> action)
         }
         private static TimeSpan GetRetryInterval(int attempt)
         {
-            // Define retry intervals as constants or values
-            var retryIntervals = new[] { ApiConstant.APIRetryIntervalFirst, ApiConstant.APIRetryIntervalSecond, ApiConstant.APIRetryIntervalThird }; // Retry intervals for 1st, 2nd, and 3rd attempts
-            if (attempt >= 1 && attempt <= retryIntervals.Length)
-                return TimeSpan.FromSeconds(retryIntervals[attempt - 1]);
+            if (attempt >= 1 && attempt <= ApiConstant.APIRetryIntervals.Count)
+                return TimeSpan.FromSeconds(ApiConstant.APIRetryIntervals[attempt - 1]);
             return TimeSpan.Zero; // Default if out of range
         }
+
     }
 }
diff --git a/src/LCT.APICommunications/SW360Apicommunication.cs b/src/LCT.APICommunications/SW360Apicommunication.cs
@@ -21,6 +21,13 @@
 
 namespace LCT.APICommunications
 {
+    public static class HttpClientExtensions
+    {
+        public static void SetLogWarnings(this HttpClient client, bool logWarnings)
+        {
+            client.DefaultRequestHeaders.Add("LogWarnings", logWarnings.ToString());
+        }
+    }
     /// <summary>
     /// Communicatest with SW360 API
     /// </summary>
@@ -98,7 +105,7 @@ public async Task<HttpResponseMessage> GetProjectsByTag(string projectTag)
 
         public async Task<HttpResponseMessage> GetProjectById(string projectId)
         {
-            HttpClient httpClient = GetHttpClient();
+            HttpClient httpClient = GetHttpClient();            
             HttpResponseMessage obj = new HttpResponseMessage();           
             var result = obj;
             string projectsByTagUrl = $"{sw360ProjectsApi}/{projectId}";
@@ -163,12 +170,14 @@ public async Task<string> GetReleases()
         public async Task<string> TriggerFossologyProcess(string releaseId, string sw360link)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string url = $"{sw360ReleaseApi}/{releaseId}{ApiConstant.FossTriggerAPIPrefix}{sw360link}{ApiConstant.FossTriggerAPISuffix}";
             return await httpClient.GetStringAsync(url);
         }
         public async Task<HttpResponseMessage> CheckFossologyProcessStatus(string link)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             return await httpClient.GetAsync(link);
         }
         public async Task<string> GetComponents()
@@ -187,13 +196,15 @@ public async Task<HttpResponseMessage> GetReleaseByExternalId(string purlId, str
         public async Task<HttpResponseMessage> GetComponentByExternalId(string purlId, string externalIdKey = "")
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string componentByExternalIdUrl = $"{sw360ComponentByExternalId}{externalIdKey}{purlId}";
             return await httpClient.GetAsync(componentByExternalIdUrl);
         }
 
         public async Task<HttpResponseMessage> GetReleaseById(string releaseId)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string url = $"{sw360ReleaseApi}/{releaseId}";
             return await httpClient.GetAsync(url);
         }
@@ -224,18 +235,21 @@ public async Task<HttpResponseMessage> UpdateLinkedRelease(string projectId, str
         public async Task<HttpResponseMessage> CreateComponent(CreateComponent createComponentContent)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             return await httpClient.PostAsJsonAsync(sw360ComponentApi, createComponentContent);
         }
 
         public async Task<HttpResponseMessage> CreateRelease(Releases createReleaseContent)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             return await httpClient.PostAsJsonAsync(sw360ReleaseApi, createReleaseContent);
         }
 
         public async Task<string> GetReleaseOfComponentById(string componentId)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string componentUrl = $"{sw360ComponentApi}/{componentId}";
             return await httpClient.GetStringAsync(componentUrl);
         }
@@ -266,6 +280,7 @@ public void DownloadAttachmentUsingWebClient(string attachmentDownloadLink, stri
         public async Task<HttpResponseMessage> UpdateRelease(string releaseId, HttpContent httpContent)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string releaseApi = $"{sw360ReleaseApi}/{releaseId}";
             return await httpClient.PatchAsync(releaseApi, httpContent);
         }
@@ -301,12 +316,14 @@ public async Task<HttpResponseMessage> GetComponentDetailsByUrl(string component
         public async Task<string> GetComponentByName(string componentName)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string url = $"{sw360ComponentApi}{ApiConstant.ComponentNameUrl}{componentName}";
             return await httpClient.GetStringAsync(url);
         }
         public async Task<HttpResponseMessage> GetComponentUsingName(string componentName)
         {
             HttpClient httpClient = GetHttpClient();
+            httpClient.SetLogWarnings(false);
             string url = $"{sw360ComponentApi}{ApiConstant.ComponentNameUrl}{componentName}";
             return await httpClient.GetAsync(url);
         }

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`	`// SPDX-License-Identifier: MIT`
`5`	`5`	`// --------------------------------------------------------------------------------------------------------------------`
`6`	`6`
	`7`	`+using System.Collections.Generic;`
	`8`	`+`
`7`	`9`	`namespace LCT.APICommunications`
`8`	`10`	`{`
`9`	`11`	`/// <summary>`
`@@ -74,8 +76,6 @@ public static class ApiConstant`
`74`	`76`	`public const string ArtifactoryRepoName = "ArtifactoryRepoName";`
`75`	`77`	`public const string JfrogArtifactoryApiSearchAql = $"/api/search/aql";`
`76`	`78`	`public const int APIRetryCount = 3;`
`77`		`- public const int APIRetryIntervalFirst = 5; // in seconds`
`78`		`- public const int APIRetryIntervalSecond = 10; // in seconds`
`79`		`- public const int APIRetryIntervalThird = 30; // in seconds`
	`79`	`+ public static readonly List<int> APIRetryIntervals = [5, 10, 30]; // in seconds`
`80`	`80`	`}`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using log4net;`
`2`	`2`	`using Polly;`
`3`	`3`	`using System;`
	`4`	`+using System.Linq;`
`4`	`5`	`using System.Net;`
`5`	`6`	`using System.Net.Http;`
`6`	`7`	`using System.Reflection;`
`@@ -12,6 +13,7 @@ public class RetryHttpClientHandler : DelegatingHandler`
`12`	`13`	`{`
`13`	`14`	`private readonly AsyncPolicy<HttpResponseMessage> _retryPolicy;`
`14`	`15`	`private static readonly ILog Logger = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);`
	`16`	`+ private bool _initialRetryLogged = false;`
`15`	`17`	`public RetryHttpClientHandler()`
`16`	`18`	`{`
`17`	`19`	`// Define the retry policy (retry on 5xx, 408, and transient errors)`
`@@ -28,15 +30,35 @@ public RetryHttpClientHandler()`
`28`	`30`	`onRetry: (outcome, timespan, attempt, context) =>`
`29`	`31`	`{`
`30`	`32`	`Logger.Debug($"Retry attempt {attempt} due to: {(outcome.Exception != null ? outcome.Exception.Message : $"{outcome.Result.StatusCode}")}");`
`31`		`- Logger.Warn($"Retry attempt {attempt} will be triggered in {timespan.TotalSeconds} seconds due to: {(outcome.Exception != null ? outcome.Exception.Message : $"{outcome.Result.StatusCode}")}");`
	`33`	`+ if (!_initialRetryLogged && context["LogWarnings"] as bool? != false)`
	`34`	`+ {`
	`35`	`+ Logger.Warn($"Retry attempt triggered due to: {(outcome.Exception != null ? outcome.Exception.Message : $"{outcome.Result.StatusCode}")}");`
	`36`	`+ }`
	`37`	`+ context["RetryAttempt"] = attempt;`
	`38`	`+ _initialRetryLogged = true;`
	`39`	`+`
`32`	`40`	`});`
`33`	`41`	`}`
`34`	`42`	`protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)`
`35`	`43`	`{`
`36`		`- return await _retryPolicy.ExecuteAsync(async () =>`
	`44`	`+ var context = new Context`
	`45`	`+ {`
	`46`	`+ ["LogWarnings"] = !request.Headers.TryGetValues("LogWarnings", out var logWarningsValues) \|\| !bool.TryParse(logWarningsValues.FirstOrDefault(), out var logWarnings) \|\| logWarnings`
	`47`	`+ };`
	`48`	`+`
	`49`	`+ var response = await _retryPolicy.ExecuteAsync(async (ctx) =>`
`37`	`50`	`{`
`38`	`51`	`return await base.SendAsync(request, cancellationToken); // Pass the request to the next handler (HttpClient)`
`39`		`- });`
	`52`	`+ }, context);`
	`53`	`+`
	`54`	`+ if (_initialRetryLogged)`
	`55`	`+ {`
	`56`	`+ var attempt = context.ContainsKey("RetryAttempt") ? context["RetryAttempt"] : 0;`
	`57`	`+ Logger.Debug($"Retry attempt successful after {attempt} attempts.");`
	`58`	`+ _initialRetryLogged = false;`
	`59`	`+ }`
	`60`	`+`
	`61`	`+ return response;`
`40`	`62`	`}`
`41`	`63`	`public static async Task ExecuteWithRetryAsync(Func<Task> action)`
`42`	`64`	`{`
`@@ -53,11 +75,10 @@ public static async Task ExecuteWithRetryAsync(Func<Task> action)`
`53`	`75`	`}`
`54`	`76`	`private static TimeSpan GetRetryInterval(int attempt)`
`55`	`77`	`{`
`56`		`- // Define retry intervals as constants or values`
`57`		`- var retryIntervals = new[] { ApiConstant.APIRetryIntervalFirst, ApiConstant.APIRetryIntervalSecond, ApiConstant.APIRetryIntervalThird }; // Retry intervals for 1st, 2nd, and 3rd attempts`
`58`		`- if (attempt >= 1 && attempt <= retryIntervals.Length)`
`59`		`- return TimeSpan.FromSeconds(retryIntervals[attempt - 1]);`
	`78`	`+ if (attempt >= 1 && attempt <= ApiConstant.APIRetryIntervals.Count)`
	`79`	`+ return TimeSpan.FromSeconds(ApiConstant.APIRetryIntervals[attempt - 1]);`
`60`	`80`	`return TimeSpan.Zero; // Default if out of range`
`61`	`81`	`}`
	`82`	`+`
`62`	`83`	`}`
`63`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,13 @@`
`21`	`21`
`22`	`22`	`namespace LCT.APICommunications`
`23`	`23`	`{`
	`24`	`+ public static class HttpClientExtensions`
	`25`	`+ {`
	`26`	`+ public static void SetLogWarnings(this HttpClient client, bool logWarnings)`
	`27`	`+ {`
	`28`	`+ client.DefaultRequestHeaders.Add("LogWarnings", logWarnings.ToString());`
	`29`	`+ }`
	`30`	`+ }`
`24`	`31`	`/// <summary>`
`25`	`32`	`/// Communicatest with SW360 API`
`26`	`33`	`/// </summary>`
`@@ -98,7 +105,7 @@ public async Task<HttpResponseMessage> GetProjectsByTag(string projectTag)`
`98`	`105`
`99`	`106`	`public async Task<HttpResponseMessage> GetProjectById(string projectId)`
`100`	`107`	`{`
`101`		`- HttpClient httpClient = GetHttpClient();`
	`108`	`+ HttpClient httpClient = GetHttpClient();`
`102`	`109`	`HttpResponseMessage obj = new HttpResponseMessage();`
`103`	`110`	`var result = obj;`
`104`	`111`	`string projectsByTagUrl = $"{sw360ProjectsApi}/{projectId}";`
`@@ -163,12 +170,14 @@ public async Task<string> GetReleases()`
`163`	`170`	`public async Task<string> TriggerFossologyProcess(string releaseId, string sw360link)`
`164`	`171`	`{`
`165`	`172`	`HttpClient httpClient = GetHttpClient();`
	`173`	`+ httpClient.SetLogWarnings(false);`
`166`	`174`	`string url = $"{sw360ReleaseApi}/{releaseId}{ApiConstant.FossTriggerAPIPrefix}{sw360link}{ApiConstant.FossTriggerAPISuffix}";`
`167`	`175`	`return await httpClient.GetStringAsync(url);`
`168`	`176`	`}`
`169`	`177`	`public async Task<HttpResponseMessage> CheckFossologyProcessStatus(string link)`
`170`	`178`	`{`
`171`	`179`	`HttpClient httpClient = GetHttpClient();`
	`180`	`+ httpClient.SetLogWarnings(false);`
`172`	`181`	`return await httpClient.GetAsync(link);`
`173`	`182`	`}`
`174`	`183`	`public async Task<string> GetComponents()`
`@@ -187,13 +196,15 @@ public async Task<HttpResponseMessage> GetReleaseByExternalId(string purlId, str`
`187`	`196`	`public async Task<HttpResponseMessage> GetComponentByExternalId(string purlId, string externalIdKey = "")`
`188`	`197`	`{`
`189`	`198`	`HttpClient httpClient = GetHttpClient();`
	`199`	`+ httpClient.SetLogWarnings(false);`
`190`	`200`	`string componentByExternalIdUrl = $"{sw360ComponentByExternalId}{externalIdKey}{purlId}";`
`191`	`201`	`return await httpClient.GetAsync(componentByExternalIdUrl);`
`192`	`202`	`}`
`193`	`203`
`194`	`204`	`public async Task<HttpResponseMessage> GetReleaseById(string releaseId)`
`195`	`205`	`{`
`196`	`206`	`HttpClient httpClient = GetHttpClient();`
	`207`	`+ httpClient.SetLogWarnings(false);`
`197`	`208`	`string url = $"{sw360ReleaseApi}/{releaseId}";`
`198`	`209`	`return await httpClient.GetAsync(url);`
`199`	`210`	`}`
`@@ -224,18 +235,21 @@ public async Task<HttpResponseMessage> UpdateLinkedRelease(string projectId, str`
`224`	`235`	`public async Task<HttpResponseMessage> CreateComponent(CreateComponent createComponentContent)`
`225`	`236`	`{`
`226`	`237`	`HttpClient httpClient = GetHttpClient();`
	`238`	`+ httpClient.SetLogWarnings(false);`
`227`	`239`	`return await httpClient.PostAsJsonAsync(sw360ComponentApi, createComponentContent);`
`228`	`240`	`}`
`229`	`241`
`230`	`242`	`public async Task<HttpResponseMessage> CreateRelease(Releases createReleaseContent)`
`231`	`243`	`{`
`232`	`244`	`HttpClient httpClient = GetHttpClient();`
	`245`	`+ httpClient.SetLogWarnings(false);`
`233`	`246`	`return await httpClient.PostAsJsonAsync(sw360ReleaseApi, createReleaseContent);`
`234`	`247`	`}`
`235`	`248`
`236`	`249`	`public async Task<string> GetReleaseOfComponentById(string componentId)`
`237`	`250`	`{`
`238`	`251`	`HttpClient httpClient = GetHttpClient();`
	`252`	`+ httpClient.SetLogWarnings(false);`
`239`	`253`	`string componentUrl = $"{sw360ComponentApi}/{componentId}";`
`240`	`254`	`return await httpClient.GetStringAsync(componentUrl);`
`241`	`255`	`}`
`@@ -266,6 +280,7 @@ public void DownloadAttachmentUsingWebClient(string attachmentDownloadLink, stri`
`266`	`280`	`public async Task<HttpResponseMessage> UpdateRelease(string releaseId, HttpContent httpContent)`
`267`	`281`	`{`
`268`	`282`	`HttpClient httpClient = GetHttpClient();`
	`283`	`+ httpClient.SetLogWarnings(false);`
`269`	`284`	`string releaseApi = $"{sw360ReleaseApi}/{releaseId}";`
`270`	`285`	`return await httpClient.PatchAsync(releaseApi, httpContent);`
`271`	`286`	`}`
`@@ -301,12 +316,14 @@ public async Task<HttpResponseMessage> GetComponentDetailsByUrl(string component`
`301`	`316`	`public async Task<string> GetComponentByName(string componentName)`
`302`	`317`	`{`
`303`	`318`	`HttpClient httpClient = GetHttpClient();`
	`319`	`+ httpClient.SetLogWarnings(false);`
`304`	`320`	`string url = $"{sw360ComponentApi}{ApiConstant.ComponentNameUrl}{componentName}";`
`305`	`321`	`return await httpClient.GetStringAsync(url);`
`306`	`322`	`}`
`307`	`323`	`public async Task<HttpResponseMessage> GetComponentUsingName(string componentName)`
`308`	`324`	`{`
`309`	`325`	`HttpClient httpClient = GetHttpClient();`
	`326`	`+ httpClient.SetLogWarnings(false);`
`310`	`327`	`string url = $"{sw360ComponentApi}{ApiConstant.ComponentNameUrl}{componentName}";`
`311`	`328`	`return await httpClient.GetAsync(url);`
`312`	`329`	`}`