Enable retries by default on Windows

Author: ycombinator

file/helper_aix.go

@@ -24,7 +24,7 @@ import (
 
 // SafeFileRotate safely rotates an existing file under path and replaces it with the tempfile
 func SafeFileRotate(path, tempfile string, opts ...RotateOpt) error {
-options := rotateOpts{}
+options := rotateOpts{enableRetries: false}
 for _, opt := range opts {
 opt(&options)
 }

file/helper_common.go

@@ -23,30 +23,31 @@ import (
 "time"
 )
 
+const renameRetryInterval = 50 * time.Millisecond
+const renameRetryDuration = 2 * time.Second
+
 type rotateOpts struct {
-renameRetryDuration time.Duration
-renameRetryInterval time.Duration
+enableRetries bool
 }
 
 type RotateOpt func(*rotateOpts)
 
-func WithRenameRetries(duration, interval time.Duration) RotateOpt {
+func DisableRetries() RotateOpt {
 return func(opts *rotateOpts) {
-opts.renameRetryDuration = duration
-opts.renameRetryInterval = interval
+opts.enableRetries = false
 }
 }
 
 func rename(src, dst string, options rotateOpts) error {
-// Perform a regular (non-retrying) rename unless all retry options are specified.
-if options.renameRetryDuration == 0 || options.renameRetryInterval == 0 {
+// Perform a regular (non-retrying) rename if retries are disabled.
+if !options.enableRetries {
 return os.Rename(src, dst)
 }
 
 // Attempt rename with retries every options.RenameRetryInterval until options.RenameRetryDuration
 // has elapsed. This is useful in cases where the destination file may be locked or in use.
 var err error
-for start := time.Now(); time.Since(start) < options.renameRetryDuration; time.Sleep(options.renameRetryInterval) {
+for start := time.Now(); time.Since(start) < renameRetryDuration; time.Sleep(renameRetryInterval) {
 err = os.Rename(src, dst)
 if err == nil {
 // Rename succeeded; no more retries needed
@@ -55,7 +56,7 @@ func rename(src, dst string, options rotateOpts) error {
 }
 
 if err != nil {
-return fmt.Errorf("failed to rename %s to %s after %v: %w", src, dst, options.renameRetryDuration, err)
+return fmt.Errorf("failed to rename %s to %s after %v: %w", src, dst, renameRetryDuration, err)
 }
 
 return nil

file/helper_other.go

@@ -26,7 +26,7 @@ import (
 
 // SafeFileRotate safely rotates an existing file under path and replaces it with the tempfile
 func SafeFileRotate(path, tempfile string, opts ...RotateOpt) error {
-options := rotateOpts{}
+options := rotateOpts{enableRetries: false}
 for _, opt := range opts {
 opt(&options)
 }

file/helper_windows.go

@@ -24,7 +24,9 @@ import (
 
 // SafeFileRotate safely rotates an existing file under path and replaces it with the tempfile
 func SafeFileRotate(path, tempfile string, opts ...RotateOpt) error {
-options := rotateOpts{}
+// Enable retries by default on Windows. This is useful in cases where path, the destination
+// file may be locked or in use.
+options := rotateOpts{enableRetries: true}
 for _, opt := range opts {
 opt(&options)
 }

file/helper_windows_test.go

@@ -52,7 +52,7 @@ func TestSafeFileRotate(t *testing.T) {
 defer destFile.Close()
 
 // Try to replace dest with new
-err = SafeFileRotate(dest, src, WithRenameRetries(2*time.Second, 100*time.Millisecond))
+err = SafeFileRotate(dest, src, DisableRetries(2*time.Second, 100*time.Millisecond))
 require.NoError(t, err)
 
 // Check that dest file has been replaced with new file