Fire visibilityChange event on out-of-process iframes.

content/renderer/render_view_impl.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "content/renderer/render_view_impl.h"
 
 #include <algorithm>
 #include <cmath>
 #include <memory>
 
@@ skipping 1318 matching lines @@
                         OnSetHistoryOffsetAndLength)
     IPC_MESSAGE_HANDLER(ViewMsg_ReleaseDisambiguationPopupBitmap,
                         OnReleaseDisambiguationPopupBitmap)
     IPC_MESSAGE_HANDLER(ViewMsg_ForceRedraw, OnForceRedraw)
     IPC_MESSAGE_HANDLER(ViewMsg_SelectWordAroundCaret, OnSelectWordAroundCaret)
 
     // Page messages.
     IPC_MESSAGE_HANDLER(PageMsg_UpdateWindowScreenRect,
                         OnUpdateWindowScreenRect)
     IPC_MESSAGE_HANDLER(PageMsg_SetZoomLevel, OnSetZoomLevel)
+    IPC_MESSAGE_HANDLER(PageMsg_WasHidden, OnPageWasHidden)
+    IPC_MESSAGE_HANDLER(PageMsg_WasShown, OnPageWasShown)
+
 #if defined(OS_ANDROID)
     IPC_MESSAGE_HANDLER(ViewMsg_UpdateTopControlsState,
                         OnUpdateTopControlsState)
     IPC_MESSAGE_HANDLER(ViewMsg_ExtractSmartClipData, OnExtractSmartClipData)
 #elif defined(OS_MACOSX)
     IPC_MESSAGE_HANDLER(ViewMsg_GetRenderedText,
                         OnGetRenderedText)
     IPC_MESSAGE_HANDLER(ViewMsg_Close, OnClose)
 #endif
     // Adding a new message? Add platform independent ones first, then put the
@@ skipping 955 matching lines @@
 }
 
 int RenderViewImpl::GetEnabledBindings() const {
   return enabled_bindings_;
 }
 
 bool RenderViewImpl::GetContentStateImmediately() const {
   return send_content_state_immediately_;
 }
 
-blink::WebPageVisibilityState RenderViewImpl::GetVisibilityState() const {
-  return visibilityState();
-}
-
 void RenderViewImpl::DidStartLoading() {
   main_render_frame_->didStartLoading(true);
 }
 
 void RenderViewImpl::DidStopLoading() {
   main_render_frame_->didStopLoading();
 }
 
 blink::WebElement RenderViewImpl::GetFocusedElement() const {
   if (!webview())
@@ skipping 442 matching lines @@
 void RenderViewImpl::Close() {
   // We need to grab a pointer to the doomed WebView before we destroy it.
   WebView* doomed = webview_;
   RenderWidget::Close();
   webview_ = nullptr;
   g_view_map.Get().erase(doomed);
   g_routing_id_view_map.Get().erase(GetRoutingID());
   RenderThread::Get()->Send(new ViewHostMsg_Close_ACK(GetRoutingID()));
 }
 
-void RenderViewImpl::OnWasHidden() {
-  RenderWidget::OnWasHidden();
-
+void RenderViewImpl::OnPageWasHidden() {
 #if defined(OS_ANDROID) && defined(ENABLE_WEBRTC)
   RenderThreadImpl::current()->video_capture_impl_manager()->
       SuspendDevices(true);
   if (speech_recognition_dispatcher_)
     speech_recognition_dispatcher_->AbortAllRecognitions();
 #endif
 
-  if (webview())
-    webview()->setVisibilityState(visibilityState(), false);
+  if (webview()) {
+    blink::WebPageVisibilityState visibilityState =
+        GetMainRenderFrame() ? GetMainRenderFrame()->visibilityState()

[kenrb, 2016/05/24 20:25:18]

Why do we defer to the main frame's visibility state for the RenderViewImpl in
the top-level frame's renderer? It looks like they should always match, since
the top RWHV will get a Hide message immediately before the PageMsg_WasHidden,
but in future when RenderWidget is separated from RenderView this seems like it
would be wrong.

[lfg, 2016/05/24 23:33:50]

This is a bit tricky to fix, it's not as simple as tracking separately the
visibility for the view. The only thing that overrides the visibilityState is
prerender, which does by looking up the frame, and I can't fully split the
visibility without fixing prerender to make it OOPIF-aware.

Note that I just moved the code that was implicitly done in
RenderViewImpl::visibilityState() before. Would it be ok to just add a TODO
here?

[kenrb, 2016/05/25 20:29:14]

I agree it should work fine as is, but I think this becomes a race condition
when RenderWidget and RenderView get split. It is reasonable to file a bug for
this and make it a blocker for that work (if you I'm right about the race).

[lfg, 2016/05/31 19:54:01]

I've added a TODO with a link to the prerendering bug, since fixing prerendering
is the proper way of handling this.

+                             : blink::WebPageVisibilityStateHidden;
+    webview()->setVisibilityState(visibilityState, false);
+  }
 }
 
-void RenderViewImpl::OnWasShown(bool needs_repainting,
-                                const ui::LatencyInfo& latency_info) {
-  RenderWidget::OnWasShown(needs_repainting, latency_info);
-
+void RenderViewImpl::OnPageWasShown() {
 #if defined(OS_ANDROID) && defined(ENABLE_WEBRTC)
   RenderThreadImpl::current()->video_capture_impl_manager()->
       SuspendDevices(false);
 #endif
 
-  if (webview())
-    webview()->setVisibilityState(visibilityState(), false);
+  if (webview()) {
+    blink::WebPageVisibilityState visibilityState =
+        GetMainRenderFrame() ? GetMainRenderFrame()->visibilityState()
+                             : blink::WebPageVisibilityStateVisible;
+    webview()->setVisibilityState(visibilityState, false);
+  }
 }
 
 GURL RenderViewImpl::GetURLForGraphicsContext3D() {
   DCHECK(webview());
   if (webview()->mainFrame()->isWebLocalFrame())
     return GURL(webview()->mainFrame()->document().url());
   else
     return GURL("chrome://gpu/RenderViewImpl::CreateGraphicsContext3D");
 }
 
@@ skipping 256 matching lines @@
 
 double RenderViewImpl::zoomLevelToZoomFactor(double zoom_level) const {
   return ZoomLevelToZoomFactor(zoom_level);
 }
 
 double RenderViewImpl::zoomFactorToZoomLevel(double factor) const {
   return ZoomFactorToZoomLevel(factor);
 }
 
 blink::WebPageVisibilityState RenderViewImpl::visibilityState() const {
-  blink::WebPageVisibilityState current_state = is_hidden() ?
-      blink::WebPageVisibilityStateHidden :
-      blink::WebPageVisibilityStateVisible;
-  blink::WebPageVisibilityState override_state = current_state;
-  // TODO(jam): move this method to WebFrameClient.
-  if (GetContentClient()->renderer()->
-          ShouldOverridePageVisibilityState(main_render_frame_,
-                                            &override_state))
-    return override_state;
-  return current_state;
+  // This method should only be used to determine initial visibility.

[kenrb, 2016/05/24 20:25:18]

This comment isn't very clear, what does 'initial visibility' mean exactly? And
should the comment be moved to the declaration in WebViewClient.h, since it is
relevant to callers of the method?

[lfg, 2016/05/24 23:33:51]

Perhaps it should be moved. When the WebViewImpl is created, there's no main
frame created yet, and we must provide the WebView with an initial
WebPageVisibilityState. This initial visibility is set by calling
WebViewImpl::setVisibilityState() with 'true' on the second argument. Subsequent
calls to setVisibilityState() will only trigger a visibilityChange event if the
new visibility state is different from the previous one.

I was afraid of changing the initial visibility to be only executed after the
main frame is created. since there's a lot of stuff that happens between those
two states, but I could give it a try. WDYT?

[kenrb, 2016/05/25 20:29:14]

Now, that I understand this better, I'm not sure if there is a good reason to
change that. Would it simplify anything?

[lfg, 2016/05/31 19:54:01]

Yes, we would be able to remove visibilityState() from WebViewClient. I'll try
to do that, but I'll do in a separate patch.

+  DCHECK(!main_render_frame_);
+  return is_hidden() ? blink::WebPageVisibilityStateHidden
+                     : blink::WebPageVisibilityStateVisible;
 }
 
 void RenderViewImpl::draggableRegionsChanged() {
   FOR_EACH_OBSERVER(
       RenderViewObserver,
       observers_,
       DraggableRegionsChanged(webview()->mainFrame()));
 }
 
 void RenderViewImpl::pageImportanceSignalsChanged() {
@@ skipping 285 matching lines @@
         return render_frame->focused_pepper_plugin();
     }
     frame = frame->traverseNext(false);
   }
 
   return nullptr;
 }
 #endif
 
 }  // namespace content