[Blink, RemotePlayback] Rename connect() to prompt()

third_party/WebKit/Source/modules/remoteplayback/RemotePlayback.cpp

 // Copyright 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 "modules/remoteplayback/RemotePlayback.h"
 
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "core/dom/DOMException.h"
 #include "core/dom/Document.h"
 #include "core/events/Event.h"
@@ skipping 62 matching lines @@
     // as soon as it's created, we probably want to limit that to when the page/element
     // is visible (see https://crbug.com/597281) and has default controls. If there's
     // no default controls, we should also start tracking availability on demand
     // meaning the Promise returned by getAvailability() will be resolved asynchronously.
     RemotePlaybackAvailability* availability = RemotePlaybackAvailability::take(resolver, m_availability);
     m_availabilityObjects.append(availability);
     resolver->resolve(availability);
     return promise;
 }
 
-ScriptPromise RemotePlayback::connect(ScriptState* scriptState)
+ScriptPromise RemotePlayback::prompt(ScriptState* scriptState)
 {
+    // TODO(avayvod): implement steps 3, 4, 5, 8, 9 of the algorithm.
+    // https://crbug.com/647441
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
 
     // TODO(avayvod): should we have a separate flag to disable the user gesture
     // requirement (for tests) or reuse the one for the PresentationRequest::start()?
     if (!UserGestureIndicator::utilizeUserGesture()) {
-        resolver->reject(DOMException::create(InvalidAccessError, "RemotePlayback::connect() requires user gesture."));
+        resolver->reject(DOMException::create(InvalidAccessError, "RemotePlayback::prompt() requires user gesture."));
         return promise;
     }
 
     if (m_state == WebRemotePlaybackState::Disconnected) {
-        m_connectPromiseResolvers.append(resolver);
+        m_promptPromiseResolvers.append(resolver);
         m_mediaElement->requestRemotePlayback();
     } else {
         m_mediaElement->requestRemotePlaybackControl();
-        resolver->resolve(false);
+        // TODO(avayvod): Need to keep the resolver until user chooses to stop
+        // the remote playback (resolve) or dismisses the UI (reject).
+        // Steps 11 and 12 of the prompt() algorithm.
+        // https://crbug.com/647441
+        resolver->resolve();
     }
 
     return promise;
 }
 
 String RemotePlayback::state() const
 {
     return remotePlaybackStateToString(m_state);
 }
 
 bool RemotePlayback::hasPendingActivity() const
 {
     return hasEventListeners()
         || !m_availabilityObjects.isEmpty()
-        || !m_connectPromiseResolvers.isEmpty();
+        || !m_promptPromiseResolvers.isEmpty();
 }
 
 void RemotePlayback::stateChanged(WebRemotePlaybackState state)
 {
     // We may get a "disconnected" state change while in the "disconnected"
     // state if initiated connection fails. So cleanup the promise resolvers
     // before checking if anything changed.
     // TODO(avayvod): cleanup this logic when we implementing the "connecting"
     // state.
     if (state != WebRemotePlaybackState::Disconnected) {
-        for (auto& resolver : m_connectPromiseResolvers)
-            resolver->resolve(true);
+        for (auto& resolver : m_promptPromiseResolvers)
+            resolver->resolve();
     } else {
-        for (auto& resolver : m_connectPromiseResolvers)
+        for (auto& resolver : m_promptPromiseResolvers)
             resolver->reject(DOMException::create(AbortError, "Failed to connect to the remote device."));
     }
-    m_connectPromiseResolvers.clear();
+    m_promptPromiseResolvers.clear();
 
     if (m_state == state)
         return;
 
     m_state = state;
     dispatchEvent(Event::create(EventTypeNames::statechange));
 }
 
 void RemotePlayback::availabilityChanged(bool available)
 {
     if (m_availability == available)
         return;
 
     m_availability = available;
     for (auto& availabilityObject : m_availabilityObjects)
         availabilityObject->availabilityChanged(available);
 }
 
-void RemotePlayback::connectCancelled()
+void RemotePlayback::promptCancelled()
 {
-    for (auto& resolver : m_connectPromiseResolvers)
-        resolver->resolve(false);
-    m_connectPromiseResolvers.clear();
+    for (auto& resolver : m_promptPromiseResolvers)
+        resolver->resolve();
+    m_promptPromiseResolvers.clear();
 }
 
 DEFINE_TRACE(RemotePlayback)
 {
     visitor->trace(m_availabilityObjects);
-    visitor->trace(m_connectPromiseResolvers);
+    visitor->trace(m_promptPromiseResolvers);
     visitor->trace(m_mediaElement);
     EventTargetWithInlineData::trace(visitor);
 }
 
 } // namespace blink