Find the necessary version of WPA and the NetBlame plug-in (NetBlameAddIn.dll) (#40)

* Improve how WPA.exe and NetBlameAddIn.dll are found, with updated version requirements.

* Clearer warnings

---------

Co-authored-by: Raymond Fowkes <[email protected]>

Author: rayfo

src/BETA/TraceNetwork.ps1

@@ -148,17 +148,56 @@ $script:PSScriptParams = $script:PSBoundParameters # volatile
 
 . "$ScriptRootPath\INCLUDE.ps1"
 
-$VersionMinForAddin = [Version]'11.0.7' # This version and later use SDK v1.0.7+
-$VersionForProcessors = [Version]'11.8.0' # Version 11.8.262 and later requires: -Processors (Earlier versions allow it.)
+$VersionMinForAddin = [Version]'11.7.383' # This public WPA version and later use SDK v1.2.2+
+$VersionForProcessors = [Version]'11.8.0' # WPA Version 11.8.262 and later requires: -Processors (Earlier versions allow it.)
 
-$AddInPath = "$script:ScriptHomePath\ADDIN" # Uses SDK v1.0.7+
+$AddInPaths = @(
+	"$script:ScriptHomePath\ADDIN" # Released ZIP with NetBlame Plug-in
+	"$script:ScriptRootPath\NetBlame\bin\*" # Cloned project with built NetBlame Plug-in
+	)
 
 $WPA_Version_RegPath = "$script:RegPathStatus\WPA-Plugin" # $RegPathStatus also used for SetProfileStartTime, etc.
 
 # Most modern versions of WPA list/accept these plug-in names via: WPA -listplugins -addsearchdir MSO-Scripts\BETA\ADDIN
 $ETW_Plugins_Default = 'Event Tracing for Windows','Office_NetBlame'
 
 
+<#
+	Find the path that contains the most recent (or 'Release') NetBlame plug-in: NetBlameAddIn.dll
+	If this installation was downloaded and unzipped from the Release site, then it will be in: BETA\ADDIN
+	If this installation was cloned and built then it will be in NetBlame\bin\Release|Debug\net8.0
+#>
+function GetAddinPath
+{
+	# List the various path(s) which contain NetBlameAddIn.dll
+
+	$moduleName = 'NetBlameAddIn.dll'
+	$paths = Resolve-Path -Path $AddInPaths -ErrorAction:SilentlyContinue
+	$pathIOs = $paths | ForEach-Object { Get-ChildItem -Path $_ -Filter $moduleName -File -Recurse -ErrorAction:SilentlyContinue }
+
+	if (!$pathIOs)
+	{
+		Write-Err "The `"NetBlame`" WPA Plug-in ($moduleName) was not be found at any of these locations:"
+		foreach ($path in $AddInPaths) { Write-Err "`t$path" }
+		foreach ($path in $paths) { Write-Err "`t$($path.Path)" }
+
+		Write-Info "Please see: https://github.com/Microsoft/MSO-Scripts/wiki/Network-Activity"
+
+		# No reason to go on!
+		exit 1
+	}
+
+	# Choose the path which contains the most recent NetBlameAddIn.dll, or a recent 'Release' version.
+	$pathIORel = $pathIOs | Where-Object { $_.FullName -like '*Release*' }
+	if ($pathIORel) { $pathIOs = $pathIORel } # filter to 'Release' version(s)
+	$pathIO = $pathIOs | Sort-Object { $_.LastWriteTime } -Descending | Select-Object -First 1
+	$path = (Split-Path -Path $pathIO.FullName -Parent)
+
+	Write-Status "NetBlame Plug-in found at: $path"
+	return $path
+}
+
+
 <#
 	Return a quoted, comma-separated string of WPA Plug-ins needed for this script.
 	Usually: "Event Tracing for Windows","Office_NetBlame"
@@ -168,7 +207,8 @@ function GetPluginsList
 Param (
 	[Version]$WpaVersion
 )
-	[string[]]$ETW_Plugins = GetRegistryValue $WPA_Version_RegPath $WpaVersion.ToString()
+	[string[]]$ETW_Plugins = $Null
+	if ($WpaVersion)   { $ETW_Plugins = GetRegistryValue $WPA_Version_RegPath $WpaVersion.ToString() }
 	if (!$ETW_Plugins) { $ETW_Plugins = $ETW_Plugins_Default }
 
 	return ($ETW_Plugins | ForEach-Object { "`"$_`"" }) -join ','
@@ -307,30 +347,38 @@ Param ( # $ViewerParams 'parameter splat'
 		Write-Action "`nThis network analyzer plug-in will not likely work before Windows 10.`n"
 	}
 
-	# The viewer: Windows Performance Analyzer (WPA)
+	# Find the most recent version of the viewer: Windows Performance Analyzer (WPA)
+
 	$WpaPath = GetWptExePath "WPA.exe"
 	$Version = GetFileVersion $WpaPath
 
-	if (!$Version -or ($Version -lt $VersionMinForAddin))
+	if ((IsRealVersion $Version) -and !$env:WPT_PATH)
 	{
-		if ($Version)
-		{
-			Write-Err "Found an older version of the Windows Performance Analyzer (WPA): $Version"
-		}
-		elseif ($WpaPath -ne 'WPA')
-		{
-			Write-Err "Found an unknown version of the Windows Performance Analyzer (WPA)."
-		}
-		Write-Err "The minimum required version is: $VersionMinForAddin"
+		# Find an even newer version, maybe.
 
-		if ($WpaPath -ne 'WPA') { WriteWPTInstallMessage "wpa.exe" } # Else GetWptExePath wrote the message
+		$WpaPath2 = GetWptExePath "WPA.exe" -Silent -AltPath
+		$Version2 = GetFileVersion $WpaPath2
 
-		if ($Version) { exit 1 } # else maybe we found WPA.bat, etc.
+		if ($Version2 -and ($Version2 -gt $Version))
+		{
+			$WpaPath = $WpaPath2
+			$Version = $Version2
+		}
 	}
 
-	if (!(Test-Path -PathType container -Path $AddInPath -ErrorAction:SilentlyContinue))
+<#
+	1. Found a recent WPA
+	2. Found an old WPA
+	3. Found WPA.bat or stub WPA.exe without 'real' version info
+	4. Found no WPA (but try to launch "WPA" anyway)
+#>
+	if ((IsRealVersion $Version) -and ($Version -lt $VersionMinForAddin))
 	{
-		Write-Err "Could not find the NetBlame add-in path: $AddInPath"
+		# Case 2: Do not proceed.
+
+		Write-Err "Found an older version of the Windows Performance Analyzer (WPA): $Version"
+		Write-Err "The minimum version for this analysis is: $VersionMinForAddin"
+		WriteWPTInstallMessage "WPA.exe"
 		exit 1
 	}
 
@@ -349,7 +397,7 @@ Param ( # $ViewerParams 'parameter splat'
 		$ExtraParams += GetArgs -processors $Processors
 	}
 
-	$ExtraParams += GetArgs -addsearchdir "`"$AddInPath`"" -NoSymbols
+	$ExtraParams += GetArgs -addsearchdir "`"$(GetAddinPath)`"" -NoSymbols
 
 	# Now load LaunchViewerCommand and related.
 

src/INCLUDE.WPA.ps1

@@ -8,6 +8,10 @@
 
 # if ($Host.Version.Major -gt 2) {Set-StrictMode -version latest }
 
+# For earlier versions of WPA than this, suggest updating.
+# cf. $VersionMinForAddIn - BETA\TraceNetwork.ps1
+$VersionMinRecent = [Version]'11.7.383'
+
 <#
 	The default SymbolDrive needs lots of free space for caching symbol files!
 	You can reset symbol paths, with X: as the SymbolDrive, by doing this:
@@ -133,7 +137,11 @@ Param (
 		{
 			$env:_NT_SYMBOL_PATH = $PdbPathDefault -replace $PDB_CACHE_FOLDER,$script:PdbCacheFolder
 
-			Write-Warn "Setting _NT_SYMBOL_PATH = $env:_NT_SYMBOL_PATH"
+			if (InvokedFromCMD)
+				{ Write-Warn "Setting _NT_SYMBOL_PATH=$env:_NT_SYMBOL_PATH" }
+			else
+				{ Write-Warn "Setting `$Env:_NT_SYMBOL_PATH = '$env:_NT_SYMBOL_PATH'" }
+
 			$DriveFreeSpace = GetDriveFreeSpace $script:SymbolDrive
 			if ($DriveFreeSpace) { $DriveFreeSpace = "($([int]($DriveFreeSpace / 1GB)) GB Free)" }
 			Write-Warn "NOTE: Cached symbols may consume lots of space on drive $script:SymbolDrive $DriveFreeSpace"
@@ -153,7 +161,11 @@ Param (
 		{
 			$env:_NT_SYMCACHE_PATH = $SymCacheDefault -replace $SYM_CACHE_FOLDER,$script:SymCacheFolder
 
-			Write-Warn "Setting _NT_SYMCACHE_PATH = $env:_NT_SYMCACHE_PATH"
+			if (InvokedFromCMD)
+				{ Write-Warn "Setting _NT_SYMCACHE_PATH=$env:_NT_SYMCACHE_PATH" }
+			else
+				{ Write-Warn "Setting `$Env:_NT_SYMCACHE_PATH = '$env:_NT_SYMCACHE_PATH'" }
+
 			Write-Warn
 		}
 		else
@@ -313,6 +325,8 @@ Param (
 			# else quick exit
 			Write-Info # End Progress
 			$global:LastExitCode = $Process.ExitCode
+			if (!$global:LastExitCode) { return "Early exit." }
+
 			$Code = ('{0:x}' -f $Process.ExitCode)
 			Write-Status "WPA Early Exit: $Code"
 			return "Early exit: $Code"
@@ -607,11 +621,11 @@ Param (
 	# v10.0.15063: -TTI -ClipRundown -Symbols -SymCacheOnly -Profile ...
 	# v10.5.16+  : -TTI -TLE -ClipRundown -Symbols -SymCacheOnly -Profile ...
 	# v11.0.7+   : -Processors ... -AddSearchDir ... (modern add-ins)
+	# v11.7.383  : First public version which uses SDK v1.2.2
 
 	$IsModernWPA  = ($VersionInfo -ge [Version]'10.0.0')     # -Symbols
 	$IsSymCacheOK = ($VersionInfo -ge [Version]'10.0.15063') # -Symbols -SymCacheOnly
 	$IsFullWPA    = ($VersionInfo -ge [Version]'10.5.16')    # ADK for Server 2022, or later
-	$IsNewerWPA   = ($VersionInfo -ge [Version]'11.0.7')     # Works with modern add-ins
 
 	# Should have previously called EnsureTracePath
 	if (!$script:TracePath) { EnsureTracePath; Write-Dbg "Trace path not set for default working folder!" }
@@ -713,21 +727,14 @@ Param (
 		}
 	}
 
-	if (!$IsNewerWPA -and $IsModernWPA)
-	{
-		Write-Warn "A newer Windows Performance Analizer (WPA) is available:"
-		Write-Warn "  Windows Store: https://apps.microsoft.com/detail/9n0w1b2bxgnz"
-		Write-Warn "  Windows Performance Toolkit: https://learn.microsoft.com/en-us/windows-hardware/test/wpt/"
-		Write-Warn "Or set WPT_PATH to the folder of a more recent WPA."
-	}
-
 	Write-Msg "Launching Windows Performance Analyzer (WPA) ..."
 	WriteCmdVerbose $ViewerPath $ViewerCmd
 
 	[DateTime]$PreStartTime = Get-Date
 
 	# Launch the viewer without Admin privileges, if possible.
 
+	$VersionRun = $Null
 	$Process = $Null
 	$ErrResult = $True
 
@@ -744,6 +751,8 @@ Param (
 			$Process = GetRunningProcess 'WPA' $PreStartTime
 			if ($Process)
 			{
+				$VersionRun = FileVersionFromFileInfo($Process.MainModule.FileVersionInfo)
+
 				$ErrResult = WaitForProcessResponsive $Process
 				if ($ErrResult) { Write-Status "WPA as Standard User: $ErrResult" }
 
@@ -777,6 +786,8 @@ Param (
 
 		if ($Process)
 		{
+			$VersionRun = FileVersionFromFileInfo($Process.MainModule.FileVersionInfo)
+
 			$ErrResult = WaitForProcessResponsive $Process
 			if ($ErrResult) { Write-Status "WPA as Current User: $ErrResult" }
 
@@ -789,6 +800,18 @@ Param (
 		}
 	}
 
+	# Test the version of the running WPA, if possible.
+
+	if (!(IsRealVersion $VersionRun)) { $VersionRun = $VersionInfo }
+	if ((IsRealVersion $VersionRun) -and ($VersionRun -lt $VersionMinRecent) -and (CheckOSVersion '10.0.0'))
+	{
+		Write-Warn "A newer Windows Performance Analizer (WPA) is available:"
+		Write-Warn "  Windows Store: https://apps.microsoft.com/detail/9n0w1b2bxgnz"
+		Write-Warn "  Windows Performance Toolkit: https://learn.microsoft.com/en-us/windows-hardware/test/wpt/"
+		Write-Warn "Or set WPT_PATH to the folder of a more recent WPA."
+		Write-Warn
+	}
+
 	if ($ErrResult)
 	{
 		Write-Err (GetCmdVerbose $ViewerPath $ViewerCmd)