Add a "status" API to DiagnosticContext, overhaul Downloads console output #1565
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or information, and change all MessageSink interaction to be line-oriented. More than one line can be printed at a time, but there must be a line *between* messages.
…on rather than saying there was a download failure when no download was attempted.
…r is always added.
Fixes many longstanding bugs and hopefully makes our console output for this more understandable: * We no longer print 'error' when an asset cache misses but the authoritative download succeeds. * We now always and consistently print output from x-script s at the time that actually happens. Resolves https://devdiv.visualstudio.com/DevDiv/_workitems/edit/2300063 * We don't tell the user that proxy settings might fix a hash mismatch problem. * We do the the user that proxy settings might fix a download from asset cache problem. * We now always tell the user the full command line we tried when invoking an x-script that fails. * We don't crash if an x-script doesn't create the file we expect, or creates a file with the wrong hash. * We now always print what we are doing *before* touching the network, so if we hang the user knows which server is being problematic. Note that this includes storing back to asset caches which we were previously entirely silent about except in case of failure. Other changes: * Removed debug output about asset cache configuration. The output was misleading / wrong depending on readwrite settings, and echoing to the user exactly what they said before we've interpreted it is not useful debug output. (Contrast with other VcpkgPaths debug output which tend to be paths we have likely changed from something a user said)
JavierMatosD
reviewed
Jan 8, 2025
| "Asset cache hit for .*; downloaded from: .*" | ||
| "A suitable version of cmake was not found \(required v[0-9\.]+\)\.", | ||
| "Trying to download cmake-[0-9.]+-[^.]+\.(zip|tar\.gz) using asset cache file://$assetCacheRegex/[0-9a-z]+", | ||
| "Download successful! Asset cache hit, did not try authoritative source https://github\.com/Kitware/CMake/releases/download/[^ ]+" |
There was a problem hiding this comment.
Suggested change
| "Download successful! Asset cache hit, did not try authoritative source https://github\.com/Kitware/CMake/releases/download/[^ ]+" | |
| Asset cache hit! |
I think that "Asset cache hit!" implies successful download which implies not trying the authoritative source. The previous line says we are engaging with asset cache so I don't think we need to say we didn't try the authoritative source.
There was a problem hiding this comment.
The original intended URI needs to be in the output somehow. Where do you want it go instead?
| #azurl (no), x-block-origin (no), asset-cache (n/a), download (sha-mismatch) | ||
| #Expected: Download message with the "you might need to configure a proxy" message and with expected/actual sha | ||
| Refresh-TestRoot | ||
| $expected = @( | ||
| "Downloading https://example\.com -> example3\.html", | ||
| "[^\n]+example3\.html\.\d+\.part: error: download from https://example\.com had an unexpected hash", |
There was a problem hiding this comment.
Do we want the error:?
Suggested change
| "[^\n]+example3\.html\.\d+\.part: error: download from https://example\.com had an unexpected hash", | |
| "[^\n]+example3\.html\.\d+\.part: warning: download from https://example\.com had an unexpected hash", |
There was a problem hiding this comment.
It's fatal and we can't continue after it happens, so I think it needs to be error?
| Remove-Item "$downloadsRoot/example3.html" | ||
| $expected = @( | ||
| "Trying to download example3\.html using asset cache file://$assetCacheRegex/[0-9a-z]+", | ||
| "Download successful! Asset cache hit, did not try authoritative source https://example\.com" |
There was a problem hiding this comment.
Same as previous comment. I will add that in the opposite , Asset cache miss', scenario we simply say "Asset cache miss; trying authoritative source".
There was a problem hiding this comment.
Are you saying you want to remove Download successful!?
SplitUrl -> SplitUrlView
# Conflicts: # src/vcpkg/base/downloads.cpp
BillyONeal
commented
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Todo (to undraft):
asset-caching.ps1for examples.Extensive overhaul of our downloads handling and console output; @JavierMatosD and I have gone back and forth several times and yet kept introducing unintended bugs in other places, which led me to believe targeted fixes would no longer cut it.
Fixes many longstanding bugs and hopefully makes our console output for this more understandable:
Other changes:
VcpkgPathsdebug output which tend to be paths we have likely changed from something a user said)Other notes:
DiagnosticContextso it will be easy to audit that the foreground/background thread behavior is correct after this.Special thanks to @JavierMatosD for his help in review of the first console output attempts and for blowing the dust off this area in the first place.