Merge remote-tracking branch 'upstream/master' into dom-bundle

Author: WorldSEnder

README.md

@@ -11,7 +11,7 @@
     <a href="https://crates.io/crates/yew"><img alt="Crate Info" src="https://img.shields.io/crates/v/yew.svg"/></a>
     <a href="https://docs.rs/yew/"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-yew-green"/></a>
     <a href="https://discord.gg/VQck8X4"><img alt="Discord Chat" src="https://img.shields.io/discord/701068342760570933"/></a>
-    <a href="https://gitlocalize.com/repo/4999/whole_project?utm_source=badge"> <img src="https://gitlocalize.com/repo/4999/whole_project/badge.svg" /> </a>
+    <a href="https://gitlocalize.com/repo/7052/whole_project?utm_source=badge"> <img src="https://gitlocalize.com/repo/7052/whole_project/badge.svg" /> </a>
     <a href="https://blog.rust-lang.org/2020/12/31/Rust-1.56.0.html"><img alt="Rustc Version 1.56.0+" src="https://img.shields.io/badge/rustc-1.56%2B-lightgrey.svg"/></a>
   </p>
 
@@ -70,7 +70,7 @@ Please [report all bugs!](https://github.com/yewstack/yew/issues/new/choose) We
 
 #### 🤓 Want to help translate?
 
-Translations can be submitted on the [Yew GitLocalize Repo](https://gitlocalize.com/repo/4999). If you are interested in being the official moderator for a language, please reach out on Discord.
+Translations can be submitted on the [Yew GitLocalize Repo](https://gitlocalize.com/repo/7052). If you are interested in being the official moderator for a language, please reach out on Discord.
 
 ## Contributors
 

packages/yew-router/tests/basename.rs

@@ -1,4 +1,6 @@
+use gloo::timers::future::sleep;
 use serde::{Deserialize, Serialize};
+use std::time::Duration;
 use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 use yew::functional::function_component;
 use yew::prelude::*;
@@ -112,19 +114,29 @@ fn root() -> Html {
 // - query parameters
 // - 404 redirects
 #[test]
-fn router_works() {
+async fn router_works() {
     yew::start_app_in_element::<Root>(gloo::utils::document().get_element_by_id("output").unwrap());
 
+    sleep(Duration::ZERO).await;
+
     assert_eq!("Home", obtain_result_by_id("result"));
 
+    sleep(Duration::ZERO).await;
+
     let initial_length = history_length();
 
+    sleep(Duration::ZERO).await;
+
     click("button"); // replacing the current route
+
+    sleep(Duration::ZERO).await;
     assert_eq!("2", obtain_result_by_id("result-params"));
     assert_eq!("bar", obtain_result_by_id("result-query"));
     assert_eq!(initial_length, history_length());
 
     click("button"); // pushing a new route
+
+    sleep(Duration::ZERO).await;
     assert_eq!("3", obtain_result_by_id("result-params"));
     assert_eq!("baz", obtain_result_by_id("result-query"));
     assert_eq!(initial_length + 1, history_length());

packages/yew-router/tests/browser_router.rs

@@ -1,4 +1,6 @@
+use gloo::timers::future::sleep;
 use serde::{Deserialize, Serialize};
+use std::time::Duration;
 use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 use yew::functional::function_component;
 use yew::prelude::*;
@@ -112,19 +114,29 @@ fn root() -> Html {
 // - query parameters
 // - 404 redirects
 #[test]
-fn router_works() {
+async fn router_works() {
     yew::start_app_in_element::<Root>(gloo::utils::document().get_element_by_id("output").unwrap());
 
+    sleep(Duration::ZERO).await;
+
     assert_eq!("Home", obtain_result_by_id("result"));
 
+    sleep(Duration::ZERO).await;
+
     let initial_length = history_length();
 
+    sleep(Duration::ZERO).await;
+
     click("button"); // replacing the current route
+
+    sleep(Duration::ZERO).await;
     assert_eq!("2", obtain_result_by_id("result-params"));
     assert_eq!("bar", obtain_result_by_id("result-query"));
     assert_eq!(initial_length, history_length());
 
     click("button"); // pushing a new route
+
+    sleep(Duration::ZERO).await;
     assert_eq!("3", obtain_result_by_id("result-params"));
     assert_eq!("baz", obtain_result_by_id("result-query"));
     assert_eq!(initial_length + 1, history_length());

packages/yew-router/tests/hash_router.rs

@@ -1,4 +1,6 @@
+use gloo::timers::future::sleep;
 use serde::{Deserialize, Serialize};
+use std::time::Duration;
 use wasm_bindgen_test::{wasm_bindgen_test as test, wasm_bindgen_test_configure};
 use yew::functional::function_component;
 use yew::prelude::*;
@@ -112,19 +114,29 @@ fn root() -> Html {
 // - query parameters
 // - 404 redirects
 #[test]
-fn router_works() {
+async fn router_works() {
     yew::start_app_in_element::<Root>(gloo::utils::document().get_element_by_id("output").unwrap());
 
+    sleep(Duration::ZERO).await;
+
     assert_eq!("Home", obtain_result_by_id("result"));
 
+    sleep(Duration::ZERO).await;
+
     let initial_length = history_length();
 
+    sleep(Duration::ZERO).await;
+
     click("button"); // replacing the current route
+
+    sleep(Duration::ZERO).await;
     assert_eq!("2", obtain_result_by_id("result-params"));
     assert_eq!("bar", obtain_result_by_id("result-query"));
     assert_eq!(initial_length, history_length());
 
     click("button"); // pushing a new route
+
+    sleep(Duration::ZERO).await;
     assert_eq!("3", obtain_result_by_id("result-params"));
     assert_eq!("baz", obtain_result_by_id("result-query"));
     assert_eq!(initial_length + 1, history_length());

packages/yew/src/dom_bundle/app_handle.rs

@@ -37,7 +37,7 @@ where
 
     /// Schedule the app for destruction
     pub fn destroy(self) {
-        self.scope.destroy()
+        self.scope.destroy(false)
     }
 }
 

packages/yew/src/dom_bundle/bcomp.rs

@@ -40,8 +40,8 @@ impl fmt::Debug for BComp {
 }
 
 impl DomBundle for BComp {
-    fn detach(self, _parent: &Element) {
-        self.scope.destroy_boxed();
+    fn detach(self, _parent: &Element, parent_to_detach: bool) {
+        self.scope.destroy_boxed(parent_to_detach);
     }
 
     fn shift(&self, next_parent: &Element, next_sibling: NodeRef) {
@@ -264,9 +264,9 @@ impl ComponentRenderState {
         }
     }
     /// Detach the rendered content from the DOM
-    pub(crate) fn detach(self) {
+    pub(crate) fn detach(self, parent_to_detach: bool) {
         if let Some(ref m) = self.parent {
-            self.root_node.detach(m);
+            self.root_node.detach(m, parent_to_detach);
         }
     }
 
@@ -282,14 +282,15 @@ pub trait Scoped {
     /// Shift the node associated with this scope to a new place
     fn shift_node(&self, parent: Element, next_sibling: NodeRef);
     /// Process an event to destroy a component
-    fn destroy(self);
-    fn destroy_boxed(self: Box<Self>);
+    fn destroy(self, parent_to_detach: bool);
+    fn destroy_boxed(self: Box<Self>, parent_to_detach: bool);
 }
 
 #[cfg(test)]
 mod tests {
     use super::*;
     use crate::dom_bundle::{DomBundle, Reconcilable};
+    use crate::scheduler;
     use crate::{
         html,
         virtual_dom::{Key, VChild, VNode},
@@ -341,6 +342,7 @@ mod tests {
 
         let comp = html! { <Comp></Comp> };
         let (_, mut bundle) = comp.attach(&parent_scope, &parent_element, NodeRef::default());
+        scheduler::start_now();
 
         for _ in 0..10000 {
             let node = html! { <Comp></Comp> };
@@ -350,6 +352,7 @@ mod tests {
                 NodeRef::default(),
                 &mut bundle,
             );
+            scheduler::start_now();
         }
     }
 
@@ -504,6 +507,7 @@ mod tests {
         parent.set_inner_html("");
 
         node.attach(scope, parent, NodeRef::default());
+        scheduler::start_now();
         parent.inner_html()
     }
 
@@ -563,9 +567,11 @@ mod tests {
         let node_ref = NodeRef::default();
         let elem = html! { <Comp ref={node_ref.clone()}></Comp> };
         let (_, elem) = elem.attach(&scope, &parent, NodeRef::default());
+        scheduler::start_now();
         let parent_node = parent.deref();
         assert_eq!(node_ref.get(), parent_node.first_child());
-        elem.detach(&parent);
+        elem.detach(&parent, false);
+        scheduler::start_now();
         assert!(node_ref.get().is_none());
     }
 }

packages/yew/src/dom_bundle/blist.rs

@@ -151,7 +151,7 @@ impl BList {
         if lefts.len() < rights.len() {
             for r in rights.drain(lefts.len()..) {
                 test_log!("removing: {:?}", r);
-                r.detach(parent);
+                r.detach(parent, false);
             }
         }
 
@@ -336,7 +336,7 @@ impl BList {
         // Step 2.3. Remove any extra rights
         for KeyedEntry(_, r) in spare_bundles.drain() {
             test_log!("removing: {:?}", r);
-            r.detach(parent);
+            r.detach(parent, false);
         }
 
         // Step 3. Diff matching children at the start
@@ -354,9 +354,9 @@ impl BList {
 }
 
 impl DomBundle for BList {
-    fn detach(self, parent: &Element) {
+    fn detach(self, parent: &Element, parent_to_detach: bool) {
         for child in self.rev_children.into_iter() {
-            child.detach(parent);
+            child.detach(parent, parent_to_detach);
         }
     }
 

packages/yew/src/dom_bundle/bnode.rs

@@ -43,19 +43,20 @@ impl BNode {
 
 impl DomBundle for BNode {
     /// Remove VNode from parent.
-    fn detach(self, parent: &Element) {
+    fn detach(self, parent: &Element, parent_to_detach: bool) {
         match self {
-            Self::BTag(vtag) => vtag.detach(parent),
-            Self::BText(btext) => btext.detach(parent),
-            Self::BComp(bsusp) => bsusp.detach(parent),
-            Self::BList(blist) => blist.detach(parent),
+            Self::BTag(vtag) => vtag.detach(parent, parent_to_detach),
+            Self::BText(btext) => btext.detach(parent, parent_to_detach),
+            Self::BComp(bsusp) => bsusp.detach(parent, parent_to_detach),
+            Self::BList(blist) => blist.detach(parent, parent_to_detach),
             Self::BRef(ref node) => {
+                // Always remove user-defined nodes to clear possible parent references of them
                 if parent.remove_child(node).is_err() {
                     console::warn!("Node not found to remove VRef");
                 }
             }
-            Self::BPortal(bportal) => bportal.detach(parent),
-            Self::BSuspense(bsusp) => bsusp.detach(parent),
+            Self::BPortal(bportal) => bportal.detach(parent, parent_to_detach),
+            Self::BSuspense(bsusp) => bsusp.detach(parent, parent_to_detach),
         }
     }
 

packages/yew/src/dom_bundle/bportal.rs

@@ -20,9 +20,9 @@ pub struct BPortal {
 }
 
 impl DomBundle for BPortal {
-    fn detach(self, _: &Element) {
+    fn detach(self, _: &Element, _parent_to_detach: bool) {
         test_log!("Detaching portal from host{:?}", self.host.outer_html());
-        self.node.detach(&self.host);
+        self.node.detach(&self.host, false);
         test_log!("Detached portal from host{:?}", self.host.outer_html());
     }
 

packages/yew/src/dom_bundle/bsuspense.rs

@@ -30,12 +30,12 @@ impl BSuspense {
 }
 
 impl DomBundle for BSuspense {
-    fn detach(self, parent: &Element) {
+    fn detach(self, parent: &Element, parent_to_detach: bool) {
         if let Some(fallback) = self.fallback_bundle {
-            fallback.detach(parent);
-            self.children_bundle.detach(&self.detached_parent);
+            fallback.detach(parent, parent_to_detach);
+            self.children_bundle.detach(&self.detached_parent, false);
         } else {
-            self.children_bundle.detach(parent);
+            self.children_bundle.detach(parent, parent_to_detach);
         }
     }
 
@@ -164,7 +164,11 @@ impl Reconcilable for VSuspense {
             }
             // Freshly unsuspended. Detach fallback from the DOM, then shift children into it.
             (false, Some(_)) => {
-                suspense.fallback_bundle.take().unwrap().detach(parent);
+                suspense
+                    .fallback_bundle
+                    .take()
+                    .unwrap() // We just matched Some(_)
+                    .detach(parent, false);
 
                 children_bundle.shift(parent, next_sibling.clone());
                 children.reconcile_node(parent_scope, parent, next_sibling, children_bundle)