From 0fae8bb9bdb908ca5c275fc2e467f6049c9bd263 Mon Sep 17 00:00:00 2001 From: Zhizhen He Date: Sun, 25 Oct 2026 22:40:47 +0800 Subject: [PATCH] clipboard: Replace existing output files atomically --- docs/changelog.rst | 3 + kittens/clipboard/read.go | 1 - kittens/clipboard/read_test.go | 109 +++++++++++++++++++++++++++++++++ 3 files changed, 112 insertions(+), 1 deletion(-) create mode 100644 kittens/clipboard/read_test.go diff --git a/docs/changelog.rst b/docs/changelog.rst index 2cfbe157c..78b2db0f5 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -382,6 +382,9 @@ Detailed list of changes write to a temporary file that is renamed into place, so an interrupted transfer no longer leaves a truncated file behind (:pull:`10713`) +- Clipboard kitten: Fix a race when replacing an existing output file and + losing the original file if renaming the temporary file fails + - Kittens: Fix laggy mouse selection and failures comparing remote directories in the diff kitten, Unicode quotes not being removed from around paths and URLs in the hints kitten, various bugs in the choose-files, diff --git a/kittens/clipboard/read.go b/kittens/clipboard/read.go index 209a0404a..40d8a33ad 100644 --- a/kittens/clipboard/read.go +++ b/kittens/clipboard/read.go @@ -130,7 +130,6 @@ func (self *Output) commit() { self.dest.Chmod(fi.Mode().Perm()) } f.Close() - os.Remove(f.Name()) } self.err = os.Rename(self.dest.Name(), self.arg) if self.err != nil { diff --git a/kittens/clipboard/read_test.go b/kittens/clipboard/read_test.go new file mode 100644 index 000000000..730b8c9d4 --- /dev/null +++ b/kittens/clipboard/read_test.go @@ -0,0 +1,109 @@ +// License: GPLv3 Copyright: 2026, Kovid Goyal, + +package clipboard + +import ( + "bytes" + "errors" + "fmt" + "os" + "path/filepath" + "testing" +) + +func TestClipboardOutputCommitAtomic(t *testing.T) { + dest := filepath.Join(t.TempDir(), "output") + old_data := bytes.Repeat([]byte("old contents\n"), 1024) + new_data := bytes.Repeat([]byte("new contents\n"), 1024) + if err := os.WriteFile(dest, old_data, 0o600); err != nil { + t.Fatal(err) + } + + started, stop := make(chan struct{}), make(chan struct{}) + result := make(chan error, 1) + go func() { + data, err := os.ReadFile(dest) + close(started) + for { + if err != nil { + result <- fmt.Errorf("Concurrent read failed: %w", err) + return + } + if !bytes.Equal(data, old_data) && !bytes.Equal(data, new_data) { + result <- fmt.Errorf("Concurrent read returned incomplete contents: %q", data) + return + } + select { + case <-stop: + result <- nil + return + default: + } + data, err = os.ReadFile(dest) + } + }() + <-started + t.Cleanup(func() { + close(stop) + if err := <-result; err != nil { + t.Error(err) + } + }) + + for i := range 100 { + data := new_data + if i%2 != 0 { + data = old_data + } + output := Output{arg: dest} + output.add_data(data) + if output.err != nil { + t.Fatal(output.err) + } + temp_name := output.dest.Name() + output.commit() + if output.err != nil { + t.Fatal(output.err) + } + actual, err := os.ReadFile(dest) + if err != nil { + t.Fatal(err) + } + if !bytes.Equal(actual, data) { + t.Fatal("Committed file has incorrect contents") + } + if _, err := os.Stat(temp_name); !os.IsNotExist(err) { + t.Fatalf("Temporary file still exists after commit: %v", err) + } + } +} + +func TestClipboardOutputCommitRenameFailure(t *testing.T) { + dir := t.TempDir() + dest := filepath.Join(dir, "output") + old_data := []byte("old contents") + if err := os.WriteFile(dest, old_data, 0o600); err != nil { + t.Fatal(err) + } + output := Output{arg: dest} + defer output.cleanup() + output.add_data([]byte("new contents")) + if output.err != nil { + t.Fatal(output.err) + } + // Removing the source forces rename to fail even when running as root. + if err := os.Remove(output.dest.Name()); err != nil { + t.Fatal(err) + } + output.commit() + if !errors.Is(output.err, os.ErrNotExist) { + t.Fatalf("Expected rename to fail with a missing source, got: %v", output.err) + } + actual, err := os.ReadFile(dest) + if err != nil { + t.Fatalf("Original destination lost after failed rename: %v", err) + } + if !bytes.Equal(actual, old_data) { + t.Fatalf("Original destination changed after failed rename: %q", actual) + } +}