-
Notifications
You must be signed in to change notification settings - Fork 5k
install: retry cache publish renames on Windows while a scanner holds a file open #35568
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
robobun
wants to merge
8
commits into
main
Choose a base branch
from
farm/a1b0131b/install-windows-av-eperm-retry
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
63069cc
install(windows): extend EPERM retry when moving extracted package in…
robobun 9041c77
[autofix.ci] apply automated fixes
autofix-ci[bot] 00ef1d9
address review: shorten comment, use Bun.$ for tar, fix fixture doc
robobun 127c5eb
switch to deadline-based retry with BUN_INSTALL_WIN32_AV_RETRY_MS, mo…
robobun d1eb73b
ci: retrigger
robobun 9ee07e0
install: share one Windows rename retry budget across all cache publi…
robobun e8a6264
tighten comments, generalize the exhausted-retry hint
robobun 2172ab4
retry the --force swap-out rename too; take the env var name from its…
robobun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| //! Retry budget for the renames that publish a directory into the install | ||
| //! cache (extracted tarball, patched package, global virtual store entry). | ||
| //! | ||
| //! On Windows a directory rename fails with `STATUS_ACCESS_DENIED` or | ||
| //! `STATUS_SHARING_VIOLATION` while any process holds a handle without | ||
| //! `FILE_SHARE_DELETE` on a file inside it, which is how antivirus and the | ||
| //! Search Indexer open freshly written files. Nothing is retried on POSIX, | ||
| //! where open handles do not block renames and `EPERM` is a real failure. | ||
|
robobun marked this conversation as resolved.
|
||
|
|
||
| use core::fmt; | ||
| use core::time::Duration; | ||
| use std::time::Instant; | ||
|
|
||
| use bun_sys as sys; | ||
|
|
||
| pub(crate) const ENV_VAR_NAME: &str = "BUN_INSTALL_WINDOWS_RENAME_RETRY_MS"; | ||
|
robobun marked this conversation as resolved.
Outdated
robobun marked this conversation as resolved.
Outdated
|
||
|
|
||
| pub(crate) struct RenameRetry { | ||
| started: Instant, | ||
| budget: Duration, | ||
| /// graceful-fs schedule: +10ms per attempt, capped at 100ms. | ||
| next_backoff: Duration, | ||
| exhausted: bool, | ||
| } | ||
|
|
||
| impl RenameRetry { | ||
| pub(crate) fn start() -> Self { | ||
| Self { | ||
| started: Instant::now(), | ||
| budget: Duration::from_millis( | ||
| bun_core::env_var::BUN_INSTALL_WINDOWS_RENAME_RETRY_MS | ||
| .get() | ||
| .unwrap_or(5_000), | ||
| ), | ||
| next_backoff: Duration::ZERO, | ||
| exhausted: false, | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn is_transient(err: &sys::Error) -> bool { | ||
| cfg!(windows) | ||
| && matches!( | ||
| err.get_errno(), | ||
| sys::Errno::EPERM | sys::Errno::EACCES | sys::Errno::EBUSY | ||
| ) | ||
| } | ||
|
|
||
| /// Sleeps and returns `true` if another attempt fits in the budget. | ||
| pub(crate) fn wait(&mut self) -> bool { | ||
| if self.started.elapsed() >= self.budget { | ||
| self.exhausted = true; | ||
| return false; | ||
| } | ||
| self.next_backoff = | ||
| (self.next_backoff + Duration::from_millis(10)).min(Duration::from_millis(100)); | ||
| std::thread::sleep(self.next_backoff); | ||
| true | ||
| } | ||
|
|
||
| pub(crate) fn exhausted(&self) -> bool { | ||
| self.exhausted | ||
| } | ||
|
|
||
| /// Error-message suffix; displays as nothing unless the budget ran out. | ||
| pub(crate) fn exhausted_hint(&self) -> ExhaustedHint { | ||
| ExhaustedHint { | ||
| waited: self.exhausted.then(|| self.started.elapsed()), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| pub(crate) struct ExhaustedHint { | ||
| waited: Option<Duration>, | ||
| } | ||
|
|
||
| impl fmt::Display for ExhaustedHint { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self.waited { | ||
| Some(waited) => write!( | ||
| f, | ||
| " (gave up after retrying for {}ms; usually another process such as antivirus has a file in the directory open. Set {} to wait longer)", | ||
| waited.as_millis(), | ||
| ENV_VAR_NAME, | ||
| ), | ||
| None => Ok(()), | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.