Adds DevTools commands for forced viewport override.

third_party/WebKit/Source/web/DevToolsEmulator.cpp

 // Copyright 2015 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 "web/DevToolsEmulator.h"
 
 #include "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/Settings.h"
 #include "core/frame/VisualViewport.h"
 #include "core/page/Page.h"
 #include "core/style/ComputedStyle.h"
 #include "platform/RuntimeEnabledFeatures.h"
+#include "platform/geometry/FloatRect.h"
 #include "public/platform/WebLayerTreeView.h"
 #include "web/WebInputEventConversion.h"
 #include "web/WebLocalFrameImpl.h"
 #include "web/WebSettingsImpl.h"
 #include "web/WebViewImpl.h"
 #include "wtf/PtrUtil.h"
 
 namespace {
 
 static float calculateDeviceScaleAdjustment(int width, int height, float deviceScaleFactor)
@@ skipping 188 matching lines @@
     }
 
     m_webViewImpl->page()->settings().setDeviceScaleAdjustment(calculateDeviceScaleAdjustment(params.viewSize.width, params.viewSize.height, params.deviceScaleFactor));
 
     if (params.screenPosition == WebDeviceEmulationParams::Mobile)
         enableMobileEmulation();
     else
         disableMobileEmulation();
 
     m_webViewImpl->setCompositorDeviceScaleFactorOverride(params.deviceScaleFactor);
-    m_webViewImpl->setRootLayerTransform(WebSize(params.offset.x, params.offset.y), params.scale);
+    updateRootLayerTransform();
     // TODO(dgozman): mainFrameImpl() is null when it's remote. Figure out how
     // we end up with enabling emulation in this case.
     if (m_webViewImpl->mainFrameImpl()) {
         if (Document* document = m_webViewImpl->mainFrameImpl()->frame()->document())
             document->mediaQueryAffectingValueChanged();
     }
 }
 
 void DevToolsEmulator::disableDeviceEmulation()
 {
     if (!m_deviceMetricsEnabled)
         return;
 
     m_deviceMetricsEnabled = false;
     m_webViewImpl->setBackgroundColorOverride(Color::transparent);
     m_webViewImpl->page()->settings().setDeviceScaleAdjustment(m_embedderDeviceScaleAdjustment);
     disableMobileEmulation();
     m_webViewImpl->setCompositorDeviceScaleFactorOverride(0.f);
-    m_webViewImpl->setRootLayerTransform(WebSize(0.f, 0.f), 1.f);
     m_webViewImpl->setPageScaleFactor(1.f);
+    updateRootLayerTransform();
     // mainFrameImpl() could be null during cleanup or remote <-> local swap.
     if (m_webViewImpl->mainFrameImpl()) {
         if (Document* document = m_webViewImpl->mainFrameImpl()->frame()->document())
             document->mediaQueryAffectingValueChanged();
     }
 }
 
 bool DevToolsEmulator::resizeIsDeviceSizeChange()
 {
     return m_deviceMetricsEnabled && m_emulateMobileEnabled;
@@ skipping 59 matching lines @@
     m_webViewImpl->setZoomFactorOverride(0);
     m_emulateMobileEnabled = false;
     m_webViewImpl->setDefaultPageScaleLimits(
         m_originalDefaultMinimumPageScaleFactor,
         m_originalDefaultMaximumPageScaleFactor);
     // mainFrameImpl() could be null during cleanup or remote <-> local swap.
     if (m_webViewImpl->mainFrameImpl())
         m_webViewImpl->mainFrameImpl()->frameView()->layout();
 }
 
+void DevToolsEmulator::setVisualTransformOverride(const WebFloatRect& area, float scale)
+{
+    if (!m_visualTransformOverride)
+        m_visualTransformOverride = VisualTransformOverride();
+
+    m_visualTransformOverride->area = area;
+    m_visualTransformOverride->scale = scale;
+
+    // Ensure that all content inside the area is painted.
+    if (m_webViewImpl->mainFrameImpl())
+        m_webViewImpl->mainFrameImpl()->frameView()->setVisibleContentRectForPainting(enclosingIntRect(area));

[chrishtr, 2016/08/12 20:56:22]

Why can't this be accomplished by changing the width and height of the frame?

[Eric Seckler, 2016/08/12 21:37:53]

I don't think width&height would suffice, since we may be translating to a
different area of the page than the current scroll offset. Anyway, the reason we
discarded frame (or viewport) repositioning/resizing is that we don't want the
page to be able to observe or interfere with our screenshotting process.
Instead, we'd like to be able to set frame size and position independently of
the screenshot area, so that we can control e.g. layout size and where fixed-pos
elements turn up. AFAICT, there's no way of changing frame size and/or scroll
offset without it affecting the page?

(We actually looked into realizing the screenshots through changing
frame+VisualViewport size/position and page scale first, and discarded the idea
because we'd have needed web-contract-breaking overrides for these - plus the
changes in size and scroll position would have been visible to the page.)

[chrishtr, 2016/08/12 21:41:36]

Why would you want it to be different than the current scroll offset? Sounds
like you want to record somewhere in the document,
and render the entire document. Frame size and scroll offset are just getting in
your way?

Also, did you consider using a viewport size that is the entire document? It's
maybe not crazy to do that for just the display list output of paint.

[Eric Seckler, 2016/08/12 21:55:36]

We want to record+render only the screenshot area, which could be smaller than
the frame (e.g. a single advert) or larger (e.g. the whole page). We'd like to
avoid
having to paint the whole document to screenshot a small area though.

For more background on our use case, see bit.ly/sized-screenshots. boliu@ also
mentioned that Android-WebView's record_whole_document can be rather slow, so
we'd like to avoid something similar, see discussion on
https://groups.google.com/a/chromium.org/forum/#!search/Screenshots$20for$20H...
.

[chrishtr, 2016/08/12 22:03:43]

Is the objection to scrolling to the desired area that the site could do
something adversarial when noticing we did that?

[Eric Seckler, 2016/08/12 22:15:46]

Correct. Javascript can listen for scroll events and/or issue window.scrollTo(),
which is why we'd have to actually override things, rather than set once. This
affects both visual viewport & frame scroll positions. If changing the frame
size, fixed-pos elements will be placed elsewhere (i.e. could obscure the
screenshot area). The page can also see changes in frame or visual viewport
size/scale through window.innerWidth/Height and react to them.

That's why we pivoted towards a solution that separates screenshot
translation/scale/size from frame/viewport state. We don't actually want to
change how/where elements in the frame get painted, just which ones, so that
they a) show up in the screenshot and b) we don't paint more than necessary :)

+
+    // Disable clipping on the visual viewport layer, to ensure the whole area is painted.
+    GraphicsLayer* containerLayer = m_webViewImpl->page()->frameHost().visualViewport().containerLayer();
+    if (containerLayer) {
+        m_visualTransformOverride->originalVisualViewportMasking = containerLayer->masksToBounds();
+        containerLayer->setMasksToBounds(false);
+    }
+
+    // Move the correct (scaled) content area to show in the top left of the
+    // CompositorFrame via the root transform.
+    updateRootLayerTransform();
+}
+
+void DevToolsEmulator::clearVisualTransformOverride()
+{
+    if (!m_visualTransformOverride)
+        return;
+
+    bool originalMasking = m_visualTransformOverride->originalVisualViewportMasking;
+    m_visualTransformOverride = WTF::nullopt;
+
+    // Restore original state.
+    if (m_webViewImpl->mainFrameImpl())
+        m_webViewImpl->mainFrameImpl()->frameView()->resetVisibleContentRectForPainting();
+    GraphicsLayer* containerLayer = m_webViewImpl->page()->frameHost().visualViewport().containerLayer();
+    if (containerLayer)
+        containerLayer->setMasksToBounds(originalMasking);
+    updateRootLayerTransform();
+}
+
+void DevToolsEmulator::mainFrameScrollOrScaleChanged()
+{
+    // Visual transform override has to take current page scale and scroll
+    // offset into account. Update the transform if override is active.
+    if (m_visualTransformOverride)
+        updateRootLayerTransform();
+}
+
+void DevToolsEmulator::applyDeviceEmulationTransform(TransformationMatrix* transform)
+{
+    if (m_deviceMetricsEnabled) {
+        WebSize offset(m_emulationParams.offset.x, m_emulationParams.offset.y);
+        // Scale first, so that translation is unaffected.
+        transform->translate(offset.width, offset.height);
+        transform->scale(m_emulationParams.scale);
+        if (m_webViewImpl->mainFrameImpl())
+            m_webViewImpl->mainFrameImpl()->setInputEventsTransformForEmulation(offset, m_emulationParams.scale);
+    } else {
+        if (m_webViewImpl->mainFrameImpl())
+            m_webViewImpl->mainFrameImpl()->setInputEventsTransformForEmulation(WebSize(0, 0), 1.0);
+    }
+}
+
+void DevToolsEmulator::applyVisualTransformOverride(TransformationMatrix* transform)
+{
+    if (!m_visualTransformOverride)
+        return;
+
+    // Transform operations follow in reverse application.
+    // Last, scale positioned area according to override.
+    transform->scale(m_visualTransformOverride->scale);
+
+    // Translate while taking into account current scroll offset.
+    WebSize scrollOffset = m_webViewImpl->mainFrame()->scrollOffset();
+    WebFloatPoint visualOffset = m_webViewImpl->visualViewportOffset();
+    float scrollX = scrollOffset.width + visualOffset.x;
+    float scrollY = scrollOffset.height + visualOffset.y;
+    transform->translate(
+        -m_visualTransformOverride->area.x + scrollX,
+        -m_visualTransformOverride->area.y + scrollY);
+
+    // First, reverse page scale, so we don't have to take it into account for
+    // calculation of the translation.
+    transform->scale(1. / m_webViewImpl->pageScaleFactor());
+}
+
+void DevToolsEmulator::updateRootLayerTransform()
+{
+    TransformationMatrix transform;
+
+    // Apply device emulation transform first, so that it is affected by the
+    // visual transform override.
+    applyVisualTransformOverride(&transform);
+    applyDeviceEmulationTransform(&transform);
+
+    m_webViewImpl->setRootLayerTransform(transform);
+}
+
 void DevToolsEmulator::setTouchEventEmulationEnabled(bool enabled)
 {
     if (m_touchEventEmulationEnabled == enabled)
         return;
     if (!m_touchEventEmulationEnabled) {
         m_originalTouchEnabled = RuntimeEnabledFeatures::touchEnabled();
         m_originalDeviceSupportsMouse = m_webViewImpl->page()->settings().deviceSupportsMouse();
         m_originalDeviceSupportsTouch = m_webViewImpl->page()->settings().deviceSupportsTouch();
         m_originalMaxTouchPoints = m_webViewImpl->page()->settings().maxTouchPoints();
     }
@@ skipping 50 matching lines @@
             m_lastPinchAnchorCss.reset();
             m_lastPinchAnchorDip.reset();
         }
         return true;
     }
 
     return false;
 }
 
 } // namespace blink