-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* The watcher should attempt to re-register on name changes * Re-register watcher after longer delays * Add a reminder for fixing watching after file changes * Move file watcher into its own file * Make file watcher testable * Watcher follows file changes * Test the file watcher * Final test tweaks * Swap back to the old delays * Final final test tweaks * Use a slightly longer delay * Shorter poll interval for file watcher * Follow through with rename
- Loading branch information
1 parent
50151d8
commit 2cea117
Showing
5 changed files
with
222 additions
and
59 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| use std::{ | ||
| path::{Path, PathBuf}, | ||
| sync::mpsc, | ||
| time::Duration, | ||
| }; | ||
|
|
||
| use crate::InlyneEvent; | ||
|
|
||
| use notify::{ | ||
| event::{EventKind, ModifyKind}, | ||
| Event, EventHandler, RecommendedWatcher, RecursiveMode, Watcher as _, | ||
| }; | ||
| use winit::event_loop::EventLoopProxy; | ||
|
|
||
| #[cfg(test)] | ||
| mod tests; | ||
|
|
||
| trait Callback: Send + 'static { | ||
| fn update(&self); | ||
| } | ||
|
|
||
| impl Callback for EventLoopProxy<InlyneEvent> { | ||
| fn update(&self) { | ||
| let _ = self.send_event(InlyneEvent::FileReload); | ||
| } | ||
| } | ||
|
|
||
| enum WatcherMsg { | ||
| // Sent by the registered file watcher | ||
| Notify(notify::Result<Event>), | ||
| // Sent by the event loop | ||
| FileChange(PathBuf), | ||
| } | ||
|
|
||
| struct MsgHandler(mpsc::Sender<WatcherMsg>); | ||
|
|
||
| impl EventHandler for MsgHandler { | ||
| fn handle_event(&mut self, event: notify::Result<Event>) { | ||
| let msg = WatcherMsg::Notify(event); | ||
| let _ = self.0.send(msg); | ||
| } | ||
| } | ||
|
|
||
| pub struct Watcher(mpsc::Sender<WatcherMsg>); | ||
|
|
||
| impl Watcher { | ||
| pub fn spawn(event_proxy: EventLoopProxy<InlyneEvent>, file_path: PathBuf) -> Self { | ||
| Self::spawn_inner(event_proxy, file_path) | ||
| } | ||
|
|
||
| fn spawn_inner<C: Callback>(reload_callback: C, file_path: PathBuf) -> Self { | ||
| let (msg_tx, msg_rx) = mpsc::channel(); | ||
| let watcher = Self(msg_tx.clone()); | ||
|
|
||
| let notify_watcher = | ||
| RecommendedWatcher::new(MsgHandler(msg_tx), notify::Config::default()).unwrap(); | ||
|
|
||
| std::thread::spawn(move || { | ||
| endlessly_handle_messages(notify_watcher, msg_rx, reload_callback, file_path); | ||
| }); | ||
|
|
||
| watcher | ||
| } | ||
|
|
||
| pub fn update_path(&self, new_path: &Path) { | ||
| let msg = WatcherMsg::FileChange(new_path.to_owned()); | ||
| let _ = self.0.send(msg); | ||
| } | ||
| } | ||
|
|
||
| fn endlessly_handle_messages<C: Callback>( | ||
| mut watcher: RecommendedWatcher, | ||
| msg_rx: mpsc::Receiver<WatcherMsg>, | ||
| reload_callback: C, | ||
| mut file_path: PathBuf, | ||
| ) { | ||
| watcher | ||
| .watch(&file_path, RecursiveMode::NonRecursive) | ||
| .unwrap(); | ||
|
|
||
| let poll_registering_watcher = |watcher: &mut RecommendedWatcher, file_path: &Path| loop { | ||
| std::thread::sleep(Duration::from_millis(20)); | ||
|
|
||
| let _ = watcher.unwatch(file_path); | ||
| if watcher | ||
| .watch(file_path, RecursiveMode::NonRecursive) | ||
| .is_ok() | ||
| { | ||
| break; | ||
| } | ||
| }; | ||
|
|
||
| while let Ok(msg) = msg_rx.recv() { | ||
| match msg { | ||
| WatcherMsg::Notify(Ok(event)) => { | ||
| log::trace!("File event: {:#?}", event); | ||
|
|
||
| if matches!( | ||
| event.kind, | ||
| EventKind::Remove(_) | EventKind::Modify(ModifyKind::Name(_)) | ||
| ) { | ||
| log::debug!("File may have been renamed/removed. Falling back to polling"); | ||
| poll_registering_watcher(&mut watcher, &file_path); | ||
| log::debug!("Successfully re-registered file watcher"); | ||
| reload_callback.update(); | ||
| } else if matches!(event.kind, EventKind::Modify(_)) { | ||
| log::debug!("Reloading file"); | ||
| reload_callback.update(); | ||
| } | ||
| } | ||
| WatcherMsg::Notify(Err(err)) => log::warn!("File watcher error: {}", err), | ||
| WatcherMsg::FileChange(new_path) => { | ||
| log::info!("Updating file watcher path: {}", new_path.display()); | ||
| let _ = watcher.unwatch(&file_path); | ||
| poll_registering_watcher(&mut watcher, &new_path); | ||
| file_path = new_path; | ||
| reload_callback.update(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| log::warn!("File watcher channel dropped unexpectedly"); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| use std::{fs, path::Path, sync::mpsc, time::Duration}; | ||
|
|
||
| use super::{Callback, Watcher}; | ||
|
|
||
| impl Callback for mpsc::Sender<()> { | ||
| fn update(&self) { | ||
| self.send(()).unwrap(); | ||
| } | ||
| } | ||
|
|
||
| const DELAY: Duration = Duration::from_millis(100); | ||
| const LONG_TIMEOUT: Duration = Duration::from_millis(2_000); | ||
| const SHORT_TIMEOUT: Duration = Duration::from_millis(50); | ||
|
|
||
| fn delay() { | ||
| std::thread::sleep(DELAY); | ||
| } | ||
|
|
||
| fn touch(file: &Path) { | ||
| let now = filetime::FileTime::now(); | ||
| filetime::set_file_mtime(file, now).unwrap(); | ||
| } | ||
|
|
||
| #[track_caller] | ||
| fn assert_no_message(callback: &mpsc::Receiver<()>) { | ||
| assert!(callback.recv_timeout(SHORT_TIMEOUT).is_err()); | ||
| } | ||
|
|
||
| #[track_caller] | ||
| fn assert_at_least_one_message(callback: &mpsc::Receiver<()>) { | ||
| assert!(callback.recv_timeout(LONG_TIMEOUT).is_ok()); | ||
| while callback.recv_timeout(SHORT_TIMEOUT).is_ok() {} | ||
| } | ||
|
|
||
| // Unfortunately this needs to be littered with sleeps/timeouts to work right :/ | ||
| #[test] | ||
| fn the_gauntlet() { | ||
| // Create our dummy test env | ||
| let temp_dir = tempfile::Builder::new() | ||
| .prefix("inlyne-tests-") | ||
| .tempdir() | ||
| .unwrap(); | ||
| let base = temp_dir.path(); | ||
| let main_file = base.join("main.md"); | ||
| let rel_file = base.join("rel.md"); | ||
| let swapped_in_file = base.join("swap_me_in.md"); | ||
| let swapped_out_file = base.join("swap_out_to_me.md"); | ||
| fs::write(&main_file, "# Main\n\n[rel](./rel.md)").unwrap(); | ||
| fs::write(&rel_file, "# Rel").unwrap(); | ||
| fs::write(&swapped_in_file, "# Swapped").unwrap(); | ||
|
|
||
| // Setup our watcher | ||
| let (callback_tx, callback_rx) = mpsc::channel::<()>(); | ||
| let watcher = Watcher::spawn_inner(callback_tx, main_file.clone()); | ||
|
|
||
| // Give the watcher time to get comfy :) | ||
| delay(); | ||
|
|
||
| // Sanity check watching | ||
| touch(&main_file); | ||
| assert_at_least_one_message(&callback_rx); | ||
|
|
||
| // Updating a file follows the new file and not the old one | ||
| watcher.update_path(&rel_file); | ||
| assert_at_least_one_message(&callback_rx); | ||
| touch(&main_file); | ||
| assert_no_message(&callback_rx); | ||
| touch(&rel_file); | ||
| assert_at_least_one_message(&callback_rx); | ||
|
|
||
| // We can slowly swap out the file and it will only follow the file it's supposed to | ||
| fs::rename(&rel_file, &swapped_out_file).unwrap(); | ||
| touch(&swapped_out_file); | ||
| assert_no_message(&callback_rx); | ||
| // The "slowly" part of this (give the watcher time to fail and start polling) | ||
| delay(); | ||
| fs::rename(&swapped_in_file, &rel_file).unwrap(); | ||
| assert_at_least_one_message(&callback_rx); | ||
| fs::remove_file(&swapped_out_file).unwrap(); | ||
| assert_no_message(&callback_rx); | ||
| touch(&rel_file); | ||
| assert_at_least_one_message(&callback_rx); | ||
| } |