Skip to content

Conversation

davidmorgan
Copy link
Contributor

@davidmorgan davidmorgan commented Oct 7, 2025

The SDK FileSystemEvent type is confusing in how it handles isDirectory: for the FileSystemDeleteEvent subclass it always returns false, even if you explicitly pass true to the constructor. Some watcher code is currently passing true to the constructor as if it will do something.

So while it initially looks like there are eight types of event (create file, create directory, modify file, modify directory, remove file, remove directory, move file, move directory) there are actually only seven.

Create an extension type around FileSystemEvent that makes this clear, use it everywhere. Use an event type enum with seven entries instead of four entries + a boolean, so as not to have to deal with the unrepresentable "delete directory".

No behavior changes :)

Other cleanup:

Simplify _canonicalEvent, removes don't specify isDirectory so those always conflict, it's only file add and file modify that can be reduced to a single "create" event.

MacOS watcher never receives move events or "modify directory" events from the OS, make this clear: assert(false) and drop the event if such an event is received, so tests will catch it and if it happens in the wild we use the code tested with no such events.

Clean up MacOS watcher _sortEvents because it can't receive directory move or "modify directory".

Windows watcher only gets a "modify directory" event from the OS alongside "directory created" or "directory deleted", and was being ignored: make it clearer that it's ignored by ignoring sooner.

Update doc for Windows _sortEvents which says it removes "move" events, it does not(!).

Copy link

github-actions bot commented Oct 7, 2025

Package publishing

Package Version Status Publish tag (post-merge)
package:benchmark_harness 2.4.0-wip WIP (no publish necessary)
package:boolean_selector 2.1.2 already published at pub.dev
package:browser_launcher 1.1.3 already published at pub.dev
package:cli_config 0.2.1-wip WIP (no publish necessary)
package:cli_util 0.5.0-wip WIP (no publish necessary)
package:clock 1.1.3-wip WIP (no publish necessary)
package:code_builder 4.11.0 already published at pub.dev
package:coverage 1.15.0 already published at pub.dev
package:csslib 1.0.2 already published at pub.dev
package:extension_discovery 2.1.0 already published at pub.dev
package:file 7.0.2-wip WIP (no publish necessary)
package:file_testing 3.1.0-wip WIP (no publish necessary)
package:glob 2.1.3 already published at pub.dev
package:graphs 2.3.3-wip WIP (no publish necessary)
package:html 0.15.6 already published at pub.dev
package:io 1.1.0-wip WIP (no publish necessary)
package:json_rpc_2 4.0.0 already published at pub.dev
package:markdown 7.3.1-wip WIP (no publish necessary)
package:mime 2.0.0 already published at pub.dev
package:oauth2 2.0.4-wip WIP (no publish necessary)
package:package_config 2.3.0-wip WIP (no publish necessary)
package:pool 1.5.2 already published at pub.dev
package:process 5.0.5 already published at pub.dev
package:pub_semver 2.2.0 already published at pub.dev
package:pubspec_parse 1.5.0 already published at pub.dev
package:source_map_stack_trace 2.1.3-wip WIP (no publish necessary)
package:source_maps 0.10.14-wip WIP (no publish necessary)
package:source_span 1.10.1 already published at pub.dev
package:sse 4.1.8 already published at pub.dev
package:stack_trace 1.12.1 already published at pub.dev
package:stream_channel 2.1.4 already published at pub.dev
package:stream_transform 2.1.2-wip WIP (no publish necessary)
package:string_scanner 1.4.1 already published at pub.dev
package:term_glyph 1.2.3-wip WIP (no publish necessary)
package:test_reflective_loader 0.4.0 already published at pub.dev
package:timing 1.0.2 already published at pub.dev
package:unified_analytics 8.0.6 ready to publish unified_analytics-v8.0.6
package:watcher 1.1.5-wip WIP (no publish necessary)
package:yaml 3.1.3 already published at pub.dev
package:yaml_edit 2.2.2 already published at pub.dev

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch from 696a962 to 6ef3705 Compare October 7, 2025 08:01
Copy link

github-actions bot commented Oct 7, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
watcher None 1.1.4 1.1.5-wip 1.1.4 ✔️

This check can be disabled by tagging the PR with skip-breaking-check.

Coverage ⚠️
File Coverage
pkgs/watcher/lib/src/directory_watcher/linux.dart 💔 91 % ⬇️ 1 %
pkgs/watcher/lib/src/directory_watcher/mac_os.dart 💔 0 % ⬇️ NaN %
pkgs/watcher/lib/src/directory_watcher/windows.dart 💔 0 % ⬇️ NaN %
pkgs/watcher/lib/src/event.dart 💚 58 %
pkgs/watcher/lib/src/file_watcher/native.dart 💚 83 % ⬆️ 3 %
pkgs/watcher/lib/src/utils.dart 💚 83 %

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbol Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/bazel_worker/benchmark/benchmark.dart
pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart
pkgs/boolean_selector/example/example.dart
pkgs/clock/lib/clock.dart
pkgs/clock/lib/src/clock.dart
pkgs/clock/lib/src/default.dart
pkgs/clock/lib/src/stopwatch.dart
pkgs/clock/lib/src/utils.dart
pkgs/clock/test/clock_test.dart
pkgs/clock/test/default_test.dart
pkgs/clock/test/stopwatch_test.dart
pkgs/clock/test/utils.dart
pkgs/coverage/lib/src/coverage_options.dart
pkgs/html/example/main.dart
pkgs/html/lib/dom.dart
pkgs/html/lib/dom_parsing.dart
pkgs/html/lib/html_escape.dart
pkgs/html/lib/parser.dart
pkgs/html/lib/src/constants.dart
pkgs/html/lib/src/encoding_parser.dart
pkgs/html/lib/src/html_input_stream.dart
pkgs/html/lib/src/list_proxy.dart
pkgs/html/lib/src/query_selector.dart
pkgs/html/lib/src/token.dart
pkgs/html/lib/src/tokenizer.dart
pkgs/html/lib/src/treebuilder.dart
pkgs/html/lib/src/utils.dart
pkgs/html/test/dom_test.dart
pkgs/html/test/parser_feature_test.dart
pkgs/html/test/parser_test.dart
pkgs/html/test/query_selector_test.dart
pkgs/html/test/selectors/level1_baseline_test.dart
pkgs/html/test/selectors/level1_lib.dart
pkgs/html/test/selectors/selectors.dart
pkgs/html/test/support.dart
pkgs/html/test/tokenizer_test.dart
pkgs/html/test/trie_test.dart
pkgs/html/tool/generate_trie.dart
pkgs/pubspec_parse/test/git_uri_test.dart
pkgs/stack_trace/example/example.dart
pkgs/watcher/test/custom_watcher_factory_test.dart
pkgs/yaml_edit/example/example.dart

This check can be disabled by tagging the PR with skip-license-check.

@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch 2 times, most recently from db92c9b to 8e6e625 Compare October 7, 2025 08:10
@github-actions github-actions bot added the type-infra A repository infrastructure change or enhancement label Oct 7, 2025
@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch from 8e6e625 to ada967c Compare October 7, 2025 08:15
@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch from ada967c to e79280c Compare October 7, 2025 09:29
@davidmorgan davidmorgan changed the title Add WatcherFilesystemEvent. Add extension type on FileSystemEvent. Oct 7, 2025
@davidmorgan davidmorgan changed the title Add extension type on FileSystemEvent. Add package-private extension type Event on FileSystemEvent. Oct 7, 2025
@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch 2 times, most recently from 286081e to 6d4b5c3 Compare October 7, 2025 11:26
@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch 7 times, most recently from 3898a07 to 246ce10 Compare October 7, 2025 14:22
@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch 4 times, most recently from 0049941 to 61995a9 Compare October 7, 2025 15:07
@davidmorgan davidmorgan force-pushed the watcher-filesystem-event branch from 61995a9 to 83a4c8a Compare October 7, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:watcher skip-changelog-check type-infra A repository infrastructure change or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant