Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

walk: stop directory traversal when the context is cancelled - fixes #9788

Rahman Yilmaz5eb5c01e36de
diff --git a/backend/local/local.go b/backend/local/local.go
index a6cf3f2eb..a7c1eb05a 100644
--- a/backend/local/local.go
+++ b/backend/local/local.go
@@ -688,6 +688,9 @@ func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err e
}()
for {
+ if ctxErr := ctx.Err(); ctxErr != nil {
+ return nil, ctxErr
+ }
var fis []os.FileInfo
if useReadDir {
// Windows and Plan9 read the directory entries with the stat information in which
diff --git a/fs/walk/walk.go b/fs/walk/walk.go
index de3db6d8c..e0916654c 100644
--- a/fs/walk/walk.go
+++ b/fs/walk/walk.go
@@ -394,6 +394,13 @@ func walk(ctx context.Context, f fs.Fs, path string, includeAll bool, maxLevel i
wg.Go(func() {
for {
select {
+ case <-ctx.Done():
+ closeQuit()
+ select {
+ case errs <- ctx.Err():
+ default:
+ }
+ return
case job, ok := <-in:
if !ok {
return
diff --git a/fs/walk/walk_context_cancel_test.go b/fs/walk/walk_context_cancel_test.go
new file mode 100644
index 000000000..db685b3cb
--- /dev/null
+++ b/fs/walk/walk_context_cancel_test.go
@@ -0,0 +1,47 @@
+package walk
+
+import (
+ "context"
+ "testing"
+ "time"
+
+ "github.com/rclone/rclone/fs"
+ "github.com/rclone/rclone/fstest/mockdir"
+ "github.com/stretchr/testify/assert"
+)
+
+// Test that walk stops listing when the context is cancelled.
+func TestWalkContextCancelled(t *testing.T) {
+ ctx, cancel := context.WithCancel(context.Background())
+ defer cancel()
+
+ started := make(chan struct{}, 1)
+ listDir := func(ctx context.Context, f fs.Fs, includeAll bool, dir string) (entries fs.DirEntries, err error) {
+ select {
+ case started <- struct{}{}:
+ default:
+ }
+ // Every directory contains one subdirectory so the walk never
+ // finishes on its own.
+ return fs.DirEntries{mockdir.New("sub")}, nil
+ }
+
+ done := make(chan error, 1)
+ go func() {
+ done <- walk(ctx, nil, "", false, -1, func(path string, entries fs.DirEntries, err error) error {
+ return nil
+ }, listDir)
+ }()
+
+ // Wait for the walk to start.
+ <-started
+
+ cancel()
+
+ select {
+ case err := <-done:
+ assert.ErrorIs(t, err, context.Canceled)
+ case <-time.After(10 * time.Second):
+ t.Fatal("walk did not stop after the context was cancelled")
+ }
+}