(ENGTASKS-3693) Prototype updating user agent with process information #3460

AdmiringWorm · 2024-06-07T12:37:29Z

Description Of Changes

Adds information to the user agent provided by NuGet when querying repositories, showing the process that called choco.exe as well as the root process of the tree (filtering out common shells, terminal emulators, and explorer.exe).

This PR also includes a prototype changes of an investigation where we include additional information about the current process tree that choco.exe is part of, including additional information about what the current process is when needed.

Additionally, benchmarks have also been added as part of this investigation.

Below is the results from these benchmarks that was ran on a dedicated computer (This had been ran multiple times, but only one result is included).

BenchmarkDotNet v0.13.12, Windows 11 (10.0.22631.3593/23H2/2023Update/SunValley3)
AMD Ryzen 7 2700X, 1 CPU, 16 logical and 8 physical cores
[Host] : .NET Framework 4.8.1 (4.8.9241.0), X86 LegacyJIT
Job-NBIXUS : .NET Framework 4.8.1 (4.8.9241.0), X64 LegacyJIT

Jit=LegacyJit Platform=X64 Runtime=.NET Framework 4.8

Method	Mean	Error	StdDev	Ratio	Gen0	Gen1	Gen2	Allocated	Alloc Ratio
GetParentProcessDocumentedPinvoke	25.297 ms	0.0724 ms	0.0677 ms	0.35	-	-	-	89.5 KB	0.010
GetParentProcessFilteredDocumentedPinvoke	26.714 ms	0.0955 ms	0.0894 ms	0.37	31.2500	-	-	186.25 KB	0.020
GetParentProcessFilteredManaged	76.386 ms	0.1347 ms	0.1260 ms	1.06	2000.0000	1000.0000	1000.0000	9499.4 KB	1.014
GetParentProcessFilteredUndocumentedPinvoke	11.621 ms	0.0451 ms	0.0422 ms	0.16	31.2500	-	-	155.88 KB	0.017
GetParentProcessManaged	72.269 ms	0.2458 ms	0.2179 ms	1.00	2000.0000	1000.0000	1000.0000	9371.36 KB	1.000
GetParentProcessTreeDocumentedPinvoke	27.000 ms	0.0896 ms	0.0838 ms	0.37	31.2500	-	-	231.5 KB	0.025
GetParentProcessTreeManaged	75.331 ms	0.2134 ms	0.1997 ms	1.04	2000.0000	1000.0000	1000.0000	9370.23 KB	1.000
GetParentProcessTreeUndocumentedPinvoke	11.561 ms	0.1412 ms	0.1569 ms	0.16	46.8750	15.6250	-	199.76 KB	0.021
GetParentProcessUndocumentedPinvoke	7.860 ms	0.0649 ms	0.0607 ms	0.11	-	-	-	59.5 KB	0.006
GetParentProcessTreeImplemented	11.416 ms	0.0385 ms	0.0360 ms	0.16	46.8750	15.6250	-	199.76 KB	0.021

Method	tree	Mean	Error	StdDev	Median	Ratio	RatioSD	Gen0	Allocated	Alloc Ratio
GetFirstFilteredProcessName	chocolatey.benchmark	1.9503 ns	0.0040 ns	0.0033 ns	1.9511 ns	?	?	-	-	?
GetFirstProcessName	chocolatey.benchmark	1.9536 ns	0.0056 ns	0.0047 ns	1.9540 ns	?	?	-	-	?
GetLastFilteredProcessName	chocolatey.benchmark	1.9520 ns	0.0036 ns	0.0033 ns	1.9525 ns	?	?	-	-	?
GetLastProcessName	chocolatey.benchmark	1.9546 ns	0.0079 ns	0.0066 ns	1.9531 ns	?	?	-	-	?
GetProcessesList	chocolatey.benchmark	0.0002 ns	0.0008 ns	0.0007 ns	0.0000 ns	?	?	-	-	?

GetFirstFilteredProcessName	choco(...)minal [63]	178.0415 ns	0.7922 ns	0.7411 ns	178.0618 ns	?	?	0.0153	64 B	?
GetFirstProcessName	choco(...)minal [63]	2.9928 ns	0.0036 ns	0.0034 ns	2.9919 ns	?	?	-	-	?
GetLastFilteredProcessName	choco(...)minal [63]	178.9408 ns	0.3029 ns	0.2685 ns	178.9092 ns	?	?	0.0153	64 B	?
GetLastProcessName	choco(...)minal [63]	3.7814 ns	0.0060 ns	0.0056 ns	3.7821 ns	?	?	-	-	?
GetProcessesList	choco(...)minal [63]	0.0000 ns	0.0000 ns	0.0000 ns	0.0000 ns	?	?	-	-	?

GetFirstFilteredProcessName	choco(...)lorer [58]	163.7587 ns	0.3715 ns	0.3475 ns	163.8501 ns	?	?	0.0172	72 B	?
GetFirstProcessName	choco(...)lorer [58]	2.9863 ns	0.0026 ns	0.0023 ns	2.9866 ns	?	?	-	-	?
GetLastFilteredProcessName	choco(...)lorer [58]	193.6758 ns	0.5614 ns	0.4688 ns	193.5690 ns	?	?	0.0248	104 B	?
GetLastProcessName	choco(...)lorer [58]	3.7737 ns	0.0127 ns	0.0112 ns	3.7711 ns	?	?	-	-	?
GetProcessesList	choco(...)lorer [58]	0.0000 ns	0.0000 ns	0.0000 ns	0.0000 ns	?	?	-	-	?

GetFirstFilteredProcessName	choco(...)Tabby [37]	189.7154 ns	1.0933 ns	0.9692 ns	189.5110 ns	?	?	0.0248	104 B	?
GetFirstProcessName	choco(...)Tabby [37]	2.7607 ns	0.0054 ns	0.0045 ns	2.7617 ns	?	?	-	-	?
GetLastFilteredProcessName	choco(...)Tabby [37]	166.6200 ns	0.3285 ns	0.3073 ns	166.6799 ns	?	?	0.0172	72 B	?
GetLastProcessName	choco(...)Tabby [37]	3.3230 ns	0.0056 ns	0.0046 ns	3.3236 ns	?	?	-	-	?
GetProcessesList	choco(...)Tabby [37]	0.0000 ns	0.0000 ns	0.0000 ns	0.0000 ns	?	?	-	-	?

Motivation and Context

To investigate possibilies that we have.

Testing

Run choco search chocolatey --debug and verify that the process tree and user agent including the root and calling process are shown in the debug logs.
Further verification can be done with wireshark or similar to intercept the network calls and verify the user agent is in fact sent as expected.

Operating Systems Testing

Windows 10
Windows 11

Change Types Made

Bug fix (non-breaking change).
Feature / Enhancement (non-breaking change).
Breaking change (fix or feature that could cause existing functionality to change).
Documentation changes.
PowerShell code changes.
Investigation

Change Checklist

Requires a change to the documentation.
Documentation has been updated.
Tests to cover my changes, have been added.
All new and existing tests passed?
PowerShell code changes: PowerShell v2 compatibility checked?

Related Issue

Fixes #3526

pauby · 2024-10-04T17:11:11Z

Raised issue #3526 for this.

src/chocolatey/infrastructure.app/nuget/NugetCommon.cs

src/chocolatey/infrastructure/information/ProcessInformation.cs

src/chocolatey/infrastructure.app/services/ProcessCollectorService.cs

vexx32 · 2024-10-31T16:11:02Z

@corbob I think this is ready for review at this point.

corbob

Just a few comments and I seem to recall a few changes...

src/chocolatey.slnf

src/chocolatey.tests/infrastructure.app/nuget/NugetCommonSpecs.cs

src/chocolatey/infrastructure.app/services/ProcessCollectorService.cs

src/chocolatey/infrastructure/information/ProcessInformation.cs

src/chocolatey/infrastructure/information/ProcessTree.cs

tests/pester-tests/features/UserAgent.Tests.ps1

src/chocolatey/infrastructure.app/nuget/NugetCommon.cs

corbob · 2024-11-06T01:52:30Z

I've run the tests in TestKitchen and am seeing failures that I wasn't seeing when running locally. I'm going to mark this as draft for now so we don't inadvertently merge it.

gep13

From a change to the CODEOWNERS files, this LGTM, however, I have left a couple comments elsewhere that I think need to be addressed.

src/chocolatey.benchmark/helpers/ManagedProcessHelper.cs

src/chocolatey.benchmark/helpers/PinvokeProcessHelper.cs

src/chocolatey.console/Program.cs

src/chocolatey.tests/infrastructure.app/nuget/NugetCommonSpecs.cs

src/chocolatey/infrastructure.app/nuget/NugetCommon.cs

src/chocolatey/infrastructure/information/ProcessTree.cs

tests/pester-tests/features/UserAgent.Tests.ps1

gep13

LGTM!

gep13 · 2024-11-07T16:18:13Z

This branch is out of date with the develop branch, so not in a position to merge this just now, but I am happy to activate the Enable auto-merge button.

Work the ProcessTree into a service that can be pulled in to the NugetCommon library in order to provide a more informative user agent when querying repositories.

The primary method is quickest, but as it is an unstable API, we have a need to provide a fallback that will be able to be used if the DLL is missing/removed, or if the entry point is later removed. Of the stable options, this p/invoke method seems to be the next best option to work with. Crucially, these p/invokes need to be provided by different types, so that if there is a TypeLoadException from a failed p/invoke, we can still attempt the fallback. Also, added a couple more exclusions for the choco.exe shim and for winlogon, which are not useful to include.

We need to define values for ReleaseOfficial for the benchmark project or the Cake build complains. Also added Chocolatey.PowerShell to the slnf in the repo, since that was missing.

RuntimeInformation is shadowed by Mono which means that build breaks and because all of the namespaces are the same under Mono's version, that name is not usable in our build currently. We can reuse our existing Platform.GetPlatform() helper here instead, rather than trying to disentangle exactly why this build configuration is not particularly functional.

These processes are not particularly useful to note as they are common terminal emulators, so we can exclude them when looking at the process tree.

Simplify some naming, also add a constant (and comment) to clarify what some of the p/invoke nonsense is doing.

AdmiringWorm requested a review from gep13 June 7, 2024 13:07

gep13 linked an issue Oct 24, 2024 that may be closed by this pull request

Provide better information through the user agent #3526

Closed

2 tasks

vexx32 reviewed Oct 28, 2024

View reviewed changes

src/chocolatey/infrastructure.app/nuget/NugetCommon.cs Outdated Show resolved Hide resolved

src/chocolatey/infrastructure/information/ProcessInformation.cs Outdated Show resolved Hide resolved

src/chocolatey/infrastructure.app/services/ProcessCollectorService.cs Show resolved Hide resolved

vexx32 force-pushed the benchmark branch 3 times, most recently from 0f118c8 to b62b5e0 Compare October 31, 2024 15:43

vexx32 marked this pull request as ready for review October 31, 2024 15:57

vexx32 requested a review from a team as a code owner October 31, 2024 15:57

vexx32 requested a review from corbob October 31, 2024 16:15

vexx32 force-pushed the benchmark branch from b62b5e0 to 79e5eb1 Compare October 31, 2024 20:43

corbob requested changes Oct 31, 2024

View reviewed changes

corbob reviewed Oct 31, 2024

View reviewed changes

src/chocolatey/infrastructure.app/nuget/NugetCommon.cs Outdated Show resolved Hide resolved

vexx32 force-pushed the benchmark branch 2 times, most recently from 35d3a34 to 8f90d16 Compare November 4, 2024 20:13

corbob force-pushed the benchmark branch from 8f90d16 to afae6e7 Compare November 4, 2024 22:54

corbob previously approved these changes Nov 4, 2024

View reviewed changes

vexx32 force-pushed the benchmark branch 3 times, most recently from d7c879f to 5a218a4 Compare November 5, 2024 19:30

corbob marked this pull request as draft November 6, 2024 01:52

gep13 requested changes Nov 6, 2024

View reviewed changes

vexx32 dismissed corbob’s stale review via 6da20b2 November 6, 2024 15:37

vexx32 force-pushed the benchmark branch 3 times, most recently from f166b16 to 1fd6951 Compare November 6, 2024 19:13

corbob reviewed Nov 6, 2024

View reviewed changes

tests/pester-tests/features/UserAgent.Tests.ps1 Outdated Show resolved Hide resolved

vexx32 force-pushed the benchmark branch from 1fd6951 to e865f77 Compare November 6, 2024 21:29

corbob marked this pull request as ready for review November 7, 2024 15:42

vexx32 force-pushed the benchmark branch from e865f77 to 9c514e3 Compare November 7, 2024 15:47

gep13 approved these changes Nov 7, 2024

View reviewed changes

gep13 enabled auto-merge November 7, 2024 16:18

AdmiringWorm and others added 10 commits November 7, 2024 09:28

(maint) Add temporary storage of benchmark

c86c388

(chocolatey#3526) Implement process tree in codebase

5286fba

(chocolatey#3526) Implement prototype for user agent updating

3497344

Work the ProcessTree into a service that can be pulled in to the NugetCommon library in order to provide a more informative user agent when querying repositories.

(chocolatey#3526) Add tests for the user agent

8a8c0af

(chocolatey#3526) Fix Cake build issues for benchmarks project

72fa3a5

We need to define values for ReleaseOfficial for the benchmark project or the Cake build complains. Also added Chocolatey.PowerShell to the slnf in the repo, since that was missing.

(chocolatey#3526) Expand the list of known terminal emulators

f58a4c4

These processes are not particularly useful to note as they are common terminal emulators, so we can exclude them when looking at the process tree.

(chocolatey#3526) Revise naming of new additions

a620b2b

Simplify some naming, also add a constant (and comment) to clarify what some of the p/invoke nonsense is doing.

(maint) Reorder / tidy using statements

aca796c

corbob force-pushed the benchmark branch from 9c514e3 to aca796c Compare November 7, 2024 17:29

gep13 merged commit 475f80b into chocolatey:develop Nov 7, 2024
5 checks passed

AdmiringWorm deleted the benchmark branch November 8, 2024 09:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(ENGTASKS-3693) Prototype updating user agent with process information #3460

(ENGTASKS-3693) Prototype updating user agent with process information #3460

AdmiringWorm commented Jun 7, 2024 •

edited by vexx32

Loading

pauby commented Oct 4, 2024

vexx32 commented Oct 31, 2024

corbob left a comment

corbob commented Nov 6, 2024

gep13 left a comment

gep13 left a comment

gep13 commented Nov 7, 2024

(ENGTASKS-3693) Prototype updating user agent with process information #3460

(ENGTASKS-3693) Prototype updating user agent with process information #3460

Conversation

AdmiringWorm commented Jun 7, 2024 • edited by vexx32 Loading

Description Of Changes

Motivation and Context

Testing

Operating Systems Testing

Change Types Made

Change Checklist

Related Issue

pauby commented Oct 4, 2024

vexx32 commented Oct 31, 2024

corbob left a comment

Choose a reason for hiding this comment

corbob commented Nov 6, 2024

gep13 left a comment

Choose a reason for hiding this comment

gep13 left a comment

Choose a reason for hiding this comment

gep13 commented Nov 7, 2024

AdmiringWorm commented Jun 7, 2024 •

edited by vexx32

Loading