WPERF-1003 fix: bugs within counting settings and edge cases

nader-zouaoui · nader-zouaoui · commit 5b6211befd93 · 2024-10-03T16:11:44.000Z
See merge request Linaro/WindowsPerf/vs-extension!112

=== ChangeLog ===

* fix: bugs within counting settings and edge cases
diff --git a/WindowsPerfGUI/Commands/SamplingExplorerCommand.cs b/WindowsPerfGUI/Commands/SamplingExplorerCommand.cs
@@ -41,11 +41,16 @@ internal sealed class SamplingExplorerCommand : BaseCommand<SamplingExplorerComm
         protected override void BeforeQueryStatus(EventArgs e)
         {
             string windowTitle = SamplingExplorerLanguagePack.WindowTitle;
-            if (
-                WPerfOptions.Instance.WperfCurrentVersion.Components[0].ComponentVersion
-                != WperfDefaults.WPERF_MIN_VERSION
-            )
-                windowTitle += $" - (UNSTABLE)";
+            try
+            {
+                if (
+                    WPerfOptions.Instance.WperfCurrentVersion != null
+                    && WPerfOptions.Instance.WperfCurrentVersion.Components[0].ComponentVersion
+                    != WperfDefaults.WPERF_MIN_VERSION
+                )
+                    windowTitle += $" - (UNSTABLE)";
+            }
+            catch (Exception) { }
             Command.Text = windowTitle;
             base.BeforeQueryStatus(e);
         }
diff --git a/WindowsPerfGUI/Options/WPerfOptions.cs b/WindowsPerfGUI/Options/WPerfOptions.cs
@@ -85,19 +85,20 @@ public void UpdateWperfOptions(WperfVersion wperfVersion, bool hasSPESupport)
 #nullable enable
         public void UpdateWperfOptions(
             WperfVersion wperfVersion,
-            WperfList? wperfList,
+            WperfList wperfList,
             bool? hasSPESupport
         )
         {
             UpdateWperfVersion(wperfVersion);
-            if (wperfList != null)
-            {
-                WperfList = wperfList;
-            }
+
+            WperfList = wperfList;
+
             if (hasSPESupport != null)
-            {
                 HasSPESupport = (bool)hasSPESupport;
-            }
+
+            if (wperfList != null && hasSPESupport != null)
+                IsWperfInitialized = true;
+
             Save();
         }
 #nullable disable
diff --git a/WindowsPerfGUI/Options/WPerfPath.xaml.cs b/WindowsPerfGUI/Options/WPerfPath.xaml.cs
@@ -61,6 +61,7 @@ public void Initialize()
             {
                 SetWperfVersion(WPerfOptions.Instance.WperfCurrentVersion);
                 SetPredefinedEventsAndMetrics(WPerfOptions.Instance.WperfList);
+                WPerfVersionCheckIgnore.IsChecked = WPerfOptions.Instance.WperfVersionCheckIgnore;
             }
 
             WPerfOptions.Instance.Save();
@@ -76,7 +77,7 @@ private void ValidateButton_Click(object sender, RoutedEventArgs e)
             try
             {
                 (WperfVersion versions, string error) = wperf.GetVersion();
-                wperf.GetTest();
+                (WperfTest wperfTest, _) = wperf.GetTest();
                 if (error != "")
                     throw new Exception(error);
                 SetWperfVersion(versions, shouldForce: true);
@@ -95,9 +96,10 @@ private void ValidateButton_Click(object sender, RoutedEventArgs e)
                 (WperfList wperfList, string errorWperfList) = wperf.GetEventList();
                 if (errorWperfList != "")
                     throw new Exception(errorWperfList);
+
                 SetPredefinedEventsAndMetrics(wperfList, shouldForce: true);
                 WPerfOptions.Instance.UpdateWperfOptions(versions, wperfList);
-                WperfDefaults.HasSPESupport = wperf.CheckIsSPESupported();
+                WperfDefaults.HasSPESupport = wperf.CheckIsSPESupported(versions, wperfTest);
             }
             catch (Exception ex)
             {
diff --git a/WindowsPerfGUI/SDK/WperfClient.cs b/WindowsPerfGUI/SDK/WperfClient.cs
@@ -126,11 +126,10 @@ protected void InitProcess()
         /// <returns>
         ///     bool
         /// </returns>
-        public bool CheckIsSPESupported()
+        public bool CheckIsSPESupported(WperfVersion versionSerializedOutput, WperfTest testSerializedOutput)
         {
             try
             {
-                (WperfVersion versionSerializedOutput, _) = GetVersion();
                 foreach (var component in versionSerializedOutput.Components)
                 {
                     if (!component.FeatureString.Contains("+spe"))
@@ -139,8 +138,6 @@ public bool CheckIsSPESupported()
                     }
                 }
 
-                (WperfTest testSerializedOutput, _) = GetTest();
-
                 TestResult speDeviceConf = testSerializedOutput
                     .TestResults.Find(el => el.TestName == "spe_device.version_name");
                 if (speDeviceConf == null) { return false; }
diff --git a/WindowsPerfGUI/ToolWindows/CountingSetting/CountingSettingDialog.xaml.cs b/WindowsPerfGUI/ToolWindows/CountingSetting/CountingSettingDialog.xaml.cs
@@ -386,7 +386,7 @@ System.Windows.Controls.SelectionChangedEventArgs e
             string metricName = CountingMetricListBox.SelectedItems[0] as string;
 
             foreach (
-                var predefinedMetric in ((List<PredefinedMetric>)MetricComboBox.ItemsSource).Select(
+                var predefinedMetric in ((List<PredefinedMetricAndGroupOfMetrics>)MetricComboBox.ItemsSource).Select(
                     (value, i) => new { value, i }
                 )
             )
diff --git a/WindowsPerfGUI/Utils/WperfDefaults.cs b/WindowsPerfGUI/Utils/WperfDefaults.cs
@@ -41,7 +41,7 @@ static class WperfDefaults
 
         public static string DefaultWPASearchDir = Environment.GetEnvironmentVariable(
             "WPA_ADDITIONAL_SEARCH_DIRECTORIES"
-        );
+        ) ?? "C:\\Program Files (x86)\\Windows Kits\\10\\Windows Performance Toolkit\\CustomDataSources";
 #nullable disable
     }
 }
diff --git a/WindowsPerfGUI/WindowsPerfGUIPackage.cs b/WindowsPerfGUI/WindowsPerfGUIPackage.cs
@@ -107,14 +107,22 @@ IProgress<ServiceProgressData> progress
         protected override async Task OnAfterPackageLoadedAsync(CancellationToken cancellationToken)
         {
             bool shouldIgnoreWperfVersion = WPerfOptions.Instance.WperfVersionCheckIgnore;
-
+            WperfClientFactory wperfClient = new();
+            
             try
             {
-                WperfClientFactory wperfClient = new();
-                bool speSupport = wperfClient.CheckIsSPESupported();
-                WperfDefaults.HasSPESupport = speSupport;
                 (WperfVersion versions, string stdVersionError) = wperfClient.GetVersion();
-                if (!string.IsNullOrEmpty(stdVersionError)) throw new Exception("Unable to get WindowsPerf version");
+                (WperfTest wperfTest, _) = wperfClient.GetTest();
+
+                bool speSupport = wperfClient.CheckIsSPESupported(versions, wperfTest);
+                WperfDefaults.HasSPESupport = speSupport;
+                
+                if (!string.IsNullOrEmpty(stdVersionError)) 
+                {
+                    WPerfOptions.Instance.IsWperfInitialized = false;
+                    throw new Exception("Unable to get WindowsPerf version"); 
+                }
+
                 (WperfList wperfList, string stdListError) = wperfClient.GetEventList();
 
                 WPerfOptions.Instance.UpdateWperfOptions(versions, wperfList, speSupport);
@@ -130,9 +138,8 @@ await VS.MessageBox.ShowWarningAsync(
                             )
                         );
                 }
-
-                wperfClient.GetTest();
             }
+
             catch (Exception e)
             {
                 Trace.WriteLine(e.Message);
diff --git a/WindowsPerfGUI/source.extension.cs b/WindowsPerfGUI/source.extension.cs
@@ -11,7 +11,7 @@ internal sealed partial class Vsix
         public const string Name = "WindowsPerf GUI";
         public const string Description = @"WindowsPerf GUI (Graphical User Interface) project, a Visual Studio 2022 extension designed to bring a seamless UI experience to WindowsPerf, the command-line performance profiling tool for Windows on Arm.";
         public const string Language = "en-US";
-        public const string Version = "3.0.0";
+        public const string Version = "3.0.1";
         public const string Author = "arm";
         public const string Tags = "WindowsPerf; WindowsPerfGUI;WindowsOnArm; WOA; Profiling; perf; PMU; Performance";
     }
diff --git a/WindowsPerfGUI/source.extension.vsixmanifest b/WindowsPerfGUI/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="WindowsPerfGUI.73de2c45-cf60-4edb-a092-b09b43acf2ae" Version="3.0.0" Language="en-US" Publisher="arm" />
+        <Identity Id="WindowsPerfGUI.73de2c45-cf60-4edb-a092-b09b43acf2ae" Version="3.0.1" Language="en-US" Publisher="arm" />
         <DisplayName>WindowsPerf GUI</DisplayName>
         <Description xml:space="preserve">WindowsPerf GUI (Graphical User Interface) project, a Visual Studio 2022 extension designed to bring a seamless UI experience to WindowsPerf, the command-line performance profiling tool for Windows on Arm.</Description>
         <MoreInfo>https://gitlab.com/Linaro/WindowsPerf/vs-extension</MoreInfo>

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ public void Initialize()`
`61`	`61`	`{`
`62`	`62`	`SetWperfVersion(WPerfOptions.Instance.WperfCurrentVersion);`
`63`	`63`	`SetPredefinedEventsAndMetrics(WPerfOptions.Instance.WperfList);`
	`64`	`+ WPerfVersionCheckIgnore.IsChecked = WPerfOptions.Instance.WperfVersionCheckIgnore;`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`WPerfOptions.Instance.Save();`
`@@ -76,7 +77,7 @@ private void ValidateButton_Click(object sender, RoutedEventArgs e)`
`76`	`77`	`try`
`77`	`78`	`{`
`78`	`79`	`(WperfVersion versions, string error) = wperf.GetVersion();`
`79`		`- wperf.GetTest();`
	`80`	`+ (WperfTest wperfTest, _) = wperf.GetTest();`
`80`	`81`	`if (error != "")`
`81`	`82`	`throw new Exception(error);`
`82`	`83`	`SetWperfVersion(versions, shouldForce: true);`
`@@ -95,9 +96,10 @@ private void ValidateButton_Click(object sender, RoutedEventArgs e)`
`95`	`96`	`(WperfList wperfList, string errorWperfList) = wperf.GetEventList();`
`96`	`97`	`if (errorWperfList != "")`
`97`	`98`	`throw new Exception(errorWperfList);`
	`99`	`+`
`98`	`100`	`SetPredefinedEventsAndMetrics(wperfList, shouldForce: true);`
`99`	`101`	`WPerfOptions.Instance.UpdateWperfOptions(versions, wperfList);`
`100`		`- WperfDefaults.HasSPESupport = wperf.CheckIsSPESupported();`
	`102`	`+ WperfDefaults.HasSPESupport = wperf.CheckIsSPESupported(versions, wperfTest);`
`101`	`103`	`}`
`102`	`104`	`catch (Exception ex)`
`103`	`105`	`{`
Original file line number	Diff line number	Diff line change
`@@ -126,11 +126,10 @@ protected void InitProcess()`
`126`	`126`	`/// <returns>`
`127`	`127`	`/// bool`
`128`	`128`	`/// </returns>`
`129`		`- public bool CheckIsSPESupported()`
	`129`	`+ public bool CheckIsSPESupported(WperfVersion versionSerializedOutput, WperfTest testSerializedOutput)`
`130`	`130`	`{`
`131`	`131`	`try`
`132`	`132`	`{`
`133`		`- (WperfVersion versionSerializedOutput, _) = GetVersion();`
`134`	`133`	`foreach (var component in versionSerializedOutput.Components)`
`135`	`134`	`{`
`136`	`135`	`if (!component.FeatureString.Contains("+spe"))`
`@@ -139,8 +138,6 @@ public bool CheckIsSPESupported()`
`139`	`138`	`}`
`140`	`139`	`}`
`141`	`140`
`142`		`- (WperfTest testSerializedOutput, _) = GetTest();`
`143`		`-`
`144`	`141`	`TestResult speDeviceConf = testSerializedOutput`
`145`	`142`	`.TestResults.Find(el => el.TestName == "spe_device.version_name");`
`146`	`143`	`if (speDeviceConf == null) { return false; }`
Original file line number	Diff line number	Diff line change
`@@ -386,7 +386,7 @@ System.Windows.Controls.SelectionChangedEventArgs e`
`386`	`386`	`string metricName = CountingMetricListBox.SelectedItems[0] as string;`
`387`	`387`
`388`	`388`	`foreach (`
`389`		`- var predefinedMetric in ((List<PredefinedMetric>)MetricComboBox.ItemsSource).Select(`
	`389`	`+ var predefinedMetric in ((List<PredefinedMetricAndGroupOfMetrics>)MetricComboBox.ItemsSource).Select(`
`390`	`390`	`(value, i) => new { value, i }`
`391`	`391`	`)`
`392`	`392`	`)`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ static class WperfDefaults`
`41`	`41`
`42`	`42`	`public static string DefaultWPASearchDir = Environment.GetEnvironmentVariable(`
`43`	`43`	`"WPA_ADDITIONAL_SEARCH_DIRECTORIES"`
`44`		`- );`
	`44`	`+ ) ?? "C:\\Program Files (x86)\\Windows Kits\\10\\Windows Performance Toolkit\\CustomDataSources";`
`45`	`45`	`#nullable disable`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ internal sealed partial class Vsix`
`11`	`11`	`public const string Name = "WindowsPerf GUI";`
`12`	`12`	`public const string Description = @"WindowsPerf GUI (Graphical User Interface) project, a Visual Studio 2022 extension designed to bring a seamless UI experience to WindowsPerf, the command-line performance profiling tool for Windows on Arm.";`
`13`	`13`	`public const string Language = "en-US";`
`14`		`- public const string Version = "3.0.0";`
	`14`	`+ public const string Version = "3.0.1";`
`15`	`15`	`public const string Author = "arm";`
`16`	`16`	`public const string Tags = "WindowsPerf; WindowsPerfGUI;WindowsOnArm; WOA; Profiling; perf; PMU; Performance";`
`17`	`17`	`}`