fix: [node-core-library] Retry transient Windows EPERM/EBUSY in FileSystem.deleteFolder(Async)#5836
Open
bartvandenende-wm wants to merge 2 commits into
Open
Conversation
…ystem.deleteFolder(Async)
… FileSystem.ensureEmptyFolderAsync
bartvandenende-wm
requested review from
apostolisms,
bmiddha,
dmichon-msft,
iclanton,
jxanthony and
octogonz
as code owners
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Restores retry-on-transient-error behavior to
FileSystem.deleteFolderandFileSystem.deleteFolderAsyncon Windows, fixingEPERM: operation not permitted, rmdirfailures duringrush rebuild/ HeftcleanFileson self-hosted Windows runners.Fixes #5373.
Details
Root cause
In v5.11.0 (PR #5088)
node-core-librarybumped itsfs-extradependency from~7.0.1to~11.3.0.fs-extra.remove(Sync)was backed byrimraf@2, which retriesEBUSY/EPERM/ENOTEMPTYon Windows by default (maxBusyTries: 3).fs-extra@10onward,remove(Sync)is a thin wrapper aroundfs.rm(path, { recursive: true, force: true })with no retry options.The retry behavior was silently lost, which made consumers susceptible to the documented Windows transient where another process briefly holds a handle to a child of the directory being removed.
Change
Replace the two affected methods with native
fs.rmSync/fsPromises.rmusing{ recursive: true, force: true, maxRetries: 3, retryDelay: 100 }.fs-extra@11'sremove(Sync)is already a thin wrapper over the same native call.Note
I also added
ensureEmptyFolder/ensureEmptyFolderAsyncfor consistency as they exhibit the same regression.How it was tested
manual testing