[webnfc] Align nfc.push operation with the specification

third_party/WebKit/Source/modules/nfc/NFC.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/nfc/NFC.h"
 
 #include "bindings/core/v8/ScriptPromiseResolver.h"
 #include "bindings/core/v8/V8ArrayBuffer.h"
 #include "bindings/core/v8/V8StringResource.h"
 #include "core/dom/DOMArrayBuffer.h"
 #include "core/dom/DOMException.h"
 #include "core/dom/Document.h"
 #include "core/dom/ExceptionCode.h"
 #include "core/dom/ExecutionContext.h"
 #include "core/frame/LocalDOMWindow.h"
 #include "modules/nfc/NFCError.h"
 #include "modules/nfc/NFCMessage.h"
 #include "modules/nfc/NFCPushOptions.h"
 #include "modules/nfc/NFCWatchOptions.h"
 #include "platform/mojo/MojoHelper.h"
 #include "public/platform/InterfaceProvider.h"
 #include "public/platform/Platform.h"
 
 namespace {
+const char kJsonMimePostfix[] = "+json";
 const char kJsonMimePrefix[] = "application/";
 const char kJsonMimeType[] = "application/json";
 const char kOpaqueMimeType[] = "application/octet-stream";
 const char kPlainTextMimeType[] = "text/plain";
 const char kPlainTextMimePrefix[] = "text/";
 const char kCharSetUTF8[] = ";charset=UTF-8";
 }  // anonymous namespace
 
 // Mojo type converters
 namespace mojo {
@@ skipping 311 matching lines @@
 
     return watchOptionsPtr;
   }
 };
 
 }  // namespace mojo
 
 namespace blink {
 namespace {
 
-bool IsValidTextRecord(const NFCRecord& record) {
+ScriptPromise RejectWithTypeError(ScriptState* script_state,
+                                  const String& message) {
+  return ScriptPromise::Reject(
+      script_state,
+      V8ThrowException::CreateTypeError(script_state->GetIsolate(), message));
+}
+
+ScriptPromise RejectWithDOMException(ScriptState* script_state,
+                                     ExceptionCode ec,
+                                     const String& message) {
+  return ScriptPromise::RejectWithDOMException(
+      script_state, DOMException::Create(ec, message));
+}
+
+ScriptPromise RejectIfInvalidTextRecord(ScriptState* script_state,
+                                        const NFCRecord& record) {
   v8::Local<v8::Value> value = record.data().V8Value();
   if (!value->IsString() &&
-      !(value->IsNumber() && !std::isnan(value.As<v8::Number>()->Value())))
-    return false;
+      !(value->IsNumber() && !std::isnan(value.As<v8::Number>()->Value()))) {
+    return RejectWithTypeError(script_state,
+                               "The data for the 'text' NFCRecords must be of "
+                               "String or UnrestrctedDouble type.");
+  }
 
   if (record.hasMediaType() &&
       !record.mediaType().StartsWith(kPlainTextMimePrefix,
-                                     kTextCaseUnicodeInsensitive))
-    return false;
+                                     kTextCaseUnicodeInsensitive)) {
+    return RejectWithDOMException(script_state, kSyntaxError,
+                                  "Invalid media type for 'text' record.");
+  }
 
-  return true;
+  return ScriptPromise();
 }
 
-bool IsValidURLRecord(const NFCRecord& record) {
-  if (!record.data().V8Value()->IsString())
-    return false;
+ScriptPromise RejectIfInvalidURLRecord(ScriptState* script_state,
+                                       const NFCRecord& record) {
+  if (!record.data().V8Value()->IsString()) {
+    return RejectWithTypeError(
+        script_state,
+        "The data for the 'url' NFCRecord must be of String type.");
+  }
 
   blink::V8StringResource<> string_resource = record.data().V8Value();
-  if (!string_resource.Prepare())
-    return false;
+  if (!string_resource.Prepare() || !KURL(KURL(), string_resource).IsValid()) {
+    return RejectWithDOMException(script_state, kSyntaxError,
+                                  "Cannot parse data for 'url' record.");
+  }
 
-  return KURL(KURL(), string_resource).IsValid();
+  return ScriptPromise();
 }
 
-bool IsValidJSONRecord(const NFCRecord& record) {
+ScriptPromise RejectIfInvalidJSONRecord(ScriptState* script_state,
+                                        const NFCRecord& record) {
   v8::Local<v8::Value> value = record.data().V8Value();
-  if (!value->IsObject() || value->IsArrayBuffer())
-    return false;
+  if (!value->IsObject() || value->IsArrayBuffer()) {
+    return RejectWithTypeError(
+        script_state,
+        "The data for the 'json' NFCRecord must be of Object type.");
+  }
 
-  if (record.hasMediaType() && !record.mediaType().StartsWith(
-                                   kJsonMimePrefix, kTextCaseASCIIInsensitive))
-    return false;
+  // If JSON record has media type, it must be equal to "application/json" or
+  // start with "application/" and end with "+json".
+  if (record.hasMediaType() &&
+      (record.mediaType() != kJsonMimeType &&
+       !(record.mediaType().StartsWith(kJsonMimePrefix,
+                                       kTextCaseASCIIInsensitive) &&
+         record.mediaType().EndsWith(kJsonMimePostfix,
+                                     kTextCaseASCIIInsensitive)))) {
+    return RejectWithDOMException(script_state, kSyntaxError,
+                                  "Invalid media type for 'json' record.");
+  }
 
-  return true;
+  return ScriptPromise();
 }
 
-bool IsValidOpaqueRecord(const NFCRecord& record) {
-  return record.data().V8Value()->IsArrayBuffer();
+ScriptPromise RejectIfInvalidOpaqueRecord(ScriptState* script_state,
+                                          const NFCRecord& record) {
+  if (!record.data().V8Value()->IsArrayBuffer()) {
+    return RejectWithTypeError(
+        script_state,
+        "The data for the 'opaque' NFCRecord must be of ArrayBuffer type.");
+  }
+
+  return ScriptPromise();
 }
 
-bool IsValidNFCRecord(const NFCRecord& record) {
+ScriptPromise RejectIfInvalidNFCRecord(ScriptState* script_state,
+                                       const NFCRecord& record) {
   device::nfc::mojom::blink::NFCRecordType type;
   if (record.hasRecordType()) {
     type = mojo::toNFCRecordType(record.recordType());
   } else {
     type = mojo::deduceRecordTypeFromDataType(record);
 
     // https://w3c.github.io/web-nfc/#creating-web-nfc-message
     // If NFCRecord.recordType is not set and record type cannot be deduced
-    // from NFCRecord.data, reject promise with SyntaxError.
+    // from NFCRecord.data, reject promise with TypeError.
     if (type == device::nfc::mojom::blink::NFCRecordType::EMPTY)
-      return false;
+      return RejectWithTypeError(script_state, "Unknown NFCRecord type.");
   }
 
   // Non-empty records must have data.
   if (!record.hasData() &&
       (type != device::nfc::mojom::blink::NFCRecordType::EMPTY)) {
-    return false;
+    return RejectWithTypeError(script_state,
+                               "Nonempty NFCRecord must have data.");
   }
 
   switch (type) {
     case device::nfc::mojom::blink::NFCRecordType::TEXT:
-      return IsValidTextRecord(record);
+      return RejectIfInvalidTextRecord(script_state, record);
     case device::nfc::mojom::blink::NFCRecordType::URL:
-      return IsValidURLRecord(record);
+      return RejectIfInvalidURLRecord(script_state, record);
     case device::nfc::mojom::blink::NFCRecordType::JSON:
-      return IsValidJSONRecord(record);
+      return RejectIfInvalidJSONRecord(script_state, record);
     case device::nfc::mojom::blink::NFCRecordType::OPAQUE_RECORD:
-      return IsValidOpaqueRecord(record);
+      return RejectIfInvalidOpaqueRecord(script_state, record);
     case device::nfc::mojom::blink::NFCRecordType::EMPTY:
-      return !record.hasData() && record.mediaType().IsEmpty();
+      return ScriptPromise();
   }
 
   NOTREACHED();
-  return false;
+  return RejectWithTypeError(script_state,
+                             "Invalid NFCRecordType was provided.");
 }
 
-bool IsValidNFCRecordArray(const HeapVector<NFCRecord>& records) {
-  if (records.IsEmpty())
-    return false;
-
+ScriptPromise RejectIfInvalidNFCRecordArray(
+    ScriptState* script_state,
+    const HeapVector<NFCRecord>& records) {
   for (const auto& record : records) {
-    if (!IsValidNFCRecord(record))
-      return false;
+    ScriptPromise isValidRecord =
+        RejectIfInvalidNFCRecord(script_state, record);
+    if (!isValidRecord.IsEmpty())
+      return isValidRecord;
   }
 
-  return true;
+  return ScriptPromise();
 }
 
-bool IsValidNFCPushMessage(const NFCPushMessage& message) {
+ScriptPromise RejectIfInvalidNFCPushMessage(
+    ScriptState* script_state,
+    const NFCPushMessage& push_message) {
   // If NFCPushMessage of invalid type, reject promise with TypeError
-  if (!message.isNFCMessage() && !message.isString() &&
-      !message.isArrayBuffer())
-    return false;
+  if (!push_message.isNFCMessage() && !push_message.isString() &&
+      !push_message.isArrayBuffer()) {
+    return RejectWithTypeError(script_state,
+                               "Invalid NFCPushMessage type was provided.");
+  }
 
-  if (message.isNFCMessage()) {
+  if (push_message.isNFCMessage()) {
     // https://w3c.github.io/web-nfc/#the-push-method
     // If NFCMessage.data is empty, reject promise with TypeError
-    if (!message.getAsNFCMessage().hasData())
-      return false;
+    const NFCMessage& message = push_message.getAsNFCMessage();
+    if (!message.hasData() || message.data().IsEmpty()) {
+      return RejectWithTypeError(script_state,
+                                 "Empty NFCMessage was provided.");
+    }
 
-    return IsValidNFCRecordArray(message.getAsNFCMessage().data());
+    return RejectIfInvalidNFCRecordArray(script_state, message.data());
   }
 
-  return true;
+  return ScriptPromise();
 }
 
 bool SetURL(const String& origin,
             device::nfc::mojom::blink::NFCMessagePtr& message) {
   KURL origin_url(kParsedURLString, origin);
 
   if (!message->url.IsEmpty() && origin_url.CanSetPathname()) {
     origin_url.SetPath(message->url);
   }
 
@@ skipping 142 matching lines @@
 
 // https://w3c.github.io/web-nfc/#writing-or-pushing-content
 // https://w3c.github.io/web-nfc/#dom-nfc-push
 ScriptPromise NFC::push(ScriptState* script_state,
                         const NFCPushMessage& push_message,
                         const NFCPushOptions& options) {
   ScriptPromise promise = RejectIfNotSupported(script_state);
   if (!promise.IsEmpty())
     return promise;
 
-  if (!IsValidNFCPushMessage(push_message)) {
-    return ScriptPromise::Reject(
-        script_state, V8ThrowException::CreateTypeError(
-                          script_state->GetIsolate(),
-                          "Invalid NFCPushMessage type was provided."));
-  }
+  ScriptPromise isValidMessage =
+      RejectIfInvalidNFCPushMessage(script_state, push_message);
+  if (!isValidMessage.IsEmpty())
+    return isValidMessage;
 
   // https://w3c.github.io/web-nfc/#dom-nfc-push
   // 9. If timeout value is NaN or negative, reject promise with "TypeError"
   // and abort these steps.
   if (options.hasTimeout() &&
       (std::isnan(options.timeout()) || options.timeout() < 0)) {
-    return ScriptPromise::Reject(
-        script_state,
-        V8ThrowException::CreateTypeError(
-            script_state->GetIsolate(),
-            "Invalid NFCPushOptions.timeout value was provided."));
+    return RejectWithTypeError(
+        script_state, "Invalid NFCPushOptions.timeout value was provided.");
   }
 
   device::nfc::mojom::blink::NFCMessagePtr message =
       device::nfc::mojom::blink::NFCMessage::From(push_message);
-  if (!message)
-    return ScriptPromise::RejectWithDOMException(
-        script_state, DOMException::Create(kSyntaxError));
+  if (!message) {
+    return RejectWithDOMException(script_state, kSyntaxError,
+                                  "Cannot convert NFCMessage.");
+  }
 
   if (!SetURL(
           ExecutionContext::From(script_state)->GetSecurityOrigin()->ToString(),
-          message))
-    return ScriptPromise::RejectWithDOMException(
-        script_state, DOMException::Create(kSyntaxError));
+          message)) {
+    return RejectWithDOMException(script_state, kSyntaxError,
+                                  "Cannot set WebNFC Id.");

[Reilly Grant (use Gerrit), 2017/05/16 15:21:04]

Not this change but are "Cannot convert NFCMessage" and "Cannot set WebNFC Id"
actionable for the developer or are they internal errors?

[Alexander Shalamov, 2017/05/16 17:49:10]

https://w3c.github.io/web-nfc/#creating-a-web-nfc-id . Document origin + user
specified path, could cause error due to incorrect input. Need a layout test for
that.
Could happen when JSON is serialized, I will try to figure out the test for that
tomorrow. Probably, when there is an object, like function or undefined.

[shalamov, 2017/05/17 13:12:26]

- Added new test for JSON serialization and check when stringifier throws an
exception.
- Added new test for invalid WebNFC id, e.g., when provided path component is
invalid.

+  }
 
   if (GetNFCMessageSize(message) >
       device::nfc::mojom::blink::NFCMessage::kMaxSize) {
-    return ScriptPromise::RejectWithDOMException(
-        script_state, DOMException::Create(kNotSupportedError));
+    return RejectWithDOMException(script_state, kNotSupportedError,
+                                  "NFCMessage exceeds maximum suppoted size.");

[Reilly Grant (use Gerrit), 2017/05/16 15:21:04]

supported

[shalamov, 2017/05/17 13:12:26]

Done.

   }
 
   ScriptPromiseResolver* resolver = ScriptPromiseResolver::Create(script_state);
   requests_.insert(resolver);
   auto callback = ConvertToBaseCallback(WTF::Bind(&NFC::OnRequestCompleted,
                                                   WrapPersistent(this),
                                                   WrapPersistent(resolver)));
   nfc_->Push(std::move(message),
              device::nfc::mojom::blink::NFCPushOptions::From(options),
              callback);
@@ skipping 39 matching lines @@
 
 // https://w3c.github.io/web-nfc/#dom-nfc-cancelwatch
 ScriptPromise NFC::cancelWatch(ScriptState* script_state, long id) {
   ScriptPromise promise = RejectIfNotSupported(script_state);
   if (!promise.IsEmpty())
     return promise;
 
   if (id) {
     callbacks_.erase(id);
   } else {
-    return ScriptPromise::RejectWithDOMException(
-        script_state, DOMException::Create(kNotFoundError));
+    return RejectWithDOMException(script_state, kNotFoundError,
+                                  "Provided watch id, cannot be found.");

[Reilly Grant (use Gerrit), 2017/05/16 15:21:04]

no comma

[shalamov, 2017/05/17 13:12:26]

Done.

   }
 
   ScriptPromiseResolver* resolver = ScriptPromiseResolver::Create(script_state);
   requests_.insert(resolver);
   nfc_->CancelWatch(id, ConvertToBaseCallback(WTF::Bind(
                             &NFC::OnRequestCompleted, WrapPersistent(this),
                             WrapPersistent(resolver))));
   return resolver->Promise();
 }
 
@@ skipping 80 matching lines @@
     return false;
   }
 
   return true;
 }
 
 ScriptPromise NFC::RejectIfNotSupported(ScriptState* script_state) {
   String error_message;
   if (!IsSupportedInContext(ExecutionContext::From(script_state),
                             error_message)) {
-    return ScriptPromise::RejectWithDOMException(
-        script_state, DOMException::Create(kSecurityError, error_message));
+    return RejectWithDOMException(script_state, kSecurityError, error_message);
   }
 
   if (!nfc_) {
-    return ScriptPromise::RejectWithDOMException(
-        script_state, DOMException::Create(kNotSupportedError));
+    return RejectWithDOMException(script_state, kNotSupportedError,
+                                  "WebNFC is not supported.");
   }
 
   return ScriptPromise();
 }
 
 void NFC::OnWatchRegistered(MessageCallback* callback,
                             ScriptPromiseResolver* resolver,
                             uint32_t id,
                             device::nfc::mojom::blink::NFCErrorPtr error) {
   requests_.erase(resolver);
@@ skipping 17 matching lines @@
 }
 
 DEFINE_TRACE(NFC) {
   PageVisibilityObserver::Trace(visitor);
   ContextLifecycleObserver::Trace(visitor);
   visitor->Trace(requests_);
   visitor->Trace(callbacks_);
 }
 
 }  // namespace blink