Print precise and correct watch warnings (and only when necessary) (#10787)

# Objective

Fixes #10401 

## Solution

* Allow sources to register specific processed/unprocessed watch
warnings.
* Specify per-platform watch warnings. This removes the need to cover
all platform cases in one warning message.
* Only register watch warnings for the _processed_ embedded source, as
warning about watching unprocessed embedded isn't helpful.

---

## Changelog

- Asset sources can now register specific watch warnings.
This commit is contained in:
Carter Anderson 2023-11-28 16:35:13 -08:00 committed by GitHub
parent 506bdc5e68
commit 4221f7e7e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 8 deletions

View file

@ -64,7 +64,12 @@ impl EmbeddedAssetRegistry {
Box::new(MemoryAssetReader { Box::new(MemoryAssetReader {
root: processed_dir.clone(), root: processed_dir.clone(),
}) })
}); })
// Note that we only add a processed watch warning because we don't want to warn
// noisily about embedded watching (which is niche) when users enable file watching.
.with_processed_watch_warning(
"Consider enabling the `embedded_watcher` cargo feature.",
);
#[cfg(feature = "embedded_watcher")] #[cfg(feature = "embedded_watcher")]
{ {

View file

@ -128,6 +128,8 @@ pub struct AssetSourceBuilder {
+ Sync, + Sync,
>, >,
>, >,
pub watch_warning: Option<&'static str>,
pub processed_watch_warning: Option<&'static str>,
} }
impl AssetSourceBuilder { impl AssetSourceBuilder {
@ -156,23 +158,31 @@ impl AssetSourceBuilder {
if watch { if watch {
let (sender, receiver) = crossbeam_channel::unbounded(); let (sender, receiver) = crossbeam_channel::unbounded();
match self.watcher.as_mut().and_then(|w|(w)(sender)) { match self.watcher.as_mut().and_then(|w| (w)(sender)) {
Some(w) => { Some(w) => {
source.watcher = Some(w); source.watcher = Some(w);
source.event_receiver = Some(receiver); source.event_receiver = Some(receiver);
}, }
None => warn!("{id} does not have an AssetWatcher configured. Consider enabling the `file_watcher` feature. Note that Web and Android do not currently support watching assets."), None => {
if let Some(warning) = self.watch_warning {
warn!("{id} does not have an AssetWatcher configured. {warning}");
}
}
} }
} }
if watch_processed { if watch_processed {
let (sender, receiver) = crossbeam_channel::unbounded(); let (sender, receiver) = crossbeam_channel::unbounded();
match self.processed_watcher.as_mut().and_then(|w|(w)(sender)) { match self.processed_watcher.as_mut().and_then(|w| (w)(sender)) {
Some(w) => { Some(w) => {
source.processed_watcher = Some(w); source.processed_watcher = Some(w);
source.processed_event_receiver = Some(receiver); source.processed_event_receiver = Some(receiver);
}, }
None => warn!("{id} does not have a processed AssetWatcher configured. Consider enabling the `file_watcher` feature. Note that Web and Android do not currently support watching assets."), None => {
if let Some(warning) = self.processed_watch_warning {
warn!("{id} does not have a processed AssetWatcher configured. {warning}");
}
}
} }
} }
Some(source) Some(source)
@ -238,6 +248,18 @@ impl AssetSourceBuilder {
self self
} }
/// Enables a warning for the unprocessed source watcher, which will print when watching is enabled and the unprocessed source doesn't have a watcher.
pub fn with_watch_warning(mut self, warning: &'static str) -> Self {
self.watch_warning = Some(warning);
self
}
/// Enables a warning for the processed source watcher, which will print when watching is enabled and the processed source doesn't have a watcher.
pub fn with_processed_watch_warning(mut self, warning: &'static str) -> Self {
self.processed_watch_warning = Some(warning);
self
}
/// Returns a builder containing the "platform default source" for the given `path` and `processed_path`. /// Returns a builder containing the "platform default source" for the given `path` and `processed_path`.
/// For most platforms, this will use [`FileAssetReader`](crate::io::file::FileAssetReader) / [`FileAssetWriter`](crate::io::file::FileAssetWriter), /// For most platforms, this will use [`FileAssetReader`](crate::io::file::FileAssetReader) / [`FileAssetWriter`](crate::io::file::FileAssetWriter),
/// but some platforms (such as Android) have their own default readers / writers / watchers. /// but some platforms (such as Android) have their own default readers / writers / watchers.
@ -248,7 +270,8 @@ impl AssetSourceBuilder {
.with_watcher(AssetSource::get_default_watcher( .with_watcher(AssetSource::get_default_watcher(
path.to_string(), path.to_string(),
Duration::from_millis(300), Duration::from_millis(300),
)); ))
.with_watch_warning(AssetSource::get_default_watch_warning());
if let Some(processed_path) = processed_path { if let Some(processed_path) = processed_path {
default default
.with_processed_reader(AssetSource::get_default_reader(processed_path.to_string())) .with_processed_reader(AssetSource::get_default_reader(processed_path.to_string()))
@ -257,6 +280,7 @@ impl AssetSourceBuilder {
processed_path.to_string(), processed_path.to_string(),
Duration::from_millis(300), Duration::from_millis(300),
)) ))
.with_processed_watch_warning(AssetSource::get_default_watch_warning())
} else { } else {
default default
} }
@ -428,6 +452,16 @@ impl AssetSource {
} }
} }
/// Returns the default non-existent [`AssetWatcher`] warning for the current platform.
pub fn get_default_watch_warning() -> &'static str {
#[cfg(target_arch = "wasm32")]
return "Web does not currently support watching assets.";
#[cfg(target_os = "android")]
return "Android does not currently support watching assets.";
#[cfg(all(not(target_arch = "wasm32"), not(target_os = "android")))]
return "Consider enabling the `file_watcher` feature.";
}
/// Returns a builder function for this platform's default [`AssetWatcher`]. `path` is the relative path to /// Returns a builder function for this platform's default [`AssetWatcher`]. `path` is the relative path to
/// the asset root. This will return [`None`] if this platform does not support watching assets by default. /// the asset root. This will return [`None`] if this platform does not support watching assets by default.
/// `file_debounce_time` is the amount of time to wait (and debounce duplicate events) before returning an event. /// `file_debounce_time` is the amount of time to wait (and debounce duplicate events) before returning an event.