mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-11-05 01:23:24 -08:00
[CrashReporting] Offer to send the installer log on abort (#7524)
* [CrashReporting] Installer log send offer on abort (inc 4) DSN parsed to CPACK_SENTRY_* (scheme-aware for http self-hosts) before include(CPack); new SendInstallerLog.ps1.in builds a byte-accurate Sentry envelope (128 KiB tail cap, X-Sentry-Auth, exit 0/1) with the abort reason read from the log file itself, so the NSIS side needs no string functions and quoting stays trivial. AbortInstall asks consent (attended installs only, silent path untouched, abort never swallowed). Empty/malformed DSN disables the offer; no secrets in repo. * [CrashReporting] Embed installer-log sender via a relative NSIS path The AbortInstall hook embedded SendInstallerLog.ps1 through the absolute CPACK_SENTRY_PS1_PATH, which carries CMake's forward slashes (D:/a/...). makensis does not treat a forward-slash drive path as absolute, so it resolved it relative to project.nsi, found nothing and aborted packaging on the Windows jobs of every branch in the stack. Embed it with the same '..\..\..\' relative path that already resolves NSIS.definitions.nsh: both are configure_file'd into the build root, three levels up from where CPack places project.nsi. Drop the now-unused CPACK_SENTRY_PS1_PATH cache variable. * [CrashReporting] Drop the installer /CRASHTEST hook, tidy the log sender Remove the /CRASHTEST switch and the matching COCKATRICE_SENTRY_DSN environment override on the installer abort path. With no deliberate in-installer trigger left, a package built without a baked DSN must never offer to post a user's log to an endpoint chosen by whatever happens to be in the environment, so the prompt is now gated on CPACK_SENTRY_ENABLED alone. This also retires the comment that claimed /S /R /CRASHTEST reaches the prompt: the switch was evaluated before /R set ReinstallMode, so that form never showed it. Alongside: correct the CPACK_SENTRY_RELEASE comment (PROJECT_VERSION keeps its "-<label>" on Development tags where CPACK_PACKAGE_VERSION does not), delete the unused CPACK_SENTRY_HOST/CPACK_SENTRY_PROJECT_ID cache vars, document the DSN regex's path-prefix fallback, log a declined send, keep the uploaded installer log free of helper-injected newlines, and bound the post with -TimeoutSec/-NonInteractive. * [CrashReporting] Derive the installer DSN vars as plain variables Review nit: every CPACK_SENTRY_* value is recomputed from COCKATRICE_SENTRY_DSN on each configure, so CACHE ... FORCE bought nothing. Set empty defaults once, override them in the match branch, and drop the duplicated else() copies. Still CPACK_-prefixed, so include(CPack) still snapshots them into CPackConfig.cmake. * [CrashReporting] Gate the installer log send at build time Review nit: test CPACK_SENTRY_ENABLED with the NSIS preprocessor instead of copying it into $SentryEnabled and branching at runtime, so a package built without a DSN compiles the prompt out rather than carrying dead code. The configure_file that produces the helper is gated the same way, so a build without reporting neither references nor embeds it. * [CrashReporting] Disclose the Windows user name in the send prompt Review nit: say that the log can include the Windows user name (a real part of what gets uploaded) and drop the "No account needed." clause, which answered a question the prompt never raised. * [CrashReporting] Show progress while the installer log is sent Review nit: DetailPrint a line before nsExec runs, so the details pane says something while the send is in flight instead of staying blank for up to the 60 s /TIMEOUT. * [CrashReporting] Rename the Sentry event local in the installer helper Review nit: $Event is a PowerShell automatic variable, so name the local $sentryEvent instead. Also drop $firstLine: Select-String returns the matching line alone, so the reason is already one physical line and the extra split added nothing. --------- Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
This commit is contained in:
parent
9f59f5c495
commit
c6f682f9cf
4 changed files with 205 additions and 0 deletions
|
|
@ -37,6 +37,9 @@ Var LogFindHandle
|
|||
Var LogFindName
|
||||
Var LogMatchLabel
|
||||
Var LogMatchPattern
|
||||
; Sentry installer-log hook state (see AbortInstall)
|
||||
Var SentryResult
|
||||
Var SentryOutput
|
||||
|
||||
!include LogicLib.nsh
|
||||
!include FileFunc.nsh
|
||||
|
|
@ -909,6 +912,48 @@ Function AbortInstall
|
|||
${If} $ReinstallMode = 1
|
||||
${OrIfNot} ${Silent}
|
||||
MessageBox MB_OK|MB_ICONEXCLAMATION "$AbortReason$\r$\n$\r$\nA detailed installer log was written to:$\r$\n$InstallLogPath"
|
||||
; Offer to send the installer log to Sentry so aborted installs can be diagnosed. This block already runs
|
||||
; only when someone is at the keyboard (attended install, or the updater's /R upgrade whose launcher has
|
||||
; quit), so a silent or package-manager install never reaches the prompt and its behavior is unchanged.
|
||||
; Only a package built with a baked DSN offers to send, so the prompt can only appear when a send
|
||||
; can actually go out. A preprocessor guard rather than a runtime test: a package built without a
|
||||
; DSN compiles the block out entirely, so it cannot even carry the helper or its baked endpoint.
|
||||
; No /SD here: a /SD would suppress this prompt on the silent /R upgrade, which is exactly the
|
||||
; attended-update case this offer exists for. The runtime gate above (ReinstallMode/Silent) is the
|
||||
; hang protection — a package-manager /S install without /R never reaches this box, matching the
|
||||
; two sibling MessageBox sites in this file.
|
||||
!if "@CPACK_SENTRY_ENABLED@" == "1"
|
||||
MessageBox MB_YESNO|MB_ICONQUESTION "Send the installer log to the developers to help fix this? The log contains file paths from this machine, which may include your Windows user name." IDYES sentry_send
|
||||
!insertmacro CockLog "sentry send: declined by user"
|
||||
Goto sentry_done
|
||||
sentry_send:
|
||||
; The abort reason is already in the log file (CockLog writes "ABORT: ..." as the
|
||||
; first thing AbortInstall does), so the helper reads it from there. Nothing
|
||||
; reason-shaped crosses the command line, which keeps quoting trivial and needs
|
||||
; no NSIS string functions.
|
||||
InitPluginsDir
|
||||
; Embedded by the same relative path that resolves NSIS.definitions.nsh above (both are
|
||||
; configure_file'd into the build root, which is three levels up from project.nsi). An
|
||||
; absolute CMake path here carries forward slashes, which makensis does not treat as
|
||||
; absolute and so fails to find the file at package time.
|
||||
File "/oname=$PLUGINSDIR\send-installer-log.ps1" "..\..\..\SendInstallerLog.ps1"
|
||||
; The send can take up to the /TIMEOUT below, so put something on the details pane
|
||||
; the moment the user says yes rather than leaving the window blank until it returns.
|
||||
DetailPrint "Sending installer log..."
|
||||
nsExec::ExecToStack /TIMEOUT=60000 'powershell -NoProfile -NonInteractive -ExecutionPolicy Bypass -File "$PLUGINSDIR\send-installer-log.ps1" -LogPath "$InstallLogPath"'
|
||||
Pop $SentryResult
|
||||
Pop $SentryOutput
|
||||
; $SentryOutput is a single line by construction: the helper flattens its message
|
||||
; and this log file is uploaded verbatim, so a stray newline must not be able to
|
||||
; forge extra lines into the artifact we send.
|
||||
!insertmacro CockLog "sentry send: result=$SentryResult output=$SentryOutput"
|
||||
${If} $SentryResult == "0"
|
||||
MessageBox MB_OK|MB_ICONINFORMATION "The installer log was sent. Thank you for helping improve Cockatrice!"
|
||||
${Else}
|
||||
MessageBox MB_OK|MB_ICONEXCLAMATION "The installer log could not be sent. You can still share it manually; it was written to:$\r$\n$InstallLogPath"
|
||||
${EndIf}
|
||||
sentry_done:
|
||||
!endif
|
||||
${EndIf}
|
||||
SetErrorLevel 1
|
||||
Abort
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue