Add retry for os.rename in atomicFileWriter
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 101
- Forks
- 61
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 5
Description
Problem: Updating files using atomicFileWriter can fail during rename on Windows, due to AV software holding the file handle.
Reproduction steps:
Run this simple program on Windows
package main
import (
"fmt"
"log"
//"time"
"github.com/moby/sys/atomicwriter"
)
func main() {
data := []byte(`{
"builder": {
"gc": {
"defaultKeepStorage": "20GB",
"enabled": true
}
},
"experimental": false
}`)
var count uint64
fmt.Println("starting the test")
for {
count++
//time.Sleep(50 * time.Millisecond)
err := atomicwriter.WriteFile("test_daemon.json", data, 0o644)
if err != nil {
log.Fatalf("write failed after %d iterations: %v\n", count, err)
}
}
}
It will fail with below error after 1 or 2 minutes:
2026/04/24 12:16:24 write failed after 7807 iterations: rename C:\Users\azureuser\tmp\.tmp-test_daemon.json854562021 C:\Users\azureuser\tmp\test_daemon.json: Access is denied.
exit status 1
I just have Microsoft Defender on this system with default configuration.
Some environments (finance sector customers) have strict security policy where customers cannot exclude folders from AV scans.
Adding a retry around os.rename at https://github.com/moby/sys/blob/main/atomicwriter/atomicwriter.go#L155 can avoid this transient rename failure.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in atomicwriter/atomicwriter.go around line 155, where os.rename is called, and review the surrounding atomicFileWriter flow. Use the provided Windows reproduction with Microsoft Defender enabled to verify that transient rename failures are retried and that successful writes still complete without errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100