Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-04 18:26:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

CmdPal: ApplicationInfoService + fix version in the error report builder (#45374)

Browse Source 
## Summary of the Pull Request

This PR introduces a new service, ApplicationInfoService, that
encapsulates host app state and infrastructure and moves the logic for
obtaining version information there. It then uses this information to
fix an issue with incorrect version reporting for unpackaged CmdPal in
ErrorReportBuilder.

- Adds ApplicationInfoService.
- Fixes an error in ErrorReportBuilder when the app runs unpackaged.
- Adds logging of the app version and environmental info at startup.

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] Closes: #45368
- [x] Closes: #45370
<!-- - [ ] Closes: #yyy (add separate lines for additional resolved
issues) -->
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
This commit is contained in:
Jiří Polášek
2026-02-09 21:00:01 +01:00
committed by GitHub
parent 4959273875
commit 1e25d17920
10 changed files with 357 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/modules/cmdpal/Microsoft.CmdPal.UI/App.xaml.cs
View File

@@ -68,11 +68,13 @@ public partial class App : Application, IDisposable
/// </summary>
public App()
{
var appInfoService = new ApplicationInfoService();
#if !CMDPAL_DISABLE_GLOBAL_ERROR_HANDLER
_globalErrorHandler.Register(this, GlobalErrorHandler.Options.Default);
_globalErrorHandler.Register(this, GlobalErrorHandler.Options.Default, appInfoService);
#endif
Services = ConfigureServices();
Services = ConfigureServices(appInfoService);
IconCacheProvider.Initialize(Services);
@@ -93,6 +95,9 @@ public partial class App : Application, IDisposable
// This way, log statements from the core project will be captured by the PT logs
var logWrapper = new LogWrapper();
CoreLogger.InitializeLogger(logWrapper);
// Now that CoreLogger is initialized, initialize the logger delegate in ApplicationInfoService
appInfoService.SetLogDirectory(() => Logger.CurrentVersionLogDirectoryPath);
}
/// <summary>
@@ -110,7 +115,7 @@ public partial class App : Application, IDisposable
/// <summary>
/// Configures the services for the application
/// </summary>
private static ServiceProvider ConfigureServices()
private static ServiceProvider ConfigureServices(IApplicationInfoService appInfoService)
{
// TODO: It's in the Labs feed, but we can use Sergio's AOT-friendly source generator for this: https://github.com/CommunityToolkit/Labs-Windows/discussions/463
ServiceCollection services = new();
@@ -121,7 +126,7 @@ public partial class App : Application, IDisposable
AddBuiltInCommands(services);
AddCoreServices(services);
AddCoreServices(services, appInfoService);
AddUIServices(services, dispatcherQueue);
@@ -197,9 +202,11 @@ public partial class App : Application, IDisposable
services.AddIconServices(dispatcherQueue);
}
private static void AddCoreServices(ServiceCollection services)
private static void AddCoreServices(ServiceCollection services, IApplicationInfoService appInfoService)
{
// Core services
services.AddSingleton(appInfoService);
services.AddSingleton<IExtensionService, ExtensionService>();
services.AddSingleton<IRunHistoryService, RunHistoryService>();

10
src/modules/cmdpal/Microsoft.CmdPal.UI/Helpers/GlobalErrorHandler.cs
View File

@@ -3,6 +3,7 @@
// See the LICENSE file in the project root for more information.
using ManagedCommon;
using Microsoft.CmdPal.Core.Common.Services;
using Microsoft.CmdPal.Core.Common.Services.Reports;
using Windows.Win32;
using Windows.Win32.Foundation;
@@ -17,19 +18,20 @@ namespace Microsoft.CmdPal.UI.Helpers;
/// </summary>
internal sealed partial class GlobalErrorHandler : IDisposable
{
private readonly ErrorReportBuilder _errorReportBuilder = new();
private ErrorReportBuilder? _errorReportBuilder;
private Options? _options;
private App? _app;
// GlobalErrorHandler is designed to be self-contained; it can be registered and invoked before a service provider is available.
internal void Register(App app, Options options)
internal void Register(App app, Options options, IApplicationInfoService? appInfoService = null)
{
ArgumentNullException.ThrowIfNull(app);
ArgumentNullException.ThrowIfNull(options);
_options = options;
_app = app;
_errorReportBuilder = new ErrorReportBuilder(appInfoService);
_app.UnhandledException += App_UnhandledException;
TaskScheduler.UnobservedTaskException += TaskScheduler_UnobservedTaskException;
AppDomain.CurrentDomain.UnhandledException += CurrentDomain_UnhandledException;
@@ -68,7 +70,7 @@ internal sealed partial class GlobalErrorHandler : IDisposable
if (context == Context.MainThreadException)
{
var report = _errorReportBuilder.BuildReport(ex, context.ToString(), _options?.RedactPii ?? true);
var report = _errorReportBuilder!.BuildReport(ex, context.ToString(), _options?.RedactPii ?? true);
StoreReport(report, storeOnDesktop: _options?.StoreReportOnUserDesktop == true);

20
src/modules/cmdpal/Microsoft.CmdPal.UI/Program.cs
View File

@@ -4,6 +4,7 @@
using System.Runtime.InteropServices;
using ManagedCommon;
using Microsoft.CmdPal.Core.Common.Services;
using Microsoft.CmdPal.UI.Events;
using Microsoft.PowerToys.Telemetry;
using Microsoft.UI.Dispatching;
@@ -65,6 +66,25 @@ internal sealed class Program
}
Logger.LogDebug($"Starting at {DateTime.UtcNow}");
// Log application startup information
try
{
var appInfoService = new ApplicationInfoService(() => Logger.CurrentVersionLogDirectoryPath);
var startupMessage = $"""
============================================================
Hello World! Command Palette is starting.
{appInfoService.GetApplicationInfoSummary()}
============================================================
""";
Logger.LogInfo(startupMessage);
}
catch (Exception ex)
{
Logger.LogError("Failed to log application startup information", ex);
}
PowerToysTelemetry.Log.WriteEvent(new CmdPalProcessStarted());
WinRT.ComWrappersSupport.InitializeComWrappers();

55
src/modules/cmdpal/Microsoft.CmdPal.UI/Settings/GeneralPage.xaml.cs
View File

@@ -2,15 +2,13 @@
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System.Diagnostics;
using System.Globalization;
using ManagedCommon;
using Microsoft.CmdPal.Core.Common.Services;
using Microsoft.CmdPal.UI.Helpers;
using Microsoft.CmdPal.UI.ViewModels;
using Microsoft.CmdPal.UI.ViewModels.Services;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.UI.Xaml.Controls;
using Windows.ApplicationModel;
namespace Microsoft.CmdPal.UI.Settings;
@@ -19,6 +17,7 @@ public sealed partial class GeneralPage : Page
private readonly TaskScheduler _mainTaskScheduler = TaskScheduler.FromCurrentSynchronizationContext();
private readonly SettingsViewModel? viewModel;
private readonly IApplicationInfoService _appInfoService;
public GeneralPage()
{
@@ -27,6 +26,7 @@ public sealed partial class GeneralPage : Page
var settings = App.Current.Services.GetService<SettingsModel>()!;
var topLevelCommandManager = App.Current.Services.GetService<TopLevelCommandManager>()!;
var themeService = App.Current.Services.GetService<IThemeService>()!;
_appInfoService = App.Current.Services.GetRequiredService<IApplicationInfoService>();
viewModel = new SettingsViewModel(settings, topLevelCommandManager, _mainTaskScheduler, themeService);
}
@@ -35,55 +35,8 @@ public sealed partial class GeneralPage : Page
get
{
var versionNo = ResourceLoaderInstance.GetString("Settings_GeneralPage_VersionNo");
if (!TryGetPackagedVersion(out var version) && !TryGetAssemblyVersion(out version))
{
version = "?";
}
var version = _appInfoService.AppVersion;
return string.Format(CultureInfo.CurrentCulture, versionNo, version);
}
}
private static bool TryGetPackagedVersion(out string version)
{
version = string.Empty;
try
{
// Package.Current throws InvalidOperationException if the app is not packaged
var v = Package.Current.Id.Version;
version = $"{v.Major}.{v.Minor}.{v.Build}.{v.Revision}";
return true;
}
catch (InvalidOperationException)
{
return false;
}
catch (Exception ex)
{
Logger.LogError("Failed to get version from the package", ex);
return false;
}
}
private static bool TryGetAssemblyVersion(out string version)
{
version = string.Empty;
try
{
var processPath = Environment.ProcessPath;
if (string.IsNullOrEmpty(processPath))
{
return false;
}
var info = FileVersionInfo.GetVersionInfo(processPath);
version = $"{info.FileMajorPart}.{info.FileMinorPart}.{info.FileBuildPart}.{info.FilePrivatePart}";
return true;
}
catch (Exception ex)
{
Logger.LogError("Failed to get version from the executable", ex);
return false;
}
}
}

11
src/modules/cmdpal/Microsoft.CmdPal.UI/Settings/InternalPage.xaml.cs
View File

@@ -3,7 +3,8 @@
// See the LICENSE file in the project root for more information.
using ManagedCommon;
using Microsoft.CommandPalette.Extensions.Toolkit;
using Microsoft.CmdPal.Core.Common.Services;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.UI.Xaml;
using Windows.System;
using Page = Microsoft.UI.Xaml.Controls.Page;
@@ -15,9 +16,13 @@ namespace Microsoft.CmdPal.UI.Settings;
/// </summary>
public sealed partial class InternalPage : Page
{
private readonly IApplicationInfoService _appInfoService;
public InternalPage()
{
InitializeComponent();
_appInfoService = App.Current.Services.GetRequiredService<IApplicationInfoService>();
}
private void ThrowPlainMainThreadException_Click(object sender, RoutedEventArgs e)
@@ -46,7 +51,7 @@ public sealed partial class InternalPage : Page
{
try
{
var logFolderPath = Logger.CurrentVersionLogDirectoryPath;
var logFolderPath = _appInfoService.LogDirectory;
if (Directory.Exists(logFolderPath))
{
await Launcher.LaunchFolderPathAsync(logFolderPath);
@@ -78,7 +83,7 @@ public sealed partial class InternalPage : Page
{
try
{
var directory = Utilities.BaseSettingsPath("Microsoft.CmdPal");
var directory = _appInfoService.ConfigDirectory;
if (Directory.Exists(directory))
{
await Launcher.LaunchFolderPathAsync(directory);