Implement WebBluetooth getDescriptor[s]

third_party/WebKit/Source/modules/bluetooth/BluetoothRemoteGATTCharacteristic.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 "modules/bluetooth/BluetoothRemoteGATTCharacteristic.h"
 
 #include "bindings/core/v8/ScriptPromise.h"
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "core/dom/DOMDataView.h"
 #include "core/dom/DOMException.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/events/Event.h"
 #include "core/inspector/ConsoleMessage.h"
 #include "modules/bluetooth/BluetoothCharacteristicProperties.h"
 #include "modules/bluetooth/BluetoothError.h"
+#include "modules/bluetooth/BluetoothRemoteGATTDescriptor.h"
 #include "modules/bluetooth/BluetoothRemoteGATTService.h"
 #include "modules/bluetooth/BluetoothSupplement.h"
+#include "modules/bluetooth/BluetoothUUID.h"
 #include "public/platform/modules/bluetooth/WebBluetooth.h"
 #include <memory>
 
 namespace blink {
 
 namespace {
 
 const char kGATTServerDisconnected[] =
     "GATT Server disconnected while performing a GATT operation.";
 const char kGATTServerNotConnected[] =
@@ skipping 85 matching lines @@
   // We will also need to unregister a characteristic once all the event
   // listeners have been removed. See http://crbug.com/541390
   if (eventType == EventTypeNames::characteristicvaluechanged) {
     WebBluetooth* webbluetooth =
         BluetoothSupplement::fromExecutionContext(getExecutionContext());
     webbluetooth->registerCharacteristicObject(
         m_webCharacteristic->characteristicInstanceID, this);
   }
 }
 
-class ReadValueCallback : public WebBluetoothReadValueCallbacks {
+class GetDescriptorsCallback : public WebBluetoothGetDescriptorsCallbacks {
  public:
-  ReadValueCallback(BluetoothRemoteGATTCharacteristic* characteristic,
-                    ScriptPromiseResolver* resolver)
+  GetDescriptorsCallback(BluetoothRemoteGATTCharacteristic* characteristic,
+                         mojom::blink::WebBluetoothGATTQueryQuantity quantity,
+                         ScriptPromiseResolver* resolver)
+      : m_characteristic(characteristic),
+        m_quantity(quantity),
+        m_resolver(resolver) {
+    // We always check that the device is connected before constructing this
+    // object.
+    CHECK(m_characteristic->gatt()->connected());
+    m_characteristic->gatt()->AddToActiveAlgorithms(m_resolver.get());
+  }
+
+  void onSuccess(const WebVector<WebBluetoothRemoteGATTDescriptorInit*>&
+                     webDescriptors) override {
+    if (!m_resolver->getExecutionContext() ||
+        m_resolver->getExecutionContext()->activeDOMObjectsAreStopped())
+      return;
+
+    // If the resolver is not in the set of ActiveAlgorithms then the frame
+    // disconnected so we reject.
+    if (!m_characteristic->gatt()->RemoveFromActiveAlgorithms(
+            m_resolver.get())) {
+      m_resolver->reject(
+          DOMException::create(NetworkError, kGATTServerDisconnected));

[ortuno, 2016/12/02 06:14:51]

I like that we can test all of the characteristic's methods in one script-test
but not returning a specific error message for descriptors like we do for
services and characteristics is really bothering me. I think we should introduce
a new error message. WDYT?

[dougt, 2016/12/02 18:31:29]

If anything, a possible spec bug?  I am not really sure at this point what sorta
detail info you'd want as a webdev when something bad happens like a disconnect.

[ortuno, 2016/12/07 08:05:12]

hmm then we should change the message since this is not really a GATT operation.

[ortuno, 2016/12/08 05:42:51]

As discussed offline, I think it's fine to use the same message for now. We can
fix in a follow up CL. This patch is big enough as is :p

+      return;
+    }
+
+    if (m_quantity == mojom::blink::WebBluetoothGATTQueryQuantity::SINGLE) {
+      DCHECK_EQ(1u, webDescriptors.size());
+      m_resolver->resolve(
+          m_characteristic->gatt()
+              ->device()
+              ->getOrCreateBluetoothRemoteGATTDescriptor(
+                  wrapUnique(webDescriptors[0]), m_characteristic));
+      return;
+    }
+
+    HeapVector<Member<BluetoothRemoteGATTDescriptor>> descriptors;
+    descriptors.reserveInitialCapacity(webDescriptors.size());
+    for (WebBluetoothRemoteGATTDescriptorInit* webDescriptor : webDescriptors) {
+      descriptors.append(m_characteristic->gatt()
+                             ->device()
+                             ->getOrCreateBluetoothRemoteGATTDescriptor(
+                                 wrapUnique(webDescriptor), m_characteristic));
+    }
+    m_resolver->resolve(descriptors);
+  }
+
+  void onError(
+      int32_t
+          error /* Corresponds to WebBluetoothResult in web_bluetooth.mojom */)
+      override {
+    if (!m_resolver->getExecutionContext() ||
+        m_resolver->getExecutionContext()->activeDOMObjectsAreStopped())
+      return;
+
+    // If the resolver is not in the set of ActiveAlgorithms then the frame
+    // disconnected so we reject.
+    if (!m_characteristic->gatt()->RemoveFromActiveAlgorithms(
+            m_resolver.get())) {
+      m_resolver->reject(
+          DOMException::create(NetworkError, kGATTServerDisconnected));
+      return;
+    }
+
+    m_resolver->reject(BluetoothError::take(m_resolver, error));
+  }
+
+ private:
+  Persistent<BluetoothRemoteGATTCharacteristic> m_characteristic;
+  mojom::blink::WebBluetoothGATTQueryQuantity m_quantity;
+  const Persistent<ScriptPromiseResolver> m_resolver;
+};
+
+ScriptPromise BluetoothRemoteGATTCharacteristic::getDescriptorsImpl(

[ortuno, 2016/12/02 06:14:51]

nit: Order of declaration should match order of implementation.

[dougt, 2016/12/02 18:31:29]

Done.

+    ScriptState* scriptState,
+    mojom::blink::WebBluetoothGATTQueryQuantity quantity,
+    const String& descriptor) {
+#if OS(MACOSX)
+  // TODO(ortuno): Remove when getDescriptor[s] is implemented.

[ortuno, 2016/12/02 06:14:51]

nit: TODO(crbug.com/624017): Remove when descriptors are implemented on MacOS.

[dougt, 2016/12/02 18:31:29]

Done.

+  return ScriptPromise::rejectWithDOMException(
+      scriptState, DOMException::create(NotSupportedError,
+                                        "getDescriptor[s] is not implemented "
+                                        "yet. See https://goo.gl/J6ASzs"));
+#endif  // OS(MACOSX)
+  WebBluetooth* webbluetooth =
+      BluetoothSupplement::fromScriptState(scriptState);
+
+  if (!gatt()->connected()) {
+    return ScriptPromise::rejectWithDOMException(
+        scriptState,
+        DOMException::create(NetworkError, kGATTServerNotConnected));
+  }
+
+  if (!gatt()->device()->isValidCharacteristic(
+          m_webCharacteristic->characteristicInstanceID)) {
+    return ScriptPromise::rejectWithDOMException(
+        scriptState,
+        DOMException::create(InvalidStateError, kInvalidCharacteristic));
+  }
+
+  ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
+  ScriptPromise promise = resolver->promise();
+
+  webbluetooth->getDescriptors(
+      m_webCharacteristic->characteristicInstanceID,
+      static_cast<int32_t>(quantity), descriptor,
+      new GetDescriptorsCallback(this, quantity, resolver));
+
+  return promise;
+}
+
+ScriptPromise BluetoothRemoteGATTCharacteristic::getDescriptor(
+    ScriptState* scriptState,
+    const StringOrUnsignedLong& descriptorUUID,
+    ExceptionState& exceptionState) {
+  String descriptor =
+      BluetoothUUID::getDescriptor(descriptorUUID, exceptionState);
+  if (exceptionState.hadException())
+    return exceptionState.reject(scriptState);
+
+  return getDescriptorsImpl(scriptState,
+                            mojom::blink::WebBluetoothGATTQueryQuantity::SINGLE,
+                            descriptor);
+}
+
+ScriptPromise BluetoothRemoteGATTCharacteristic::getDescriptors(
+    ScriptState* scriptState,
+    ExceptionState&) {
+  return getDescriptorsImpl(
+      scriptState, mojom::blink::WebBluetoothGATTQueryQuantity::MULTIPLE);
+}
+
+ScriptPromise BluetoothRemoteGATTCharacteristic::getDescriptors(
+    ScriptState* scriptState,
+    const StringOrUnsignedLong& descriptorUUID,
+    ExceptionState& exceptionState) {
+  String descriptor =
+      BluetoothUUID::getDescriptor(descriptorUUID, exceptionState);
+  if (exceptionState.hadException())
+    return exceptionState.reject(scriptState);
+
+  return getDescriptorsImpl(
+      scriptState, mojom::blink::WebBluetoothGATTQueryQuantity::MULTIPLE,
+      descriptor);
+}
+
+class CharacteristicReadValueCallback : public WebBluetoothReadValueCallbacks {
+ public:
+  CharacteristicReadValueCallback(
+      BluetoothRemoteGATTCharacteristic* characteristic,
+      ScriptPromiseResolver* resolver)
       : m_characteristic(characteristic), m_resolver(resolver) {
     // We always check that the device is connected before constructing this
     // object.
     CHECK(m_characteristic->gatt()->connected());
     m_characteristic->gatt()->AddToActiveAlgorithms(m_resolver.get());
   }
 
   void onSuccess(const WebVector<uint8_t>& value) override {
     if (!m_resolver->getExecutionContext() ||
         m_resolver->getExecutionContext()->activeDOMObjectsAreStopped())
@@ skipping 49 matching lines @@
     return ScriptPromise::rejectWithDOMException(
         scriptState,
         DOMException::create(InvalidStateError, kInvalidCharacteristic));
   }
 
   WebBluetooth* webbluetooth =
       BluetoothSupplement::fromScriptState(scriptState);
 
   ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
   ScriptPromise promise = resolver->promise();
-  webbluetooth->readValue(m_webCharacteristic->characteristicInstanceID,
-                          new ReadValueCallback(this, resolver));
+  webbluetooth->characteristicReadValue(
+      m_webCharacteristic->characteristicInstanceID,
+      new CharacteristicReadValueCallback(this, resolver));
 
   return promise;
 }
 
-class WriteValueCallback : public WebBluetoothWriteValueCallbacks {
+class CharacteristicWriteValueCallback
+    : public WebBluetoothWriteValueCallbacks {
  public:
-  WriteValueCallback(BluetoothRemoteGATTCharacteristic* characteristic,
-                     ScriptPromiseResolver* resolver)
+  CharacteristicWriteValueCallback(
+      BluetoothRemoteGATTCharacteristic* characteristic,
+      ScriptPromiseResolver* resolver)
       : m_characteristic(characteristic), m_resolver(resolver) {
     // We always check that the device is connected before constructing this
     // object.
     CHECK(m_characteristic->gatt()->connected());
     m_characteristic->gatt()->AddToActiveAlgorithms(m_resolver.get());
   }
 
   void onSuccess(const WebVector<uint8_t>& value) override {
     if (!m_resolver->getExecutionContext() ||
         m_resolver->getExecutionContext()->activeDOMObjectsAreStopped())
@@ skipping 12 matching lines @@
     m_resolver->resolve();
   }
 
   void onError(
       int32_t
           error /* Corresponds to WebBluetoothResult in web_bluetooth.mojom */)
       override {
     if (!m_resolver->getExecutionContext() ||
         m_resolver->getExecutionContext()->activeDOMObjectsAreStopped())
       return;
-
     if (!m_characteristic->gatt()->RemoveFromActiveAlgorithms(
             m_resolver.get())) {
       m_resolver->reject(
           DOMException::create(NetworkError, kGATTServerDisconnected));
       return;
     }
 
     m_resolver->reject(BluetoothError::take(m_resolver, error));
   }
 
@@ skipping 30 matching lines @@
     return ScriptPromise::rejectWithDOMException(
         scriptState, DOMException::create(InvalidModificationError,
                                           "Value can't exceed 512 bytes."));
 
   // Let valueVector be a copy of the bytes held by value.
   WebVector<uint8_t> valueVector(value.bytes(), value.byteLength());
 
   ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
 
   ScriptPromise promise = resolver->promise();
-  webbluetooth->writeValue(m_webCharacteristic->characteristicInstanceID,
-                           valueVector, new WriteValueCallback(this, resolver));
+  webbluetooth->characteristicWriteValue(
+      m_webCharacteristic->characteristicInstanceID, valueVector,
+      new CharacteristicWriteValueCallback(this, resolver));
 
   return promise;
 }
 
 class NotificationsCallback : public WebBluetoothNotificationsCallbacks {
  public:
   NotificationsCallback(BluetoothRemoteGATTCharacteristic* characteristic,
                         ScriptPromiseResolver* resolver)
       : m_characteristic(characteristic), m_resolver(resolver) {
     // We always check that the device is connected before constructing this
@@ skipping 99 matching lines @@
 
 DEFINE_TRACE(BluetoothRemoteGATTCharacteristic) {
   visitor->trace(m_service);
   visitor->trace(m_properties);
   visitor->trace(m_value);
   EventTargetWithInlineData::trace(visitor);
   ActiveDOMObject::trace(visitor);
 }
 
 }  // namespace blink