Skip to content

Commit 76b291e

Browse files
committed
fix(reload): filter filesystem events before queueing
1 parent 8a1b04d commit 76b291e

4 files changed

Lines changed: 116 additions & 2 deletions

File tree

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ opentelemetry = [
6262
"psutil>=7",
6363
]
6464
orjson = ["orjson>=3"]
65-
reload = ["watchdog>=4", "gitignore-parser>=0"]
65+
reload = ["watchdog>=4.0.2", "gitignore-parser>=0"]
6666
uv = ["uvloop>=0.16.0,<1; sys_platform != 'win32'"]
6767
zmq = ["pyzmq>=26"]
6868

‎taskiq/cli/worker/process_manager.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
from typing import Any
1313

1414
try:
15+
from watchdog.events import (
16+
FileCreatedEvent,
17+
FileDeletedEvent,
18+
FileModifiedEvent,
19+
FileMovedEvent,
20+
)
1521
from watchdog.observers import Observer
1622

1723
from taskiq.cli.watcher import FileWatcher
@@ -181,6 +187,13 @@ def __init__(
181187
),
182188
path=path_to_watch,
183189
recursive=True,
190+
# Filter open/close events before watchdog queues them.
191+
event_filter=[
192+
FileModifiedEvent,
193+
FileCreatedEvent,
194+
FileDeletedEvent,
195+
FileMovedEvent,
196+
],
184197
)
185198

186199
shutdown_handler = get_signal_handler(self.action_queue, ShutdownAction())
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
from pathlib import Path
2+
from queue import Queue
3+
from unittest.mock import Mock
4+
5+
import pytest
6+
from watchdog import events
7+
from watchdog.events import (
8+
FileClosedEvent,
9+
FileCreatedEvent,
10+
FileDeletedEvent,
11+
FileModifiedEvent,
12+
FileMovedEvent,
13+
FileOpenedEvent,
14+
FileSystemEvent,
15+
)
16+
from watchdog.observers.api import BaseObserver, EventEmitter
17+
18+
from taskiq.cli.worker import process_manager
19+
from taskiq.cli.worker.args import WorkerArgs
20+
from taskiq.cli.worker.process_manager import ProcessManager, ReloadAllAction
21+
22+
23+
@pytest.fixture(params=[[], ["first", "second"]], ids=["default", "multiple-dirs"])
24+
def reloading_manager(
25+
monkeypatch: pytest.MonkeyPatch,
26+
tmp_path: Path,
27+
request: pytest.FixtureRequest,
28+
) -> tuple[ProcessManager, BaseObserver]:
29+
monkeypatch.chdir(tmp_path)
30+
monkeypatch.setattr(process_manager.signal, "signal", Mock())
31+
monkeypatch.setattr(process_manager, "Queue", Queue)
32+
reload_dirs = [str(tmp_path / name) for name in request.param]
33+
for directory in reload_dirs:
34+
Path(directory).mkdir()
35+
36+
# Leave the observer stopped so dispatch cannot hide unwanted queued events.
37+
observer = BaseObserver(EventEmitter)
38+
manager = ProcessManager(
39+
WorkerArgs(
40+
broker="example:broker",
41+
modules=[],
42+
reload=True,
43+
reload_dirs=reload_dirs,
44+
no_gitignore=True,
45+
),
46+
worker_function=Mock(),
47+
observer=observer,
48+
)
49+
assert {emitter.watch.path for emitter in observer.emitters} == set(
50+
reload_dirs or ["."],
51+
)
52+
assert all(emitter.watch.is_recursive for emitter in observer.emitters)
53+
return manager, observer
54+
55+
56+
@pytest.mark.parametrize(
57+
"event_class",
58+
[
59+
FileOpenedEvent,
60+
FileClosedEvent,
61+
getattr(events, "FileClosedNoWriteEvent", None),
62+
],
63+
ids=["opened", "closed", "closed-no-write"],
64+
)
65+
def test_open_and_close_events_never_enter_observer_queue(
66+
reloading_manager: tuple[ProcessManager, BaseObserver],
67+
event_class: type[FileSystemEvent] | None,
68+
) -> None:
69+
if event_class is None:
70+
pytest.skip("This watchdog version does not emit read-only close events")
71+
72+
manager, observer = reloading_manager
73+
for emitter in observer.emitters:
74+
for index in range(10):
75+
emitter.queue_event(event_class(f"task_{index}.py"))
76+
assert observer.event_queue.empty()
77+
assert manager.action_queue.empty()
78+
79+
80+
@pytest.mark.parametrize(
81+
"event",
82+
[
83+
FileCreatedEvent("task.py"),
84+
FileModifiedEvent("task.py"),
85+
FileDeletedEvent("task.py"),
86+
FileMovedEvent("task.py", "renamed_task.py"),
87+
],
88+
ids=["created", "modified", "deleted", "moved"],
89+
)
90+
def test_file_changes_queue_worker_reload(
91+
reloading_manager: tuple[ProcessManager, BaseObserver],
92+
event: FileSystemEvent,
93+
) -> None:
94+
manager, observer = reloading_manager
95+
for emitter in observer.emitters:
96+
emitter.queue_event(event)
97+
assert not observer.event_queue.empty()
98+
observer.dispatch_events(observer.event_queue)
99+
assert isinstance(manager.action_queue.get_nowait(), ReloadAllAction)
100+
assert manager.action_queue.empty()
101+
assert observer.event_queue.empty()

‎uv.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)