Replace telemetry backend with Devolutions OpenSearch

.github/workflows/build-release.yml

@@ -91,6 +91,8 @@ jobs:
     env:
       UNIGETUI_GITHUB_CLIENT_ID: ${{ secrets.UNIGETUI_GITHUB_CLIENT_ID }}
       UNIGETUI_GITHUB_CLIENT_SECRET: ${{ secrets.UNIGETUI_GITHUB_CLIENT_SECRET }}
+      UNIGETUI_OPENSEARCH_USERNAME: ${{ secrets.UNIGETUI_OPENSEARCH_USERNAME }}
+      UNIGETUI_OPENSEARCH_PASSWORD: ${{ secrets.UNIGETUI_OPENSEARCH_PASSWORD }}
       NUGET_PACKAGES: ${{ github.workspace }}\.nuget\packages
     strategy:
       fail-fast: false
@@ -318,6 +320,8 @@ jobs:
     env:
       UNIGETUI_GITHUB_CLIENT_ID: ${{ secrets.UNIGETUI_GITHUB_CLIENT_ID }}
       UNIGETUI_GITHUB_CLIENT_SECRET: ${{ secrets.UNIGETUI_GITHUB_CLIENT_SECRET }}
+      UNIGETUI_OPENSEARCH_USERNAME: ${{ secrets.UNIGETUI_OPENSEARCH_USERNAME }}
+      UNIGETUI_OPENSEARCH_PASSWORD: ${{ secrets.UNIGETUI_OPENSEARCH_PASSWORD }}
       NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
     strategy:
       fail-fast: false

src/UniGetUI.Avalonia/App.axaml.cs

@@ -47,7 +47,7 @@ public override void OnFrameworkInitializationCompleted()
             ApplyTheme(CoreSettings.GetValue(CoreSettings.K.PreferredTheme));
             var mainWindow = new MainWindow();
             desktop.MainWindow = mainWindow;
-            _ = Task.Run(PEInterface.LoadManagers);
+            _ = AvaloniaBootstrapper.InitializeAsync();
         }
 
         base.OnFrameworkInitializationCompleted();

src/UniGetUI.Avalonia/Infrastructure/AvaloniaBootstrapper.cs

@@ -53,6 +53,9 @@ private static Task InitializeSharedServicesAsync()
                 CancellationToken.None,
                 TaskContinuationOptions.OnlyOnFaulted,
                 TaskScheduler.Default);
+        TelemetryHandler.Configure(
+            Secrets.GetOpenSearchUsername(),
+            Secrets.GetOpenSearchPassword());
         _ = TelemetryHandler.InitializeAsync()
             .ContinueWith(
                 t => Logger.Error(t.Exception!),
@@ -82,7 +85,7 @@ private static Task InitializeSharedServicesAsync()
 
     private static async Task InitializePackageEngineAsync()
     {
-        await Task.Run(PEInterface.LoadLoaders);
+        // LoadLoaders is called synchronously in App.axaml.cs before MainWindow creation
         await Task.Run(PEInterface.LoadManagers);
     }
 

src/UniGetUI.Avalonia/Infrastructure/AvaloniaPackageOperationHelper.cs

@@ -1,5 +1,6 @@
 using UniGetUI.Core.Logging;
 using UniGetUI.Interface.Enums;
+using UniGetUI.Interface.Telemetry;
 using UniGetUI.PackageEngine.Enums;
 using UniGetUI.PackageEngine.Operations;
 using UniGetUI.PackageEngine.PackageClasses;
@@ -20,6 +21,8 @@ public static async Task UpdateAllAsync()
             if (pkg.Tag is PackageTag.BeingProcessed or PackageTag.OnQueue) continue;
             var opts = await InstallOptionsFactory.LoadApplicableAsync(pkg);
             var op = new UpdatePackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.SUCCESS);
+            op.OperationFailed += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.FAILED);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }
@@ -34,6 +37,8 @@ public static async Task UpdateAllForManagerAsync(string managerName)
             if (pkg.Tag is PackageTag.BeingProcessed or PackageTag.OnQueue) continue;
             var opts = await InstallOptionsFactory.LoadApplicableAsync(pkg);
             var op = new UpdatePackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.SUCCESS);
+            op.OperationFailed += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.FAILED);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }
@@ -50,6 +55,8 @@ public static async Task UpdateForIdAsync(string packageId)
 
         var opts = await InstallOptionsFactory.LoadApplicableAsync(pkg);
         var op = new UpdatePackageOperation(pkg, opts);
+        op.OperationSucceeded += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.SUCCESS);
+        op.OperationFailed += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.FAILED);
         AvaloniaOperationRegistry.Add(op);
         _ = op.MainThread();
     }

src/UniGetUI.Avalonia/Infrastructure/Secrets.cs

@@ -8,5 +8,7 @@ internal static partial class Secrets
      *          Seeing errors? Build the project (maybe twice)
      */
     public static partial string GetGitHubClientId();
+    public static partial string GetOpenSearchUsername();
+    public static partial string GetOpenSearchPassword();
     /* ------------------------------------------------------------------------ */
 }

src/UniGetUI.Avalonia/Infrastructure/generate-secrets.ps1

@@ -12,8 +12,12 @@ if (-not (Test-Path -Path $generatedDir)) {
 }
 
 $clientId = $env:UNIGETUI_GITHUB_CLIENT_ID
+$openSearchUsername = $env:UNIGETUI_OPENSEARCH_USERNAME
+$openSearchPassword = $env:UNIGETUI_OPENSEARCH_PASSWORD
 
 if (-not $clientId) { $clientId = "CLIENT_ID_UNSET" }
+if (-not $openSearchUsername) { $openSearchUsername = "OPENSEARCH_USERNAME_UNSET" }
+if (-not $openSearchPassword) { $openSearchPassword = "OPENSEARCH_PASSWORD_UNSET" }
 
 @"
 // Auto-generated file - do not modify
@@ -22,6 +26,8 @@ namespace UniGetUI.Avalonia.Infrastructure
     internal static partial class Secrets
     {
         public static partial string GetGitHubClientId() => `"$clientId`";
+        public static partial string GetOpenSearchUsername() => `"$openSearchUsername`";
+        public static partial string GetOpenSearchPassword() => `"$openSearchPassword`";
     }
 }
 "@ | Set-Content -Encoding UTF8 "Generated Files\Secrets.Generated.cs"

src/UniGetUI.Avalonia/Infrastructure/generate-secrets.sh

@@ -5,8 +5,12 @@ if [ ! -d "Generated Files" ]; then mkdir -p "Generated Files"; fi
 if [ ! -d "${OUTPUT_PATH}Generated Files" ]; then mkdir -p "${OUTPUT_PATH}Generated Files"; fi
 
 CLIENT_ID="${UNIGETUI_GITHUB_CLIENT_ID}"
+OPENSEARCH_USERNAME="${UNIGETUI_OPENSEARCH_USERNAME}"
+OPENSEARCH_PASSWORD="${UNIGETUI_OPENSEARCH_PASSWORD}"
 
 if [ -z "$CLIENT_ID" ]; then CLIENT_ID="CLIENT_ID_UNSET"; fi
+if [ -z "$OPENSEARCH_USERNAME" ]; then OPENSEARCH_USERNAME="OPENSEARCH_USERNAME_UNSET"; fi
+if [ -z "$OPENSEARCH_PASSWORD" ]; then OPENSEARCH_PASSWORD="OPENSEARCH_PASSWORD_UNSET"; fi
 
 cat > "Generated Files/Secrets.Generated.cs" << CSEOF
 // Auto-generated file - do not modify
@@ -15,6 +19,8 @@ namespace UniGetUI.Avalonia.Infrastructure
     internal static partial class Secrets
     {
         public static partial string GetGitHubClientId() => "$CLIENT_ID";
+        public static partial string GetOpenSearchUsername() => "$OPENSEARCH_USERNAME";
+        public static partial string GetOpenSearchPassword() => "$OPENSEARCH_PASSWORD";
     }
 }
 CSEOF

src/UniGetUI.Avalonia/ViewModels/SoftwarePages/PackagesPageViewModel.cs

@@ -15,6 +15,7 @@
 using UniGetUI.Avalonia.Views.Controls;
 using UniGetUI.Core.SettingsEngine;
 using UniGetUI.Core.Tools;
+using UniGetUI.Interface.Telemetry;
 using UniGetUI.PackageEngine.Enums;
 using UniGetUI.PackageEngine.Interfaces;
 using UniGetUI.PackageEngine.Operations;
@@ -784,6 +785,8 @@ public static async Task LaunchInstall(
             var opts = await InstallOptionsFactory.LoadApplicableAsync(
                 pkg, elevated: elevated, interactive: interactive, no_integrity: no_integrity);
             var op = new InstallPackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.InstallPackage(pkg, TEL_OP_RESULT.SUCCESS, TEL_InstallReferral.DIRECT_SEARCH);
+            op.OperationFailed += (_, _) => TelemetryHandler.InstallPackage(pkg, TEL_OP_RESULT.FAILED, TEL_InstallReferral.DIRECT_SEARCH);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }

src/UniGetUI.Avalonia/Views/DialogPages/PackageDetailsWindow.axaml.cs

@@ -1,6 +1,7 @@
 using Avalonia.Controls;
 using UniGetUI.Avalonia.Infrastructure;
 using UniGetUI.Avalonia.ViewModels;
+using UniGetUI.Interface.Telemetry;
 using UniGetUI.PackageEngine.Enums;
 using UniGetUI.PackageEngine.Interfaces;
 using UniGetUI.PackageEngine.Operations;
@@ -35,6 +36,7 @@ protected override void OnOpened(EventArgs e)
     {
         base.OnOpened(e);
         _ = _vm.LoadDetailsAsync();
+        TelemetryHandler.PackageDetails(_vm.Package, _vm.OperationRole.ToString());
     }
 
     private MenuFlyout BuildActionFlyout()
@@ -110,6 +112,22 @@ private async Task LaunchAndClose(
             _ => throw new ArgumentOutOfRangeException(nameof(role)),
         };
 
+        switch (role)
+        {
+            case OperationType.Install:
+                op.OperationSucceeded += (_, _) => TelemetryHandler.InstallPackage(pkg, TEL_OP_RESULT.SUCCESS, TEL_InstallReferral.DIRECT_SEARCH);
+                op.OperationFailed += (_, _) => TelemetryHandler.InstallPackage(pkg, TEL_OP_RESULT.FAILED, TEL_InstallReferral.DIRECT_SEARCH);
+                break;
+            case OperationType.Update:
+                op.OperationSucceeded += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.SUCCESS);
+                op.OperationFailed += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.FAILED);
+                break;
+            case OperationType.Uninstall:
+                op.OperationSucceeded += (_, _) => TelemetryHandler.UninstallPackage(pkg, TEL_OP_RESULT.SUCCESS);
+                op.OperationFailed += (_, _) => TelemetryHandler.UninstallPackage(pkg, TEL_OP_RESULT.FAILED);
+                break;
+        }
+
         AvaloniaOperationRegistry.Add(op);
         _ = op.MainThread();
     }

src/UniGetUI.Avalonia/Views/SoftwarePages/InstalledPackagesPage.cs

@@ -7,6 +7,7 @@
 using UniGetUI.Core.Logging;
 using UniGetUI.Core.SettingsEngine;
 using UniGetUI.Core.Tools;
+using UniGetUI.Interface.Telemetry;
 using UniGetUI.PackageEngine.Classes.Manager.Classes;
 using UniGetUI.PackageEngine.Enums;
 using UniGetUI.PackageEngine.Interfaces;
@@ -320,6 +321,8 @@ private static async Task LaunchUninstall(
             var opts = await InstallOptionsFactory.LoadApplicableAsync(
                 pkg, elevated: elevated, interactive: interactive, remove_data: remove_data);
             var op = new UninstallPackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.UninstallPackage(pkg, TEL_OP_RESULT.SUCCESS);
+            op.OperationFailed += (_, _) => TelemetryHandler.UninstallPackage(pkg, TEL_OP_RESULT.FAILED);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }
@@ -330,6 +333,8 @@ private static async Task LaunchReinstall(IPackage? package)
         if (package is null || package.Source.IsVirtualManager) return;
         var opts = await InstallOptionsFactory.LoadApplicableAsync(package);
         var op = new InstallPackageOperation(package, opts);
+        op.OperationSucceeded += (_, _) => TelemetryHandler.InstallPackage(package, TEL_OP_RESULT.SUCCESS, TEL_InstallReferral.ALREADY_INSTALLED);
+        op.OperationFailed += (_, _) => TelemetryHandler.InstallPackage(package, TEL_OP_RESULT.FAILED, TEL_InstallReferral.ALREADY_INSTALLED);
         AvaloniaOperationRegistry.Add(op);
         _ = op.MainThread();
     }
@@ -340,7 +345,11 @@ private static async Task LaunchUninstallThenReinstall(IPackage? package)
         var uninstallOpts = await InstallOptionsFactory.LoadApplicableAsync(package);
         var reinstallOpts = await InstallOptionsFactory.LoadApplicableAsync(package);
         var uninstallOp = new UninstallPackageOperation(package, uninstallOpts);
+        uninstallOp.OperationSucceeded += (_, _) => TelemetryHandler.UninstallPackage(package, TEL_OP_RESULT.SUCCESS);
+        uninstallOp.OperationFailed += (_, _) => TelemetryHandler.UninstallPackage(package, TEL_OP_RESULT.FAILED);
         var reinstallOp = new InstallPackageOperation(package, reinstallOpts, req: uninstallOp);
+        reinstallOp.OperationSucceeded += (_, _) => TelemetryHandler.InstallPackage(package, TEL_OP_RESULT.SUCCESS, TEL_InstallReferral.ALREADY_INSTALLED);
+        reinstallOp.OperationFailed += (_, _) => TelemetryHandler.InstallPackage(package, TEL_OP_RESULT.FAILED, TEL_InstallReferral.ALREADY_INSTALLED);
         AvaloniaOperationRegistry.Add(uninstallOp);
         AvaloniaOperationRegistry.Add(reinstallOp);
         _ = uninstallOp.MainThread();

src/UniGetUI.Avalonia/Views/SoftwarePages/PackageBundlesPage.cs

@@ -282,6 +282,8 @@ public async Task ImportAndInstallPackage(
             var opts = await InstallOptionsFactory.LoadApplicableAsync(
                 pkg, elevated: elevated, interactive: interactive, no_integrity: skiphash);
             var op = new InstallPackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.InstallPackage(pkg, TEL_OP_RESULT.SUCCESS, TEL_InstallReferral.FROM_BUNDLE);
+            op.OperationFailed += (_, _) => TelemetryHandler.InstallPackage(pkg, TEL_OP_RESULT.FAILED, TEL_InstallReferral.FROM_BUNDLE);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }

src/UniGetUI.Avalonia/Views/SoftwarePages/SoftwareUpdatesPage.cs

@@ -5,6 +5,7 @@
 using UniGetUI.Avalonia.Views;
 using UniGetUI.Core.Logging;
 using UniGetUI.Core.Tools;
+using UniGetUI.Interface.Telemetry;
 using UniGetUI.PackageEngine.Classes.Manager.Classes;
 using UniGetUI.PackageEngine.Classes.Packages.Classes;
 using UniGetUI.PackageEngine.Enums;
@@ -339,6 +340,8 @@ private static async Task LaunchUpdate(
             var opts = await InstallOptionsFactory.LoadApplicableAsync(
                 pkg, elevated: elevated, interactive: interactive, no_integrity: no_integrity);
             var op = new UpdatePackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.SUCCESS);
+            op.OperationFailed += (_, _) => TelemetryHandler.UpdatePackage(pkg, TEL_OP_RESULT.FAILED);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }
@@ -350,6 +353,8 @@ private static async Task LaunchUninstallFromUpdates(IEnumerable<IPackage> packa
         {
             var opts = await InstallOptionsFactory.LoadApplicableAsync(pkg);
             var op = new UninstallPackageOperation(pkg, opts);
+            op.OperationSucceeded += (_, _) => TelemetryHandler.UninstallPackage(pkg, TEL_OP_RESULT.SUCCESS);
+            op.OperationFailed += (_, _) => TelemetryHandler.UninstallPackage(pkg, TEL_OP_RESULT.FAILED);
             AvaloniaOperationRegistry.Add(op);
             _ = op.MainThread();
         }
@@ -361,7 +366,11 @@ private static async Task LaunchUninstallThenUpdate(IPackage? package)
         var uninstallOpts = await InstallOptionsFactory.LoadApplicableAsync(package);
         var updateOpts = await InstallOptionsFactory.LoadApplicableAsync(package);
         var uninstallOp = new UninstallPackageOperation(package, uninstallOpts);
+        uninstallOp.OperationSucceeded += (_, _) => TelemetryHandler.UninstallPackage(package, TEL_OP_RESULT.SUCCESS);
+        uninstallOp.OperationFailed += (_, _) => TelemetryHandler.UninstallPackage(package, TEL_OP_RESULT.FAILED);
         var updateOp = new UpdatePackageOperation(package, updateOpts, req: uninstallOp);
+        updateOp.OperationSucceeded += (_, _) => TelemetryHandler.UpdatePackage(package, TEL_OP_RESULT.SUCCESS);
+        updateOp.OperationFailed += (_, _) => TelemetryHandler.UpdatePackage(package, TEL_OP_RESULT.FAILED);
         AvaloniaOperationRegistry.Add(uninstallOp);
         AvaloniaOperationRegistry.Add(updateOp);
         _ = uninstallOp.MainThread();

src/UniGetUI.Interface.Telemetry/Events/TelemetryEventBase.cs

@@ -0,0 +1,67 @@
+using System.Text.Json.Serialization;
+
+namespace UniGetUI.Interface.Telemetry;
+
+/// <summary>
+/// Common fields shared by all UniGetUI telemetry events.
+/// Mirrors the field names expected by the Devolutions OpenSearch schema.
+/// </summary>
+public abstract class TelemetryEventBase
+{
+    protected TelemetryEventBase()
+    {
+        EventID = Guid.NewGuid().ToString();
+        EventDate = DateTime.UtcNow;
+    }
+
+    [JsonPropertyName("eventID")]
+    public string EventID { get; set; }
+
+    [JsonPropertyName("eventDate")]
+    public DateTime EventDate { get; set; }
+
+    [JsonPropertyName("installID")]
+    public required string InstallID { get; set; }
+
+    [JsonPropertyName("locale")]
+    public string? Locale { get; set; }
+
+    [JsonPropertyName("application")]
+    public required TelemetryApplicationInfo Application { get; set; }
+
+    [JsonPropertyName("platform")]
+    public TelemetryPlatformInfo? Platform { get; set; }
+}
+
+public sealed class TelemetryApplicationInfo
+{
+    [JsonPropertyName("name")]
+    public required string Name { get; set; }
+
+    [JsonPropertyName("version")]
+    public required string Version { get; set; }
+
+    [JsonPropertyName("dataSource")]
+    public required string DataSource { get; set; }
+
+    [JsonPropertyName("pricing")]
+    public required string Pricing { get; set; }
+
+    [JsonPropertyName("language")]
+    public string? Language { get; set; }
+
+    [JsonPropertyName("architectureType")]
+    public string? ArchitectureType { get; set; }
+}
+
+public sealed class TelemetryPlatformInfo
+{
+    [JsonPropertyName("name")]
+    public required string Name { get; set; }
+
+    [JsonPropertyName("version")]
+    public string? Version { get; set; }
+
+    [JsonPropertyName("architecture")]
+    public string? Architecture { get; set; }
+}

src/UniGetUI.Interface.Telemetry/Events/UniGetUIActivityEvent.cs

@@ -0,0 +1,15 @@
+using System.Text.Json.Serialization;
+
+namespace UniGetUI.Interface.Telemetry;
+
+public sealed class UniGetUIActivityEvent : TelemetryEventBase
+{
+    [JsonPropertyName("enabledManagers")]
+    public string[] EnabledManagers { get; set; } = [];
+
+    [JsonPropertyName("foundManagers")]
+    public string[] FoundManagers { get; set; } = [];
+
+    [JsonPropertyName("activeSettings")]
+    public int ActiveSettings { get; set; }
+}

src/UniGetUI.Interface.Telemetry/Events/UniGetUIBundleEvent.cs

@@ -0,0 +1,12 @@
+using System.Text.Json.Serialization;
+
+namespace UniGetUI.Interface.Telemetry;
+
+public sealed class UniGetUIBundleEvent : TelemetryEventBase
+{
+    [JsonPropertyName("operation")]
+    public required string Operation { get; set; }
+
+    [JsonPropertyName("bundleType")]
+    public required string BundleType { get; set; }
+}

src/UniGetUI.Interface.Telemetry/Events/UniGetUIPackageEvent.cs

@@ -0,0 +1,24 @@
+using System.Text.Json.Serialization;
+
+namespace UniGetUI.Interface.Telemetry;
+
+public sealed class UniGetUIPackageEvent : TelemetryEventBase
+{
+    [JsonPropertyName("operation")]
+    public required string Operation { get; set; }
+
+    [JsonPropertyName("packageId")]
+    public required string PackageId { get; set; }
+
+    [JsonPropertyName("managerName")]
+    public required string ManagerName { get; set; }
+
+    [JsonPropertyName("sourceName")]
+    public required string SourceName { get; set; }
+
+    [JsonPropertyName("operationResult")]
+    public string? OperationResult { get; set; }
+
+    [JsonPropertyName("eventSource")]
+    public string? EventSource { get; set; }
+}