Skip to content

Ignoring change watch events misses fast re-creation events and leaves environment state stale #1569

@tk-oai

Description

@tk-oai

Environment data

  • Python Environments extension version: 1.30.0
  • Python extension (ms-python.python) version: 2026.4.0
  • VS Code version (Help → About): 1.123.0
  • OS and version: macOS 26.5.1 (should happen on Linux and Windows too)
  • Python version: Any
  • Environment manager in use: Not relevant (uv)
  • Shell: Not relevant (bash)
  • Remote / container scenario: none
  • Workspace type: single folder
  • Is this a regression?: Unknown

Repro Steps

  1. Open a workspace containing a Python environment.
  2. Allow the Python Environments extension to discover the environment.
  3. Replace a watched file, such as an activation script or package METADATA
    file, using a rapid remove-and-create or atomic replacement operation.
  4. Observe the Python Environments view - if the operation happened fast enough
    to be coalesced into a UPDATED, it will not result in the extension picking
    up the change.

A simple way to reproduce this is to use uv sync --python <different version to the current one> on a reasonably fast machine.

Expected behavior

The relevant environment or package state is invalidated and refreshed after
the watched file is replaced, regardless of whether VS Code reports the
operation to the extension as create/delete events or as a change event.

Actual behavior

The extension does not refresh when VS Code or (in case of FS Events on MacOS,
the underlying filesystem API) coalesces the DELETED and ADDED into a UPDATED.

Logs

Example (partially redacted and trimmed) of VS Code coalescing two parcel events:

...
2026-06-07 12:42:45.951 [trace] [File Watcher ('parcel')] [DELETED] /.../project/.venv/bin/activate
...
2026-06-07 12:42:46.015 [trace] [File Watcher ('parcel')] [ADDED] /.../project/.venv/bin/activate
...
2026-06-07 12:42:46.027 [trace] [File Watcher ('parcel')]  >> normalized [CHANGED] /.../project/.venv/bin/activate
...

Additional context

The affected watchers explicitly ignore change events and register handlers
only for creation and deletion:

const packageWatcher = createFileSystemWatcher(
'**/site-packages/*.dist-info/METADATA',
false, // don't ignore create events (pip install)
true, // ignore change events (content changes in METADATA don't affect package list)
false // don't ignore delete events (pip uninstall)
);
disposables.push(
packageDebouncedRefresh,
packageWatcher,
packageWatcher.onDidCreate(() => {
packageDebouncedRefresh.trigger();
}),
packageWatcher.onDidDelete(() => {
packageDebouncedRefresh.trigger();
}),

const activationWatcher = createFileSystemWatcher('{**/activate}', false, true, false);
disposables.push(
activationWatcher,
activationWatcher.onDidCreate(() => {
venvDebouncedRefresh.trigger();
}),
activationWatcher.onDidDelete(() => {
venvDebouncedRefresh.trigger();
}),

The second ignore argument is ignoreChangeEvents, so onDidChange is never
delivered. There is also no onDidChange listener.

A rapid delete and recreate may be coalesced into a change event by various
parts of the VSCode file watching stack:

Therefore, the assumption that the code makes, that changes are not relevant,
is unsound.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions