dashboard / erock/pico / fix(rsync): delete largest path first #98 rss

open · opened on 2025-12-19T01:28:25Z by erock
Help
checkout latest patchset:
ssh pr.pico.sh print pr-98 | git am -3
checkout any patchset in a patch request:
ssh pr.pico.sh print ps-X | git am -3
add changes to patch request:
git format-patch main --stdout | ssh pr.pico.sh pr add 98
add review to patch request:
git format-patch main --stdout | ssh pr.pico.sh pr add --review 98
accept PR:
ssh pr.pico.sh pr accept 98
close PR:
ssh pr.pico.sh pr close 98

Logs

erock created pr with ps-178 on 2025-12-19T01:28:25Z
erock added ps-179 on 2025-12-19T01:39:08Z

Patchsets

ps-178 by erock on 2025-12-19T01:28:25Z
Range Diff ↕ rd-179
1: f8ad8c5 = 1: f8ad8c5 fix(rsync): delete largest path first
-: ------- > 2: 0d69224 chore: add tests
ps-179 by erock on 2025-12-19T01:39:08Z

+8 -0 pkg/send/protocols/rsync/rsync.go link
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
diff --git a/pkg/send/protocols/rsync/rsync.go b/pkg/send/protocols/rsync/rsync.go
index a50d0c2..765142e 100644
--- a/pkg/send/protocols/rsync/rsync.go
+++ b/pkg/send/protocols/rsync/rsync.go
@@ -153,6 +153,14 @@ func (h *handler) Remove(willReceive []*rsyncutils.ReceiverFile) error {
 		}
 	}
 
+	// Sort by path depth descending so children are deleted before parents.
+	// This ensures directories are empty before we try to remove them.
+	slices.SortFunc(toDelete, func(a, b string) int {
+		depthA := strings.Count(a, "/")
+		depthB := strings.Count(b, "/")
+		return depthB - depthA
+	})
+
 	var errs []error
 
 	for _, file := range toDelete {

+1 -1 pkg/send/protocols/rsync/rsync.go link
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
diff --git a/pkg/send/protocols/rsync/rsync.go b/pkg/send/protocols/rsync/rsync.go
index 765142e..cb2e544 100644
--- a/pkg/send/protocols/rsync/rsync.go
+++ b/pkg/send/protocols/rsync/rsync.go
@@ -148,7 +148,7 @@ func (h *handler) Remove(willReceive []*rsyncutils.ReceiverFile) error {
 			return rf.Name == entry.Name()
 		})
 
-		if !exists && entry.Name() != "._pico_keep_dir" {
+		if !exists && path.Base(entry.Name()) != "._pico_keep_dir" {
 			toDelete = append(toDelete, entry.Name())
 		}
 	}
+237 -0 pkg/send/protocols/rsync/rsync_test.go link
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
diff --git a/pkg/send/protocols/rsync/rsync_test.go b/pkg/send/protocols/rsync/rsync_test.go
new file mode 100644
index 0000000..90dc36e
--- /dev/null
+++ b/pkg/send/protocols/rsync/rsync_test.go
@@ -0,0 +1,237 @@
+package rsync
+
+import (
+	"bytes"
+	"context"
+	"io"
+	"io/fs"
+	"log/slog"
+	"os"
+	"testing"
+	"time"
+
+	rsyncutils "github.com/picosh/go-rsync-receiver/utils"
+	"github.com/picosh/pico/pkg/pssh"
+	"github.com/picosh/pico/pkg/send/utils"
+	"golang.org/x/crypto/ssh"
+)
+
+// mockFileInfo implements fs.FileInfo for testing.
+type mockFileInfo struct {
+	name    string
+	size    int64
+	mode    fs.FileMode
+	modTime time.Time
+	isDir   bool
+}
+
+func (m *mockFileInfo) Name() string       { return m.name }
+func (m *mockFileInfo) Size() int64        { return m.size }
+func (m *mockFileInfo) Mode() fs.FileMode  { return m.mode }
+func (m *mockFileInfo) ModTime() time.Time { return m.modTime }
+func (m *mockFileInfo) IsDir() bool        { return m.isDir }
+func (m *mockFileInfo) Sys() any           { return nil }
+
+// mockWriteHandler implements utils.CopyFromClientHandler for testing.
+// It records the order of Delete calls to verify deletion order.
+type mockWriteHandler struct {
+	entries      []os.FileInfo
+	deleteCalls  []string
+	deleteErrors map[string]error
+}
+
+func (m *mockWriteHandler) Delete(_ *pssh.SSHServerConnSession, entry *utils.FileEntry) error {
+	m.deleteCalls = append(m.deleteCalls, entry.Filepath)
+	if m.deleteErrors != nil {
+		if err, ok := m.deleteErrors[entry.Filepath]; ok {
+			return err
+		}
+	}
+	return nil
+}
+
+func (m *mockWriteHandler) Write(_ *pssh.SSHServerConnSession, _ *utils.FileEntry) (string, error) {
+	return "", nil
+}
+
+func (m *mockWriteHandler) Read(_ *pssh.SSHServerConnSession, _ *utils.FileEntry) (os.FileInfo, utils.ReadAndReaderAtCloser, error) {
+	return nil, nil, nil
+}
+
+func (m *mockWriteHandler) List(_ *pssh.SSHServerConnSession, _ string, _ bool, _ bool) ([]os.FileInfo, error) {
+	return m.entries, nil
+}
+
+func (m *mockWriteHandler) GetLogger(_ *pssh.SSHServerConnSession) *slog.Logger {
+	return slog.Default()
+}
+
+func (m *mockWriteHandler) Validate(_ *pssh.SSHServerConnSession) error {
+	return nil
+}
+
+// mockChannel implements ssh.Channel for testing.
+type mockChannel struct {
+	stderr *bytes.Buffer
+}
+
+func (m *mockChannel) Read(_ []byte) (int, error)     { return 0, io.EOF }
+func (m *mockChannel) Write(data []byte) (int, error) { return len(data), nil }
+func (m *mockChannel) Close() error                   { return nil }
+func (m *mockChannel) CloseWrite() error              { return nil }
+func (m *mockChannel) SendRequest(_ string, _ bool, _ []byte) (bool, error) {
+	return true, nil
+}
+func (m *mockChannel) Stderr() io.ReadWriter { return m.stderr }
+
+var _ ssh.Channel = (*mockChannel)(nil)
+
+// newMockSession creates a mock SSHServerConnSession for testing.
+func newMockSession() (*pssh.SSHServerConnSession, *bytes.Buffer) {
+	stderr := &bytes.Buffer{}
+	channel := &mockChannel{stderr: stderr}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	logger := slog.Default()
+	server := pssh.NewSSHServer(ctx, logger, &pssh.SSHServerConfig{})
+	serverConn := pssh.NewSSHServerConn(ctx, logger, &ssh.ServerConn{
+		Permissions: &ssh.Permissions{
+			Extensions: map[string]string{},
+		},
+	}, server)
+
+	session := &pssh.SSHServerConnSession{
+		Channel:       channel,
+		SSHServerConn: serverConn,
+		Ctx:           ctx,
+		CancelFunc:    cancel,
+	}
+
+	return session, stderr
+}
+
+func TestRemove_DeletesChildrenBeforeParents(t *testing.T) {
+	session, _ := newMockSession()
+	mockHandler := &mockWriteHandler{
+		entries: []os.FileInfo{
+			&mockFileInfo{name: "a", isDir: true},
+			&mockFileInfo{name: "a/file.txt", size: 100},
+			&mockFileInfo{name: "b/c", isDir: true},
+			&mockFileInfo{name: "b/c/deep.txt", size: 50},
+			&mockFileInfo{name: "b", isDir: true},
+		},
+	}
+
+	h := &handler{
+		session:      session,
+		writeHandler: mockHandler,
+		root:         "test",
+	}
+
+	err := h.Remove([]*rsyncutils.ReceiverFile{})
+	if err != nil {
+		t.Fatalf("Remove() returned error: %v", err)
+	}
+
+	if len(mockHandler.deleteCalls) != 5 {
+		t.Fatalf("expected 5 delete calls, got %d: %v", len(mockHandler.deleteCalls), mockHandler.deleteCalls)
+	}
+
+	indexOfA := -1
+	indexOfAFile := -1
+	indexOfB := -1
+	indexOfBC := -1
+	indexOfBCDeep := -1
+
+	for i, path := range mockHandler.deleteCalls {
+		switch path {
+		case "/test/a":
+			indexOfA = i
+		case "/test/a/file.txt":
+			indexOfAFile = i
+		case "/test/b":
+			indexOfB = i
+		case "/test/b/c":
+			indexOfBC = i
+		case "/test/b/c/deep.txt":
+			indexOfBCDeep = i
+		}
+	}
+
+	if indexOfAFile > indexOfA {
+		t.Errorf("a/file.txt (index %d) should be deleted before a (index %d)", indexOfAFile, indexOfA)
+	}
+	if indexOfBCDeep > indexOfBC {
+		t.Errorf("b/c/deep.txt (index %d) should be deleted before b/c (index %d)", indexOfBCDeep, indexOfBC)
+	}
+	if indexOfBC > indexOfB {
+		t.Errorf("b/c (index %d) should be deleted before b (index %d)", indexOfBC, indexOfB)
+	}
+}
+
+func TestRemove_IgnoresPicoKeepDir(t *testing.T) {
+	session, _ := newMockSession()
+	mockHandler := &mockWriteHandler{
+		entries: []os.FileInfo{
+			&mockFileInfo{name: "dir", isDir: true},
+			&mockFileInfo{name: "dir/._pico_keep_dir", size: 0},
+			&mockFileInfo{name: "dir/file.txt", size: 100},
+		},
+	}
+
+	h := &handler{
+		session:      session,
+		writeHandler: mockHandler,
+		root:         "test",
+	}
+
+	err := h.Remove([]*rsyncutils.ReceiverFile{})
+	if err != nil {
+		t.Fatalf("Remove() returned error: %v", err)
+	}
+
+	for _, path := range mockHandler.deleteCalls {
+		if path == "/test/dir/._pico_keep_dir" {
+			t.Error("._pico_keep_dir should not be in delete list")
+		}
+	}
+
+	if len(mockHandler.deleteCalls) != 2 {
+		t.Errorf("expected 2 delete calls (dir, dir/file.txt), got %d: %v", len(mockHandler.deleteCalls), mockHandler.deleteCalls)
+	}
+}
+
+func TestRemove_OnlyDeletesFilesNotInWillReceive(t *testing.T) {
+	session, _ := newMockSession()
+	mockHandler := &mockWriteHandler{
+		entries: []os.FileInfo{
+			&mockFileInfo{name: "a.txt", size: 100},
+			&mockFileInfo{name: "b.txt", size: 100},
+			&mockFileInfo{name: "c.txt", size: 100},
+		},
+	}
+
+	h := &handler{
+		session:      session,
+		writeHandler: mockHandler,
+		root:         "test",
+	}
+
+	willReceive := []*rsyncutils.ReceiverFile{
+		{Name: "a.txt"},
+		{Name: "c.txt"},
+	}
+
+	err := h.Remove(willReceive)
+	if err != nil {
+		t.Fatalf("Remove() returned error: %v", err)
+	}
+
+	if len(mockHandler.deleteCalls) != 1 {
+		t.Fatalf("expected 1 delete call, got %d: %v", len(mockHandler.deleteCalls), mockHandler.deleteCalls)
+	}
+
+	if mockHandler.deleteCalls[0] != "/test/b.txt" {
+		t.Errorf("expected to delete /test/b.txt, got %s", mockHandler.deleteCalls[0])
+	}
+}