[Extensions Bindings] Support chrome.extension.lastError

extensions/renderer/api_last_error.cc

 // Copyright 2017 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 "extensions/renderer/api_last_error.h"
 
 #include "gin/converter.h"
+#include "gin/data_object_builder.h"
 #include "gin/handle.h"
 #include "gin/object_template_builder.h"
 #include "gin/wrappable.h"
 
 namespace extensions {
 
 namespace {
 
 const char kLastErrorProperty[] = "lastError";
 const char kScriptSuppliedValueKey[] = "script_supplied_value";
@@ skipping 107 matching lines @@
 
   // The various accesses/sets on an object could potentially fail if script has
   // set any crazy interceptors. For the most part, we don't care about behaving
   // perfectly in these circumstances, but we eat the exception so callers don't
   // have to worry about it. We also SetVerbose() so that developers will have a
   // clue what happened if this does arise.
   // TODO(devlin): Whether or not this needs to be verbose is debatable.
   v8::TryCatch try_catch(isolate);
   try_catch.SetVerbose(true);
 
-  v8::Local<v8::Object> parent = get_parent_.Run(context);
-  if (parent.IsEmpty())
-    return;
-  v8::Local<v8::String> key = gin::StringToSymbol(isolate, kLastErrorProperty);
-  v8::Local<v8::Value> v8_error;
-  // Two notes: this Get() is visible to external script, and this will actually
-  // mark the lastError as accessed, if one exists. These shouldn't be a
-  // problem (lastError is meant to be helpful, but isn't designed to handle
-  // crazy chaining, etc). However, if we decide we needed to be fancier, we
-  // could detect the presence of a current error through a GetPrivate(), and
-  // optionally throw it if one exists.
-  if (!parent->Get(context, key).ToLocal(&v8_error))
-    return;
+  v8::Local<v8::Object> secondary_parent;
+  v8::Local<v8::Object> parent = get_parent_.Run(context, &secondary_parent);
 
-  if (!v8_error->IsUndefined()) {
-    // There may be an existing last error to overwrite.
-    LastErrorObject* last_error = nullptr;
-    if (!gin::Converter<LastErrorObject*>::FromV8(isolate, v8_error,
-                                                  &last_error)) {
-      // If it's not a real lastError (e.g. if a script manually set it), don't
-      // do anything. We shouldn't mangle a property set by other script.
-      // TODO(devlin): Or should we? If someone sets chrome.runtime.lastError,
-      // it might be the right course of action to overwrite it.
-      return;
-    }
-    last_error->Reset(error);
-  } else {
-    v8::Local<v8::Value> last_error =
-        gin::CreateHandle(isolate, new LastErrorObject(error)).ToV8();
-    v8::Maybe<bool> set_private = parent->SetPrivate(
-        context, v8::Private::ForApi(isolate, key), last_error);
-    if (!set_private.IsJust() || !set_private.FromJust()) {
-      NOTREACHED();
-      return;
-    }
-    DCHECK(!last_error.IsEmpty());
-    // This Set() can fail, but there's nothing to do if it does (the exception
-    // will be caught by the TryCatch above).
-    ignore_result(parent->SetAccessor(context, key, &LastErrorGetter,
-                                      &LastErrorSetter, last_error));
-  }
+  SetErrorOnPrimaryParent(context, parent, error);
+  SetErrorOnSecondaryParent(context, secondary_parent, error);
 }
 
 void APILastError::ClearError(v8::Local<v8::Context> context,
                               bool report_if_unchecked) {
   v8::Isolate* isolate = context->GetIsolate();
   v8::HandleScope handle_scope(isolate);
 
   v8::Local<v8::Object> parent;
+  v8::Local<v8::Object> secondary_parent;
   LastErrorObject* last_error = nullptr;
   v8::Local<v8::String> key;
   v8::Local<v8::Private> private_key;
   {
     // See comment in SetError().
     v8::TryCatch try_catch(isolate);
     try_catch.SetVerbose(true);
 
-    parent = get_parent_.Run(context);
+    parent = get_parent_.Run(context, &secondary_parent);

[lazyboy, 2017/06/27 17:58:44]

It feels a bit odd to return two parents differently from GetParent: one through
return value and the other through a pointer arg. Returning both through pointer
arg seems consistent,  up to you.

[Devlin, 2017/06/28 17:52:01]

I have a slight preference for this, since the primary parent should almost
never be null, whereas the secondary parent might be.  If it's alright, I'd like
to keep it as-is.

     if (parent.IsEmpty())
       return;
     key = gin::StringToSymbol(isolate, kLastErrorProperty);
     private_key = v8::Private::ForApi(isolate, key);
     v8::Local<v8::Value> error;
     // Access through GetPrivate() so that we don't trigger accessed().
-    if (!parent->GetPrivate(context, private_key).ToLocal(&error))
-      return;
-    if (!gin::Converter<LastErrorObject*>::FromV8(context->GetIsolate(), error,
+    if (!parent->GetPrivate(context, private_key).ToLocal(&error) ||
+        !gin::Converter<LastErrorObject*>::FromV8(context->GetIsolate(), error,
                                                   &last_error)) {
       return;
     }
   }
 
   if (report_if_unchecked && !last_error->accessed()) {
     add_console_error_.Run(
         context, "Unchecked runtime.lastError: " + last_error->error());
   }
 
   // See comment in SetError().
   v8::TryCatch try_catch(isolate);
   try_catch.SetVerbose(true);
 
   v8::Maybe<bool> delete_private = parent->DeletePrivate(context, private_key);
   if (!delete_private.IsJust() || !delete_private.FromJust()) {
     NOTREACHED();
     return;
   }
-  // This Delete() can fail, but there's nothing to do if it does (the exception
-  // will be caught by the TryCatch above).
+  // These Delete()s can fail, but there's nothing to do if it does (the
+  // exception will be caught by the TryCatch above).
   ignore_result(parent->Delete(context, key));
+  if (!secondary_parent.IsEmpty())
+    ignore_result(secondary_parent->Delete(context, key));
 }
 
 bool APILastError::HasError(v8::Local<v8::Context> context) {
   v8::Isolate* isolate = context->GetIsolate();
   v8::HandleScope handle_scope(isolate);
 
   // See comment in SetError().
   v8::TryCatch try_catch(isolate);
   try_catch.SetVerbose(true);
 
-  v8::Local<v8::Object> parent = get_parent_.Run(context);
+  v8::Local<v8::Object> parent = get_parent_.Run(context, nullptr);
   if (parent.IsEmpty())
     return false;
   v8::Local<v8::Value> error;
   v8::Local<v8::Private> key = v8::Private::ForApi(
       isolate, gin::StringToSymbol(isolate, kLastErrorProperty));
   // Access through GetPrivate() so we don't trigger accessed().
   if (!parent->GetPrivate(context, key).ToLocal(&error))
     return false;
 
   LastErrorObject* last_error = nullptr;
   return gin::Converter<LastErrorObject*>::FromV8(context->GetIsolate(), error,
                                                   &last_error);
 }
 
+void APILastError::SetErrorOnPrimaryParent(v8::Local<v8::Context> context,
+                                           v8::Local<v8::Object> parent,
+                                           const std::string& error) {
+  if (parent.IsEmpty())

[Devlin, 2017/06/24 01:24:17]

Note: copy-paste from above.

+    return;
+  v8::Isolate* isolate = context->GetIsolate();
+  v8::Local<v8::String> key = gin::StringToSymbol(isolate, kLastErrorProperty);
+  v8::Local<v8::Value> v8_error;
+  // Two notes: this Get() is visible to external script, and this will actually
+  // mark the lastError as accessed, if one exists. These shouldn't be a
+  // problem (lastError is meant to be helpful, but isn't designed to handle
+  // crazy chaining, etc). However, if we decide we needed to be fancier, we
+  // could detect the presence of a current error through a GetPrivate(), and
+  // optionally throw it if one exists.
+  if (!parent->Get(context, key).ToLocal(&v8_error))
+    return;
+
+  if (!v8_error->IsUndefined()) {
+    // There may be an existing last error to overwrite.
+    LastErrorObject* last_error = nullptr;
+    if (!gin::Converter<LastErrorObject*>::FromV8(isolate, v8_error,
+                                                  &last_error)) {
+      // If it's not a real lastError (e.g. if a script manually set it), don't
+      // do anything. We shouldn't mangle a property set by other script.
+      // TODO(devlin): Or should we? If someone sets chrome.runtime.lastError,
+      // it might be the right course of action to overwrite it.
+      return;
+    }
+    last_error->Reset(error);
+  } else {
+    v8::Local<v8::Value> last_error =
+        gin::CreateHandle(isolate, new LastErrorObject(error)).ToV8();
+    v8::Maybe<bool> set_private = parent->SetPrivate(
+        context, v8::Private::ForApi(isolate, key), last_error);
+    if (!set_private.IsJust() || !set_private.FromJust()) {
+      NOTREACHED();
+      return;
+    }
+    DCHECK(!last_error.IsEmpty());
+    // This Set() can fail, but there's nothing to do if it does (the exception

[jbroman, 2017/06/25 00:12:49]

nit: this is SetAccessor, not Set.

[Devlin, 2017/06/28 17:52:01]

Done.

+    // will be caught by the TryCatch above).

[jbroman, 2017/06/25 00:12:49]

Here and below: is "the TryCatch above" the one in APILastError::SetError?

[Devlin, 2017/06/28 17:52:01]

Yep, clarified in the comments.

+    ignore_result(parent->SetAccessor(context, key, &LastErrorGetter,
+                                      &LastErrorSetter, last_error));
+  }
+}
+
+void APILastError::SetErrorOnSecondaryParent(
+    v8::Local<v8::Context> context,
+    v8::Local<v8::Object> secondary_parent,
+    const std::string& error) {
+  if (secondary_parent.IsEmpty())
+    return;
+
+  // For the secondary parent, simply set chrome.extension.lastError to
+  // {message: <error>}.
+  // TODO(devlin): Gather metrics on how frequently this is checked. It'd be
+  // nice to get rid of it.
+  v8::Isolate* isolate = context->GetIsolate();
+  v8::Local<v8::String> key = gin::StringToSymbol(isolate, kLastErrorProperty);
+  // This Set() can fail, but there's nothing to do if it does (the exception
+  // will be caught by the TryCatch above).
+  ignore_result(secondary_parent->CreateDataProperty(

[jbroman, 2017/06/25 00:12:49]

nit: this is CreateDataProperty, not Set.

[Devlin, 2017/06/28 17:52:01]

Done.

+      context, key,
+      gin::DataObjectBuilder(isolate).Set("message", error).Build()));
+}
+
 }  // namespace extensions