[view-transitions] Skip view transition on hidden pages

https://bugs.webkit.org/show_bug.cgi?id=271248 rdar://125017653 Reviewed by NOBODY (OOPS!). Follow: - https://drafts.csswg.org/css-view-transitions-1/#page-visibility-change-steps - w3c/csswg-drafts#9543 Add transition-in-hidden-page.html WPT from upstream. * LayoutTests/imported/w3c/web-platform-tests/css/css-view-transitions/transition-in-hidden-page-expected.txt: Added. * LayoutTests/imported/w3c/web-platform-tests/css/css-view-transitions/transition-in-hidden-page.html: Added. * LayoutTests/imported/w3c/web-platform-tests/css/css-view-transitions/window-resize-aborts-transition-before-ready-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/css/css-view-transitions/window-resize-aborts-transition-expected.txt: * Source/WebCore/dom/Document.cpp: (WebCore::Document::visibilityStateChanged): Make this more robust to allow unregistering clients while iterating. (WebCore::Document::startViewTransition): * Source/WebCore/dom/ViewTransition.cpp: (WebCore::ViewTransition::ViewTransition): (WebCore::ViewTransition::skipViewTransition): (WebCore::ViewTransition::stop): (WebCore::ViewTransition::visibilityStateChanged): * Source/WebCore/dom/ViewTransition.h:
nt1m · Jun 11, 2024 · 8481719 · 8481719
1 parent 258ed7a
commit 8481719
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 11 deletions.
diff --git a/...ed/w3c/web-platform-tests/css/css-view-transitions/transition-in-hidden-page-expected.txt b/...ed/w3c/web-platform-tests/css/css-view-transitions/transition-in-hidden-page-expected.txt
@@ -1,5 +1,8 @@
+CONSOLE MESSAGE: Unhandled Promise Rejection: InvalidStateError: View transition was skipped because document visibility state is hidden.
 
-FAIL A view transition should be immediately skipped if started when document is hidden assert_unreached: Should have rejected: undefined Reached unreachable code
-FAIL A view transition should be skipped when a document becomes hidden while processing update callback assert_equals: expected "rejected" but got "fulfilled"
-FAIL A view transition should be skipped when a document becomes hidden while animating assert_equals: expected "finished" but got "timeout"
+Harness Error (FAIL), message = Unhandled rejection: View transition was skipped because document visibility state is hidden.
+
+PASS A view transition should be immediately skipped if started when document is hidden
+PASS A view transition should be skipped when a document becomes hidden while processing update callback
+PASS A view transition should be skipped when a document becomes hidden while animating
 
diff --git a/...-tests/css/css-view-transitions/window-resize-aborts-transition-before-ready-expected.txt b/...-tests/css/css-view-transitions/window-resize-aborts-transition-before-ready-expected.txt
@@ -1,5 +1,5 @@
 
-PASS
+FAIL
 View transitions: Resizing viewport before animating rejects the ready promise.
-
+ assert_true: Transition must be skipped. expected true got false
 
diff --git a/.../web-platform-tests/css/css-view-transitions/window-resize-aborts-transition-expected.txt b/.../web-platform-tests/css/css-view-transitions/window-resize-aborts-transition-expected.txt
@@ -1,3 +1,10 @@
+CONSOLE MESSAGE: Unhandled Promise Rejection: InvalidStateError: View transition was skipped because document visibility state is hidden.
 
-PASS View transitions: Resizing viewport skips the transition
+Harness Error (FAIL), message = Unhandled rejection: View transition was skipped because document visibility state is hidden.
+
+TIMEOUT View transitions: Resizing viewport skips the transition Test timed out
+
+Harness Error (FAIL), message = Unhandled rejection: View transition was skipped because document visibility state is hidden.
+
+TIMEOUT View transitions: Resizing viewport skips the transition Test timed out
 
diff --git a/Source/WebCore/dom/Document.cpp b/Source/WebCore/dom/Document.cpp
@@ -2346,8 +2346,9 @@ void Document::visibilityStateChanged()
 {
     // https://w3c.github.io/page-visibility/#reacting-to-visibilitychange-changes
     queueTaskToDispatchEvent(TaskSource::UserInteraction, Event::create(eventNames().visibilitychangeEvent, Event::CanBubble::Yes, Event::IsCancelable::No));
-    for (auto& client : m_visibilityStateCallbackClients)
+    m_visibilityStateCallbackClients.forEach([](auto& client) {
         client.visibilityStateChanged();
+    });
 
 #if ENABLE(MEDIA_STREAM) && PLATFORM(IOS_FAMILY)
     if (auto mediaSessionManager = PlatformMediaSessionManager::sharedManagerIfExists()) {
@@ -10596,6 +10597,11 @@ RefPtr<ViewTransition> Document::startViewTransition(RefPtr<ViewTransitionUpdate
 
     Ref viewTransition = ViewTransition::create(*this, WTFMove(updateCallback));
 
+    if (hidden()) {
+        viewTransition->skipViewTransition(Exception { ExceptionCode::InvalidStateError, "View transition was skipped because document visibility state is hidden."_s });
+        return viewTransition;
+    }
+
     if (RefPtr activeViewTransition = m_activeViewTransition)
         activeViewTransition->skipViewTransition(Exception { ExceptionCode::AbortError, "Old view transition aborted by new view transition."_s });
 

diff --git a/Source/WebCore/dom/ViewTransition.cpp b/Source/WebCore/dom/ViewTransition.cpp
@@ -69,6 +69,7 @@ ViewTransition::ViewTransition(Document& document, RefPtr<ViewTransitionUpdateCa
     , m_updateCallbackDone(createPromiseAndWrapper(document))
     , m_finished(createPromiseAndWrapper(document))
 {
+    document.registerForVisibilityStateChangedCallbacks(*this);
 }
 
 ViewTransition::~ViewTransition() = default;
@@ -774,24 +775,34 @@ RenderViewTransitionCapture* ViewTransition::viewTransitionNewPseudoForCapturedE
     return nullptr;
 }
 
+void ViewTransition::visibilityStateChanged()
+{
+    if (!document())
+        return;
+
+    if (protectedDocument()->hidden() && protectedDocument()->activeViewTransition() == this)
+        skipViewTransition(Exception { ExceptionCode::InvalidStateError, "Skipping view transition because document visibility state has become hidden."_s });
+}
+
 void ViewTransition::stop()
 {
     if (!document())
         return;
 
     m_phase = ViewTransitionPhase::Done;
+    document()->unregisterForVisibilityStateChangedCallbacks(*this);
 
     if (document()->activeViewTransition() == this)
         clearViewTransition();
 }
 
 bool ViewTransition::documentElementIsCaptured() const
 {
-    RefPtr doc = document();
-    if (!doc)
+    RefPtr document = this->document();
+    if (!document)
         return false;
 
-    RefPtr documentElement = doc->documentElement();
+    RefPtr documentElement = document->documentElement();
     if (!documentElement)
         return false;
 

diff --git a/Source/WebCore/dom/ViewTransition.h b/Source/WebCore/dom/ViewTransition.h
@@ -34,6 +34,7 @@
 #include "MutableStyleProperties.h"
 #include "Styleable.h"
 #include "ViewTransitionUpdateCallback.h"
+#include "VisibilityChangeClient.h"
 #include <wtf/CheckedRef.h>
 #include <wtf/Ref.h>
 #include <wtf/text/AtomString.h>
@@ -132,7 +133,7 @@ struct OrderedNamedElementsMap {
     HashMap<AtomString, UniqueRef<CapturedElement>> m_map;
 };
 
-class ViewTransition : public RefCounted<ViewTransition>, public CanMakeWeakPtr<ViewTransition>, public ActiveDOMObject {
+class ViewTransition : public RefCounted<ViewTransition>, public VisibilityChangeClient, public ActiveDOMObject {
 public:
     static Ref<ViewTransition> create(Document&, RefPtr<ViewTransitionUpdateCallback>&&);
     ~ViewTransition();
@@ -180,6 +181,9 @@ class ViewTransition : public RefCounted<ViewTransition>, public CanMakeWeakPtr<
 
     void clearViewTransition();
 
+    // VisibilityChangeClient.
+    void visibilityStateChanged() final;
+
     // ActiveDOMObject.
     void stop() final;