Move persistent gesture state to Document, add DocumentUserGestureToken

third_party/WebKit/Source/platform/UserGestureIndicatorTest.cpp

 // Copyright (c) 2016 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 "platform/UserGestureIndicator.h"
 
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace blink {
 
+class TestUserGestureToken final : public UserGestureToken {
+  WTF_MAKE_NONCOPYABLE(TestUserGestureToken);
+
+ public:
+  static PassRefPtr<UserGestureToken> create(
+      Status status = PossiblyExistingGesture) {
+    return adoptRef(new TestUserGestureToken(status));
+  }
+
+  ~TestUserGestureToken() final {}
+
+ private:
+  TestUserGestureToken(Status status) : UserGestureToken(status) {}
+};
+
 // Checks for the initial state of UserGestureIndicator.
 TEST(UserGestureIndicatorTest, InitialState) {
   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
-  EXPECT_FALSE(UserGestureIndicator::processedUserGestureSinceLoad());

[Nate Chapin, 2016/10/13 20:03:19]

I don't love the loss of test coverage for this, but this flag is now a lot
simpler, so idk.

[Rick Byers, 2016/10/17 17:02:47]

Can you replace it with some test coverage for DocumentUserGestureToken?  It's
pretty trivial so shouldn't need much I don't think, still probably worth having
something...

[Nate Chapin, 2016/10/18 23:26:33]

Done.

   EXPECT_EQ(nullptr, UserGestureIndicator::currentToken());
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
 }
 
 TEST(UserGestureIndicatorTest, ConstructedWithNewUserGesture) {
-  UserGestureIndicator::clearProcessedUserGestureSinceLoad();
   UserGestureIndicator userGestureScope(
-      UserGestureToken::create(UserGestureToken::NewGesture));
+      TestUserGestureToken::create(UserGestureToken::NewGesture));
 
   EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
-  EXPECT_TRUE(UserGestureIndicator::processedUserGestureSinceLoad());
   EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
 
   EXPECT_TRUE(UserGestureIndicator::consumeUserGesture());
 }
 
 TEST(UserGestureIndicatorTest, ConstructedWithUserGesture) {
-  UserGestureIndicator::clearProcessedUserGestureSinceLoad();
-  UserGestureIndicator userGestureScope(UserGestureToken::create());
+  UserGestureIndicator userGestureScope(TestUserGestureToken::create());
 
   EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
-  EXPECT_TRUE(UserGestureIndicator::processedUserGestureSinceLoad());
   EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
 
   EXPECT_TRUE(UserGestureIndicator::consumeUserGesture());
 }
 
 TEST(UserGestureIndicatorTest, ConstructedWithNoUserGesture) {
-  UserGestureIndicator::clearProcessedUserGestureSinceLoad();
   UserGestureIndicator userGestureScope(nullptr);
 
   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
-  EXPECT_FALSE(UserGestureIndicator::processedUserGestureSinceLoad());
   EXPECT_EQ(nullptr, UserGestureIndicator::currentToken());
 
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
 }
 
 // Check that after UserGestureIndicator destruction state will be cleared.
 TEST(UserGestureIndicatorTest, DestructUserGestureIndicator) {
   {
-    UserGestureIndicator userGestureScope(UserGestureToken::create());
+    UserGestureIndicator userGestureScope(TestUserGestureToken::create());
 
     EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
-    EXPECT_TRUE(UserGestureIndicator::processedUserGestureSinceLoad());
     EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
   }
 
   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
   EXPECT_EQ(nullptr, UserGestureIndicator::currentToken());
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
 }
 
 // Tests creation of scoped UserGestureIndicator objects.
 TEST(UserGestureIndicatorTest, ScopedNewUserGestureIndicators) {
   // Root GestureIndicator and GestureToken.
   UserGestureIndicator userGestureScope(
-      UserGestureToken::create(UserGestureToken::NewGesture));
+      TestUserGestureToken::create(UserGestureToken::NewGesture));
 
   EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
-  EXPECT_TRUE(UserGestureIndicator::processedUserGestureSinceLoad());
   EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
   {
     // Construct inner UserGestureIndicator.
     // It should share GestureToken with the root indicator.
     UserGestureIndicator innerUserGesture(
-        UserGestureToken::create(UserGestureToken::NewGesture));
+        TestUserGestureToken::create(UserGestureToken::NewGesture));
 
     EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
     EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
 
     // Consume inner gesture.
     EXPECT_TRUE(UserGestureIndicator::consumeUserGesture());
   }
 
   EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
   EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
@@ skipping 18 matching lines @@
 
  private:
   unsigned m_usedCount;
 };
 
 // Tests callback invocation.
 TEST(UserGestureIndicatorTest, Callback) {
   UsedCallback cb;
 
   {
-    UserGestureIndicator userGestureScope(UserGestureToken::create());
+    UserGestureIndicator userGestureScope(TestUserGestureToken::create());
     UserGestureIndicator::currentToken()->setUserGestureUtilizedCallback(&cb);
     EXPECT_EQ(0u, cb.getAndResetUsedCount());
 
     // Untracked doesn't invoke the callback
     EXPECT_TRUE(UserGestureIndicator::processingUserGesture());
     EXPECT_EQ(0u, cb.getAndResetUsedCount());
 
     // But processingUserGesture does
     EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
     EXPECT_EQ(1u, cb.getAndResetUsedCount());
 
     // But only the first time
     EXPECT_TRUE(UserGestureIndicator::utilizeUserGesture());
     EXPECT_TRUE(UserGestureIndicator::consumeUserGesture());
     EXPECT_EQ(0u, cb.getAndResetUsedCount());
   }
   EXPECT_EQ(0u, cb.getAndResetUsedCount());
 
   {
-    UserGestureIndicator userGestureScope(UserGestureToken::create());
+    UserGestureIndicator userGestureScope(TestUserGestureToken::create());
     UserGestureIndicator::currentToken()->setUserGestureUtilizedCallback(&cb);
 
     // Consume also invokes the callback
     EXPECT_TRUE(UserGestureIndicator::consumeUserGesture());
     EXPECT_EQ(1u, cb.getAndResetUsedCount());
 
     // But only once
     EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
     EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
     EXPECT_EQ(0u, cb.getAndResetUsedCount());
   }
 
   {
     std::unique_ptr<UserGestureIndicator> userGestureScope(
-        new UserGestureIndicator(UserGestureToken::create()));
+        new UserGestureIndicator(TestUserGestureToken::create()));
     RefPtr<UserGestureToken> token = UserGestureIndicator::currentToken();
     token->setUserGestureUtilizedCallback(&cb);
     userGestureScope.reset();
 
     // The callback should be cleared when the UseGestureIndicator is deleted.
     EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
     EXPECT_EQ(0u, cb.getAndResetUsedCount());
   }
 
   // The callback isn't invoked outside the scope of the UGI
   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
   EXPECT_EQ(0u, cb.getAndResetUsedCount());
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
   EXPECT_EQ(0u, cb.getAndResetUsedCount());
 }
 
 }  // namespace blink