7.0.4 release

lanesCSO · lanesCSO · commit 8602913d00ef · 2024-07-10T16:29:45.000+01:00
diff --git a/db/TD_API_TRACE.sql b/db/TD_API_TRACE.sql
@@ -10,7 +10,7 @@
     [TRC_DURATION] DECIMAL(18,3) NOT NULL, 
     [TRC_STATUSCODE] INT NOT NULL, 
     [TRC_MACHINENAME] varchar(256) NOT NULL,
-    [TRC_REQUEST_TYPE] VARCHAR(50) NOT NULL, 
+    [TRC_REQUEST_TYPE] VARCHAR(50) NULL, 
     [TRC_REQUEST_VERB] VARCHAR(50) NOT NULL, 
     [TRC_ERROR_PATH] VARCHAR(1024) NULL,
     [TRC_CORRELATION_ID] VARCHAR(1024) null,
diff --git a/db/configuration/stored procedures/Security_Trace_Create.sql b/db/configuration/stored procedures/Security_Trace_Create.sql
@@ -25,7 +25,7 @@ CREATE PROCEDURE Security_Trace_Create @TrcMethod NVARCHAR(256)  = null
 	,@TrcMachineName varchar(256)
 	,@TrcErrorPath varchar(1028) = null
 	,@TrcRequestVerb varchar(50)
-	,@TrcRequestType varchar(50)
+	,@TrcRequestType varchar(50) = null
 	,@TrcCorrelationID varchar(1028)
 	,@TrcJsonRpcErrorCode int  =null
 AS
diff --git a/rls/packages/API.Library.7.0.2.nupkg b/rls/packages/API.Library.7.0.2.nupkg
diff --git a/rls/packages/API.Library.7.0.3.nupkg b/rls/packages/API.Library.7.0.3.nupkg
diff --git a/rls/packages/API.Library.7.0.4.nupkg b/rls/packages/API.Library.7.0.4.nupkg
diff --git a/src/API.Library/API.Library.csproj b/src/API.Library/API.Library.csproj
@@ -12,12 +12,12 @@
     <PackageId>API.Library</PackageId>
     <Product>API Library</Product>
     <Copyright>Central Statistics Office, Ireland</Copyright>
-    <Version>7.0.1</Version>
+    <Version>7.0.4</Version>
     <Authors>Central Statistics Office, Ireland</Authors>
     <SignAssembly>False</SignAssembly>
     <RepositoryUrl>https://github.com/CSOIreland/Server-API-Library</RepositoryUrl>
     <PackageReleaseNotes>
-      - [BUG FIX] check that key is not already in attribute dictionarys
+			- [BUG FIX] allow request type for tracing to be null
     </PackageReleaseNotes>
     <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
     <RestoreLockedMode>true</RestoreLockedMode>
@@ -40,8 +40,7 @@
 	<ItemGroup>
 		<PackageReference Include="EnyimMemcachedCore" Version="3.2.1" />
 		<PackageReference Include="log4net" Version="2.0.17" />
-		<PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="8.0.4" />
-		<PackageReference Include="Microsoft.Data.SqlClient" Version="5.2.0" />
+		<PackageReference Include="Microsoft.Data.SqlClient" Version="5.2.1" />
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging.Log4Net.AspNetCore" Version="8.0.0" />
diff --git a/src/API.Library/Entities/API.Common.cs b/src/API.Library/Entities/API.Common.cs
@@ -507,6 +507,7 @@ internal static MethodInfo CheckAPICallsAllowed(string methodName, string method
             dynamic jsonObj = new ExpandoObject();
             jsonObj.methodName = methodName;
             jsonObj.methodPath = methodPath;
+            jsonObj.methodType = typeOfClassType.Name; //Fixes bug where previous RESTful call breaks subsequent JSON-rpc calls and vice versa
 
             string serializedAPIInfo = Utility.JsonSerialize_IgnoreLoopingReference(jsonObj);
 
diff --git a/src/API.Library/Entities/API.RESTful.cs b/src/API.Library/Entities/API.RESTful.cs
@@ -110,6 +110,9 @@ public async Task ProcessRequest(HttpContext httpContext, CancellationTokenSourc
 
                     if (httpContext.Request.Method == "HEAD")
                     {
+
+                        trace.TrcRequestType = "HEAD";
+
                         httpContext.Response.Headers.Append("Cache-Control", "public");
 
                         if (!String.IsNullOrEmpty(result.mimeType))
diff --git a/src/API.Library/Entities/Performance.ADO.cs b/src/API.Library/Entities/Performance.ADO.cs
@@ -7,34 +7,47 @@ internal static class Performance_ADO
 
         internal static void Create(ADO ado, List<PerformanceObj> performanceList, bool api_performance_enabled)
         {
-            if (!api_performance_enabled)
+            try
             {
-                return;
-            }
+                
+                if (!api_performance_enabled)
+                {
+                    return;
+                }
+
+                Log.Instance.Info("Performance Records Collected: " + performanceList.Count.ToString());
+
+                DataTable performanceTable = new DataTable();
+                performanceTable.Columns.Add("PRF_PROCESSOR_PERCENTAGE");
+                performanceTable.Columns.Add("PRF_MEMORY_AVAILABLE");
+                performanceTable.Columns.Add("PRF_REQUEST_QUEUE");
+                performanceTable.Columns.Add("PRF_REQUEST_PERSECOND");
+                performanceTable.Columns.Add("PRF_DATETIME");
+                performanceTable.Columns.Add("PRF_SERVER");
 
-            Log.Instance.Info("Performance Records Collected: " + performanceList.Count.ToString());
+                foreach (var p in performanceList)
+                {
+                    performanceTable.Rows.Add(new object[] { p.ProcessorPercentage, p.MemoryAvailableMBytes, p.RequestsQueued, p.RequestPerSec, p.DateTime, p.Server });
+                }
 
-            DataTable performanceTable = new DataTable();
-            performanceTable.Columns.Add("PRF_PROCESSOR_PERCENTAGE");
-            performanceTable.Columns.Add("PRF_MEMORY_AVAILABLE");
-            performanceTable.Columns.Add("PRF_REQUEST_QUEUE");
-            performanceTable.Columns.Add("PRF_REQUEST_PERSECOND");
-            performanceTable.Columns.Add("PRF_DATETIME");
-            performanceTable.Columns.Add("PRF_SERVER");
+                var mapping = new List<KeyValuePair<string, string>>();
+                for (int i = 0; i < performanceTable.Columns.Count; i++)
+                {
+                    mapping.Add(new KeyValuePair<string, string>(performanceTable.Columns[i].ColumnName, performanceTable.Columns[i].ColumnName));
+                }
 
-            foreach (var p in performanceList)
+         
+                ado.ExecuteBulkCopy("TD_PERFORMANCE", mapping, performanceTable);
+            }
+            catch (Exception ex)
             {
-                performanceTable.Rows.Add(new object[] { p.ProcessorPercentage, p.MemoryAvailableMBytes, p.RequestsQueued, p.RequestPerSec, p.DateTime, p.Server });
+                Log.Instance.Error("Error storing performance information");
+                Log.Instance.Error(ex);
             }
-
-            var mapping = new List<KeyValuePair<string, string>>();
-            for (int i = 0; i < performanceTable.Columns.Count; i++)
+            finally
             {
-                mapping.Add(new KeyValuePair<string, string>(performanceTable.Columns[i].ColumnName, performanceTable.Columns[i].ColumnName));
+                ado.Dispose();
             }
-            ado.ExecuteBulkCopy("TD_PERFORMANCE", mapping, performanceTable);
-
-            ado.Dispose();
         }
     }
 }
diff --git a/src/API.Library/Entities/Performance.cs b/src/API.Library/Entities/Performance.cs
@@ -53,13 +53,18 @@ internal void CollectData(CancellationToken cancelToken)
                     performanceObj.MemoryAvailableMBytes = (int)Math.Round(memoryAvailableMBytes);
                     performanceObj.RequestsQueued = (int)Math.Round(requestsQueued);
                     performanceObj.RequestPerSec = (int)Math.Round(requestPerSec);
-                    performanceObj.DateTime = DateTime.Now.TrimToMinute(TimeSpan.TicksPerMinute); ;
+                    performanceObj.DateTime = DateTime.Now.TrimToMinute(TimeSpan.TicksPerMinute);
 
                     items.Add(performanceObj);
 
                     // Collect data every second
                     Thread.Sleep(1000);
                 }
+
+                if (cancelToken.IsCancellationRequested)
+                {
+                    Performance_ADO.Create(String.IsNullOrEmpty(ApiServicesHelper.ADOSettings.API_PERFORMANCE_DATABASE) ? new ADO() : new ADO(ApiServicesHelper.ADOSettings.API_PERFORMANCE_DATABASE), items, ApiServicesHelper.APIPerformanceSettings.API_PERFORMANCE_ENABLED);
+                }
             }
             catch (ThreadAbortException e)
             {
@@ -82,22 +87,7 @@ internal void CollectData(CancellationToken cancelToken)
         /// </summary>
         public void Dispose()
         {
-            Dispose(true);
             GC.SuppressFinalize(this);
         }
-
-        /// <summary>
-        ///  The bulk of the clean-up code is implemented in Dispose(bool)
-        /// </summary>
-        /// <param name="disposing"></param>
-        protected virtual void Dispose(bool disposing)
-        {
-            // Store Perfromance
-            if (disposing)
-            {
-                // Store data
-                Performance_ADO.Create(String.IsNullOrEmpty(ApiServicesHelper.ADOSettings.API_PERFORMANCE_DATABASE) ? new ADO() : new ADO(ApiServicesHelper.ADOSettings.API_PERFORMANCE_DATABASE), items, ApiServicesHelper.APIPerformanceSettings.API_PERFORMANCE_ENABLED);
-            }
-        }
     }
 }
diff --git a/src/API.Library/Entities/Tracing/Trace/Trace_ADO.cs b/src/API.Library/Entities/Tracing/Trace/Trace_ADO.cs
@@ -29,11 +29,13 @@ internal static void Create(Trace trace)
                 new ADO_inputParams() {name= "@TrcDuration",value=trace.TrcDuration},
                 new ADO_inputParams() {name= "@TrcStatusCode",value=trace.TrcStatusCode},
                 new ADO_inputParams() {name= "@TrcMachineName",value=trace.TrcMachineName},
-                new ADO_inputParams() {name= "@TrcRequestType", value = trace.TrcRequestType},
                 new ADO_inputParams() {name= "@TrcRequestVerb", value = trace.TrcRequestVerb},
                 new ADO_inputParams() {name= "@TrcCorrelationID", value = trace.TrcCorrelationID},
             };
 
+            if (!string.IsNullOrEmpty(trace.TrcRequestType))
+                    inputParamList.Add(new ADO_inputParams() { name = "@TrcRequestType", value = trace.TrcRequestType });
+
             if (trace.TrcJsonRpcErrorCode != null)
                 inputParamList.Add(new ADO_inputParams() { name = "@TrcJsonRpcErrorCode", value = trace.TrcJsonRpcErrorCode });
 
diff --git a/src/API.Library/Middleware/API.Middleware.cs b/src/API.Library/Middleware/API.Middleware.cs
@@ -71,6 +71,11 @@ public async Task InvokeAsync(HttpContext context)
                         cancelPerformance.Cancel(true);
                         Log.Instance.Info("performance thread cancelled");
                     }
+                    catch (Exception ex)
+                    {
+                        Log.Instance.Error("Something went wrong with performance thread");
+                        Log.Instance.Error(ex);
+                    }
                 });
 
 
@@ -263,33 +268,36 @@ public async Task InvokeAsync(HttpContext context)
                 }
                 finally
                 {
-                    if (context.Response.StatusCode != (int)HttpStatusCode.NotModified)
+                    try
                     {
 
-                        //IF NO RESPONSE SENT AT ALL SEND 204 STATUS CODE
-                        if (!context.Response.HasStarted)
+                        if (context.Response.StatusCode != (int)HttpStatusCode.NotModified)
                         {
-                            context.Response.StatusCode = (int)HttpStatusCode.NoContent;
-                            await context.Response.WriteAsync("");
+
+                            //IF NO RESPONSE SENT AT ALL SEND 204 STATUS CODE
+                            if (!context.Response.HasStarted)
+                            {
+                                context.Response.StatusCode = (int)HttpStatusCode.NoContent;
+                                await context.Response.WriteAsync("");
+                            }
                         }
-                    }
 
-                    apiCancellationToken.Cancel(true);
-                    apiCancellationToken.Dispose();
-                    // Terminate Performance collection
-                    cancelPerformance.Cancel(true);//safely cancel thread    
-                    cancelPerformance.Dispose();
-                    // Stop the activity
-                    activity.Stop();
-                    
-                    Log.Instance.Info("API Execution Time (s): " + ((float)Math.Round(activity.Duration.TotalMilliseconds / 1000, 3)).ToString());
-                    Log.Instance.Info("API Interface Closed");
+                        apiCancellationToken.Cancel(true);
+                        apiCancellationToken.Dispose();
+                        // Terminate Performance collection
+                        cancelPerformance.Cancel(true);//safely cancel thread    
+                        cancelPerformance.Dispose();
+                        // Stop the activity
+                        activity.Stop();
 
+                        Log.Instance.Info("API Execution Time (s): " + ((float)Math.Round(activity.Duration.TotalMilliseconds / 1000, 3)).ToString());
+                        Log.Instance.Info("API Interface Closed");
 
 
-                    if (ApiServicesHelper.ApiConfiguration.API_TRACE_ENABLED)
-                    {
-                       
+
+                        if (ApiServicesHelper.ApiConfiguration.API_TRACE_ENABLED)
+                        {
+
                             trace.TrcStatusCode = context.Response.StatusCode;
                             trace.TrcDuration = ((float)Math.Round(activity.Duration.TotalMilliseconds / 1000, 3));
                             trace.TrcMachineName = System.Environment.MachineName;
@@ -308,23 +316,30 @@ public async Task InvokeAsync(HttpContext context)
 
                             Trace_ADO.Create(trace);
 
-                    }
+                        }
 
-                    if (ApiServicesHelper.CacheConfig.API_CACHE_TRACE_ENABLED)
-                    {
-                        //store the cache trace info
-                        CacheTrace_ADO.Create(cacheTraceDataTable.Value);
-                        cacheTraceDataTable.Value.Dispose();
-                        cacheTraceDataTable.Value = null;
-                    }
+                        if (ApiServicesHelper.CacheConfig.API_CACHE_TRACE_ENABLED)
+                        {
+                            //store the cache trace info
+                            CacheTrace_ADO.Create(cacheTraceDataTable.Value);
+                            cacheTraceDataTable.Value.Dispose();
+                            cacheTraceDataTable.Value = null;
+                        }
 
-                    if (ApiServicesHelper.DatabaseTracingConfiguration.API_DATABASE_TRACE_ENABLED)
+                        if (ApiServicesHelper.DatabaseTracingConfiguration.API_DATABASE_TRACE_ENABLED)
+                        {
+                            //store the database trace info
+                            DatabaseTrace_ADO.Create(databaseTraceDataTable.Value);
+                            databaseTraceDataTable.Value.Dispose();
+                            databaseTraceDataTable.Value = null;
+                        }
+                    }
+                    catch (Exception ex)
                     {
-                        //store the database trace info
-                        DatabaseTrace_ADO.Create(databaseTraceDataTable.Value);
-                        databaseTraceDataTable.Value.Dispose();
-                        databaseTraceDataTable.Value = null;
+                        Log.Instance.Error("Something went wrong after response sent");
+                        Log.Instance.Error(ex);
                     }
+
                 }
             }
         }
diff --git a/src/API.Library/packages.lock.json b/src/API.Library/packages.lock.json

Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,9 @@ public async Task ProcessRequest(HttpContext httpContext, CancellationTokenSourc`
`110`	`110`
`111`	`111`	`if (httpContext.Request.Method == "HEAD")`
`112`	`112`	`{`
	`113`	`+`
	`114`	`+ trace.TrcRequestType = "HEAD";`
	`115`	`+`
`113`	`116`	`httpContext.Response.Headers.Append("Cache-Control", "public");`
`114`	`117`
`115`	`118`	`if (!String.IsNullOrEmpty(result.mimeType))`