Simplify use of ContentDecryptionModuleResult with promises

Since ContentDecryptionModuleResult objects are often used to return
promises, add ContentDecryptionModuleResultPromise as a base class
that includes the promise and allow existing classes to only override
the complete() method that they expect to get called.

BUG=358271
TEST=existing EME tests pass

Review URL: https://codereview.chromium.org/687533004

git-svn-id: svn://svn.chromium.org/blink/trunk@185168 bbb929c8-8fbe-4397-9dbb-9b2b20218538

third_party/WebKit/Source/modules/encryptedmedia/SimpleContentDecryptionModuleResult.cpp → third_party/WebKit/Source/modules/encryptedmedia/ContentDecryptionModuleResultPromise.cpp

@@ -3,14 +3,11 @@
 // found in the LICENSE file.
 
 #include "config.h"
-#include "modules/encryptedmedia/SimpleContentDecryptionModuleResult.h"
+#include "modules/encryptedmedia/ContentDecryptionModuleResultPromise.h"
 
 #include "bindings/core/v8/ScriptPromise.h"
-#include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "bindings/core/v8/ScriptState.h"
-#include "bindings/core/v8/V8Binding.h"
 #include "core/dom/DOMException.h"
-#include "platform/Logging.h"
 #include "public/platform/WebString.h"
 #include "wtf/Assertions.h"
 
@@ -41,41 +38,51 @@ ExceptionCode WebCdmExceptionToExceptionCode(WebContentDecryptionModuleException
     return UnknownError;
 }
 
-SimpleContentDecryptionModuleResult::SimpleContentDecryptionModuleResult(ScriptState* scriptState)
+ContentDecryptionModuleResultPromise::ContentDecryptionModuleResultPromise(ScriptState* scriptState)
     : m_resolver(ScriptPromiseResolver::create(scriptState))
 {
 }
 
-SimpleContentDecryptionModuleResult::~SimpleContentDecryptionModuleResult()
+ContentDecryptionModuleResultPromise::~ContentDecryptionModuleResultPromise()
 {
 }
 
-void SimpleContentDecryptionModuleResult::complete()
+void ContentDecryptionModuleResultPromise::complete()
 {
-    m_resolver->resolve(V8UndefinedType());
-    m_resolver.clear();
+    ASSERT_NOT_REACHED();
+    reject(InvalidStateError, "Unexpected completion.");
 }
 
-void SimpleContentDecryptionModuleResult::completeWithSession(WebContentDecryptionModuleResult::SessionStatus status)
+void ContentDecryptionModuleResultPromise::completeWithSession(WebContentDecryptionModuleResult::SessionStatus status)
 {
     ASSERT_NOT_REACHED();
-    completeWithDOMException(InvalidStateError, "Unexpected completion.");
+    reject(InvalidStateError, "Unexpected completion.");
 }
 
-void SimpleContentDecryptionModuleResult::completeWithError(WebContentDecryptionModuleException exceptionCode, unsigned long systemCode, const WebString& errorMessage)
+void ContentDecryptionModuleResultPromise::completeWithError(WebContentDecryptionModuleException exceptionCode, unsigned long systemCode, const WebString& errorMessage)
 {
-    completeWithDOMException(WebCdmExceptionToExceptionCode(exceptionCode), errorMessage);
+    reject(WebCdmExceptionToExceptionCode(exceptionCode), errorMessage);
 }
 
-ScriptPromise SimpleContentDecryptionModuleResult::promise()
+ScriptPromise ContentDecryptionModuleResultPromise::promise()
 {
     return m_resolver->promise();
 }
 
-void SimpleContentDecryptionModuleResult::completeWithDOMException(ExceptionCode code, const String& errorMessage)
+void ContentDecryptionModuleResultPromise::reject(ExceptionCode code, const String& errorMessage)
 {
     m_resolver->reject(DOMException::create(code, errorMessage));
     m_resolver.clear();
 }
 
+ExecutionContext* ContentDecryptionModuleResultPromise::executionContext() const
+{
+    return m_resolver->executionContext();
+}
+
+void ContentDecryptionModuleResultPromise::trace(Visitor* visitor)
+{
+    ContentDecryptionModuleResult::trace(visitor);
+}
+
 } // namespace blink

third_party/WebKit/Source/modules/encryptedmedia/SimpleContentDecryptionModuleResult.h → third_party/WebKit/Source/modules/encryptedmedia/ContentDecryptionModuleResultPromise.h

@@ -2,47 +2,57 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#ifndef SimpleContentDecryptionModuleResult_h
-#define SimpleContentDecryptionModuleResult_h
+#ifndef ContentDecryptionModuleResultPromise_h
+#define ContentDecryptionModuleResultPromise_h
 
+#include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "core/dom/ExceptionCode.h"
 #include "platform/ContentDecryptionModuleResult.h"
-#include "wtf/Forward.h"
 
 namespace blink {
 
-class ScriptPromise;
-class ScriptPromiseResolver;
-class ScriptState;
-class WebString;
-
 ExceptionCode WebCdmExceptionToExceptionCode(WebContentDecryptionModuleException);
 
-// This class wraps the promise resolver and is passed (indirectly) to Chromium
-// to fullfill the promise. This implementation of complete() will resolve the
-// promise with undefined, while completeWithError() reject the promise with an
-// exception. completeWithSession() is not expected to be called, and will
-// reject the promise.
-class SimpleContentDecryptionModuleResult : public ContentDecryptionModuleResult {
+// This class wraps the promise resolver to simplify creation of
+// ContentDecryptionModuleResult objects. The default implementations of the
+// complete(), completeWithSession(), etc. methods will reject the promise
+// with an error. It needs to be subclassed and the appropriate complete()
+// method overridden to resolve the promise as needed.
+class ContentDecryptionModuleResultPromise : public ContentDecryptionModuleResult {
 public:
-    explicit SimpleContentDecryptionModuleResult(ScriptState*);
-    virtual ~SimpleContentDecryptionModuleResult();
+    virtual ~ContentDecryptionModuleResultPromise();
 
     // ContentDecryptionModuleResult implementation.
     virtual void complete() override;
     virtual void completeWithSession(WebContentDecryptionModuleResult::SessionStatus) override;
-    virtual void completeWithError(WebContentDecryptionModuleException, unsigned long systemCode, const WebString&) override;
+    virtual void completeWithError(WebContentDecryptionModuleException, unsigned long systemCode, const WebString&) final;
 
     // It is only valid to call this before completion.
     ScriptPromise promise();
 
-private:
-    // Reject the promise with a DOMException.
-    void completeWithDOMException(ExceptionCode, const String& errorMessage);
+    virtual void trace(Visitor*);
+
+protected:
+    explicit ContentDecryptionModuleResultPromise(ScriptState*);
+
+    // Resolves the promise with |value|. Used by subclasses to resolve the
+    // promise.
+    template <typename... T>
+    void resolve(T... value)
+    {
+        m_resolver->resolve(value...);
+        m_resolver.clear();
+    }
 
+    // Rejects the promise with a DOMException.
+    void reject(ExceptionCode, const String& errorMessage);
+
+    ExecutionContext* executionContext() const;
+
+private:
     RefPtr<ScriptPromiseResolver> m_resolver;
 };
 
 } // namespace blink
 
-#endif // SimpleContentDecryptionModuleResult_h
+#endif // ContentDecryptionModuleResultPromise_h

third_party/WebKit/Source/modules/encryptedmedia/HTMLMediaElementEncryptedMedia.cpp

@@ -15,9 +15,9 @@
 #include "core/html/HTMLMediaElement.h"
 #include "core/html/MediaKeyError.h"
 #include "core/html/MediaKeyEvent.h"
+#include "modules/encryptedmedia/ContentDecryptionModuleResultPromise.h"
 #include "modules/encryptedmedia/MediaEncryptedEvent.h"
 #include "modules/encryptedmedia/MediaKeys.h"
-#include "modules/encryptedmedia/SimpleContentDecryptionModuleResult.h"
 #include "platform/ContentDecryptionModuleResult.h"
 #include "platform/Logging.h"
 #include "platform/RuntimeEnabledFeatures.h"

third_party/WebKit/Source/modules/encryptedmedia/MediaKeySession.cpp

@@ -36,9 +36,10 @@
 #include "core/events/Event.h"
 #include "core/events/GenericEventQueue.h"
 #include "core/html/MediaKeyError.h"
+#include "modules/encryptedmedia/ContentDecryptionModuleResultPromise.h"
 #include "modules/encryptedmedia/MediaKeyMessageEvent.h"
 #include "modules/encryptedmedia/MediaKeys.h"
-#include "modules/encryptedmedia/SimpleContentDecryptionModuleResult.h"
+#include "modules/encryptedmedia/SimpleContentDecryptionModuleResultPromise.h"
 #include "platform/ContentDecryptionModuleResult.h"
 #include "platform/ContentType.h"
 #include "platform/Logging.h"
@@ -201,62 +202,37 @@ private:
 // completeWithSession() will resolve the promise with void, while
 // completeWithError() will reject the promise with an exception. complete()
 // is not expected to be called, and will reject the promise.
-class NewSessionResult : public ContentDecryptionModuleResult {
+class NewSessionResultPromise : public ContentDecryptionModuleResultPromise {
 public:
-    NewSessionResult(ScriptState* scriptState, MediaKeySession* session)
-        : m_resolver(ScriptPromiseResolver::create(scriptState))
+    NewSessionResultPromise(ScriptState* scriptState, MediaKeySession* session)
+        : ContentDecryptionModuleResultPromise(scriptState)
         , m_session(session)
     {
-        WTF_LOG(Media, "NewSessionResult(%p)", this);
     }
 
-    virtual ~NewSessionResult()
+    virtual ~NewSessionResultPromise()
     {
-        WTF_LOG(Media, "~NewSessionResult(%p)", this);
     }
 
     // ContentDecryptionModuleResult implementation.
-    virtual void complete() override
-    {
-        ASSERT_NOT_REACHED();
-        completeWithDOMException(InvalidStateError, "Unexpected completion.");
-    }
-
     virtual void completeWithSession(WebContentDecryptionModuleResult::SessionStatus status) override
     {
         if (status != WebContentDecryptionModuleResult::NewSession) {
             ASSERT_NOT_REACHED();
-            completeWithDOMException(InvalidStateError, "Unexpected completion.");
+            reject(InvalidStateError, "Unexpected completion.");
         }
 
         m_session->finishGenerateRequest();
-        m_resolver->resolve();
-        m_resolver.clear();
-    }
-
-    virtual void completeWithError(WebContentDecryptionModuleException exceptionCode, unsigned long systemCode, const WebString& errorMessage) override
-    {
-        completeWithDOMException(WebCdmExceptionToExceptionCode(exceptionCode), errorMessage);
+        resolve();
     }
 
-    // It is only valid to call this before completion.
-    ScriptPromise promise() { return m_resolver->promise(); }
-
     void trace(Visitor* visitor)
     {
         visitor->trace(m_session);
-        ContentDecryptionModuleResult::trace(visitor);
+        ContentDecryptionModuleResultPromise::trace(visitor);
     }
 
 private:
-    // Reject the promise with a DOMException.
-    void completeWithDOMException(ExceptionCode code, const String& errorMessage)
-    {
-        m_resolver->reject(DOMException::create(code, errorMessage));
-        m_resolver.clear();
-    }
-
-    RefPtr<ScriptPromiseResolver> m_resolver;
     Member<MediaKeySession> m_session;
 };
 
@@ -265,27 +241,19 @@ private:
 // completeWithSession() will resolve the promise with true/false, while
 // completeWithError() will reject the promise with an exception. complete()
 // is not expected to be called, and will reject the promise.
-class LoadSessionResult : public ContentDecryptionModuleResult {
+class LoadSessionResultPromise : public ContentDecryptionModuleResultPromise {
 public:
-    LoadSessionResult(ScriptState* scriptState, MediaKeySession* session)
-        : m_resolver(ScriptPromiseResolver::create(scriptState))
+    LoadSessionResultPromise(ScriptState* scriptState, MediaKeySession* session)
+        : ContentDecryptionModuleResultPromise(scriptState)
         , m_session(session)
     {
-        WTF_LOG(Media, "LoadSessionResult(%p)", this);
     }
 
-    virtual ~LoadSessionResult()
+    virtual ~LoadSessionResultPromise()
     {
-        WTF_LOG(Media, "~LoadSessionResult(%p)", this);
     }
 
     // ContentDecryptionModuleResult implementation.
-    virtual void complete() override
-    {
-        ASSERT_NOT_REACHED();
-        completeWithDOMException(InvalidStateError, "Unexpected completion.");
-    }
-
     virtual void completeWithSession(WebContentDecryptionModuleResult::SessionStatus status) override
     {
         bool result = false;
@@ -300,38 +268,21 @@ public:
 
         case WebContentDecryptionModuleResult::SessionAlreadyExists:
             ASSERT_NOT_REACHED();
-            completeWithDOMException(InvalidStateError, "Unexpected completion.");
+            reject(InvalidStateError, "Unexpected completion.");
             return;
         }
 
         m_session->finishLoad();
-        m_resolver->resolve(result);
-        m_resolver.clear();
-    }
-
-    virtual void completeWithError(WebContentDecryptionModuleException exceptionCode, unsigned long systemCode, const WebString& errorMessage) override
-    {
-        completeWithDOMException(WebCdmExceptionToExceptionCode(exceptionCode), errorMessage);
+        resolve(result);
     }
 
-    // It is only valid to call this before completion.
-    ScriptPromise promise() { return m_resolver->promise(); }
-
     void trace(Visitor* visitor)
     {
         visitor->trace(m_session);
-        ContentDecryptionModuleResult::trace(visitor);
+        ContentDecryptionModuleResultPromise::trace(visitor);
     }
 
 private:
-    // Reject the promise with a DOMException.
-    void completeWithDOMException(ExceptionCode code, const String& errorMessage)
-    {
-        m_resolver->reject(DOMException::create(code, errorMessage));
-        m_resolver.clear();
-    }
-
-    RefPtr<ScriptPromiseResolver> m_resolver;
     Member<MediaKeySession> m_session;
 };
 
@@ -480,7 +431,7 @@ ScriptPromise MediaKeySession::generateRequestInternal(ScriptState* scriptState,
     //    (Done in constructor.)
 
     // 9. Let promise be a new promise.
-    NewSessionResult* result = new NewSessionResult(scriptState, this);
+    NewSessionResultPromise* result = new NewSessionResultPromise(scriptState, this);
     ScriptPromise promise = result->promise();
 
     // 10. Run the following steps asynchronously (documented in
@@ -536,7 +487,7 @@ ScriptPromise MediaKeySession::load(ScriptState* scriptState, const String& sess
     //    (Done by CDM.)
 
     // 7. Let promise be a new promise.
-    LoadSessionResult* result = new LoadSessionResult(scriptState, this);
+    LoadSessionResultPromise* result = new LoadSessionResultPromise(scriptState, this);
     ScriptPromise promise = result->promise();
 
     // 8. Run the following steps asynchronously (documented in
@@ -582,7 +533,7 @@ ScriptPromise MediaKeySession::updateInternal(ScriptState* scriptState, PassRefP
     //    (Copied in the caller.)
 
     // 3. Let promise be a new promise.
-    SimpleContentDecryptionModuleResult* result = new SimpleContentDecryptionModuleResult(scriptState);
+    SimpleContentDecryptionModuleResultPromise* result = new SimpleContentDecryptionModuleResultPromise(scriptState);
     ScriptPromise promise = result->promise();
 
     // 4. Run the following steps asynchronously (documented in
@@ -619,7 +570,7 @@ ScriptPromise MediaKeySession::close(ScriptState* scriptState)
         return ScriptPromise::cast(scriptState, ScriptValue());
 
     // 3. Let promise be a new promise.
-    SimpleContentDecryptionModuleResult* result = new SimpleContentDecryptionModuleResult(scriptState);
+    SimpleContentDecryptionModuleResultPromise* result = new SimpleContentDecryptionModuleResultPromise(scriptState);
     ScriptPromise promise = result->promise();
 
     // 4. Run the following steps asynchronously (documented in
@@ -663,7 +614,7 @@ ScriptPromise MediaKeySession::remove(ScriptState* scriptState)
     }
 
     // 4. Let promise be a new promise.
-    SimpleContentDecryptionModuleResult* result = new SimpleContentDecryptionModuleResult(scriptState);
+    SimpleContentDecryptionModuleResultPromise* result = new SimpleContentDecryptionModuleResultPromise(scriptState);
     ScriptPromise promise = result->promise();
 
     // 5. Run the following steps asynchronously (documented in

third_party/WebKit/Source/modules/encryptedmedia/MediaKeySession.h

@@ -98,8 +98,8 @@ public:
 
 private:
     class PendingAction;
-    friend class NewSessionResult;
-    friend class LoadSessionResult;
+    friend class NewSessionResultPromise;
+    friend class LoadSessionResultPromise;
 
     MediaKeySession(ScriptState*, MediaKeys*, const String& sessionType);
 

third_party/WebKit/Source/modules/encryptedmedia/MediaKeys.cpp

@@ -33,7 +33,7 @@
 #include "core/dom/ExceptionCode.h"
 #include "core/dom/ExecutionContext.h"
 #include "modules/encryptedmedia/MediaKeySession.h"
-#include "modules/encryptedmedia/SimpleContentDecryptionModuleResult.h"
+#include "modules/encryptedmedia/SimpleContentDecryptionModuleResultPromise.h"
 #include "platform/ContentType.h"
 #include "platform/Logging.h"
 #include "platform/MIMETypeRegistry.h"
@@ -165,7 +165,7 @@ ScriptPromise MediaKeys::setServerCertificateInternal(ScriptState* scriptState,
     //    (Done in caller.)
 
     // 4. Let promise be a new promise.
-    SimpleContentDecryptionModuleResult* result = new SimpleContentDecryptionModuleResult(scriptState);
+    SimpleContentDecryptionModuleResultPromise* result = new SimpleContentDecryptionModuleResultPromise(scriptState);
     ScriptPromise promise = result->promise();
 
     // 5. Run the following steps asynchronously (documented in timerFired()).

third_party/WebKit/Source/modules/encryptedmedia/SimpleContentDecryptionModuleResultPromise.cpp

+// Copyright 2014 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 "config.h"
+#include "modules/encryptedmedia/SimpleContentDecryptionModuleResultPromise.h"
+
+namespace blink {
+
+SimpleContentDecryptionModuleResultPromise::SimpleContentDecryptionModuleResultPromise(ScriptState* scriptState)
+    : ContentDecryptionModuleResultPromise(scriptState)
+{
+}
+
+SimpleContentDecryptionModuleResultPromise::~SimpleContentDecryptionModuleResultPromise()
+{
+}
+
+void SimpleContentDecryptionModuleResultPromise::complete()
+{
+    resolve();
+}
+
+} // namespace blink

third_party/WebKit/Source/modules/encryptedmedia/SimpleContentDecryptionModuleResultPromise.h

+// Copyright 2014 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.
+
+#ifndef SimpleContentDecryptionModuleResultPromise_h
+#define SimpleContentDecryptionModuleResultPromise_h
+
+#include "modules/encryptedmedia/ContentDecryptionModuleResultPromise.h"
+
+namespace blink {
+
+// This class creates a simple ContentDecryptionModuleResultPromise where the
+// implementation of complete() will resolve the promise with void. All other
+// complete() methods are not expected to be called (and will reject the
+// promise).
+class SimpleContentDecryptionModuleResultPromise : public ContentDecryptionModuleResultPromise {
+public:
+    explicit SimpleContentDecryptionModuleResultPromise(ScriptState*);
+    virtual ~SimpleContentDecryptionModuleResultPromise();
+
+    // ContentDecryptionModuleResultPromise implementation.
+    virtual void complete() override;
+};
+
+} // namespace blink
+
+#endif // SimpleContentDecryptionModuleResultPromise_h

third_party/WebKit/Source/modules/modules.gypi

@@ -415,6 +415,8 @@
       'encoding/TextDecoder.h',
       'encoding/TextEncoder.cpp',
       'encoding/TextEncoder.h',
+      'encryptedmedia/ContentDecryptionModuleResultPromise.cpp',
+      'encryptedmedia/ContentDecryptionModuleResultPromise.h',
       'encryptedmedia/HTMLMediaElementEncryptedMedia.cpp',
       'encryptedmedia/HTMLMediaElementEncryptedMedia.h',
       'encryptedmedia/MediaEncryptedEvent.cpp',
@@ -432,8 +434,8 @@
       'encryptedmedia/MediaKeysController.h',
       'encryptedmedia/NavigatorRequestMediaKeySystemAccess.cpp',
       'encryptedmedia/NavigatorRequestMediaKeySystemAccess.h',
-      'encryptedmedia/SimpleContentDecryptionModuleResult.cpp',
-      'encryptedmedia/SimpleContentDecryptionModuleResult.h',
+      'encryptedmedia/SimpleContentDecryptionModuleResultPromise.cpp',
+      'encryptedmedia/SimpleContentDecryptionModuleResultPromise.h',
       'filesystem/DOMFilePath.cpp',
       'filesystem/DOMFilePath.h',
       'filesystem/DOMFileSystem.cpp',