Make WebMIDI use blink Promise.

Source/modules/webmidi/MIDIAccess.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 13 matching lines @@
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "modules/webmidi/MIDIAccess.h"
 
+#include "bindings/v8/DOMRequestState.h"
+#include "bindings/v8/DOMWrapperWorld.h"
+#include "bindings/v8/ScriptPromise.h"
+#include "bindings/v8/ScriptPromiseResolver.h"
+#include "bindings/v8/V8Binding.h"
 #include "core/dom/DOMError.h"
 #include "core/dom/Document.h"
 #include "core/loader/DocumentLoadTiming.h"
 #include "core/loader/DocumentLoader.h"
-#include "modules/webmidi/MIDIAccessPromise.h"
 #include "modules/webmidi/MIDIConnectionEvent.h"
 #include "modules/webmidi/MIDIController.h"
+#include "modules/webmidi/MIDIOptions.h"
 #include "modules/webmidi/MIDIPort.h"
+#include "modules/webmidi/NavigatorWebMIDI.h"
 
 namespace WebCore {
 
-PassRefPtrWillBeRawPtr<MIDIAccess> MIDIAccess::create(ExecutionContext* context, MIDIAccessPromise* promise)
+PassRefPtrWillBeRawPtr<MIDIAccess> MIDIAccess::create(const MIDIOptions& options, ExecutionContext* context)
 {
-    RefPtrWillBeRawPtr<MIDIAccess> midiAccess(adoptRefCountedWillBeRefCountedGarbageCollected(new MIDIAccess(context, promise)));
+    RefPtrWillBeRawPtr<MIDIAccess> midiAccess(adoptRefCountedWillBeRefCountedGarbageCollected(new MIDIAccess(options, context)));
     midiAccess->suspendIfNeeded();
-    midiAccess->startRequest();
     return midiAccess.release();
 }
 
 MIDIAccess::~MIDIAccess()
 {
-    stop();
+    ASSERT(!m_requesting);
 }
 
-MIDIAccess::MIDIAccess(ExecutionContext* context, MIDIAccessPromise* promise)
+MIDIAccess::MIDIAccess(const MIDIOptions& options, ExecutionContext* context)
     : ActiveDOMObject(context)
-    , m_promise(promise)
+    , m_activeDOMObjectState(Active)
+    , m_promiseState(Pending)
+    , m_options(options)
     , m_hasAccess(false)
     , m_sysExEnabled(false)
     , m_requesting(false)
+    , m_resumeTimer(this, &MIDIAccess::resumeTimerFired)
 {
     ScriptWrappable::init(this);
     m_accessor = MIDIAccessor::create(this);
 }
 
 void MIDIAccess::setSysExEnabled(bool enable)
 {
-    m_requesting = false;
     m_sysExEnabled = enable;
-    if (enable)
+    if (enable) {
         m_accessor->startSession();
-    else
-        permissionDenied();
+    } else {
+        reject(DOMError::create("SecurityError"));
+        // |this| may be deleted here.
+    }
 }
 
 void MIDIAccess::didAddInputPort(const String& id, const String& manufacturer, const String& name, const String& version)
 {
     ASSERT(isMainThread());
 
     m_inputs.append(MIDIInput::create(this, id, manufacturer, name, version));
 }
 
 void MIDIAccess::didAddOutputPort(const String& id, const String& manufacturer, const String& name, const String& version)
 {
     ASSERT(isMainThread());
 
     unsigned portIndex = m_outputs.size();
     m_outputs.append(MIDIOutput::create(this, portIndex, id, manufacturer, name, version));
 }
 
 void MIDIAccess::didStartSession(bool success)
 {
     ASSERT(isMainThread());
-
-    m_hasAccess = success;
+    if (!m_requesting)
+        return;
     if (success)
-        m_promise->fulfill();
+        resolve();
     else
-        m_promise->reject(DOMError::create("InvalidStateError"));
+        reject(DOMError::create("InvalidStateError"));
+    // |this| may be deleted here.
 }
 
 void MIDIAccess::didReceiveMIDIData(unsigned portIndex, const unsigned char* data, size_t length, double timeStamp)
 {
     ASSERT(isMainThread());
 
     if (m_hasAccess && portIndex < m_inputs.size()) {
         // Convert from time in seconds which is based on the time coordinate system of monotonicallyIncreasingTime()
         // into time in milliseconds (a DOMHighResTimeStamp) according to the same time coordinate system as performance.now().
         // This is how timestamps are defined in the Web MIDI spec.
@@ skipping 21 matching lines @@
             Document* document = toDocument(executionContext());
             ASSERT(document);
             double documentStartTime = document->loader()->timing()->referenceMonotonicTime();
             timeStamp = documentStartTime + 0.001 * timeStampInMilliseconds;
         }
 
         m_accessor->sendMIDIData(portIndex, data, length, timeStamp);
     }
 }
 
+void MIDIAccess::suspend()
+{
+    ASSERT(m_activeDOMObjectState == Active);
+    m_activeDOMObjectState = Suspended;
+    m_resumeTimer.stop();
+}
+
+void MIDIAccess::resume()
+{
+    ASSERT(m_activeDOMObjectState == Suspended);
+    m_activeDOMObjectState = Active;
+    if (m_promiseState == Resolving || m_promiseState == Rejecting)
+        m_resumeTimer.startOneShot(0);
+}
+
 void MIDIAccess::stop()
 {
+    RefPtrWillBeRawPtr<MIDIAccess> protect(this);
+    m_activeDOMObjectState = Stopped;
     m_hasAccess = false;
+    m_promiseState = ResolvedOrRejected;
+    m_error.clear();
+    m_resumeTimer.stop();
+    m_accessor.clear();
     if (!m_requesting)
         return;
-    m_requesting = false;
     Document* document = toDocument(executionContext());
     ASSERT(document);
     MIDIController* controller = MIDIController::from(document->page());
     ASSERT(controller);
     controller->cancelSysExPermissionRequest(this);
+    setRequesting(false);
 }
 
-void MIDIAccess::startRequest()
+void MIDIAccess::permissionDenied()
 {
-    if (!m_promise->options()->sysex) {
+    ASSERT(isMainThread());
+    reject(DOMError::create("SecurityError"));
+}
+
+void MIDIAccess::setRequesting(bool value)
+{
+    ASSERT(m_requesting != value);
+    if (value) {
+        setPendingActivity(this);
+        m_requesting = true;

[haraken, 2014/02/26 11:30:39]

Could you avoid using setPendingActivity/unsetPendingActivity by overriding
hasPendingActivity?

  bool hasPendingActivity() {
    return m_requesting;
  }

[yhirano, 2014/02/26 11:55:15]

Because MIDIAccess is not exposed to the V8 GC at the creation time, setting
hasPendingActivity don't take effect.

[haraken, 2014/02/26 12:09:52]

Then probably should we use ContextLifecycleObserver instead of ActiveDOMObject?
ActiveDOMObject is designed for managing lifetime of wrappers (but people are
misusing it in a couple of places:-).

[yhirano, 2014/02/26 12:16:37]

MIDIAccess will be exposed to the GC, but it is not at the creation time.
The wrapper will be created when Promise onFulfilled callback is called.

[yhirano, 2014/02/26 12:37:12]

Sorry, I was wrong. The wrapper will be created when the promise is resolved
with this object.

[haraken, 2014/02/26 12:52:40]

Let's discuss this issue offline tomorrow. I think we need to improve an
infrastructure of ActiveDOMObject and ContextLifecycleObserver so that they can
handle cases like MIDIAccess.

[yhirano, 2014/03/04 17:52:59]

Done.

+    } else {
+        m_requesting = false;
+        unsetPendingActivity(this);
+    }
+}
+
+ScriptPromise MIDIAccess::startRequest()
+{
+    ASSERT(!m_requesting);
+    ScriptPromise promise = ScriptPromise::createPending();
+    m_resolver = MIDIAccessResolver::create(ScriptPromiseResolver::create(promise, executionContext()), executionContext());
+    setRequesting(true);
+    if (!m_options.sysex) {
         m_accessor->startSession();
-        return;
+        return promise;
     }
     Document* document = toDocument(executionContext());
     ASSERT(document);
     MIDIController* controller = MIDIController::from(document->page());
     if (controller) {
-        m_requesting = true;
         controller->requestSysExPermission(this);
     } else {
-        permissionDenied();
+        reject(DOMError::create("SecurityError"));
+        // |this| may be deleted here.
+    }
+    return promise;
+}
+
+void MIDIAccess::resolve()
+{
+    if (m_promiseState != Pending || m_activeDOMObjectState == Stopped)
+        return;
+    if (m_activeDOMObjectState == Active) {
+        resolveNow();
+        // |this| may be deleted here.
+    } else {
+        ASSERT(m_activeDOMObjectState == Suspended);
+        m_promiseState = Resolving;
     }
 }
 
-void MIDIAccess::permissionDenied()
+void MIDIAccess::reject(PassRefPtr<DOMError> error)
 {
-    ASSERT(isMainThread());
+    if (m_promiseState != Pending || m_activeDOMObjectState == Stopped)
+        return;
+    if (m_activeDOMObjectState == Active) {
+        rejectNow(error);
+        // |this| may be deleted here.
+    } else {
+        ASSERT(m_activeDOMObjectState == Suspended);
+        m_promiseState = Rejecting;
+        m_error = error;
+    }
+}
 
+void MIDIAccess::resolveNow()
+{
+    if (!m_requesting)
+        return;
+    ASSERT(m_promiseState != ResolvedOrRejected);
+    ASSERT(m_activeDOMObjectState == Active);
+
+    RefPtrWillBeRawPtr<MIDIAccess> protect(this);
+    m_promiseState = ResolvedOrRejected;
+    m_hasAccess = true;
+    setRequesting(false);
+    m_resolver->resolve(this);
+}
+
+void MIDIAccess::rejectNow(PassRefPtr<DOMError> error)
+{
+    if (!m_requesting)
+        return;
+    ASSERT(m_promiseState != ResolvedOrRejected);
+    ASSERT(m_activeDOMObjectState == Active);
+
+    RefPtrWillBeRawPtr<MIDIAccess> protect(this);
+    m_promiseState = ResolvedOrRejected;
     m_hasAccess = false;
-    m_promise->reject(DOMError::create("SecurityError"));
+    setRequesting(false);
+    m_resolver->reject(error);
+}
+
+void MIDIAccess::resumeTimerFired(Timer<MIDIAccess>*)
+{
+    ASSERT(m_activeDOMObjectState == Active);
+    if (m_promiseState == Resolving) {
+        resolveNow();
+    } else {
+        ASSERT(m_promiseState == Rejecting);
+        rejectNow(m_error.release());
+    }
+    // |this| may be deleted here.
 }
 
 void MIDIAccess::trace(Visitor* visitor)
 {
     visitor->trace(m_inputs);
     visitor->trace(m_outputs);
-    visitor->trace(m_promise);
 }
 
 } // namespace WebCore