From c95bd9d052d7eae378d31c5be0f92669cadb2c85 Mon Sep 17 00:00:00 2001
From: Mukilan Thiyagarajan <mukilan@igalia.com>
Date: Thu, 13 Feb 2025 14:34:41 +0530
Subject: [PATCH] libservo: change 'request_fullscreen_state_change' API to a
 notification (#35445)

Signed-off-by: Mukilan Thiyagarajan <mukilan@igalia.com>
---
 components/constellation/tracing.rs   | 4 +++-
 components/script/dom/document.rs     | 4 ++--
 components/servo/lib.rs               | 4 ++--
 components/servo/webview_delegate.rs  | 9 ++++++---
 components/shared/embedder/lib.rs     | 8 +++++---
 ports/servoshell/desktop/app_state.rs | 2 +-
 6 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/components/constellation/tracing.rs b/components/constellation/tracing.rs
index bccfdf17b90..78ac8ae8fd9 100644
--- a/components/constellation/tracing.rs
+++ b/components/constellation/tracing.rs
@@ -220,7 +220,9 @@ mod from_script {
                 Self::SetCursor(..) => target_variant!("SetCursor"),
                 Self::NewFavicon(..) => target_variant!("NewFavicon"),
                 Self::HistoryChanged(..) => target_variant!("HistoryChanged"),
-                Self::SetFullscreenState(..) => target_variant!("SetFullscreenState"),
+                Self::NotifyFullscreenStateChanged(..) => {
+                    target_variant!("NotifyFullscreenStateChanged")
+                },
                 Self::NotifyLoadStatusChanged(_, LoadStatus::Started) => {
                     target_variant!("NotifyLoadStatusChanged(LoadStatus::Started)")
                 },
diff --git a/components/script/dom/document.rs b/components/script/dom/document.rs
index be6ee41e599..497decca433 100644
--- a/components/script/dom/document.rs
+++ b/components/script/dom/document.rs
@@ -4250,7 +4250,7 @@ impl Document {
         let window = self.window();
         // Step 6
         if !error {
-            let event = EmbedderMsg::SetFullscreenState(self.webview_id(), true);
+            let event = EmbedderMsg::NotifyFullscreenStateChanged(self.webview_id(), true);
             self.send_to_embedder(event);
         }
 
@@ -4292,7 +4292,7 @@ impl Document {
 
         let window = self.window();
         // Step 8
-        let event = EmbedderMsg::SetFullscreenState(self.webview_id(), false);
+        let event = EmbedderMsg::NotifyFullscreenStateChanged(self.webview_id(), false);
         self.send_to_embedder(event);
 
         // Step 9
diff --git a/components/servo/lib.rs b/components/servo/lib.rs
index 6c62e22cb18..1e8f89d9b66 100644
--- a/components/servo/lib.rs
+++ b/components/servo/lib.rs
@@ -871,11 +871,11 @@ impl Servo {
                     webview.set_url(current_url);
                 }
             },
-            EmbedderMsg::SetFullscreenState(webview_id, fullscreen) => {
+            EmbedderMsg::NotifyFullscreenStateChanged(webview_id, fullscreen) => {
                 if let Some(webview) = self.get_webview_handle(webview_id) {
                     webview
                         .delegate()
-                        .request_fullscreen_state_change(webview, fullscreen);
+                        .notify_fullscreen_state_changed(webview, fullscreen);
                 }
             },
             EmbedderMsg::WebResourceRequested(
diff --git a/components/servo/webview_delegate.rs b/components/servo/webview_delegate.rs
index 204eaf2f4d7..c84ef699647 100644
--- a/components/servo/webview_delegate.rs
+++ b/components/servo/webview_delegate.rs
@@ -188,6 +188,12 @@ pub trait WebViewDelegate {
     /// Notifies the embedder about media session events
     /// (i.e. when there is metadata for the active media session, playback state changes...).
     fn notify_media_session_event(&self, _webview: WebView, _event: MediaSessionEvent) {}
+    /// A notification that the [`WebView`] has entered or exited fullscreen mode. This is an
+    /// opportunity for the embedder to transition the containing window into or out of fullscreen
+    /// mode and to show or hide extra UI elements. Regardless of how the notification is handled,
+    /// the page will enter or leave fullscreen state internally according to the [Fullscreen
+    /// API](https://fullscreen.spec.whatwg.org/).
+    fn notify_fullscreen_state_changed(&self, _webview: WebView, _: bool) {}
 
     /// Whether or not to allow a [`WebView`] to load a URL in its main frame or one of its
     /// nested `<iframe>`s. [`NavigationRequest`]s are accepted by default.
@@ -239,9 +245,6 @@ pub trait WebViewDelegate {
         let _ = result_sender.send(ContextMenuResult::Ignored);
     }
 
-    /// Enter or exit fullscreen
-    fn request_fullscreen_state_change(&self, _webview: WebView, _: bool) {}
-
     /// Open dialog to select bluetooth device.
     /// TODO: This API needs to be reworked to match the new model of how responses are sent.
     fn show_bluetooth_device_dialog(
diff --git a/components/shared/embedder/lib.rs b/components/shared/embedder/lib.rs
index 66d70539e30..5d4bbc020fc 100644
--- a/components/shared/embedder/lib.rs
+++ b/components/shared/embedder/lib.rs
@@ -209,8 +209,8 @@ pub enum EmbedderMsg {
     NewFavicon(WebViewId, ServoUrl),
     /// The history state has changed.
     HistoryChanged(WebViewId, Vec<ServoUrl>, usize),
-    /// Enter or exit fullscreen
-    SetFullscreenState(WebViewId, bool),
+    /// Entered or exited fullscreen.
+    NotifyFullscreenStateChanged(WebViewId, bool),
     /// The [`LoadStatus`] of the Given `WebView` has changed.
     NotifyLoadStatusChanged(WebViewId, LoadStatus),
     WebResourceRequested(
@@ -277,7 +277,9 @@ impl Debug for EmbedderMsg {
             EmbedderMsg::SetCursor(..) => write!(f, "SetCursor"),
             EmbedderMsg::NewFavicon(..) => write!(f, "NewFavicon"),
             EmbedderMsg::HistoryChanged(..) => write!(f, "HistoryChanged"),
-            EmbedderMsg::SetFullscreenState(..) => write!(f, "SetFullscreenState"),
+            EmbedderMsg::NotifyFullscreenStateChanged(..) => {
+                write!(f, "NotifyFullscreenStateChanged")
+            },
             EmbedderMsg::NotifyLoadStatusChanged(_, status) => {
                 write!(f, "NotifyLoadStatusChanged({status:?})")
             },
diff --git a/ports/servoshell/desktop/app_state.rs b/ports/servoshell/desktop/app_state.rs
index a6a2ff8302f..2f4a7d8adee 100644
--- a/ports/servoshell/desktop/app_state.rs
+++ b/ports/servoshell/desktop/app_state.rs
@@ -473,7 +473,7 @@ impl WebViewDelegate for RunningAppState {
         self.inner_mut().need_update = true;
     }
 
-    fn request_fullscreen_state_change(&self, _webview: servo::WebView, fullscreen_state: bool) {
+    fn notify_fullscreen_state_changed(&self, _webview: servo::WebView, fullscreen_state: bool) {
         self.inner().window.set_fullscreen(fullscreen_state);
     }