Integrate ErrorConsole with Apps Dev Tool

chrome/browser/extensions/api/developer_private/developer_private_api.cc

 // Copyright (c) 2012 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 "chrome/browser/extensions/api/developer_private/developer_private_api.h"
 
 #include "apps/app_load_service.h"
 #include "apps/app_restore_service.h"
 #include "apps/saved_files_service.h"
 #include "apps/shell_window.h"
 #include "apps/shell_window_registry.h"
 #include "base/base64.h"
+#include "base/bind.h"
 #include "base/command_line.h"
 #include "base/file_util.h"
 #include "base/files/file_enumerator.h"
 #include "base/i18n/file_util_icu.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/devtools/devtools_window.h"
 #include "chrome/browser/extensions/api/developer_private/developer_private_api_factory.h"
 #include "chrome/browser/extensions/api/developer_private/entry_picker.h"
 #include "chrome/browser/extensions/api/extension_action/extension_action_api.h"
 #include "chrome/browser/extensions/api/file_handlers/app_file_handler_util.h"
 #include "chrome/browser/extensions/devtools_util.h"
 #include "chrome/browser/extensions/extension_disabled_ui.h"
 #include "chrome/browser/extensions/extension_error_reporter.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_util.h"
 #include "chrome/browser/extensions/unpacked_installer.h"
 #include "chrome/browser/extensions/updater/extension_updater.h"
 #include "chrome/browser/platform_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/sync_file_system/drive_backend_v1/drive_file_sync_service.h"
 #include "chrome/browser/sync_file_system/syncable_file_system_util.h"
 #include "chrome/browser/ui/chrome_select_file_policy.h"
+#include "chrome/browser/ui/webui/extensions/extension_error_ui_util.h"
 #include "chrome/browser/ui/webui/extensions/extension_icon_source.h"
 #include "chrome/common/extensions/api/developer_private.h"
 #include "chrome/common/extensions/manifest_handlers/app_launch_info.h"
 #include "chrome/common/extensions/manifest_handlers/icons_handler.h"
 #include "chrome/common/extensions/manifest_url_handler.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/site_instance.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
+#include "extensions/browser/extension_error.h"
 #include "extensions/browser/extension_registry.h"
 #include "extensions/browser/extension_system.h"
 #include "extensions/browser/management_policy.h"
 #include "extensions/browser/view_type_utils.h"
 #include "extensions/common/constants.h"
 #include "extensions/common/extension_resource.h"
 #include "extensions/common/extension_set.h"
 #include "extensions/common/install_warning.h"
 #include "extensions/common/manifest_handlers/background_info.h"
 #include "extensions/common/manifest_handlers/incognito_info.h"
@@ skipping 67 matching lines @@
   return GetImageURLFromData(contents);
 }
 
 std::string GetExtensionID(const RenderViewHost* render_view_host) {
   if (!render_view_host->GetSiteInstance())
     return std::string();
 
   return render_view_host->GetSiteInstance()->GetSiteURL().host();
 }
 
+void SetString(base::DictionaryValue* dict,
+               const std::string& name,
+               const base::string16& value) {
+  dict->SetString(name, value);
+}
+
 }  // namespace
 
 namespace AllowFileAccess = api::developer_private::AllowFileAccess;
 namespace AllowIncognito = api::developer_private::AllowIncognito;
 namespace ChoosePath = api::developer_private::ChoosePath;
 namespace Enable = api::developer_private::Enable;
 namespace GetItemsInfo = api::developer_private::GetItemsInfo;
 namespace Inspect = api::developer_private::Inspect;
 namespace PackDirectory = api::developer_private::PackDirectory;
 namespace Reload = api::developer_private::Reload;
@@ skipping 16 matching lines @@
     chrome::NOTIFICATION_EXTENSION_VIEW_REGISTERED,
     chrome::NOTIFICATION_EXTENSION_VIEW_UNREGISTERED
   };
 
   CHECK(registrar_.IsEmpty());
   for (size_t i = 0; i < arraysize(types); ++i) {
     registrar_.Add(this,
                    types[i],
                    content::Source<Profile>(profile_));
   }
+
+  ErrorConsole::Get(profile)->AddObserver(this);
 }
 
+DeveloperPrivateEventRouter::~DeveloperPrivateEventRouter() {
+  ErrorConsole::Get(profile_)->RemoveObserver(this);
+}
 
-DeveloperPrivateEventRouter::~DeveloperPrivateEventRouter() {}
+void DeveloperPrivateEventRouter::AddExtensionId(
+    const std::string& extension_id) {
+  extension_ids_.insert(extension_id);
+}
+
+void DeveloperPrivateEventRouter::RemoveExtensionId(
+    const std::string& extension_id) {
+  extension_ids_.erase(extension_id);
+}
 
 void DeveloperPrivateEventRouter::Observe(
     int type,
     const content::NotificationSource& source,
     const content::NotificationDetails& details) {
   const char* event_name = NULL;
   Profile* profile = content::Source<Profile>(source).ptr();
   CHECK(profile);
   CHECK(profile_->IsSameProfile(profile));
   developer::EventData event_data;
@@ skipping 37 matching lines @@
     event_data.item_id = extension->id();
 
   scoped_ptr<base::ListValue> args(new base::ListValue());
   args->Append(event_data.ToValue().release());
 
   event_name = developer_private::OnItemStateChanged::kEventName;
   scoped_ptr<Event> event(new Event(event_name, args.Pass()));
   ExtensionSystem::Get(profile)->event_router()->BroadcastEvent(event.Pass());
 }
 
+void DeveloperPrivateEventRouter::OnErrorAdded(const ExtensionError* error) {
+  // We don't want to handle errors thrown by extensions subscribed to these
+  // events (currently only the Apps Developer Tool), because doing so risks
+  // entering a loop.
+  if (extension_ids_.find(error->extension_id()) != extension_ids_.end())
+    return;
+
+  developer::EventData event_data;
+  event_data.event_type = developer::EVENT_TYPE_ERROR_ADDED;
+  event_data.item_id = error->extension_id();
+
+  scoped_ptr<base::ListValue> args(new base::ListValue);
+  args->Append(event_data.ToValue().release());
+
+  ExtensionSystem::Get(profile_)->event_router()->BroadcastEvent(
+      scoped_ptr<Event>(new Event(
+          developer_private::OnItemStateChanged::kEventName, args.Pass())));
+}
+
 void DeveloperPrivateAPI::SetLastUnpackedDirectory(const base::FilePath& path) {
   last_unpacked_directory_ = path;
 }
 
 void DeveloperPrivateAPI::RegisterNotifications() {
   ExtensionSystem::Get(profile_)->event_router()->RegisterObserver(
       this, developer_private::OnItemStateChanged::kEventName);
 }
 
 DeveloperPrivateAPI::~DeveloperPrivateAPI() {}
 
 void DeveloperPrivateAPI::Shutdown() {}
 
 void DeveloperPrivateAPI::OnListenerAdded(
     const EventListenerInfo& details) {
-  if (!developer_private_event_router_)
+  if (!developer_private_event_router_) {
     developer_private_event_router_.reset(
         new DeveloperPrivateEventRouter(profile_));
+  }
+
+  developer_private_event_router_->AddExtensionId(details.extension_id);
 }
 
 void DeveloperPrivateAPI::OnListenerRemoved(
     const EventListenerInfo& details) {
   if (!ExtensionSystem::Get(profile_)->event_router()->HasEventListener(
-          developer_private::OnItemStateChanged::kEventName))
+          developer_private::OnItemStateChanged::kEventName)) {
     developer_private_event_router_.reset(NULL);
+  } else {
+    developer_private_event_router_->RemoveExtensionId(details.extension_id);
+  }
 }
 
 namespace api {
 
 bool DeveloperPrivateAutoUpdateFunction::RunImpl() {
   ExtensionUpdater* updater = GetExtensionUpdater(GetProfile());
   if (updater)
     updater->CheckNow(ExtensionUpdater::CheckParams());
   SetResult(new base::FundamentalValue(true));
   return true;
 }
 
 DeveloperPrivateAutoUpdateFunction::~DeveloperPrivateAutoUpdateFunction() {}
 
 scoped_ptr<developer::ItemInfo>
-  DeveloperPrivateGetItemsInfoFunction::CreateItemInfo(
-      const Extension& item,
-      bool item_is_enabled) {
+DeveloperPrivateGetItemsInfoFunction::CreateItemInfo(
+    const Extension& item,
+    bool item_is_enabled) {
   scoped_ptr<developer::ItemInfo> info(new developer::ItemInfo());
 
   ExtensionSystem* system = ExtensionSystem::Get(GetProfile());
   ExtensionService* service = system->extension_service();
   ExtensionRegistry* registry = ExtensionRegistry::Get(GetProfile());
 
   info->id = item.id();
   info->name = item.name();
   info->enabled = service->IsExtensionEnabled(info->id);
   info->offline_enabled = OfflineEnabledInfo::IsOfflineEnabled(&item);
@@ skipping 13 matching lines @@
     info->type = developer::ITEM_TYPE_THEME;
   } else if (item.is_extension()) {
     info->type = developer::ITEM_TYPE_EXTENSION;
   } else {
     NOTREACHED();
   }
 
   if (Manifest::IsUnpackedLocation(item.location())) {
     info->path.reset(
         new std::string(base::UTF16ToUTF8(item.path().LossyDisplayName())));
-    for (std::vector<extensions::InstallWarning>::const_iterator it =
-             item.install_warnings().begin();
-         it != item.install_warnings().end(); ++it) {
-      developer::InstallWarning* warning = new developer::InstallWarning();
-      warning->message = it->message;
-      info->install_warnings.push_back(make_linked_ptr(warning));
+    // If the ErrorConsole is enabled, get the errors for the extension and add
+    // them to the list. Otherwise, use the install warnings (using both is
+    // redundant).
+    ErrorConsole* error_console = ErrorConsole::Get(GetProfile());
+    if (error_console->enabled()) {
+      const ErrorList& errors = error_console->GetErrorsForExtension(item.id());
+      if (!errors.empty()) {
+        for (ErrorList::const_iterator iter = errors.begin();
+             iter != errors.end(); ++iter) {
+          if ((*iter)->type() == ExtensionError::MANIFEST_ERROR) {
+            info->manifest_errors.push_back(
+                make_linked_ptr((*iter)->ToValue().release()));
+          } else {  // runtime error
+            const RuntimeError* error = static_cast<const RuntimeError*>(*iter);
+            scoped_ptr<base::DictionaryValue> value = error->ToValue();
+            bool can_inspect =
+                content::RenderViewHost::FromID(
+                    error->render_process_id(),
+                    error->render_view_id()) != NULL;
+            value->SetBoolean("canInspect", can_inspect);
+            info->runtime_errors.push_back(make_linked_ptr(value.release()));
+          }
+        }
+      }
+    } else {
+      for (std::vector<extensions::InstallWarning>::const_iterator it =
+               item.install_warnings().begin();
+           it != item.install_warnings().end(); ++it) {
+        developer::InstallWarning* warning = new developer::InstallWarning();

[Dan Beam, 2014/02/11 02:43:49]

nit: arguably make this a scoped_ptr and .release() as I've seen multiple leaks
from doing this:

  for (size_t i = 0; i < leakers; ++i) {
    Thinger* leaky  = new Thinger;
    if (i % 2 == 0)
      continue;  // or i == 3, break; or something
    other_object->Take(leaky);
  }

where if you break/continue in the loop the memory is semi-sneakily leaked.

[Devlin, 2014/02/11 18:41:16]

Done.

+        warning->message = it->message;
+        info->install_warnings.push_back(make_linked_ptr(warning));
+      }
     }
   }
 
   info->incognito_enabled = util::IsIncognitoEnabled(item.id(), GetProfile());
   info->wants_file_access = item.wants_file_access();
   info->allow_file_access = util::AllowFileAccess(item.id(), GetProfile());
   info->allow_reload = Manifest::IsUnpackedLocation(item.location());
   info->is_unpacked = Manifest::IsUnpackedLocation(item.location());
   info->terminated = registry->terminated_extensions().Contains(item.id());
   info->allow_incognito = item.can_be_incognito_enabled();
@@ skipping 979 matching lines @@
       IDS_APPS_DEVTOOL_DELETE_CONFIRMATION_MESSAGE_APP);
   SET_STRING("deleteConfirmationMessageExtension",
       IDS_APPS_DEVTOOL_DELETE_CONFIRMATION_MESSAGE_EXTENSION);
 
 // Dialog when profile is managed.
   SET_STRING("managedProfileDialogCloseButton",
       IDS_APPS_DEVTOOL_MANAGED_PROFILE_DIALOG_CLOSE_BUTTON);
   SET_STRING("managedProfileDialogTitle",
       IDS_APPS_DEVTOOL_MANAGED_PROFILE_DIALOG_TITLE);
   SET_STRING("managedProfileDialogDescription",
       IDS_APPS_DEVTOOL_MANAGED_PROFILE_DIALOG_DESCRIPTION);

[dvh, 2014/02/10 20:04:04]

I think that the strings above are probably deprecated.
You can probably clean them up.

[Devlin, 2014/02/10 22:59:41]

Done.

 
   #undef   SET_STRING
+
+  error_ui_util::GetLocalizedValues(
+      base::Bind(&SetString, base::Unretained(dict)));

[dvh, 2014/02/10 20:04:04]

What is it used for?

--
I went through all the review. I think DeveloperPrivateGetStringsFunction is
deprecated now and can be removed. Apps Developer Tools does not rely on it but
on its embedded strings.

[Devlin, 2014/02/10 22:59:41]

Woo!  That makes it a little cleaner.  Done.

+
   return true;
 }
 
 DeveloperPrivateGetStringsFunction::~DeveloperPrivateGetStringsFunction() {}
 
 bool DeveloperPrivateIsProfileManagedFunction::RunImpl() {
   SetResult(new base::FundamentalValue(GetProfile()->IsManaged()));
   return true;
 }
 
 DeveloperPrivateIsProfileManagedFunction::
     ~DeveloperPrivateIsProfileManagedFunction() {
 }
 
+DeveloperPrivateRequestFileSourceFunction::
+DeveloperPrivateRequestFileSourceFunction() {}

[Dan Beam, 2014/02/11 02:43:49]

nit: indent by 4\s to show it's a continuation

[Devlin, 2014/02/11 18:41:16]

Done in Patch Set 2.

+
+DeveloperPrivateRequestFileSourceFunction::
+~DeveloperPrivateRequestFileSourceFunction() {}
+
+bool DeveloperPrivateRequestFileSourceFunction::RunImpl() {
+  scoped_ptr<developer::RequestFileSource::Params> params(
+      developer::RequestFileSource::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get() != NULL);
+
+  base::DictionaryValue* dict = NULL;
+  if (!params->dict->GetAsDictionary(&dict)) {
+    NOTREACHED();
+    return false;
+  }
+
+  AddRef();  // Balanced in LaunchCallback().
+  error_ui_util::HandleRequestFileSource(
+      dict,
+      GetProfile(),
+      base::Bind(&DeveloperPrivateRequestFileSourceFunction::LaunchCallback,
+                 base::Unretained(this)));
+  return true;
+}
+
+void DeveloperPrivateRequestFileSourceFunction::LaunchCallback(
+    const base::DictionaryValue& results) {
+  SetResult(results.DeepCopy());
+  SendResponse(true);
+  Release();  // Balanced in RunImpl().
+}
+
+DeveloperPrivateOpenDevToolsFunction::DeveloperPrivateOpenDevToolsFunction() {}
+DeveloperPrivateOpenDevToolsFunction::~DeveloperPrivateOpenDevToolsFunction() {}
+
+bool DeveloperPrivateOpenDevToolsFunction::RunImpl() {
+  scoped_ptr<developer::OpenDevTools::Params> params(
+      developer::OpenDevTools::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get() != NULL);
+
+  base::DictionaryValue* dict = NULL;
+  if (!params->dict->GetAsDictionary(&dict)) {
+    NOTREACHED();
+    return false;
+  }
+
+  error_ui_util::HandleOpenDevTools(dict);
+
+  return true;
+}
+
 } // namespace api
 
 } // namespace extensions