Track USBDevice open state in Blink.

third_party/WebKit/Source/modules/webusb/USBDevice.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/webusb/USBDevice.h"
 
 #include "bindings/core/v8/CallbackPromiseAdapter.h"
 #include "bindings/core/v8/ScriptPromise.h"
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "bindings/core/v8/ToV8.h"
 #include "core/dom/DOMArrayBuffer.h"
 #include "core/dom/DOMArrayBufferView.h"
 #include "core/dom/DOMException.h"
 #include "core/dom/ExceptionCode.h"
 #include "modules/webusb/USBConfiguration.h"
 #include "modules/webusb/USBControlTransferParameters.h"
 #include "modules/webusb/USBError.h"
 #include "modules/webusb/USBInTransferResult.h"
 #include "modules/webusb/USBIsochronousInTransferResult.h"
 #include "modules/webusb/USBIsochronousOutTransferResult.h"
 #include "modules/webusb/USBOutTransferResult.h"
 #include "public/platform/modules/webusb/WebUSBTransferInfo.h"
 #include "wtf/Assertions.h"
 
 namespace blink {
 
 namespace {
 
+const char kOpenCloseInProgress[] = "An open() or close() task is in progress.";
+const char kOpenRequired[] = "The device must be open()ed first.";
+
 DOMException* convertControlTransferParameters(
     WebUSBDevice::TransferDirection direction,
     const USBControlTransferParameters& parameters,
     WebUSBDevice::ControlTransferParameters* webParameters)
 {
     webParameters->direction = direction;
 
     if (parameters.requestType() == "standard")
         webParameters->type = WebUSBDevice::RequestType::Standard;
     else if (parameters.requestType() == "class")
@@ skipping 28 matching lines @@
     case WebUSBTransferInfo::Status::Stall:
         return "stall";
     case WebUSBTransferInfo::Status::Babble:
         return "babble";
     default:
         ASSERT_NOT_REACHED();
         return "";
     }
 }
 
+class OpenClosePromiseAdapter : public WebCallbacks<void, const WebUSBError&> {
+public:
+    OpenClosePromiseAdapter(USBDevice* device, ScriptPromiseResolver* resolver, bool desiredState)
+        : m_device(device)
+        , m_resolver(resolver)
+        , m_desiredState(desiredState)
+    {
+    }
+
+    void onSuccess() override
+    {
+        if (!m_resolver->executionContext() || m_resolver->executionContext()->activeDOMObjectsAreStopped())
+            return;
+        if (m_device)
+            m_device->setOpened(m_desiredState);
+        m_resolver->resolve();
+    }
+
+    void onError(const WebUSBError& e) override
+    {
+        if (!m_resolver->executionContext() || m_resolver->executionContext()->activeDOMObjectsAreStopped())
+            return;
+        if (m_device)
+            m_device->setOpened(!m_desiredState);
+        m_resolver->reject(USBError::take(m_resolver, e));
+    }
+
+private:
+    WeakPersistent<USBDevice> m_device;
+    Persistent<ScriptPromiseResolver> m_resolver;
+    bool m_desiredState;

[juncai, 2016/03/09 19:33:51]

nit: can add some comment about this variable, since it is used by setOpened().
For example, true/false means the desired state is opened/closed.

[Reilly Grant (use Gerrit), 2016/03/10 00:27:49]

Done.

+};
+
 class GetConfigurationPromiseAdapter : public WebCallbacks<uint8_t, const WebUSBError&> {
 public:
     GetConfigurationPromiseAdapter(USBDevice* device, ScriptPromiseResolver* resolver) : m_device(device), m_resolver(resolver) {}
 
     void onSuccess(uint8_t value) override
     {
         if (!m_resolver->executionContext() || m_resolver->executionContext()->activeDOMObjectsAreStopped())
             return;
         m_resolver->resolve(USBConfiguration::createFromValue(m_device, value));
     }
@@ skipping 98 matching lines @@
             return m_buffer.getAsArrayBuffer()->byteLength();
         return m_buffer.getAsArrayBufferView()->byteLength();
     }
 
 private:
     const ArrayBufferOrArrayBufferView& m_buffer;
 };
 
 } // namespace
 
+// static
+USBDevice* USBDevice::take(ScriptPromiseResolver* resolver, PassOwnPtr<WebUSBDevice> device)
+{
+    return USBDevice::create(device, resolver->executionContext());
+}
+
+void USBDevice::setOpened(bool opened)
+{
+    m_opened = opened;
+    m_openStateChangeInProgress = false;
+}
+
 HeapVector<Member<USBConfiguration>> USBDevice::configurations() const
 {
     HeapVector<Member<USBConfiguration>> configurations;
     for (size_t i = 0; i < info().configurations.size(); ++i)
         configurations.append(USBConfiguration::create(this, i));
     return configurations;
 }
 
 ScriptPromise USBDevice::open(ScriptState* scriptState)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->open(new CallbackPromiseAdapter<void, USBError>(resolver));
-    setContext(scriptState->executionContext());
+    if (m_openStateChangeInProgress) {
+        resolver->reject(DOMException::create(InvalidStateError, kOpenCloseInProgress));
+    } else if (m_opened) {
+        resolver->resolve();
+    } else {
+        m_openStateChangeInProgress = true;
+        m_device->open(new OpenClosePromiseAdapter(this, resolver, true));

[juncai, 2016/03/09 19:33:50]

nit: add comments about the true parameter passed to this function.

[Reilly Grant (use Gerrit), 2016/03/10 00:27:49]

Done.

+    }
     return promise;
 }
 
 ScriptPromise USBDevice::close(ScriptState* scriptState)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->close(new CallbackPromiseAdapter<void, USBError>(resolver));
-    setContext(nullptr);
+    if (m_openStateChangeInProgress) {

[juncai, 2016/03/09 19:33:51]

nit: does it make sense to rename this variable to be:
m_openCloseStateChangeInProgress? Since it is used by both open() and close()
functions?

[Reilly Grant (use Gerrit), 2016/03/10 00:27:49]

In my next patch I decided to change it to m_deviceStateChangeInProgress and so
have backported that change here.

+        resolver->reject(DOMException::create(InvalidStateError, kOpenCloseInProgress));
+    } else if (!m_opened) {
+        resolver->resolve();
+    } else {
+        m_openStateChangeInProgress = true;
+        m_device->close(new OpenClosePromiseAdapter(this, resolver, false));

[juncai, 2016/03/09 19:33:51]

nit: same here for the false parameter.

[Reilly Grant (use Gerrit), 2016/03/10 00:27:49]

Done.

+    }
     return promise;
 }
 
 ScriptPromise USBDevice::getConfiguration(ScriptState* scriptState)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
     m_device->getConfiguration(new GetConfigurationPromiseAdapter(this, resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::setConfiguration(ScriptState* scriptState, uint8_t configurationValue)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->setConfiguration(configurationValue, new CallbackPromiseAdapter<void, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->setConfiguration(configurationValue, new CallbackPromiseAdapter<void, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::claimInterface(ScriptState* scriptState, uint8_t interfaceNumber)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->claimInterface(interfaceNumber, new CallbackPromiseAdapter<void, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->claimInterface(interfaceNumber, new CallbackPromiseAdapter<void, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::releaseInterface(ScriptState* scriptState, uint8_t interfaceNumber)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->releaseInterface(interfaceNumber, new CallbackPromiseAdapter<void, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->releaseInterface(interfaceNumber, new CallbackPromiseAdapter<void, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::setInterface(ScriptState* scriptState, uint8_t interfaceNumber, uint8_t alternateSetting)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->setInterface(interfaceNumber, alternateSetting, new CallbackPromiseAdapter<void, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->setInterface(interfaceNumber, alternateSetting, new CallbackPromiseAdapter<void, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::controlTransferIn(ScriptState* scriptState, const USBControlTransferParameters& setup, unsigned length)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
+    if (!m_opened) {
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+        return promise;
+    }
+
     WebUSBDevice::ControlTransferParameters parameters;
     DOMException* error = convertControlTransferParameters(WebUSBDevice::TransferDirection::In, setup, &parameters);
-    if (error)
+    if (error) {
         resolver->reject(error);
-    else
-        m_device->controlTransfer(parameters, nullptr, length, 0, new CallbackPromiseAdapter<InputTransferResult, USBError>(resolver));
+        return promise;
+    }
+
+    m_device->controlTransfer(parameters, nullptr, length, 0, new CallbackPromiseAdapter<InputTransferResult, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::controlTransferOut(ScriptState* scriptState, const USBControlTransferParameters& setup)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
+    if (!m_opened) {
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+        return promise;
+    }
+
     WebUSBDevice::ControlTransferParameters parameters;
     DOMException* error = convertControlTransferParameters(WebUSBDevice::TransferDirection::Out, setup, &parameters);
-    if (error)
+    if (error) {
         resolver->reject(error);
-    else
-        m_device->controlTransfer(parameters, nullptr, 0, 0, new CallbackPromiseAdapter<OutputTransferResult, USBError>(resolver));
+        return promise;
+    }
+
+    m_device->controlTransfer(parameters, nullptr, 0, 0, new CallbackPromiseAdapter<OutputTransferResult, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::controlTransferOut(ScriptState* scriptState, const USBControlTransferParameters& setup, const ArrayBufferOrArrayBufferView& data)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
+    if (!m_opened) {
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+        return promise;
+    }
+
     WebUSBDevice::ControlTransferParameters parameters;
     DOMException* error = convertControlTransferParameters(WebUSBDevice::TransferDirection::Out, setup, &parameters);
     if (error) {
         resolver->reject(error);
-    } else {
-        BufferSource buffer(data);
-        m_device->controlTransfer(parameters, buffer.data(), buffer.size(), 0, new CallbackPromiseAdapter<OutputTransferResult, USBError>(resolver));
+        return promise;
     }
+
+    BufferSource buffer(data);
+    m_device->controlTransfer(parameters, buffer.data(), buffer.size(), 0, new CallbackPromiseAdapter<OutputTransferResult, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::clearHalt(ScriptState* scriptState, uint8_t endpointNumber)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->clearHalt(endpointNumber, new CallbackPromiseAdapter<void, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->clearHalt(endpointNumber, new CallbackPromiseAdapter<void, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::transferIn(ScriptState* scriptState, uint8_t endpointNumber, unsigned length)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->transfer(WebUSBDevice::TransferDirection::In, endpointNumber, nullptr, length, 0, new CallbackPromiseAdapter<InputTransferResult, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->transfer(WebUSBDevice::TransferDirection::In, endpointNumber, nullptr, length, 0, new CallbackPromiseAdapter<InputTransferResult, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::transferOut(ScriptState* scriptState, uint8_t endpointNumber, const ArrayBufferOrArrayBufferView& data)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    BufferSource buffer(data);
-    m_device->transfer(WebUSBDevice::TransferDirection::Out, endpointNumber, buffer.data(), buffer.size(), 0, new CallbackPromiseAdapter<OutputTransferResult, USBError>(resolver));
+    if (!m_opened) {
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    } else {
+        BufferSource buffer(data);
+        m_device->transfer(WebUSBDevice::TransferDirection::Out, endpointNumber, buffer.data(), buffer.size(), 0, new CallbackPromiseAdapter<OutputTransferResult, USBError>(resolver));
+    }
     return promise;
 }
 
 ScriptPromise USBDevice::isochronousTransferIn(ScriptState* scriptState, uint8_t endpointNumber, Vector<unsigned> packetLengths)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->isochronousTransfer(WebUSBDevice::TransferDirection::In, endpointNumber, nullptr, 0, packetLengths, 0, new CallbackPromiseAdapter<IsochronousInputTransferResult, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->isochronousTransfer(WebUSBDevice::TransferDirection::In, endpointNumber, nullptr, 0, packetLengths, 0, new CallbackPromiseAdapter<IsochronousInputTransferResult, USBError>(resolver));
     return promise;
 }
 
 ScriptPromise USBDevice::isochronousTransferOut(ScriptState* scriptState, uint8_t endpointNumber, const ArrayBufferOrArrayBufferView& data, Vector<unsigned> packetLengths)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    BufferSource buffer(data);
-    m_device->isochronousTransfer(WebUSBDevice::TransferDirection::Out, endpointNumber, buffer.data(), buffer.size(), packetLengths, 0, new CallbackPromiseAdapter<IsochronousOutputTransferResult, USBError>(resolver));
+    if (!m_opened) {
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    } else {
+        BufferSource buffer(data);
+        m_device->isochronousTransfer(WebUSBDevice::TransferDirection::Out, endpointNumber, buffer.data(), buffer.size(), packetLengths, 0, new CallbackPromiseAdapter<IsochronousOutputTransferResult, USBError>(resolver));
+    }
     return promise;
 }
 
 ScriptPromise USBDevice::reset(ScriptState* scriptState)
 {
     ScriptPromiseResolver* resolver = ScriptPromiseResolver::create(scriptState);
     ScriptPromise promise = resolver->promise();
-    m_device->reset(new CallbackPromiseAdapter<void, USBError>(resolver));
+    if (!m_opened)
+        resolver->reject(DOMException::create(InvalidStateError, kOpenRequired));
+    else
+        m_device->reset(new CallbackPromiseAdapter<void, USBError>(resolver));
     return promise;
 }
 
 void USBDevice::contextDestroyed()
 {
-    m_device->close(new WebUSBDeviceCloseCallbacks());
+    if (m_opened)
+        m_device->close(new WebUSBDeviceCloseCallbacks());
 }
 
 DEFINE_TRACE(USBDevice)
 {
     ContextLifecycleObserver::trace(visitor);
 }
 
 } // namespace blink