Use scroll-boundary-behavior to control overscroll-refresh/glow on android.

content/browser/android/overscroll_controller_android_unittest.cc

+// Copyright 2017 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/browser/android/overscroll_controller_android.h"
+#include <memory>
+#include "base/macros.h"
+#include "base/memory/ptr_util.h"
+#include "cc/layers/layer.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "ui/android/overscroll_glow.h"
+#include "ui/android/overscroll_refresh.h"
+#include "ui/android/resources/resource_manager_impl.h"
+#include "ui/android/window_android_compositor.h"
+#include "ui/events/blink/did_overscroll_params.h"
+
+using ui::EdgeEffectBase;
+using ui::ResourceManager;
+using ui::OverscrollGlow;
+using ui::OverscrollGlowClient;
+using ui::OverscrollRefresh;
+using ui::WindowAndroidCompositor;
+using ::testing::_;
+using ::testing::Return;
+
+namespace content {
+
+namespace {
+
+class MockCompositor : public WindowAndroidCompositor {
+ public:
+  void AttachLayerForReadback(scoped_refptr<cc::Layer>) override {}
+  void RequestCopyOfOutputOnRootLayer(
+      std::unique_ptr<viz::CopyOutputRequest>) override {}
+  void SetNeedsAnimate() override {}
+  MOCK_METHOD0(GetResourceManager, ResourceManager&());
+  MOCK_METHOD0(GetFrameSinkId, viz::FrameSinkId());
+  void AddChildFrameSink(const viz::FrameSinkId& frame_sink_id) override {}
+  void RemoveChildFrameSink(const viz::FrameSinkId& frame_sink_id) override {}
+};
+
+class MockGlowClient : public OverscrollGlowClient {
+ public:
+  MOCK_METHOD0(CreateEdgeEffect, std::unique_ptr<EdgeEffectBase>());
+};
+
+class MockGlow : public OverscrollGlow {
+ public:
+  MockGlow() : OverscrollGlow(new MockGlowClient()) {}
+  MOCK_METHOD5(OnOverscrolled,
+               bool(base::TimeTicks,
+                    gfx::Vector2dF,
+                    gfx::Vector2dF,
+                    gfx::Vector2dF,
+                    gfx::Vector2dF));
+};
+
+class MockRefresh : public OverscrollRefresh {
+ public:
+  MockRefresh() : OverscrollRefresh() {}
+  MOCK_METHOD0(OnOverscrolled, void());
+  MOCK_METHOD0(Reset, void());
+  MOCK_CONST_METHOD0(IsActive, bool());
+  MOCK_CONST_METHOD0(IsAwaitingScrollUpdateAck, bool());
+};
+
+class OverscrollControllerAndroidUnitTest : public testing::Test {
+ public:
+  OverscrollControllerAndroidUnitTest() {
+    std::unique_ptr<MockGlow> glow_ptr = base::MakeUnique<MockGlow>();
+    std::unique_ptr<MockRefresh> refresh_ptr = base::MakeUnique<MockRefresh>();
+    compositor_ = base::MakeUnique<MockCompositor>();
+    glow_ = glow_ptr.get();
+    refresh_ = refresh_ptr.get();
+    controller_ = OverscrollControllerAndroid::CreateForTests(
+        compositor_.get(), 560, std::move(glow_ptr), std::move(refresh_ptr));
+  }
+
+  ui::DidOverscrollParams CreateVerticalOverscrollParams() {
+    ui::DidOverscrollParams params;
+    params.accumulated_overscroll = gfx::Vector2dF(0, 1);
+    params.latest_overscroll_delta = gfx::Vector2dF(0, 1);
+    params.current_fling_velocity = gfx::Vector2dF(0, 1);
+    params.causal_event_viewport_point = gfx::PointF(100, 100);
+    return params;
+  }
+
+ protected:
+  MockGlow* glow_;
+  MockRefresh* refresh_;
+  std::unique_ptr<MockCompositor> compositor_;
+  std::unique_ptr<OverscrollControllerAndroid> controller_;
+};
+
+TEST_F(OverscrollControllerAndroidUnitTest,
+       ScrollBoundaryBehaviorAutoAllowsGlowAndNavigation) {
+  ui::DidOverscrollParams params = CreateVerticalOverscrollParams();
+  params.scroll_boundary_behavior.y = cc::ScrollBoundaryBehavior::
+      ScrollBoundaryBehaviorType::kScrollBoundaryBehaviorTypeAuto;
+
+  EXPECT_CALL(*refresh_, OnOverscrolled());
+  EXPECT_CALL(*refresh_, IsActive()).WillOnce(Return(true));
+  EXPECT_CALL(*refresh_, IsAwaitingScrollUpdateAck()).Times(0);
+  EXPECT_CALL(*glow_, OnOverscrolled(_, _, _, _, _)).Times(0);
+
+  controller_->OnOverscrolled(params);
+  testing::Mock::VerifyAndClearExpectations(&refresh_);
+}
+
+TEST_F(OverscrollControllerAndroidUnitTest,
+       ScrollBoundaryBehaviorContainPreventsNavigation) {
+  ui::DidOverscrollParams params = CreateVerticalOverscrollParams();
+  params.scroll_boundary_behavior.y = cc::ScrollBoundaryBehavior::
+      ScrollBoundaryBehaviorType::kScrollBoundaryBehaviorTypeContain;
+
+  EXPECT_CALL(*refresh_, OnOverscrolled()).Times(0);
+  EXPECT_CALL(*refresh_, Reset());
+  EXPECT_CALL(*refresh_, IsActive()).WillOnce(Return(false));
+  EXPECT_CALL(*refresh_, IsAwaitingScrollUpdateAck()).WillOnce(Return(false));
+  EXPECT_CALL(*glow_,
+              OnOverscrolled(_, gfx::Vector2dF(0, 560), gfx::Vector2dF(0, 560),
+                             gfx::Vector2dF(0, 560), _));
+
+  controller_->OnOverscrolled(params);
+  testing::Mock::VerifyAndClearExpectations(refresh_);
+  testing::Mock::VerifyAndClearExpectations(glow_);
+
+  // Test that the "contain" set on x-axis would not affect navigation.
+  params.scroll_boundary_behavior.y = cc::ScrollBoundaryBehavior::
+      ScrollBoundaryBehaviorType::kScrollBoundaryBehaviorTypeAuto;
+  params.scroll_boundary_behavior.x = cc::ScrollBoundaryBehavior::
+      ScrollBoundaryBehaviorType::kScrollBoundaryBehaviorTypeContain;
+
+  EXPECT_CALL(*refresh_, OnOverscrolled());
+  EXPECT_CALL(*refresh_, Reset()).Times(0);
+  EXPECT_CALL(*refresh_, IsActive()).WillOnce(Return(true));
+  EXPECT_CALL(*refresh_, IsAwaitingScrollUpdateAck()).Times(0);
+  EXPECT_CALL(*glow_, OnOverscrolled(_, _, _, _, _)).Times(0);
+
+  controller_->OnOverscrolled(params);
+  testing::Mock::VerifyAndClearExpectations(refresh_);
+  testing::Mock::VerifyAndClearExpectations(glow_);
+}
+
+TEST_F(OverscrollControllerAndroidUnitTest,
+       ScrollBoundaryBehaviorNonePreventsNavigationAndGlow) {
+  ui::DidOverscrollParams params = CreateVerticalOverscrollParams();
+  params.scroll_boundary_behavior.y = cc::ScrollBoundaryBehavior::
+      ScrollBoundaryBehaviorType::kScrollBoundaryBehaviorTypeNone;
+
+  EXPECT_CALL(*refresh_, OnOverscrolled()).Times(0);
+  EXPECT_CALL(*refresh_, Reset());
+  EXPECT_CALL(*refresh_, IsActive()).WillOnce(Return(false));
+  EXPECT_CALL(*refresh_, IsAwaitingScrollUpdateAck()).WillOnce(Return(false));
+  EXPECT_CALL(*glow_, OnOverscrolled(_, gfx::Vector2dF(), gfx::Vector2dF(),
+                                     gfx::Vector2dF(), _));
+
+  controller_->OnOverscrolled(params);
+  testing::Mock::VerifyAndClearExpectations(refresh_);
+  testing::Mock::VerifyAndClearExpectations(glow_);
+
+  // Test that the "none" set on y-axis would not affect glow on x-axis.
+  params.accumulated_overscroll = gfx::Vector2dF(1, 1);
+  params.latest_overscroll_delta = gfx::Vector2dF(1, 1);
+  params.current_fling_velocity = gfx::Vector2dF(1, 1);
+
+  EXPECT_CALL(*refresh_, OnOverscrolled()).Times(0);
+  EXPECT_CALL(*refresh_, Reset());
+  EXPECT_CALL(*refresh_, IsActive()).WillOnce(Return(false));
+  EXPECT_CALL(*refresh_, IsAwaitingScrollUpdateAck()).WillOnce(Return(false));
+  EXPECT_CALL(*glow_,
+              OnOverscrolled(_, gfx::Vector2dF(560, 0), gfx::Vector2dF(560, 0),
+                             gfx::Vector2dF(560, 0), _));
+
+  controller_->OnOverscrolled(params);
+  testing::Mock::VerifyAndClearExpectations(refresh_);
+  testing::Mock::VerifyAndClearExpectations(glow_);
+}
+
+}  // namespace
+
+}  // namespace content