Update EME errors to use TypeError

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

 /*
  * Copyright (C) 2013 Apple 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:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 11 matching lines @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  * THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "modules/encryptedmedia/MediaKeySession.h"
 
 #include "bindings/core/v8/DOMWrapperWorld.h"
 #include "bindings/core/v8/ScriptPromise.h"
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "bindings/core/v8/ScriptState.h"
+#include "bindings/core/v8/V8ThrowException.h"
 #include "core/dom/DOMArrayBuffer.h"
 #include "core/dom/DOMException.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/events/Event.h"
 #include "core/events/GenericEventQueue.h"
 #include "modules/encryptedmedia/ContentDecryptionModuleResultPromise.h"
 #include "modules/encryptedmedia/EncryptedMediaUtils.h"
 #include "modules/encryptedmedia/MediaKeyMessageEvent.h"
 #include "modules/encryptedmedia/MediaKeys.h"
 #include "platform/ContentDecryptionModuleResult.h"
@@ skipping 32 matching lines @@
 
   // Check that the sessionId only contains alphanumeric characters.
   for (unsigned i = 0; i < sessionId.length(); ++i) {
     if (!isASCIIAlphanumeric(sessionId[i]))
       return false;
   }
 
   return true;
 }
 
+static bool IsPersistentSessionType(WebEncryptedMediaSessionType sessionType) {

[xhwang, 2016/10/17 23:13:55]

Add a comment that this implements "5.1.1 Is persistent session type"?

https://w3c.github.io/encrypted-media/#is-persistent-session-type

Also OOC, what's the plan for "persistent-usage-record"?

[jrummell, 2016/10/18 00:50:39]

Done.

+  switch (sessionType) {
+    case WebEncryptedMediaSessionType::Temporary:
+      return false;
+    case WebEncryptedMediaSessionType::PersistentLicense:
+      return true;
+    case WebEncryptedMediaSessionType::PersistentReleaseMessage:
+      return true;
+    case blink::WebEncryptedMediaSessionType::Unknown:
+      break;
+  }
+
+  NOTREACHED();
+  return false;
+}
+
 static String ConvertKeyStatusToString(
     const WebEncryptedMediaKeyInformation::KeyStatus status) {
   switch (status) {
     case WebEncryptedMediaKeyInformation::KeyStatus::Usable:
       return "usable";
     case WebEncryptedMediaKeyInformation::KeyStatus::Expired:
       return "expired";
     case WebEncryptedMediaKeyInformation::KeyStatus::Released:
       return "released";
     case WebEncryptedMediaKeyInformation::KeyStatus::OutputRestricted:
@@ skipping 10 matching lines @@
   return "internal-error";
 }
 
 static ScriptPromise CreateRejectedPromiseNotCallable(
     ScriptState* scriptState) {
   return ScriptPromise::rejectWithDOMException(
       scriptState,
       DOMException::create(InvalidStateError, "The session is not callable."));
 }
 
+static ScriptPromise CreateRejectedPromiseAlreadyClosed(
+    ScriptState* scriptState) {
+  return ScriptPromise::rejectWithDOMException(
+      scriptState, DOMException::create(InvalidStateError,
+                                        "The session is already closed."));
+}
+
 static ScriptPromise CreateRejectedPromiseAlreadyInitialized(
     ScriptState* scriptState) {
   return ScriptPromise::rejectWithDOMException(
       scriptState, DOMException::create(InvalidStateError,
                                         "The session is already initialized."));
 }
 
 // A class holding a pending action.
 class MediaKeySession::PendingAction
     : public GarbageCollectedFinalized<MediaKeySession::PendingAction> {
@@ skipping 296 matching lines @@
 ScriptPromise MediaKeySession::generateRequest(ScriptState* scriptState,
                                                const String& initDataTypeString,
                                                const DOMArrayPiece& initData) {
   DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this << ") "
                                      << initDataTypeString;
 
   // From https://w3c.github.io/encrypted-media/#generateRequest:
   // Generates a request based on the initData. When this method is invoked,
   // the user agent must run the following steps:
 
-  // 1. If this object's uninitialized value is false, return a promise
-  //    rejected with a new DOMException whose name is "InvalidStateError".
+  // 1. If this object is closed, return a promise rejected with an
+  //    InvalidStateError.
+  if (m_isClosed)
+    return CreateRejectedPromiseAlreadyClosed(scriptState);
+
+  // 2. If this object's uninitialized value is false, return a promise
+  //    rejected with an InvalidStateError.
   if (!m_isUninitialized)
     return CreateRejectedPromiseAlreadyInitialized(scriptState);
 
-  // 2. Let this object's uninitialized be false.
+  // 3. Let this object's uninitialized be false.
   m_isUninitialized = false;
 
-  // 3. If initDataType is an empty string, return a promise rejected with a
-  //    new DOMException whose name is "InvalidAccessError".
+  // 4. If initDataType is the empty string, return a promise rejected
+  //    with a newly created TypeError.
   if (initDataTypeString.isEmpty()) {
-    return ScriptPromise::rejectWithDOMException(
+    return ScriptPromise::reject(
         scriptState,
-        DOMException::create(InvalidAccessError,
-                             "The initDataType parameter is empty."));
+        V8ThrowException::createTypeError(
+            scriptState->isolate(), "The initDataType parameter is empty."));
   }
 
-  // 4. If initData is an empty array, return a promise rejected with a new
-  //    DOMException whose name is"InvalidAccessError".
+  // 5. If initData is an empty array, return a promise rejected with a
+  //    newly created TypeError.
   if (!initData.byteLength()) {
-    return ScriptPromise::rejectWithDOMException(
-        scriptState, DOMException::create(InvalidAccessError,
+    return ScriptPromise::reject(
+        scriptState,
+        V8ThrowException::createTypeError(scriptState->isolate(),
                                           "The initData parameter is empty."));
   }
 
-  // 5. If the Key System implementation represented by this object's cdm
+  // 6. If the Key System implementation represented by this object's cdm
   //    implementation value does not support initDataType as an
   //    Initialization Data Type, return a promise rejected with a new
   //    DOMException whose name is NotSupportedError. String comparison
   //    is case-sensitive.
   //    (blink side doesn't know what the CDM supports, so the proper check
   //     will be done on the Chromium side. However, we can verify that
   //     |initDataType| is one of the registered values.)
   WebEncryptedMediaInitDataType initDataType =
       EncryptedMediaUtils::convertToInitDataType(initDataTypeString);
   if (initDataType == WebEncryptedMediaInitDataType::Unknown) {
     return ScriptPromise::rejectWithDOMException(
         scriptState,
         DOMException::create(NotSupportedError,
                              "The initialization data type '" +
                                  initDataTypeString + "' is not supported."));
   }
 
-  // 6. Let init data be a copy of the contents of the initData parameter.
+  // 7. Let init data be a copy of the contents of the initData parameter.
   DOMArrayBuffer* initDataBuffer =
       DOMArrayBuffer::create(initData.data(), initData.byteLength());
 
-  // 7. Let session type be this object's session type.
+  // 8. Let session type be this object's session type.
   //    (Done in constructor.)
 
-  // 8. Let promise be a new promise.
+  // 9. Let promise be a new promise.
   NewSessionResultPromise* result =
       new NewSessionResultPromise(scriptState, this);
   ScriptPromise promise = result->promise();
 
-  // 9. Run the following steps asynchronously (documented in
-  //    actionTimerFired())
+  // 10. Run the following steps asynchronously (documented in
+  //     actionTimerFired())
   m_pendingActions.append(PendingAction::CreatePendingGenerateRequest(
       result, initDataType, initDataBuffer));
   DCHECK(!m_actionTimer.isActive());
   m_actionTimer.startOneShot(0, BLINK_FROM_HERE);
 
-  // 10. Return promise.
+  // 11. Return promise.
   return promise;
 }
 
 ScriptPromise MediaKeySession::load(ScriptState* scriptState,
                                     const String& sessionId) {
   DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this << ") "
                                      << sessionId;
 
   // From https://w3c.github.io/encrypted-media/#load:
   // Loads the data stored for the specified session into this object. When
   // this method is invoked, the user agent must run the following steps:
 
-  // 1. If this object's uninitialized value is false, return a promise
-  //    rejected with a new DOMException whose name is "InvalidStateError".
+  // 1. If this object is closed, return a promise rejected with an
+  //    InvalidStateError.
+  if (m_isClosed)
+    return CreateRejectedPromiseAlreadyClosed(scriptState);
+
+  // 2. If this object's uninitialized value is false, return a promise
+  //    rejected with an InvalidStateError.
   if (!m_isUninitialized)
     return CreateRejectedPromiseAlreadyInitialized(scriptState);
 
-  // 2. Let this object's uninitialized be false.
+  // 3. Let this object's uninitialized value be false.
   m_isUninitialized = false;
 
-  // 3. If sessionId is an empty string, return a promise rejected with a
-  //    new DOMException whose name is "InvalidAccessError".
+  // 4. If sessionId is the empty string, return a promise rejected with
+  //    a newly created TypeError.
   if (sessionId.isEmpty()) {
-    return ScriptPromise::rejectWithDOMException(
-        scriptState, DOMException::create(InvalidAccessError,
+    return ScriptPromise::reject(
+        scriptState,
+        V8ThrowException::createTypeError(scriptState->isolate(),
                                           "The sessionId parameter is empty."));
   }
 
-  // 4. If this object's session type is not "persistent-license" or
-  //    "persistent-release-message", return a promise rejected with a
-  //    new DOMException whose name is InvalidAccessError.
-  if (m_sessionType != WebEncryptedMediaSessionType::PersistentLicense &&
-      m_sessionType != WebEncryptedMediaSessionType::PersistentReleaseMessage) {
-    return ScriptPromise::rejectWithDOMException(
+  // 5. If the result of running the "Is persistent session type?" algorithm
+  //    on this object's session type is false, return a promise rejected
+  //    with a newly created TypeError.
+  if (!IsPersistentSessionType(m_sessionType)) {
+    return ScriptPromise::reject(
         scriptState,
-        DOMException::create(InvalidAccessError,
-                             "The session type is not persistent."));
+        V8ThrowException::createTypeError(
+            scriptState->isolate(), "The session type is not persistent."));
   }
 
-  // 5. If the Key System implementation represented by this object's cdm
-  //    implementation value does not support loading previous sessions,
-  //    return a promise rejected with a new DOMException whose name is
-  //    NotSupportedError.
-  // FIXME: Implement this (http://crbug.com/448922).
-
   // 6. Let origin be the origin of this object's Document.
   //    (Available as getExecutionContext()->getSecurityOrigin() anytime.)
 
   // 7. Let promise be a new promise.
   LoadSessionResultPromise* result =
       new LoadSessionResultPromise(scriptState, this);
   ScriptPromise promise = result->promise();
 
   // 8. Run the following steps asynchronously (documented in
   //    actionTimerFired())
   m_pendingActions.append(
       PendingAction::CreatePendingLoadRequest(result, sessionId));
   DCHECK(!m_actionTimer.isActive());
   m_actionTimer.startOneShot(0, BLINK_FROM_HERE);
 
   // 9. Return promise.
   return promise;
 }
 
 ScriptPromise MediaKeySession::update(ScriptState* scriptState,
                                       const DOMArrayPiece& response) {
   DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this << ")";
-  DCHECK(!m_isClosed);
 
   // From https://w3c.github.io/encrypted-media/#update:
   // Provides messages, including licenses, to the CDM. When this method is
   // invoked, the user agent must run the following steps:
 
-  // 1. If this object's callable value is false, return a promise rejected
-  //    with a new DOMException whose name is InvalidStateError.
+  // 1. If this object is closed, return a promise rejected with an
+  //    InvalidStateError.
+  if (m_isClosed)
+    return CreateRejectedPromiseAlreadyClosed(scriptState);
+
+  // 2. If this object's callable value is false, return a promise
+  //    rejected with an InvalidStateError.
   if (!m_isCallable)
     return CreateRejectedPromiseNotCallable(scriptState);
 
-  // 2. If response is an empty array, return a promise rejected with a
-  //    new DOMException whose name is InvalidAccessError.
+  // 3. If response is an empty array, return a promise rejected with a
+  //    newly created TypeError.
   if (!response.byteLength()) {
-    return ScriptPromise::rejectWithDOMException(
-        scriptState, DOMException::create(InvalidAccessError,
+    return ScriptPromise::reject(
+        scriptState,
+        V8ThrowException::createTypeError(scriptState->isolate(),
                                           "The response parameter is empty."));
   }
 
-  // 3. Let response copy be a copy of the contents of the response parameter.
+  // 4. Let response copy be a copy of the contents of the response parameter.
   DOMArrayBuffer* responseCopy =
       DOMArrayBuffer::create(response.data(), response.byteLength());
 
-  // 4. Let promise be a new promise.
+  // 5. Let promise be a new promise.
   SimpleResultPromise* result = new SimpleResultPromise(scriptState, this);
   ScriptPromise promise = result->promise();
 
-  // 5. Run the following steps asynchronously (documented in
+  // 6. Run the following steps asynchronously (documented in
   //    actionTimerFired())
   m_pendingActions.append(
       PendingAction::CreatePendingUpdate(result, responseCopy));
   if (!m_actionTimer.isActive())
     m_actionTimer.startOneShot(0, BLINK_FROM_HERE);
 
-  // 6. Return promise.
+  // 7. Return promise.
   return promise;
 }
 
 ScriptPromise MediaKeySession::close(ScriptState* scriptState) {
   DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this << ")";
 
   // From https://w3c.github.io/encrypted-media/#close:
   // Indicates that the application no longer needs the session and the CDM
   // should release any resources associated with this object and close it.
   // When this method is invoked, the user agent must run the following steps:
@@ skipping 22 matching lines @@
   return promise;
 }
 
 ScriptPromise MediaKeySession::remove(ScriptState* scriptState) {
   DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this << ")";
 
   // From https://w3c.github.io/encrypted-media/#remove:
   // Removes stored session data associated with this object. When this
   // method is invoked, the user agent must run the following steps:
 
-  // 1. If this object's callable value is false, return a promise rejected
-  //    with a new DOMException whose name is "InvalidStateError".
+  // 1. If this object is closed, return a promise rejected with an
+  //    InvalidStateError.
+  if (m_isClosed)
+    return CreateRejectedPromiseAlreadyClosed(scriptState);
+
+  // 2. If this object's callable value is false, return a promise rejected
+  //    with an InvalidStateError.
   if (!m_isCallable)
     return CreateRejectedPromiseNotCallable(scriptState);
 
-  // 2. If this object's session type is not "persistent-license" or
-  //    "persistent-release-message", return a promise rejected with a
-  //    new DOMException whose name is InvalidAccessError.
-  if (m_sessionType != WebEncryptedMediaSessionType::PersistentLicense &&
-      m_sessionType != WebEncryptedMediaSessionType::PersistentReleaseMessage) {
-    return ScriptPromise::rejectWithDOMException(
+  // 3. If the result of running the "Is persistent session type?" algorithm
+  //    on this object's session type is false, return a promise rejected
+  //    with a newly created TypeError.
+  if (!IsPersistentSessionType(m_sessionType)) {
+    return ScriptPromise::reject(
         scriptState,
-        DOMException::create(InvalidAccessError,
-                             "The session type is not persistent."));
-  }
-
-  // 3. If the Session Close algorithm has been run on this object, return a
-  //    promise rejected with a new DOMException whose name is
-  //    "InvalidStateError".
-  if (m_isClosed) {
-    return ScriptPromise::rejectWithDOMException(
-        scriptState, DOMException::create(InvalidStateError,
-                                          "The session is already closed."));
+        V8ThrowException::createTypeError(
+            scriptState->isolate(), "The session type is not persistent."));
   }
 
   // 4. Let promise be a new promise.
   SimpleResultPromise* result = new SimpleResultPromise(scriptState, this);
   ScriptPromise promise = result->promise();
 
   // 5. Run the following steps asynchronously (documented in
   //    actionTimerFired()).
   m_pendingActions.append(PendingAction::CreatePendingRemove(result));
   if (!m_actionTimer.isActive())
     m_actionTimer.startOneShot(0, BLINK_FROM_HERE);
 
   // 6. Return promise.
   return promise;
 }
 
 void MediaKeySession::actionTimerFired(TimerBase*) {
   DCHECK(m_pendingActions.size());
 
   // Resolving promises now run synchronously and may result in additional
   // actions getting added to the queue. As a result, swap the queue to
   // a local copy to avoid problems if this happens.
   HeapDeque<Member<PendingAction>> pendingActions;
   pendingActions.swap(m_pendingActions);
 
   while (!pendingActions.isEmpty()) {
     PendingAction* action = pendingActions.takeFirst();
 
     switch (action->getType()) {
       case PendingAction::GenerateRequest:

[xhwang, 2016/10/17 23:13:55]

nit: Not related to this CL. I wonder whether we should wrap the content of each
"case" block into a helper function so that we can put the async part directly
under the sync part for better readability, e.g.

load() {
// Load step 1 to 7
}

loadTask() {
// Load step 8
}

actionTimerFired() {
  ...
  case Load:
    loadTask();
}

[jrummell, 2016/10/18 00:50:39]

Good idea. Next CL.

-        // NOTE: Continue step 9 of MediaKeySession::generateRequest().
+        // NOTE: Continue step 10 of MediaKeySession::generateRequest().
         DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this
                                            << ") GenerateRequest";
 
-        // initializeNewSession() in Chromium will execute steps 9.1 to 9.7.
+        // initializeNewSession() in Chromium will execute steps 10.1 to 10.9.
         m_session->initializeNewSession(
             action->initDataType(),
             static_cast<unsigned char*>(action->data()->data()),
             action->data()->byteLength(), m_sessionType,
             action->result()->result());
 
-        // Remaining steps (from 9.8) executed in finishGenerateRequest(),
+        // Remaining steps (from 10.10) executed in finishGenerateRequest(),
         // called when |result| is resolved.
         break;
 
       case PendingAction::Load:
         // NOTE: Continue step 8 of MediaKeySession::load().
         DVLOG(MEDIA_KEY_SESSION_LOG_LEVEL) << __func__ << "(" << this
                                            << ") Load";
 
         // 8.1 Let sanitized session ID be a validated and/or sanitized
         //     version of sessionId. The user agent should thoroughly
         //     validate the sessionId value before passing it to the CDM.
         //     At a minimum, this should include checking that the length
         //     and value (e.g. alphanumeric) are reasonable.
-        // 8.2 If the previous step failed, reject promise with a new
-        //     DOMException whose name is "InvalidAccessError".
+        // 8.2 If the preceding step failed, or if sanitized session ID
+        //     is empty, reject promise with a newly created TypeError.
         if (!isValidSessionId(action->sessionId())) {
           action->result()->completeWithError(
-              WebContentDecryptionModuleExceptionInvalidAccessError, 0,
+              WebContentDecryptionModuleExceptionTypeError, 0,
               "Invalid sessionId");
           return;
         }
 
         // 8.3 If there is an unclosed session in the object's Document
         //     whose sessionId attribute is sanitized session ID, reject
         //     promise with a new DOMException whose name is
         //     QuotaExceededError. In other words, do not create a session
         //     if a non-closed session, regardless of type, already exists
         //     for this sanitized session ID in this browsing context.
@@ skipping 272 matching lines @@
   visitor->trace(m_asyncEventQueue);
   visitor->trace(m_pendingActions);
   visitor->trace(m_mediaKeys);
   visitor->trace(m_keyStatusesMap);
   visitor->trace(m_closedPromise);
   EventTargetWithInlineData::trace(visitor);
   ActiveDOMObject::trace(visitor);
 }
 
 }  // namespace blink