Fix: Robust shutdown and error handling for large file change batches in docker compose watch #13525

amyssnippet · 2026-01-17T06:24:58Z

What I did

Fixed an issue where docker compose up --watch could become unresponsive after a large number of file changes (e.g., after a branch switch).
Ensured all watcher and sync goroutines and channels are robustly closed on context cancellation or error.
Added explicit logging for large batches and context cancellation to prevent stuck processes and ensure graceful shutdown on Ctrl-C.

Related issue

This PR addresses an issue where docker compose up --watch could become unresponsive after a large number of file changes (such as after a branch switch), causing logs to stop and Ctrl-C to not exit cleanly. The issue is #13136 . The fix ensures that all watcher and sync goroutines and channels are robustly closed on context cancellation or error, and adds explicit logging for large batches and context cancellation. This prevents the process from getting stuck and ensures graceful shutdown, even after large file change events.

By fixing:

I improved the shutdown logic in the watcher and sync system, ensuring all goroutines and channels are closed on context cancellation or error.
I added explicit logging for large file change batches and for context cancellation.
The patch directly addresses the symptoms described: logs stopping, Ctrl-C not exiting, and the process getting stuck after a large batch of file changes (such as after a branch switch).

ndeloof · 2026-01-19T10:15:36Z

pkg/compose/watch.go

 		select {
 		case <-ctx.Done():
-			options.LogTo.Log(api.WatchLogger, "Watch disabled")
+			options.LogTo.Log(api.WatchLogger, "Watch disabled (context canceled)")


"context" doesn't make any sense for end-user

ndeloof · 2026-01-19T10:15:54Z

pkg/compose/watch.go

 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()

-	// debounce and group filesystem events so that we capture IDE saving many files as one "batch" event


why remove this comment?

ndeloof · 2026-01-19T10:17:27Z

pkg/compose/watch.go

-		case batch := <-batchEvents:
+		case batch, ok := <-batchEvents:
+			if !ok {
+				options.LogTo.Log(api.WatchLogger, "Watch event channel closed")


WatchLogger is used to provide end-user message on the TUI, we should not refer to technical / implementation details

amyssnippet · 2026-01-19T14:29:05Z

@ndeloof Thank you for the review! I've addressed your feedback on all comments in the latest commit

ndeloof · 2026-01-19T16:33:22Z

pkg/compose/create.go

 	}

-	err = s.ensureImagesExists(ctx, project, options.Build, options.QuietPull)
+	prepareNetworks(project)


unrelated changes

i just tried to fix an issue, i just changed reorders the create function to ensure networks and volumes are provisioned before building images, which fixes a test failure

AFAICT this "fix" is unrelated to the current PR, and I can't see a test failure on main branch. Please avoid such undocumented changes.

ok, i have reverted back the irrelevant changes, take a look now and lets try running workflows.

ndeloof · 2026-01-20T06:45:31Z

pkg/compose/create.go

 	}

-	err = s.ensureImagesExists(ctx, project, options.Build, options.QuietPull)
+	prepareNetworks(project)


AFAICT this "fix" is unrelated to the current PR, and I can't see a test failure on main branch. Please avoid such undocumented changes.

ndeloof · 2026-01-20T07:07:52Z

You PR is now mixing changes from upstream. Please squash commit and prefer rebase over merge from main

Ensured all watcher and sync goroutines and channels are robustly closed on context cancellation or error. Added explicit logging for large batches and context cancellation to prevent stuck processes and ensure graceful shutdown on Ctrl-C. Signed-off-by: Amol Yadav <amyssnipet@yahoo.com>

amyssnippet · 2026-01-20T07:19:11Z

@ndeloof now??
i rebased all changes related to the issue i choose to solve

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/compose](https://github.com/docker/compose) | patch | `v5.0.1` → `v5.0.2` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>docker/compose (docker/compose)</summary> ### [`v5.0.2`](https://github.com/docker/compose/releases/tag/v5.0.2) [Compare Source](docker/compose@v5.0.1...v5.0.2) #### What's Changed ##### 🐛 Fixes - Fixed progress UI to adapt to terminal width by [@ndeloof](https://github.com/ndeloof) in [#13519](docker/compose#13519) - Removed warning when no explicit build has been requested. by [@ndeloof](https://github.com/ndeloof) in [#13493](docker/compose#13493) - Restored `runtime_flags` support in `models` by [@ilopezluna](https://github.com/ilopezluna) in [#13460](docker/compose#13460) - Added service name completion to `down` command by [@bmo-at](https://github.com/bmo-at) in [#13470](docker/compose#13470) - Fixed tilde in `--env-file` paths expanded to user home directory by [@tensorworkerr](https://github.com/tensorworkerr) in [#13510](docker/compose#13510) - Handle `healthcheck.disable: true` by [@stavros-k](https://github.com/stavros-k) in [#13494](docker/compose#13494) - Fixed shutdown and error handling for large file change batches in `watch` by [@amyssnippet](https://github.com/amyssnippet) in [#13525](docker/compose#13525) ##### 🔧 Internal - Added unit test for upOptions.OnExit method by [@htoyoda18](https://github.com/htoyoda18) in [#13489](docker/compose#13489) - clean up temporary compose files after conversion by [@htoyoda18](https://github.com/htoyoda18) in [#13483](docker/compose#13483) - Fixed typo in isSwarmEnabled method name by [@htoyoda18](https://github.com/htoyoda18) in [#13481](docker/compose#13481) - Fixed incorrect usage of errgroup.WithContext by [@htoyoda18](https://github.com/htoyoda18) in [#13480](docker/compose#13480) - Fixed timeout initialization when waitTimeout is zero by [@htoyoda18](https://github.com/htoyoda18) in [#13471](docker/compose#13471) - Extracted API version constants to dedicated file by [@htoyoda18](https://github.com/htoyoda18) in [#13503](docker/compose#13503) - Replace tabbed indentation in sdk.md by [@pkqk](https://github.com/pkqk) in [#13505](docker/compose#13505) - Improved attach error handling and cleanup by [@htoyoda18](https://github.com/htoyoda18) in [#13488](docker/compose#13488) - Modernize tests by [@dgageot](https://github.com/dgageot) in [#13531](docker/compose#13531) - set fsnotify build tag when building for OSX by [@ndeloof](https://github.com/ndeloof) in [#13532](docker/compose#13532) ##### ⚙️ Dependencies - build(deps): bump github.com/klauspost/compress to v1.18.2 by [@thaJeztah](https://github.com/thaJeztah) in [#13499](docker/compose#13499) - go.mod: remove exclude rules by [@thaJeztah](https://github.com/thaJeztah) in [#13498](docker/compose#13498) - build(deps): bump github.com/containerd/containerd/v2 to v2.2.1 by [@thaJeztah](https://github.com/thaJeztah) in [#13497](docker/compose#13497) - build(deps): bump golang.org/x/sys from 0.39.0 to 0.40.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#13502](docker/compose#13502) - build(deps): bump google.golang.org/grpc from 1.77.0 to 1.78.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#13475](docker/compose#13475) - build(deps): bump github.com/go-viper/mapstructure/v2 from 2.4.0 to 2.5.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#13506](docker/compose#13506) - build(deps): bump github.com/sirupsen/logrus v1.9.4 by [@thaJeztah](https://github.com/thaJeztah) in [#13518](docker/compose#13518) - Bump compose to v2.10.1 by [@ndeloof](https://github.com/ndeloof) in [#13528](docker/compose#13528) #### New Contributors - [@bmo-at](https://github.com/bmo-at) made their first contribution in [#13470](docker/compose#13470) - [@pkqk](https://github.com/pkqk) made their first contribution in [#13505](docker/compose#13505) - [@tensorworkerr](https://github.com/tensorworkerr) made their first contribution in [#13510](docker/compose#13510) - [@stavros-k](https://github.com/stavros-k) made their first contribution in [#13494](docker/compose#13494) - [@amyssnippet](https://github.com/amyssnippet) made their first contribution in [#13525](docker/compose#13525) - [@dgageot](https://github.com/dgageot) made their first contribution in [#13531](docker/compose#13531) **Full Changelog**: <docker/compose@v5.0.1...v5.0.2> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

amyssnippet requested a review from a team as a code owner January 17, 2026 06:24

amyssnippet requested review from glours and ndeloof January 17, 2026 06:25

amyssnippet force-pushed the main branch from 17e8401 to 5b0b89d Compare January 17, 2026 06:27

ndeloof reviewed Jan 19, 2026

View reviewed changes

amyssnippet requested review from ndeloof January 19, 2026 14:31

ndeloof previously approved these changes Jan 19, 2026

View reviewed changes

ndeloof enabled auto-merge (rebase) January 19, 2026 14:37

auto-merge was automatically disabled January 19, 2026 15:08
Head branch was pushed to by a user without write access

amyssnippet dismissed ndeloof’s stale review via b8b0c3b January 19, 2026 15:08

amyssnippet force-pushed the main branch from b8b0c3b to 5596014 Compare January 19, 2026 15:09

ndeloof reviewed Jan 19, 2026

View reviewed changes

amyssnippet requested a review from ndeloof January 19, 2026 17:17

ndeloof requested changes Jan 20, 2026

View reviewed changes

amyssnippet force-pushed the main branch 2 times, most recently from 52025fd to 3f43fdc Compare January 20, 2026 07:03

amyssnippet requested a review from ndeloof January 20, 2026 07:04

amyssnippet force-pushed the main branch from 3f43fdc to 55878bb Compare January 20, 2026 07:16

ndeloof approved these changes Jan 20, 2026

View reviewed changes

ndeloof enabled auto-merge (rebase) January 20, 2026 07:24

ndeloof merged commit b92b87d into docker:main Jan 20, 2026
24 checks passed

amyssnippet mentioned this pull request Jan 20, 2026

[BUG] Very large code changes (e.g. checking out a different branch) cause docker compose up --watch to break #13136

Closed

BrewTestBot mentioned this pull request Jan 21, 2026

docker-compose 5.0.2 Homebrew/homebrew-core#263803

Merged

rancherbot mentioned this pull request Jan 21, 2026

rddepman: bump dockerCompose from 5.0.1 to 5.0.2 rancher-sandbox/rancher-desktop#9778

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Robust shutdown and error handling for large file change batches in docker compose watch #13525

Fix: Robust shutdown and error handling for large file change batches in docker compose watch #13525

amyssnippet commented Jan 17, 2026

Uh oh!

ndeloof Jan 19, 2026

Uh oh!

ndeloof Jan 19, 2026

Uh oh!

ndeloof Jan 19, 2026

Uh oh!

amyssnippet commented Jan 19, 2026

Uh oh!

ndeloof Jan 19, 2026

Uh oh!

amyssnippet Jan 19, 2026

Uh oh!

ndeloof Jan 20, 2026

Uh oh!

amyssnippet Jan 20, 2026

Uh oh!

ndeloof Jan 20, 2026

Uh oh!

ndeloof commented Jan 20, 2026

Uh oh!

amyssnippet commented Jan 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix: Robust shutdown and error handling for large file change batches in docker compose watch #13525

Fix: Robust shutdown and error handling for large file change batches in docker compose watch #13525

Conversation

amyssnippet commented Jan 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amyssnippet commented Jan 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ndeloof commented Jan 20, 2026

Uh oh!

amyssnippet commented Jan 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants