psake / psake/PowerShellBuild

Windows builds hang when the HEAD commit message is large (Invoke-Git deadlock)

Abierto
#167 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug
Lenguaje dominante
PowerShell
Estrellas
145
Forks
27
Merge medio
10 h 16 min
PR fusionados (30 d)
34

Descripción

Part of #120. Found while verifying the #162 merge.

Symptom

On Windows, Set-BuildEnvironment hangs forever when the HEAD commit message is large. Nothing
is printed, no error, no timeout — the build never starts.

This is currently happening on main. The push-triggered CI run for 9720cb7 hung both Windows
legs for 27+ minutes with zero output (ubuntu and macOS passed); I cancelled it. Every local
./build.ps1 on Windows hangs the same way, because build.ps1 calls Set-BuildEnvironment -Force before Invoke-psake.

Root cause

BuildHelpers\Invoke-Git (2.0.16) redirects both output streams and then waits for the process
to exit before reading them:

$pinfo.RedirectStandardError  = $RedirectStandardError   # $true
$pinfo.RedirectStandardOutput = $RedirectStandardOutput  # $true
...
$null = $p.Start()
$p.WaitForExit()                        # <-- blocks here
...
$stdout = $p.StandardOutput.ReadToEnd() # <-- never reached

When git writes more than the pipe buffer holds, git blocks waiting for someone to drain the
pipe, and Invoke-Git blocks waiting for git to exit. Neither can proceed. It is the textbook
WaitForExit-before-ReadToEnd deadlock described in the
ProcessStartInfo.RedirectStandardOutput remarks.

Get-BuildVariable calls it as Invoke-Git log --format=%B -n 1 <sha> to populate
$env:BHCommitMessage, so the payload is the full commit message body.

Reproduction

Measured on Windows 11, PowerShell 7.6.4, BuildHelpers 2.0.16, against real commits on main:

Commit Message size Result
f726f48 2617 bytes returns
64b7207 5498 bytes returns
9720cb7 5757 bytes hangs
Import-Module BuildHelpers
Invoke-Git -Arguments 'log --format=%B -n 1 9720cb7'   # never returns on Windows

Linux and macOS have a larger pipe buffer and do not hit the threshold at these sizes, which is
why only the Windows legs hang.

Why CI did not catch it before merge

On a pull_request event, GitHub checks out a synthetic merge commit whose message is short
(Merge <sha> into <sha>). The real squash message only becomes HEAD on the push to main.
Every PR will be green and then hang main if its squashed body is large enough.

This repository writes long PR bodies and squash-merges them verbatim, so the trigger is not
exotic — it is the house style. #163 and #165 both have bodies over the threshold today.

Consumer impact

This is not only a repo-internal problem. Initialize-PSBuild calls Set-BuildEnvironment, so
any consumer building on Windows hangs when their own HEAD commit message crosses the threshold.
A hang with no output is a bad failure mode to ship at 1.0.0.

Options

  1. Stop passing the payload through Invoke-Git. Populate $env:BHCommitMessage ourselves
    before calling Set-BuildEnvironment, or truncate it. Narrow, immediate, ours to control
  2. Fix upstream. Read the streams asynchronously (BeginOutputReadLine, or ReadToEnd
    before WaitForExit) and PR it to BuildHelpers, then raise the RequiredModules floor once
    released. Correct fix, slowest path
  3. Trim squash commit messages at merge time. Pure process change, no code — but it depends
    on every future merge remembering, and it does nothing for consumers
  4. Drop the BuildHelpers dependency for this variable. Largest change; worth naming only
    because #120 already asks what 1.0.0 should depend on

Options 1 and 2 are not exclusive: 1 unblocks now, 2 fixes it for everyone.

Immediate mitigation

Until this is fixed, squash-merge with a short commit body on this repo. The full PR
description stays on the pull request either way.

Done when

./build.ps1 and Windows CI complete regardless of HEAD commit message size, with a regression
test covering a message larger than the pipe buffer.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con build.ps1 y la ruta de Set-BuildEnvironment; después inspecciona BuildHelpers\Invoke-Git y Get-BuildVariable para confirmar cómo se lee el mensaje del commit. Reproduce el bloqueo con Invoke-Git log --format=%B -n 1 9720cb7 en Windows y revisa #120 antes de elegir entre las opciones de mitigación indicadas. Se considera terminado cuando ./build.ps1 y Windows CI se completan correctamente para mensajes grandes de HEAD, con una prueba de regresión que cubra un mensaje mayor que el búfer de la tubería.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
git, powershell
Área
build-system, ci-cd, tooling
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Activo
Claridad
Bastante claro
Aptitud para principiantes
50/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.