Skip to content

fix: handle recursive watcher ignore paths correctly#13756

Open
ManManavadaria wants to merge 4 commits into
docker:mainfrom
ManManavadaria:13750-watch-ignore-fix
Open

fix: handle recursive watcher ignore paths correctly#13756
ManManavadaria wants to merge 4 commits into
docker:mainfrom
ManManavadaria:13750-watch-ignore-fix

Conversation

@ManManavadaria
Copy link
Copy Markdown

What I did
Applied ignore rules at the watcher layer and updated recursive traversal to skip ignored files/directories, ensuring permission errors from paths in the ignore list do not fail watch.

Related issue
fixes #13750

(not mandatory) A picture of a cute animal, if possible in relation to what you did

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to fix Docker Compose watch startup failures when an ignored path is unreadable by pushing ignore handling down into the watcher layer. In the codebase, that primarily affects how pkg/compose constructs file watchers and how pkg/watch traverses directories on different platforms.

Changes:

  • Added an ignore matcher parameter to the watcher API and threaded it through Compose watch setup.
  • Updated the naive watcher to skip ignored directories during recursive traversal and to suppress permission errors for ignored paths during startup walks.
  • Adjusted Darwin watcher and test fixture construction to use the new watcher signature.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
pkg/watch/watcher_naive.go Adds ignore-aware traversal and permission handling to the non-fsevents watcher implementation.
pkg/watch/watcher_darwin.go Updates the Darwin watcher constructor signature to match the new watcher API.
pkg/watch/notify_test.go Updates test fixture setup to call NewWatcher with an ignore matcher.
pkg/watch/notify.go Extends the exported watcher constructor to accept an ignore matcher.
pkg/compose/watch.go Builds ignore matchers from watch triggers and passes them into watcher creation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pkg/watch/watcher_naive.go Outdated
Comment thread pkg/watch/watcher_naive.go Outdated
Comment thread pkg/compose/watch.go Outdated
Comment thread pkg/watch/watcher_darwin.go Outdated
Comment thread pkg/watch/watcher_naive.go Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented May 4, 2026

Codecov Report

❌ Patch coverage is 58.06452% with 13 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
pkg/watch/watcher_naive.go 47.61% 8 Missing and 3 partials ⚠️
pkg/compose/watch.go 75.00% 1 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

@ManManavadaria ManManavadaria force-pushed the 13750-watch-ignore-fix branch from 1e22d66 to bba54a8 Compare May 6, 2026 19:15
@ManManavadaria
Copy link
Copy Markdown
Author

Hi @glours @ndeloof ,
I’ve addressed all the review feedbacks in the latest commit. please review it, appreciate your time and feedback.

@ManManavadaria ManManavadaria force-pushed the 13750-watch-ignore-fix branch from bba54a8 to 4ab735b Compare May 7, 2026 13:18
@glours
Copy link
Copy Markdown
Contributor

glours commented May 7, 2026

/review

Copy link
Copy Markdown

@docker-agent docker-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

This PR correctly applies ignore rules to the watcher layer for Linux/Windows (naive watcher) and handles permission errors from ignored paths during recursive directory traversal. However, there are two issues worth addressing:

  1. macOS (Darwin) — the ignore parameter is silently discarded, so the fix does not apply on macOS.
  2. Multi-trigger ignore OR-logic — merging all trigger ignore matchers with OR logic at the watcher layer can cause directories needed by one trigger to be skipped because another trigger ignores them.

Reviewed 6 files: pkg/compose/watch.go, pkg/watch/notify.go, pkg/watch/notify_test.go, pkg/watch/watcher_darwin.go, pkg/watch/watcher_naive.go, pkg/watch/watcher_naive_test.go

Comment thread pkg/watch/watcher_darwin.go Outdated
Comment thread pkg/compose/watch.go Outdated
Comment thread pkg/watch/watcher_naive.go Outdated
Comment thread pkg/watch/watcher_naive.go Outdated
Comment thread pkg/watch/watcher_naive.go Outdated
Comment thread pkg/watch/watcher_naive.go
Comment thread pkg/watch/watcher_darwin.go Outdated
@ManManavadaria ManManavadaria force-pushed the 13750-watch-ignore-fix branch from 4ab735b to 43cc3f0 Compare May 11, 2026 13:30
Signed-off-by: ManManavadaria <manmanavadaria@gmail.com>
…nd apply review fixes

Signed-off-by: ManManavadaria <manmanavadaria@gmail.com>
- Add multiNotify and watcher methods for grouped per-path watches

- Centralize per-path multi-watcher behavior so the naive watcher flow stays the same

- Add intersectPathMatcher implementing PathMatcher for shared roots

- Remove unnecessary conditions in the naive watcher as per feedback

Signed-off-by: ManManavadaria <manmanavadaria@gmail.com>
- Store PathMatcher on fseventNotify and filter events with shouldIgnore and shouldNotify, matching the naive watcher

Signed-off-by: ManManavadaria <manmanavadaria@gmail.com>
@ManManavadaria ManManavadaria force-pushed the 13750-watch-ignore-fix branch from 43cc3f0 to cf46c2c Compare May 11, 2026 13:34
@ManManavadaria
Copy link
Copy Markdown
Author

ManManavadaria commented May 11, 2026

Hi @glours, Thanks for the valuable feedback. Based on the review comments, I’ve refactored the per-path trigger watchers and intersectPathMatcher and implemented multiNotify methods for grouped per-path watches and implemented PathMatcher ignores in Darwin watcher.

Please review the changes and share your feedback.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] watch tries to read ignored folders leading to permission denied

3 participants