Merge pull request #217 from TransactionProcessing/task/#end_to_end_correlationid

StuartFerguson · web-flow · commit 42dec58addbe · 2025-07-30T11:52:20.000+01:00
first cut with end to end correlation id
diff --git a/.github/workflows/android_e2e_tests.yml b/.github/workflows/android_e2e_tests.yml
@@ -163,25 +163,25 @@ jobs:
         run: dotnet test TransactionProcessor.Mobile.UITests/TransactionProcessor.Mobile.UITests.csproj --filter "(Category=PRTest)&(Category=Android)" --no-restore
 
       - name: Upload Logs on Failure
-        if: failure()  # Runs only if a previous step fails
+        #if: failure()  # Runs only if a previous step fails
         uses: actions/upload-artifact@v4
         with:
             name: android-e2e_tests
             path: /home/txnproc/trace/
 
       - name: Upload Appium Logs on Failure
-        if: failure()
+        #if: failure()
         uses: actions/upload-artifact@v4
         with:
             name: android-e2e_tests_appium
             path: appium.log
 
       - name: Capture emulator logs
-        if: failure()
+        #if: failure()
         run: adb logcat -d > emulator-log.txt
 
       - name: Upload emulator logs
-        if: failure()
+        #if: failure()
         uses: actions/upload-artifact@v4
         with:
             name: android-emulator-logs
diff --git a/TransactionProcessor.Mobile.BusinessLogic/Common/IdGenerationService.cs b/TransactionProcessor.Mobile.BusinessLogic/Common/IdGenerationService.cs
@@ -28,4 +28,32 @@
 
         public static Guid GenerateGuid(Object o) => IdGenerationService.GenerateUniqueId(o);
     }*/
+
+    public static class CorrelationIdProvider
+    {
+        private static readonly AsyncLocal<string?> _correlationId = new();
+
+        public static string CorrelationId
+        {
+            get
+            {
+                if (string.IsNullOrWhiteSpace(_correlationId.Value))
+                {
+                    _correlationId.Value = Guid.NewGuid().ToString();
+                }
+
+                return _correlationId.Value;
+            }
+            set => _correlationId.Value = value;
+        }
+
+        //public static string? CorrelationId
+        //{
+        //    get => _correlationId.Value;
+        //    set => _correlationId.Value = value;
+        //}
+
+        //public static void New() => CorrelationId = Guid.NewGuid().ToString();
+        public static void NewId() => CorrelationId = Guid.NewGuid().ToString();
+    }
 }
diff --git a/TransactionProcessor.Mobile.BusinessLogic/Logging/ConsoleLogger.cs b/TransactionProcessor.Mobile.BusinessLogic/Logging/ConsoleLogger.cs
@@ -1,13 +1,15 @@
 ﻿using System.Diagnostics.CodeAnalysis;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
 
 namespace TransactionProcessor.Mobile.BusinessLogic.Logging;
 
 [ExcludeFromCodeCoverage]
 public class ConsoleLogger : ILogger{
+    
     #region Constructors
 
-    public ConsoleLogger(){
+    public ConsoleLogger() {
         this.IsInitialised = true;
     }
 
@@ -23,17 +25,16 @@ public ConsoleLogger(){
 
     internal void Log(LogMessage logMessageModel)
     {
-        List<LogMessage> logMessageModels = new List<LogMessage>{
-                                                                    logMessageModel
-                                                                };
+        List<LogMessage> logMessageModels = [logMessageModel];
         this.Log(logMessageModels);
     }
 
     internal void Log(List<LogMessage> logMessageModels)
     {
+        String correlationId = CorrelationIdProvider.CorrelationId;
         foreach (LogMessage item in logMessageModels)
         {
-            Console.WriteLine($"AppLog|{item.EntryDateTime}|{item.LogLevel}|{item.Message}");
+            Console.WriteLine($"AppLog|{item.EntryDateTime}|Correlation Id: {correlationId}|{item.LogLevel}|{item.Message}");
         }
     }
 
diff --git a/TransactionProcessor.Mobile.BusinessLogic/RequestHandlers/TransactionRequestHandler.cs b/TransactionProcessor.Mobile.BusinessLogic/RequestHandlers/TransactionRequestHandler.cs
@@ -1,6 +1,8 @@
 ﻿using MediatR;
+using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 using SimpleResults;
+using System.Diagnostics;
 using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Database;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Admin/AdminPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Admin/AdminPageViewModel.cs
@@ -1,8 +1,9 @@
-﻿using System.Windows.Input;
-using CommunityToolkit.Mvvm.Input;
+﻿using CommunityToolkit.Mvvm.Input;
 using MediatR;
 using MvvmHelpers.Commands;
 using SimpleResults;
+using System.Windows.Input;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
 using TransactionProcessor.Mobile.BusinessLogic.Requests;
 using TransactionProcessor.Mobile.BusinessLogic.Services;
@@ -37,6 +38,7 @@ public AdminPageViewModel(IMediator mediator, INavigationService navigationServi
         [RelayCommand]
         private async Task Reconciliation()
         {
+            CorrelationIdProvider.NewId();
             PerformReconciliationRequest request =
                 PerformReconciliationRequest.Create(DateTime.Now, String.Empty, this.ApplicationInfoService.VersionString);
 
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/LoginPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/LoginPageViewModel.cs
@@ -7,6 +7,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Windows.Input;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Logging;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
 using TransactionProcessor.Mobile.BusinessLogic.Requests;
@@ -155,6 +156,8 @@ private async Task<Result<Decimal>> GetMerchantBalance() {
 
         [RelayCommand]
         private async Task Logon(){
+            CorrelationIdProvider.NewId();
+
             this.CacheUseTrainingMode();
 
             Stopwatch sw = Stopwatch.StartNew();
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/MyAccount/MyAccountPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/MyAccount/MyAccountPageViewModel.cs
@@ -105,6 +105,7 @@ private async Task LogoutCommandExecute() {
 
         [RelayCommand]
         private async Task OptionSelected(ItemSelected<ListViewItem> arg) {
+            CorrelationIdProvider.NewId();
             AccountOptions selectedOption = (AccountOptions)arg.SelectedItemIndex;
 
             Task navigationTask = selectedOption switch {
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Reports/ReportsPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Reports/ReportsPageViewModel.cs
@@ -57,6 +57,7 @@ public override async Task Initialise(CancellationToken cancellationToken)
         [RelayCommand]
         private async Task OptionSelected(ItemSelected<ListViewItem> arg)
         {
+            CorrelationIdProvider.NewId();
             ReportsOptions selectedOption = (ReportsOptions)arg.SelectedItemIndex;
 
             Task navigationTask = selectedOption switch
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Reports/ReportsSalesAnalysisPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Reports/ReportsSalesAnalysisPageViewModel.cs
@@ -1,11 +1,12 @@
-﻿using System.Diagnostics.CodeAnalysis;
-using CommunityToolkit.Mvvm.Input;
+﻿using CommunityToolkit.Mvvm.Input;
 using LiveChartsCore;
 using LiveChartsCore.Defaults;
 using LiveChartsCore.Kernel.Sketches;
 using LiveChartsCore.Measure;
 using LiveChartsCore.SkiaSharpView;
 using MediatR;
+using System.Diagnostics.CodeAnalysis;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Services;
 using TransactionProcessor.Mobile.BusinessLogic.UIServices;
 
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Support/SupportPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Support/SupportPageViewModel.cs
@@ -1,8 +1,9 @@
-﻿using System.Text;
-using System.Windows.Input;
-using CommunityToolkit.Mvvm.Input;
+﻿using CommunityToolkit.Mvvm.Input;
 using MediatR;
 using MvvmHelpers.Commands;
+using System.Text;
+using System.Windows.Input;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Database;
 using TransactionProcessor.Mobile.BusinessLogic.Logging;
 using TransactionProcessor.Mobile.BusinessLogic.Requests;
@@ -65,6 +66,7 @@ public String Platform {
 
         [RelayCommand]
         private async Task UploadLogs() {
+            CorrelationIdProvider.NewId();
             Logger.LogInformation("UploadLogs called");
 
             UploadLogsRequest uploadLogsRequest = UploadLogsRequest.Create(String.Empty);
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/BillPaymentGetAccountPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/BillPaymentGetAccountPageViewModel.cs
@@ -1,6 +1,7 @@
 ﻿using CommunityToolkit.Mvvm.Input;
 using MediatR;
 using SimpleResults;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Logging;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
 using TransactionProcessor.Mobile.BusinessLogic.Requests;
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/BillPaymentGetMeterPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/BillPaymentGetMeterPageViewModel.cs
@@ -1,8 +1,9 @@
-﻿using System.Windows.Input;
-using CommunityToolkit.Mvvm.Input;
+﻿using CommunityToolkit.Mvvm.Input;
 using MediatR;
 using MvvmHelpers.Commands;
 using SimpleResults;
+using System.Windows.Input;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Logging;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
 using TransactionProcessor.Mobile.BusinessLogic.Requests;
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/BillPaymentPayBillPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/BillPaymentPayBillPageViewModel.cs
@@ -1,8 +1,9 @@
-﻿using System.Windows.Input;
-using CommunityToolkit.Mvvm.Input;
+﻿using CommunityToolkit.Mvvm.Input;
 using MediatR;
 using MvvmHelpers.Commands;
 using SimpleResults;
+using System.Windows.Input;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Logging;
 using TransactionProcessor.Mobile.BusinessLogic.Models;
 using TransactionProcessor.Mobile.BusinessLogic.Requests;
diff --git a/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/TransactionsPageViewModel.cs b/TransactionProcessor.Mobile.BusinessLogic/ViewModels/Transactions/TransactionsPageViewModel.cs
@@ -1,6 +1,8 @@
 ﻿using CommunityToolkit.Mvvm.Input;
 using MvvmHelpers.Commands;
 using System.Windows.Input;
+using ClientProxyBase;
+using TransactionProcessor.Mobile.BusinessLogic.Common;
 using TransactionProcessor.Mobile.BusinessLogic.Logging;
 using TransactionProcessor.Mobile.BusinessLogic.Services;
 using TransactionProcessor.Mobile.BusinessLogic.UIServices;
@@ -34,27 +36,31 @@ public async Task Admin()
         [RelayCommand]
         public async Task BillPayment()
         {
+            CorrelationIdProvider.NewId();
             Logger.LogInformation("Bill Payment called");
             await this.NavigationService.GoToBillPaymentSelectOperatorPage();
         }
 
         [RelayCommand]
         public async Task MobileTopup()
         {
+            CorrelationIdProvider.NewId();
             Logger.LogInformation("Mobile Topup called");
             await this.NavigationService.GoToMobileTopupSelectOperatorPage();
         }
 
         [RelayCommand]
         public async Task MobileWallet()
         {
+            CorrelationIdProvider.NewId();
             Logger.LogInformation("MobileWallet called");
             await this.NavigationService.GoToHome();
         }
 
         [RelayCommand]
         public async Task Voucher()
         {
+            CorrelationIdProvider.NewId();
             Logger.LogInformation("Voucher called");
             await this.NavigationService.GoToVoucherSelectOperatorPage();
         }
diff --git a/TransactionProcessor.Mobile.UITests/Features/EndToEndTests.feature.cs b/TransactionProcessor.Mobile.UITests/Features/EndToEndTests.feature.cs
diff --git a/TransactionProcessor.Mobile/Extensions/MauiAppBuilderExtensions.cs b/TransactionProcessor.Mobile/Extensions/MauiAppBuilderExtensions.cs
@@ -30,6 +30,8 @@
 //using TransactionProcessor.Mobile.Platforms.Android;
 using TransactionProcessor.Mobile.UIServices;
 using LogMessage = TransactionProcessor.Mobile.BusinessLogic.Models.LogMessage;
+using ClientProxyBase;
+
 
 #if ANDROID
 using Javax.Net.Ssl;
@@ -54,9 +56,21 @@ public static MauiAppBuilder ConfigureDatabase(this MauiAppBuilder builder) {
         }
 
         public static MauiAppBuilder ConfigureAppServices(this MauiAppBuilder builder) {
+            //builder.Services.AddHttpClient()
+            //    .AddHttpMessageHandler<CorrelationIdHandler>()
+            //    .ConfigurePrimaryHttpMessageHandler(GetHandler);
+
+            builder.Services.AddHttpClient("default")
+                .AddHttpMessageHandler<CorrelationIdHandler>()
+                .ConfigurePrimaryHttpMessageHandler(GetHandler);
+
+            // Register as the default HttpClient
+            builder.Services.AddTransient(sp =>
+            {
+                var factory = sp.GetRequiredService<IHttpClientFactory>();
+                return factory.CreateClient("default");
+            });
 
-            HttpClient httpClient = CreateHttpClient();
-            builder.Services.AddSingleton<HttpClient>(httpClient);
             builder.Services.AddSingleton<Func<String, String>>(
                                                                 new Func<String, String>(configSetting =>
                                                                                          {
@@ -157,16 +171,16 @@ public static MauiAppBuilder ConfigureAppServices(this MauiAppBuilder builder) {
                                                                                                                    }
                                                                                                                }));
 
-            builder.Services.AddSingleton<ISecurityServiceClient, SecurityServiceClient>();
+            builder.Services.RegisterHttpClientX<ISecurityServiceClient, SecurityServiceClient>();
             builder.Services.AddSingleton<IApplicationCache, ApplicationCache>();
 
             builder.ConfigureDeviceIdProvider();
 
             return builder;
         }
 
-        private static HttpClient CreateHttpClient() {
-
+        public static HttpMessageHandler GetHandler()
+        {
 #if ANDROID
             CustomAndroidMessageHandler androidMessageHandler = new()
             {
@@ -177,22 +191,22 @@ private static HttpClient CreateHttpClient() {
                     errors) => true,
 
             };
-            return new HttpClient(androidMessageHandler);
+            return androidMessageHandler;
 #else
-            HttpMessageHandler httpMessageHandler = new SocketsHttpHandler
-                                                    {
-                                                        SslOptions = new SslClientAuthenticationOptions
-                                                                     {
-                                                                         RemoteCertificateValidationCallback = (sender,
-                                                                                                                certificate,
-                                                                                                                chain,
-                                                                                                                errors) => true,
-                                                                     }
-                                                    };
-            return new HttpClient(httpMessageHandler);
+                        HttpMessageHandler httpMessageHandler = new SocketsHttpHandler
+                                                                {
+                                                                    SslOptions = new SslClientAuthenticationOptions
+                                                                                 {
+                                                                                     RemoteCertificateValidationCallback = (sender,
+                                                                                                                            certificate,
+                                                                                                                            chain,
+                                                                                                                            errors) => true,
+                                                                                 }
+                                                                };
+                        return httpMessageHandler;
 #endif
         }
-
+        
         public static MauiAppBuilder ConfigureUIServices(this MauiAppBuilder builder) {
             builder.Services.AddSingleton<IDialogService, DialogService>();
             builder.Services.AddSingleton<INavigationService, ShellNavigationService>();
@@ -311,6 +325,20 @@ public static MauiAppBuilder ConfigurePages(this MauiAppBuilder builder) {
         }
 
         #endregion
+
+        public static IHttpClientBuilder RegisterHttpClientX<TInterface, TImplementation>(
+            this IServiceCollection services)
+            where TInterface : class
+            where TImplementation : class, TInterface
+        {
+            services.AddTransient<CorrelationIdHandler>();
+
+            services.AddHttpClient<TInterface, TImplementation>()
+                .AddHttpMessageHandler<CorrelationIdHandler>()
+                .ConfigurePrimaryHttpMessageHandler(GetHandler);
+
+            return services.AddHttpClient<TImplementation>();
+        }
     }
 
 #if ANDROID
diff --git a/TransactionProcessor.Mobile/MauiProgram.cs b/TransactionProcessor.Mobile/MauiProgram.cs
diff --git a/TransactionProcessor.Mobile/TransactionProcessor.Mobile.csproj b/TransactionProcessor.Mobile/TransactionProcessor.Mobile.csproj

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,15 @@`
`1`	`1`	`using System.Diagnostics.CodeAnalysis;`
	`2`	`+using TransactionProcessor.Mobile.BusinessLogic.Common;`
`2`	`3`	`using TransactionProcessor.Mobile.BusinessLogic.Models;`
`3`	`4`
`4`	`5`	`namespace TransactionProcessor.Mobile.BusinessLogic.Logging;`
`5`	`6`
`6`	`7`	`[ExcludeFromCodeCoverage]`
`7`	`8`	`public class ConsoleLogger : ILogger{`
	`9`	`+`
`8`	`10`	`#region Constructors`
`9`	`11`
`10`		`- public ConsoleLogger(){`
	`12`	`+ public ConsoleLogger() {`
`11`	`13`	`this.IsInitialised = true;`
`12`	`14`	`}`
`13`	`15`
`@@ -23,17 +25,16 @@ public ConsoleLogger(){`
`23`	`25`
`24`	`26`	`internal void Log(LogMessage logMessageModel)`
`25`	`27`	`{`
`26`		`- List<LogMessage> logMessageModels = new List<LogMessage>{`
`27`		`- logMessageModel`
`28`		`- };`
	`28`	`+ List<LogMessage> logMessageModels = [logMessageModel];`
`29`	`29`	`this.Log(logMessageModels);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`internal void Log(List<LogMessage> logMessageModels)`
`33`	`33`	`{`
	`34`	`+ String correlationId = CorrelationIdProvider.CorrelationId;`
`34`	`35`	`foreach (LogMessage item in logMessageModels)`
`35`	`36`	`{`
`36`		`- Console.WriteLine($"AppLog\|{item.EntryDateTime}\|{item.LogLevel}\|{item.Message}");`
	`37`	`+ Console.WriteLine($"AppLog\|{item.EntryDateTime}\|Correlation Id: {correlationId}\|{item.LogLevel}\|{item.Message}");`
`37`	`38`	`}`
`38`	`39`	`}`
`39`	`40`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ public override async Task Initialise(CancellationToken cancellationToken)`
`57`	`57`	`[RelayCommand]`
`58`	`58`	`private async Task OptionSelected(ItemSelected<ListViewItem> arg)`
`59`	`59`	`{`
	`60`	`+ CorrelationIdProvider.NewId();`
`60`	`61`	`ReportsOptions selectedOption = (ReportsOptions)arg.SelectedItemIndex;`
`61`	`62`
`62`	`63`	`Task navigationTask = selectedOption switch`