Add Loader Snaps to DevDiagnostics's insights #3815

timkur · 2024-09-09T19:32:47Z

Summary of the pull request

This adds the ability for DevDiagnostics to monitor for processes terminating due to missing dependencies, and let the user know which files were missing.

and after the user has enabled loader snaps

References and relevant issues

Detailed description of the pull request / Additional comments

This utilizes the NT service to monitor for process terminations that exited due to missing files. From that, we rely on the user to launch an elevated exe that writes to the image file execution options (ifeo) to enable loader snaps for a particular image, and then when the process runs again, we parse that log and show the relevant information.

We listen to the kernel ETW provider to learn about process start/stops in the NT service, and we listen to the Windows Loader ETW channel in DevDiagnostics for loader snaps.

As part of this, I revamped the Insights UI to allow insights providers to create a custom control to show their content. This was needed in this scenario to show a button in addition to text, and I would imagine we'll have more scenarios in the future.

This also implements a dummy NT service, so if for whatever reason DevDiagnostics is not able to connect to the real NT service, there is a "stand in" service object instantiated in-proc to ensure DD can still run.

Validation steps performed

Used the TestLoadFailure app to trigger errors.

Testing this both via F5 deploy and package installed.

Ran through the new controls with narrator and confirmed they are accessible.

PR checklist

Closes #xxx
Tests added/passed
Documentation updated

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs

tools/DevDiagnostics/DevHome.DevDiagnostics/Strings/en-us/Resources.resw

service/DevHome.Service/ServiceLifetimeController.cs

service/DevHome.Service/DevHomeService.cs

service/DevHome.Service/NativeMethods.txt

tools/DevDiagnostics/Utilities/EnableLoaderSnaps/EnableLoaderSnaps.cs

...gnostics/DevHome.DevDiagnostics/Controls/InsightForMissingFileProcessTerminationControl.xaml

tools/DevDiagnostics/DevHome.DevDiagnostics/Pages/InsightsPage.xaml

tools/DevDiagnostics/DevHome.DevDiagnostics/DDApp.xaml.cs

tools/DevDiagnostics/DevHome.DevDiagnostics/NativeMethods.txt

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs

tools/DevDiagnostics/DevHome.DevDiagnostics/Controls/InsightSimpleTextControl.xaml.cs

aeloros · 2024-09-09T20:37:30Z

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs

+            return false;
+        }
+
+        if ((tracingFlags & 0x4) != 0x4)


Great opportunity for a

[Flags]
enum TracingFlags : uint
{
Foo = 0x4,
etc = 0x8,
}

Followed by
tracingFlags.HasFlag(Foo) instead of this manual stuff :) #Resolved

Example on how to do this (save you loading a web page if you don't know how)

https://github.com/microsoft/devhome/blob/user/scodar/imageoptions/tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/ImageFileExecutionOptions.cs

Got it. I ended up defining the flags twice, as I didn't want to reference a common assembly in my elevated process. But this seems to work well.

What's wrong with using common assemblies in an elevated process?

Just need to worry about statics.... make sure code isn't executing unexpectedly.

I don't see how that's ever going to work at scale. Adding a bad project reference will get overlooked 99 times out of 100 without automation.

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs

aeloros

Any telemetry for the feature usage etc?

jaholme · 2024-09-09T22:39:27Z

nit: delete boilerplate new project comments #Resolved

Refers to: tools/DevDiagnostics/TestTools/TestLoadFailure/TestLoadFailure.cpp:27 in 31b782c. [](commit_id = 31b782c, deletion_comment = False)

tools/DevDiagnostics/Utilities/EnableLoaderSnaps/app.manifest

timkur · 2024-09-09T23:21:47Z

Ok

In reply to: 2339275118

Refers to: tools/DevDiagnostics/TestTools/TestLoadFailure/TestLoadFailure.cpp:27 in 31b782c. [](commit_id = 31b782c, deletion_comment = False)

timkur · 2024-09-10T00:05:03Z

Any telemetry for the feature usage etc? #Resolved

In reply to: 2290951672

krschau · 2024-09-10T16:53:33Z

tools/DevDiagnostics/DevHome.DevDiagnostics/DevHome.DevDiagnostics.csproj

@@ -1,11 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
  <Import Project="$(SolutionDir)ToolingVersions.props" />
+  <Import Project="$(SolutionDir)Directory.CppBuild.props" />


It feels wrong to put a CppBuild into a csproj. What property is this using? Can it go in a general or cs-specific props file? #Resolved

Good callout. I should just be including Directory.Build.props instead.

Actually, that was wrong... sounds like this file is automatically included (I missed the build warning earlier). I'll just remove this line.

krschau · 2024-09-10T17:06:28Z

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs

+
+    public LoaderSnapAssistantTool()
+    {
+        _dispatcher = Microsoft.UI.Dispatching.DispatcherQueue.GetForCurrentThread();


I know DD does something different than the rest of Dev Home where apparently it's guaranteed to be running on the UI thread more than the rest can guarantee, but are you sure you're always going to be running on the UI thread here? If you're not, this returns null and you get in trouble. #Resolved

I added an assert here to confirm this is created on the UI thread.

krschau · 2024-09-10T17:24:03Z

tools/DevDiagnostics/DevHome.DevDiagnostics/DDApp.xaml.cs

-
-    internal static void Log(string eventName, LogLevel level, Guid? relatedActivityId = null) => Logger.Log(eventName, level, new UsageEventData(), relatedActivityId);
-}
+// Copyright (c) Microsoft Corporation.


It may be worth changing the files like this one where the whole file's line endings got corrected back to LF just for diff's sake. We can do a giant sweep to fix line endings separately.

It's a good point. These line ends making merges/etc super painful.

For diffing, can tell the website to ignore whitespace so you can see the exact changes...

That would give you the real diff. Now if only git merges could do that too.

Updates

c3a16a8

timkur requested review from xhan65, aeloros, jaholme, andreww-msft, dabhattimsft and zadesai September 9, 2024 19:32

timkur commented Sep 9, 2024

View reviewed changes

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs Outdated Show resolved Hide resolved

andreww-msft reviewed Sep 9, 2024

View reviewed changes

tools/DevDiagnostics/DevHome.DevDiagnostics/Strings/en-us/Resources.resw Show resolved Hide resolved

aeloros requested changes Sep 9, 2024

View reviewed changes

andreww-msft reviewed Sep 9, 2024

View reviewed changes

tools/DevDiagnostics/DevHome.DevDiagnostics/Controls/InsightSimpleTextControl.xaml.cs Show resolved Hide resolved

aeloros reviewed Sep 9, 2024

View reviewed changes

andreww-msft reviewed Sep 9, 2024

View reviewed changes

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs Outdated Show resolved Hide resolved

andreww-msft reviewed Sep 9, 2024

View reviewed changes

tools/DevDiagnostics/DevHome.DevDiagnostics/Helpers/LoaderSnapAssistantTool.cs Outdated Show resolved Hide resolved

aeloros requested review from aeloros and andreww-msft September 9, 2024 20:45

Fix build break, manifest whitespace

31b782c

aeloros reviewed Sep 9, 2024

View reviewed changes

aeloros self-requested a review September 9, 2024 21:51

PR feedback

2e06fa4

aeloros reviewed Sep 9, 2024

View reviewed changes

tools/DevDiagnostics/Utilities/EnableLoaderSnaps/app.manifest Outdated Show resolved Hide resolved

aeloros approved these changes Sep 9, 2024

View reviewed changes

More PR feedback

d40b479

krschau reviewed Sep 10, 2024

View reviewed changes

timkur added 2 commits September 10, 2024 10:52

PR feedback

52a3a86

PR feedback

cf77f93

andreww-msft approved these changes Sep 10, 2024

View reviewed changes

timkur merged commit c9745cc into main Sep 10, 2024
4 checks passed

krschau added this to the Dev Home v0.18 milestone Sep 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Loader Snaps to DevDiagnostics's insights #3815

Add Loader Snaps to DevDiagnostics's insights #3815

timkur commented Sep 9, 2024

aeloros Sep 9, 2024 •

edited by timkur

Loading

aeloros Sep 9, 2024

timkur Sep 9, 2024

aeloros Sep 9, 2024

timkur Sep 9, 2024

aeloros Sep 9, 2024

aeloros left a comment

jaholme commented Sep 9, 2024 •

edited by timkur

Loading

timkur commented Sep 9, 2024

timkur commented Sep 10, 2024 •

edited

Loading

krschau Sep 10, 2024 •

edited by timkur

Loading

timkur Sep 10, 2024

timkur Sep 10, 2024 •

edited

Loading

krschau Sep 10, 2024 •

edited by timkur

Loading

timkur Sep 10, 2024

krschau Sep 10, 2024

timkur Sep 10, 2024

Add Loader Snaps to DevDiagnostics's insights #3815

Add Loader Snaps to DevDiagnostics's insights #3815

Conversation

timkur commented Sep 9, 2024

Summary of the pull request

References and relevant issues

Detailed description of the pull request / Additional comments

Validation steps performed

PR checklist

aeloros Sep 9, 2024 • edited by timkur Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aeloros left a comment

Choose a reason for hiding this comment

jaholme commented Sep 9, 2024 • edited by timkur Loading

timkur commented Sep 9, 2024

timkur commented Sep 10, 2024 • edited Loading

krschau Sep 10, 2024 • edited by timkur Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timkur Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

krschau Sep 10, 2024 • edited by timkur Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aeloros Sep 9, 2024 •

edited by timkur

Loading

jaholme commented Sep 9, 2024 •

edited by timkur

Loading

timkur commented Sep 10, 2024 •

edited

Loading

krschau Sep 10, 2024 •

edited by timkur

Loading

timkur Sep 10, 2024 •

edited

Loading

krschau Sep 10, 2024 •

edited by timkur

Loading