From 9abe472928b8f4deb84b0ff20c70ea8740d09092 Mon Sep 17 00:00:00 2001
From: Matthew Olsson <matthewcolsson@gmail.com>
Date: Mon, 5 Feb 2024 20:18:00 -0700
Subject: [PATCH] LibWeb: Implement Animation.finish()

---
 .../Libraries/LibWeb/Animations/Animation.cpp | 65 +++++++++++++++++++
 .../Libraries/LibWeb/Animations/Animation.h   |  1 +
 .../Libraries/LibWeb/Animations/Animation.idl |  2 +-
 3 files changed, 67 insertions(+), 1 deletion(-)

diff --git a/Userland/Libraries/LibWeb/Animations/Animation.cpp b/Userland/Libraries/LibWeb/Animations/Animation.cpp
index f7fd8bb24d..33cfd8d7b0 100644
--- a/Userland/Libraries/LibWeb/Animations/Animation.cpp
+++ b/Userland/Libraries/LibWeb/Animations/Animation.cpp
@@ -359,6 +359,71 @@ void Animation::set_replace_state(Bindings::AnimationReplaceState value)
     }
 }
 
+// https://www.w3.org/TR/web-animations-1/#dom-animation-finish
+WebIDL::ExceptionOr<void> Animation::finish()
+{
+    // 1. If animation’s effective playback rate is zero, or if animation’s effective playback rate > 0 and associated
+    //    effect end is infinity, throw an "InvalidStateError" DOMException and abort these steps.
+    auto effective_playback_rate = this->effective_playback_rate();
+    if (effective_playback_rate == 0.0)
+        return WebIDL::InvalidStateError::create(realm(), "Animation with a playback rate of 0 cannot be finished"_fly_string);
+    if (effective_playback_rate > 0.0 && isinf(associated_effect_end()))
+        return WebIDL::InvalidStateError::create(realm(), "Animation with no end cannot be finished"_fly_string);
+
+    // 2. Apply any pending playback rate to animation.
+    apply_any_pending_playback_rate();
+
+    // 3. Set limit as follows:
+    //    -> If playback rate > 0,
+    //       Let limit be associated effect end.
+    //    -> Otherwise,
+    //       Let limit be zero.
+    auto playback_rate = this->playback_rate();
+    auto limit = playback_rate > 0.0 ? associated_effect_end() : 0.0;
+
+    // 4. Silently set the current time to limit.
+    TRY(silently_set_current_time(limit));
+
+    // 5. If animation’s start time is unresolved and animation has an associated active timeline, let the start time be
+    //    the result of evaluating timeline time - (limit / playback rate) where timeline time is the current time value
+    //    of the associated timeline.
+    if (!m_start_time.has_value() && m_timeline && !m_timeline->is_inactive())
+        m_start_time = m_timeline->current_time().value() - (limit / playback_rate);
+
+    // 6. If there is a pending pause task and start time is resolved,
+    auto should_resolve_ready_promise = false;
+    if (m_pending_pause_task == TaskState::Scheduled && m_start_time.has_value()) {
+        // 1. Let the hold time be unresolved.
+        // Note: Typically the hold time will already be unresolved except in the case when the animation was previously
+        //       idle.
+        m_hold_time = {};
+
+        // 2. Cancel the pending pause task.
+        m_pending_pause_task = TaskState::None;
+
+        // 3. Resolve the current ready promise of animation with animation.
+        should_resolve_ready_promise = true;
+    }
+
+    // 7. If there is a pending play task and start time is resolved, cancel that task and resolve the current ready
+    //    promise of animation with animation.
+    if (m_pending_play_task == TaskState::Scheduled && m_start_time.has_value()) {
+        m_pending_play_task = TaskState::None;
+        should_resolve_ready_promise = true;
+    }
+
+    if (should_resolve_ready_promise) {
+        HTML::TemporaryExecutionContext execution_context { Bindings::host_defined_environment_settings_object(realm()) };
+        WebIDL::resolve_promise(realm(), current_ready_promise(), this);
+    }
+
+    // 8. Run the procedure to update an animation’s finished state for animation with the did seek flag set to true,
+    //    and the synchronously notify flag set to true.
+    update_finished_state(DidSeek::Yes, SynchronouslyNotify::Yes);
+
+    return {};
+}
+
 // https://www.w3.org/TR/web-animations-1/#dom-animation-play
 WebIDL::ExceptionOr<void> Animation::play()
 {
diff --git a/Userland/Libraries/LibWeb/Animations/Animation.h b/Userland/Libraries/LibWeb/Animations/Animation.h
index 0f122b7feb..c8950e0f17 100644
--- a/Userland/Libraries/LibWeb/Animations/Animation.h
+++ b/Userland/Libraries/LibWeb/Animations/Animation.h
@@ -70,6 +70,7 @@ public:
         Yes,
         No,
     };
+    WebIDL::ExceptionOr<void> finish();
     WebIDL::ExceptionOr<void> play();
     WebIDL::ExceptionOr<void> play_an_animation(AutoRewind);
     WebIDL::ExceptionOr<void> pause();
diff --git a/Userland/Libraries/LibWeb/Animations/Animation.idl b/Userland/Libraries/LibWeb/Animations/Animation.idl
index 1ecb3a9387..a73ffe557d 100644
--- a/Userland/Libraries/LibWeb/Animations/Animation.idl
+++ b/Userland/Libraries/LibWeb/Animations/Animation.idl
@@ -25,7 +25,7 @@ interface Animation : EventTarget {
     // FIXME: attribute EventHandler onremove;
 
     // FIXME: undefined cancel();
-    // FIXME: undefined finish();
+    undefined finish();
     undefined play();
     undefined pause();
     // FIXME: undefined updatePlaybackRate(double playbackRate);