Rework a bunch of cfg(feature) flags to be more principled (#2666)

* rework a bunch of feature flags to be more principled * fixup of Collectable * silence clippy * unfix Mountable trait leads to bundle size increase, so stick to the optimized version * use required-features for function_router * use --all-features in various places * disable tokio dependency on wasm tests again * add some #[inline] annotations * merge one more feature annotations * fixup: remove a line connected to trace_hydration
yewstack · May 7, 2022 · 1d579a8 · 1d579a8 · github-actions · May 7, 2022
1 parent 64e2582
commit 1d579a8
Show file tree

Hide file tree

Showing 49 changed files with 362 additions and 398 deletions.
diff --git a/.github/workflows/main-checks.yml b/.github/workflows/main-checks.yml
@@ -120,7 +120,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: -p yew --doc --features doc_test --target wasm32-unknown-unknown
+          args: -p yew --doc --all-features --target wasm32-unknown-unknown
 
   integration_tests:
     name: Integration Tests on ${{ matrix.toolchain }}
@@ -159,8 +159,8 @@ jobs:
       - name: Run tests - yew
         run: |
           cd packages/yew
-          CHROMEDRIVER=$(which chromedriver) cargo test --features wasm_test --target wasm32-unknown-unknown
-          GECKODRIVER=$(which geckodriver) cargo test --features wasm_test --target wasm32-unknown-unknown
+          CHROMEDRIVER=$(which chromedriver) cargo test --features csr,hydration,ssr --target wasm32-unknown-unknown
+          GECKODRIVER=$(which geckodriver) cargo test --features csr,hydration,ssr --target wasm32-unknown-unknown
 
       - name: Run tests - yew-router
         run: |

diff --git a/examples/function_router/Cargo.toml b/examples/function_router/Cargo.toml
@@ -19,5 +19,6 @@ instant = { version = "0.1", features = ["wasm-bindgen"] }
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 getrandom = { version = "0.2", features = ["js"] }
 
-[features]
-csr = ["yew/csr"]
+[[bin]]
+name = "function_router"
+required-features = ["yew/csr"]
diff --git a/examples/function_router/index.html b/examples/function_router/index.html
@@ -11,7 +11,7 @@
       href="https://cdn.jsdelivr.net/npm/bulma@0.9.0/css/bulma.min.css"
     />
     <link data-trunk rel="sass" href="index.scss" />
-    <link data-trunk rel="rust" data-cargo-features="csr" data-bin="function_router" />
+    <link data-trunk rel="rust" data-cargo-features="yew/csr" data-bin="function_router" />
   </head>
 
   <body></body>

diff --git a/examples/function_router/src/bin/function_router.rs b/examples/function_router/src/bin/function_router.rs
@@ -2,6 +2,5 @@ pub use function_router::*;
 
 fn main() {
     wasm_logger::init(wasm_logger::Config::new(log::Level::Trace));
-    #[cfg(feature = "csr")]
     yew::Renderer::<App>::new().render();
 }
diff --git a/examples/ssr_router/Cargo.toml b/examples/ssr_router/Cargo.toml
@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-yew = { path = "../../packages/yew", features = ["ssr", "hydration", "trace_hydration"] }
+yew = { path = "../../packages/yew", features = ["ssr", "hydration"] }
 function_router = { path = "../function_router" }
 log = "0.4"
 

diff --git a/examples/suspense/Cargo.toml b/examples/suspense/Cargo.toml
@@ -7,7 +7,7 @@ license = "MIT OR Apache-2.0"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-yew = { path = "../../packages/yew", features = ["tokio", "csr"] }
+yew = { path = "../../packages/yew", features = ["csr"] }
 gloo-timers = { version = "0.2.2", features = ["futures"] }
 wasm-bindgen-futures = "0.4"
 wasm-bindgen = "0.2"

diff --git a/examples/suspense/src/main.rs b/examples/suspense/src/main.rs
@@ -26,7 +26,7 @@ fn app_content() -> HtmlResult {
         })
     };
 
-    let on_take_a_break = Callback::from(move |_| (resleep.clone())());
+    let on_take_a_break = Callback::from(move |_| resleep());
 
     Ok(html! {
         <div class="content-area">

diff --git a/packages/yew-macro/Cargo.toml b/packages/yew-macro/Cargo.toml
@@ -34,5 +34,4 @@ yew = { path = "../yew" }
 [build-dependencies]
 
 [features]
-doc_test = []
 lints = []
diff --git a/packages/yew-router/Cargo.toml b/packages/yew-router/Cargo.toml
@@ -11,9 +11,6 @@ description = "A router implementation for the Yew framework"
 repository = "https://github.com/yewstack/yew"
 rust-version = "1.56.0"
 
-[features]
-wasm_test = []
-
 [dependencies]
 yew = { version = "0.19.3", path = "../yew", default-features= false }
 yew-router-macro = { version = "0.16.0", path = "../yew-router-macro" }

diff --git a/packages/yew/Cargo.toml b/packages/yew/Cargo.toml
@@ -87,17 +87,16 @@ features = [
 ]
 
 [features]
-ssr = ["futures", "html-escape"]
+# TODO: `dep:` syntax only supported with MSRV 1.60, would be more precise
+# tokio = ["dep:tokio"]
+ssr = ["futures", "html-escape"] # dep:html-escape
 csr = []
 hydration = ["csr"]
-trace_hydration = ["hydration"]
-doc_test = ["csr", "hydration", "ssr"]
-wasm_test = ["csr", "hydration", "ssr"]
 default = []
 
 [target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
 tokio = { version = "1.15.0", features = ["full"] }
 
 [package.metadata.docs.rs]
-features = ["doc_test"]
+all-features = true
 rustdoc-args = ["--cfg", "documenting"]
diff --git a/packages/yew/Makefile.toml b/packages/yew/Makefile.toml
@@ -10,14 +10,15 @@ args = [
     "--headless",
     "--",
     "--features",
-    "wasm_test"
+    "csr,hydration,ssr",
 ]
 
 [tasks.ssr-test]
 command = "cargo"
 args = ["test", "ssr_tests", "--features", "ssr"]
 
 [tasks.test]
+args = ["test", "--all-targets", "--all-features"]
 dependencies = ["native-test", "wasm-test"]
 
 [tasks.clippy-feature-soundness]

diff --git a/packages/yew/src/app_handle.rs b/packages/yew/src/app_handle.rs
@@ -9,8 +9,8 @@ use crate::dom_bundle::BSubtree;
 use crate::html::{BaseComponent, NodeRef, Scope, Scoped};
 
 /// An instance of an application.
-#[derive(Debug)]
 #[cfg_attr(documenting, doc(cfg(feature = "csr")))]
+#[derive(Debug)]
 pub struct AppHandle<COMP: BaseComponent> {
     /// `Scope` holder
     pub(crate) scope: Scope<COMP>,

diff --git a/packages/yew/src/dom_bundle/bcomp.rs b/packages/yew/src/dom_bundle/bcomp.rs
@@ -176,7 +176,7 @@ mod feat_hydration {
     }
 }
 
-#[cfg(feature = "wasm_test")]
+#[cfg(target_arch = "wasm32")]
 #[cfg(test)]
 mod tests {
     use std::ops::Deref;
@@ -481,7 +481,7 @@ mod tests {
     }
 }
 
-#[cfg(feature = "wasm_test")]
+#[cfg(target_arch = "wasm32")]
 #[cfg(test)]
 mod layout_tests {
     extern crate self as yew;

diff --git a/packages/yew/src/dom_bundle/blist.rs b/packages/yew/src/dom_bundle/blist.rs
@@ -504,11 +504,11 @@ mod feat_hydration {
     }
 }
 
-#[cfg(all(test, feature = "wasm_test"))]
+#[cfg(target_arch = "wasm32")]
+#[cfg(test)]
 mod layout_tests {
     extern crate self as yew;
 
-    #[cfg(feature = "wasm_test")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 
     use crate::html;
@@ -581,11 +581,11 @@ mod layout_tests {
     }
 }
 
-#[cfg(all(test, feature = "wasm_test"))]
+#[cfg(target_arch = "wasm32")]
+#[cfg(test)]
 mod layout_tests_keys {
     extern crate self as yew;
 
-    #[cfg(feature = "wasm_test")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
     use web_sys::Node;
 

diff --git a/packages/yew/src/dom_bundle/bnode.rs b/packages/yew/src/dom_bundle/bnode.rs
@@ -291,9 +291,9 @@ mod feat_hydration {
     }
 }
 
-#[cfg(all(test, feature = "wasm_test"))]
+#[cfg(target_arch = "wasm32")]
+#[cfg(test)]
 mod layout_tests {
-    #[cfg(feature = "wasm_test")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 
     use super::*;

diff --git a/packages/yew/src/dom_bundle/bportal.rs b/packages/yew/src/dom_bundle/bportal.rs
@@ -118,11 +118,11 @@ impl BPortal {
     }
 }
 
-#[cfg(all(test, feature = "wasm_test"))]
+#[cfg(target_arch = "wasm32")]
+#[cfg(test)]
 mod layout_tests {
     extern crate self as yew;
 
-    #[cfg(feature = "wasm_test")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
     use yew::virtual_dom::VPortal;
 

diff --git a/packages/yew/src/dom_bundle/btag/listeners.rs b/packages/yew/src/dom_bundle/btag/listeners.rs
@@ -196,7 +196,7 @@ impl Registry {
     }
 }
 
-#[cfg(feature = "wasm_test")]
+#[cfg(target_arch = "wasm32")]
 #[cfg(test)]
 mod tests {
     use std::marker::PhantomData;

diff --git a/packages/yew/src/dom_bundle/btag/mod.rs b/packages/yew/src/dom_bundle/btag/mod.rs
@@ -265,13 +265,13 @@ impl BTag {
         self.key.as_ref()
     }
 
-    #[cfg(feature = "wasm_test")]
+    #[cfg(target_arch = "wasm32")]
     #[cfg(test)]
     fn reference(&self) -> &Element {
         &self.reference
     }
 
-    #[cfg(feature = "wasm_test")]
+    #[cfg(target_arch = "wasm32")]
     #[cfg(test)]
     fn children(&self) -> &[BNode] {
         match &self.inner {
@@ -280,7 +280,7 @@ impl BTag {
         }
     }
 
-    #[cfg(feature = "wasm_test")]
+    #[cfg(target_arch = "wasm32")]
     #[cfg(test)]
     fn tag(&self) -> &str {
         match &self.inner {
@@ -383,7 +383,7 @@ mod feat_hydration {
     }
 }
 
-#[cfg(feature = "wasm_test")]
+#[cfg(target_arch = "wasm32")]
 #[cfg(test)]
 mod tests {
     use gloo_utils::document;
@@ -975,11 +975,11 @@ mod tests {
     }
 }
 
-#[cfg(all(test, feature = "wasm_test"))]
+#[cfg(target_arch = "wasm32")]
+#[cfg(test)]
 mod layout_tests {
     extern crate self as yew;
 
-    #[cfg(feature = "wasm_test")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 
     use crate::html;

diff --git a/packages/yew/src/dom_bundle/btext.rs b/packages/yew/src/dom_bundle/btext.rs
@@ -157,12 +157,12 @@ mod feat_hydration {
 mod test {
     extern crate self as yew;
 
-    #[cfg(feature = "wasm_test")]
+    #[cfg(target_arch = "wasm32")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 
     use crate::html;
 
-    #[cfg(feature = "wasm_test")]
+    #[cfg(target_arch = "wasm32")]
     wasm_bindgen_test_configure!(run_in_browser);
 
     #[test]
@@ -177,11 +177,11 @@ mod test {
     }
 }
 
-#[cfg(all(test, feature = "wasm_test"))]
+#[cfg(target_arch = "wasm32")]
+#[cfg(test)]
 mod layout_tests {
     extern crate self as yew;
 
-    #[cfg(feature = "wasm_test")]
     use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 
     use crate::html;

diff --git a/packages/yew/src/dom_bundle/fragment.rs b/packages/yew/src/dom_bundle/fragment.rs
@@ -3,13 +3,13 @@ use std::ops::{Deref, DerefMut};
 
 use web_sys::{Element, Node};
 
-use super::BSubtree;
+use crate::dom_bundle::BSubtree;
 use crate::html::NodeRef;
 use crate::virtual_dom::Collectable;
 
 /// A Hydration Fragment
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
-pub(crate) struct Fragment(VecDeque<Node>);
+pub struct Fragment(VecDeque<Node>);
 
 impl Deref for Fragment {
     type Target = VecDeque<Node>;

diff --git a/packages/yew/src/dom_bundle/mod.rs b/packages/yew/src/dom_bundle/mod.rs
@@ -19,9 +19,6 @@ mod btag;
 mod btext;
 mod subtree_root;
 
-#[cfg(feature = "hydration")]
-mod fragment;
-
 mod traits;
 mod utils;
 
@@ -32,16 +29,9 @@ use bportal::BPortal;
 use bsuspense::BSuspense;
 use btag::{BTag, Registry};
 use btext::BText;
-#[cfg(feature = "hydration")]
-pub(crate) use fragment::Fragment;
-pub use subtree_root::set_event_bubbling;
-pub(crate) use subtree_root::BSubtree;
 use subtree_root::EventDescriptor;
-#[cfg(feature = "hydration")]
-use traits::Hydratable;
+pub use subtree_root::{set_event_bubbling, BSubtree};
 use traits::{Reconcilable, ReconcileTarget};
-#[cfg(feature = "hydration")]
-use utils::node_type_str;
 use utils::{insert_node, test_log};
 
 /// A Bundle.
@@ -84,9 +74,15 @@ impl Bundle {
 }
 
 #[cfg(feature = "hydration")]
+#[path = "."]
 mod feat_hydration {
-    use super::*;
+    pub(super) use super::traits::Hydratable;
+    pub(super) use super::utils::node_type_str;
+    #[path = "./fragment.rs"]
+    mod fragment;
+    pub use fragment::Fragment;
 
+    use super::*;
     impl Bundle {
         /// Creates a bundle by hydrating a virtual dom layout.
         pub fn hydrate(
@@ -101,3 +97,5 @@ mod feat_hydration {
         }
     }
 }
+#[cfg(feature = "hydration")]
+pub(crate) use feat_hydration::*;
diff --git a/packages/yew/src/dom_bundle/utils.rs b/packages/yew/src/dom_bundle/utils.rs
@@ -13,13 +13,13 @@ pub(super) fn insert_node(node: &Node, parent: &Element, next_sibling: Option<&N
     };
 }
 
-#[cfg(all(test, feature = "wasm_test", verbose_tests))]
+#[cfg(all(test, target_arch = "wasm32", verbose_tests))]
 macro_rules! test_log {
     ($fmt:literal, $($arg:expr),* $(,)?) => {
         ::wasm_bindgen_test::console_log!(concat!("\t  ", $fmt), $($arg),*);
     };
 }
-#[cfg(not(all(test, feature = "wasm_test", verbose_tests)))]
+#[cfg(not(all(test, target_arch = "wasm32", verbose_tests)))]
 macro_rules! test_log {
     ($fmt:literal, $($arg:expr),* $(,)?) => {
         // Only type-check the format expression, do not run any side effects
Benchmark suite	Current: `1d579a8`	Previous: `00b94d0`	Ratio
`yew-struct-keyed 01_run1k`	`154.59699999999998`	`241.63`	`0.64`
`yew-struct-keyed 02_replace1k`	`163.981`	`246.188`	`0.67`
`yew-struct-keyed 03_update10th1k_x16`	`249.861`	`461.602`	`0.54`
`yew-struct-keyed 04_select1k`	`39.646`	`81.29599999999999`	`0.49`
`yew-struct-keyed 05_swap1k`	`57.77`	`106.9075`	`0.54`
`yew-struct-keyed 06_remove-one-1k`	`22.75`	`35.332`	`0.64`
`yew-struct-keyed 07_create10k`	`2640.744`	`3940.698`	`0.67`
`yew-struct-keyed 08_create1k-after1k_x2`	`348.0135`	`579.2225`	`0.60`
`yew-struct-keyed 09_clear1k_x8`	`144.3865`	`229.027`	`0.63`
`yew-struct-keyed 21_ready-memory`	`1.459808349609375`	`1.459808349609375`	`1`
`yew-struct-keyed 22_run-memory`	`1.6990852355957031`	`1.659912109375`	`1.02`
`yew-struct-keyed 23_update5-memory`	`1.6686859130859375`	`1.700092315673828`	`0.98`
`yew-struct-keyed 24_run5-memory`	`1.7175369262695312`	`1.7315826416015625`	`0.99`
`yew-struct-keyed 25_run-clear-memory`	`1.3325920104980469`	`1.3325920104980469`	`1`
`yew-struct-keyed 31_startup-ci`	`1729.296`	`1882.66`	`0.92`
`yew-struct-keyed 32_startup-bt`	`23.675999999999995`	`41.3`	`0.57`
`yew-struct-keyed 33_startup-mainthreadcost`	`203.70800000000008`	`260.676`	`0.78`
`yew-struct-keyed 34_startup-totalbytes`	`328.7373046875`	`328.7412109375`	`1.00`