UserGestureIndicator is a mess. Clean it up.

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 {
 
 // Checks for the initial state of UserGestureIndicator.
 TEST(UserGestureIndicatorTest, InitialState) {
   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
   EXPECT_FALSE(UserGestureIndicator::processedUserGestureSinceLoad());
   EXPECT_EQ(nullptr, UserGestureIndicator::currentToken());
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
 }
 
 TEST(UserGestureIndicatorTest, ConstructedWithNewUserGesture) {
   UserGestureIndicator::clearProcessedUserGestureSinceLoad();
-  UserGestureIndicator userGestureScope(DefinitelyProcessingNewUserGesture);
+  UserGestureIndicator userGestureScope(
+      UserGestureToken::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(DefinitelyProcessingUserGesture);
+  UserGestureIndicator userGestureScope(UserGestureToken::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(DefinitelyNotProcessingUserGesture);
+  UserGestureIndicator userGestureScope(nullptr);
 
   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
   EXPECT_FALSE(UserGestureIndicator::processedUserGestureSinceLoad());
-  EXPECT_NE(nullptr, UserGestureIndicator::currentToken());
+  EXPECT_EQ(nullptr, UserGestureIndicator::currentToken());
 
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
 }
 
 // Check that after UserGestureIndicator destruction state will be cleared.
 TEST(UserGestureIndicatorTest, DestructUserGestureIndicator) {
   {
-    UserGestureIndicator userGestureScope(DefinitelyProcessingUserGesture);
+    UserGestureIndicator userGestureScope(UserGestureToken::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(DefinitelyProcessingNewUserGesture);
+  UserGestureIndicator userGestureScope(
+      UserGestureToken::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(DefinitelyProcessingNewUserGesture);
+    UserGestureIndicator innerUserGesture(
+        UserGestureToken::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(DefinitelyProcessingUserGesture, &cb);
+    RefPtr<UserGestureToken> token = UserGestureToken::create();
+    token->setUserGestureUtilizedCallback(&cb);
+    UserGestureIndicator userGestureScope(token);
     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(DefinitelyProcessingUserGesture, &cb);
+    RefPtr<UserGestureToken> token = UserGestureToken::create();
+    token->setUserGestureUtilizedCallback(&cb);
+    UserGestureIndicator userGestureScope(token);
 
     // 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());
   }
 
-  {
-    UserGestureIndicator userGestureScope(DefinitelyNotProcessingUserGesture,
-                                          &cb);
-
-    // Callback not invoked when there isn't actually a user gesture
-    EXPECT_FALSE(UserGestureIndicator::processingUserGesture());
-    EXPECT_EQ(0u, cb.getAndResetUsedCount());
-  }
-
   // The callback isn't invoked outside the scope of the UGI

[Rick Byers, 2016/10/11 18:00:19]

With the separation from the token, this is probably the test which should
validate the callback lifetime semantics.  I probably should have written this
test using a nested UGI, then it would have failed as a result of this
refactoring.

[Nate Chapin, 2016/10/11 19:17:55]

Done (with a unique_ptr instead of with nested scopes).

   EXPECT_FALSE(UserGestureIndicator::utilizeUserGesture());
   EXPECT_EQ(0u, cb.getAndResetUsedCount());
   EXPECT_FALSE(UserGestureIndicator::consumeUserGesture());
   EXPECT_EQ(0u, cb.getAndResetUsedCount());
 }
 
 }  // namespace blink