LibWeb: Support subtree option in Animatable.getAnimations()

mattco98 · awesomekling · commit a80af938eb78 · 2024-06-02T16:07:12.000+02:00
diff --git a/Tests/LibWeb/Text/expected/WebAnimations/misc/animatable.txt b/Tests/LibWeb/Text/expected/WebAnimations/misc/animatable.txt
@@ -0,0 +1,6 @@
+        num animations without subtree: 1
+num animations with subtree: 4
+Anim for element parent is in the correct order: true
+Anim for element child1 is in the correct order: true
+Anim for element child2 is in the correct order: true
+Anim for element child3 is in the correct order: true
diff --git a/Tests/LibWeb/Text/input/WebAnimations/misc/animatable.html b/Tests/LibWeb/Text/input/WebAnimations/misc/animatable.html
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<div id="parent">
+    <div id="child1"></div>
+    <div id="child2">
+        <div id="child3"></div>
+    </div>
+</div>
+<script src="../../include.js"></script>
+<script>
+    test(() => {
+        const elements = ["parent", "child1", "child2", "child3"];
+        for (const id of elements)
+            document.getElementById(id).animate({}, { duration: Infinity });
+
+        const parent = document.getElementById("parent");
+        const subtreeAnimations = parent.getAnimations({ subtree: true });
+        println(`num animations without subtree: ${parent.getAnimations({ subtree: false }).length}`);
+        println(`num animations with subtree: ${subtreeAnimations.length}`);
+
+        for (let i = 0; i < elements.length; i++) {
+            const elem = document.getElementById(elements[i]);
+            const correctOrder = Object.is(subtreeAnimations[i], elem.getAnimations()[0]);
+            println(`Anim for element ${elements[i]} is in the correct order: ${correctOrder}`);
+        }
+    })
+</script>
diff --git a/Userland/Libraries/LibWeb/Animations/Animatable.cpp b/Userland/Libraries/LibWeb/Animations/Animatable.cpp
@@ -55,7 +55,7 @@ WebIDL::ExceptionOr<JS::NonnullGCPtr<Animation>> Animatable::animate(Optional<JS
 }
 
 // https://www.w3.org/TR/web-animations-1/#dom-animatable-getanimations
-Vector<JS::NonnullGCPtr<Animation>> Animatable::get_animations(Web::Animations::GetAnimationsOptions options)
+Vector<JS::NonnullGCPtr<Animation>> Animatable::get_animations(GetAnimationsOptions options)
 {
     // Returns the set of relevant animations for this object, or, if an options parameter is passed with subtree set to
     // true, returns the set of relevant animations for a subtree for this object.
@@ -71,15 +71,20 @@ Vector<JS::NonnullGCPtr<Animation>> Animatable::get_animations(Web::Animations::
         m_is_sorted_by_composite_order = true;
     }
 
-    // FIXME: Support subtree
-    (void)options;
-
     Vector<JS::NonnullGCPtr<Animation>> relevant_animations;
     for (auto const& animation : m_associated_animations) {
         if (animation->is_relevant())
             relevant_animations.append(*animation);
     }
 
+    if (options.subtree) {
+        JS::NonnullGCPtr target { *static_cast<DOM::Element*>(this) };
+        target->for_each_child_of_type<DOM::Element>([&](auto& child) {
+            relevant_animations.extend(child.get_animations(options));
+            return IterationDecision::Continue;
+        });
+    }
+
     return relevant_animations;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ WebIDL::ExceptionOr<JS::NonnullGCPtr<Animation>> Animatable::animate(Optional<JS`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`// https://www.w3.org/TR/web-animations-1/#dom-animatable-getanimations`
`58`		`-Vector<JS::NonnullGCPtr<Animation>> Animatable::get_animations(Web::Animations::GetAnimationsOptions options)`
	`58`	`+Vector<JS::NonnullGCPtr<Animation>> Animatable::get_animations(GetAnimationsOptions options)`
`59`	`59`	`{`
`60`	`60`	`// Returns the set of relevant animations for this object, or, if an options parameter is passed with subtree set to`
`61`	`61`	`// true, returns the set of relevant animations for a subtree for this object.`
`@@ -71,15 +71,20 @@ Vector<JS::NonnullGCPtr<Animation>> Animatable::get_animations(Web::Animations::`
`71`	`71`	`m_is_sorted_by_composite_order = true;`
`72`	`72`	`}`
`73`	`73`
`74`		`- // FIXME: Support subtree`
`75`		`- (void)options;`
`76`		`-`
`77`	`74`	`Vector<JS::NonnullGCPtr<Animation>> relevant_animations;`
`78`	`75`	`for (auto const& animation : m_associated_animations) {`
`79`	`76`	`if (animation->is_relevant())`
`80`	`77`	`relevant_animations.append(*animation);`
`81`	`78`	`}`
`82`	`79`
	`80`	`+ if (options.subtree) {`
	`81`	`+ JS::NonnullGCPtr target { static_cast<DOM::Element>(this) };`
	`82`	`+ target->for_each_child_of_type<DOM::Element>([&](auto& child) {`
	`83`	`+ relevant_animations.extend(child.get_animations(options));`
	`84`	`+ return IterationDecision::Continue;`
	`85`	`+ });`
	`86`	`+ }`
	`87`	`+`
`83`	`88`	`return relevant_animations;`
`84`	`89`	`}`
`85`	`90`