Warn instead of logging "tweak completed" after a tweak step error (#5090)

* Warn instead of logging tweak completed after a step error

Invoke-WinUtilTweaks wrote "Apply tweak completed" unconditionally, even
when Invoke-WinUtilScript or another helper had just logged an ERROR for
that tweak. The job layer already counts those errors, so snapshot the
count after the header line and compare at the end: log a WARN line with
the error count when it grew, otherwise the existing completed line.

Two Pester cases run the real logger and script runner against a temp
log file to pin both outcomes.

* Count tweak step errors from the shared log list

The job error counter only increments inside a Start-WinUtilJob worker.
Toggle switches call Invoke-WinUtilTweaks directly on the UI thread, so
a failing toggle still logged "tweak completed" after its ERROR line.

Every ERROR line is added to $sync.LoggedErrors from any runspace, and
Invoke-WinUtilAutoRun already reads it as a before/after delta, so the
tweak runner now does the same. The completion-status tests run without
the worker flag and seed an earlier unrelated error, and a new case
covers a failing UndoScript.

* Count tweak errors on the logging runspace, not the shared list

Diffing $sync.LoggedErrors charged a toggle with errors a concurrent
job logged from its own runspace. Global scope is per runspace, so the
logger now bumps the runspace counter for every headline error and the
tweak status diffs that. Job workers still reset the counter at start
and end, so job results are unchanged.
This commit is contained in:
Malin Fossum
2026-09-29 10:58:32 -05:00
committed by GitHub
parent 6f1266eb86
commit d0d39d6478
4 changed files with 97 additions and 5 deletions
+9 -1
View File
@@ -23,6 +23,9 @@ function Invoke-WinUtilTweaks {
$action = if ($undo) { "Undo" } else { "Apply" }
Write-WinUtilLog -Component "Tweaks" -Message "$action tweak: $CheckBox"
# The counter lives in this runspace, so an error a concurrent job logs from its own
# runspace cannot be charged to a toggle flipped on the UI thread
$errorsBefore = [int]$global:WinUtilJobErrorCount
if ($undo) {
$Values = @{
@@ -81,5 +84,10 @@ function Invoke-WinUtilTweaks {
Remove-WinUtilProvisionedAPPX -PackageList $sync.configs.tweaks.$CheckBox.appx
}
}
Write-WinUtilLog -Component "Tweaks" -Message "$action tweak completed: $CheckBox"
$errorCount = [int]$global:WinUtilJobErrorCount - $errorsBefore
if ($errorCount -gt 0) {
Write-WinUtilLog -Level "WARN" -Component "Tweaks" -Message "$action tweak finished with $errorCount error(s): $CheckBox"
} else {
Write-WinUtilLog -Component "Tweaks" -Message "$action tweak completed: $CheckBox"
}
}
+4 -1
View File
@@ -42,7 +42,10 @@ function Write-WinUtilLog {
$null = $sync.LoggedErrors.Add("[$Component] $Message")
}
if ($Level -eq "ERROR" -and -not $Detail -and $global:WinUtilIsJobWorker) {
# Global scope is per runspace, so this counter only ever sees errors logged by the
# runspace that owns it: a job worker reads its own, and a tweak on the UI thread reads the
# UI thread's
if ($Level -eq "ERROR" -and -not $Detail) {
$global:WinUtilJobErrorCount++
}