mash: Support ShelfModel access in Chrome.

chrome/browser/ui/ash/launcher/chrome_launcher_controller.cc

 // Copyright 2013 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/ui/ash/launcher/chrome_launcher_controller.h"
 
 #include "ash/multi_profile_uma.h"
+#include "ash/public/cpp/remote_shelf_item_delegate.h"
 #include "ash/public/cpp/shelf_item.h"
 #include "ash/public/interfaces/constants.mojom.h"
 #include "ash/resources/grit/ash_resources.h"
 #include "ash/shelf/shelf.h"
 #include "ash/shelf/shelf_model.h"
 #include "ash/shell.h"
 #include "ash/shell_port.h"
 #include "ash/strings/grit/ash_strings.h"
 #include "ash/system/tray/system_tray_delegate.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/pattern.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "chrome/browser/chromeos/arc/arc_util.h"
+#include "chrome/browser/chromeos/ash_config.h"
 #include "chrome/browser/extensions/chrome_app_icon_loader.h"
 #include "chrome/browser/extensions/extension_util.h"
 #include "chrome/browser/prefs/pref_service_syncable_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/ui/app_list/app_list_syncable_service_factory.h"
 #include "chrome/browser/ui/app_list/arc/arc_app_icon_loader.h"
 #include "chrome/browser/ui/app_list/arc/arc_app_utils.h"
 #include "chrome/browser/ui/ash/app_sync_ui_state.h"
 #include "chrome/browser/ui/ash/ash_util.h"
@@ skipping 239 matching lines @@
   if (instance_ == this)
     instance_ = nullptr;
 }
 
 void ChromeLauncherController::Init() {
   // Start observing the shelf controller.
   if (ConnectToShelfController()) {
     ash::mojom::ShelfObserverAssociatedPtrInfo ptr_info;
     observer_binding_.Bind(mojo::MakeRequest(&ptr_info));
     shelf_controller_->AddObserver(std::move(ptr_info));
+    // ShelfModel's constructor should have initialized the app list item.
+    DCHECK_EQ(1, model_->item_count());
+    DCHECK_EQ(ash::kAppListId, model_->items()[0].id.app_id);
   }
 
   CreateBrowserShortcutLauncherItem();
   UpdateAppLaunchersFromPref();
 
   // TODO(sky): update unit test so that this test isn't necessary.
   if (ash::Shell::HasInstance())
     SetVirtualKeyboardBehaviorFromPrefs();
 
   prefs_observer_ = ChromeLauncherPrefsObserver::CreateIfNecessary(profile());
@@ skipping 969 matching lines @@
 
 void ChromeLauncherController::OnAutoHideBehaviorChanged(
     ash::ShelfAutoHideBehavior auto_hide,
     int64_t display_id) {
   DCHECK(!updating_shelf_pref_from_observer_);
   base::AutoReset<bool> updating(&updating_shelf_pref_from_observer_, true);
   // This will uselessly store a preference value for invalid display ids.
   SetShelfAutoHideBehaviorPref(profile_->GetPrefs(), display_id, auto_hide);
 }
 
+void ChromeLauncherController::OnShelfItemAdded(int32_t index,
+                                                const ash::ShelfItem& item) {
+  // Ignore notifications of adding the AppList item; it should already exist.
+  if (item.id.app_id == ash::kAppListId) {
+    DCHECK_EQ(0, model_->ItemIndexByID(item.id));
+    return;
+  }
+
+  DCHECK(ash_util::IsRunningInMash()) << "Unexpected model synchronization";
+  DCHECK(!applying_remote_shelf_model_changes_) << "Unexpected model change";
+  DCHECK_GE(model_->item_count(), index) << "Models out of sync";
+  base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, true);
+  model_->AddAt(index, item);
+}
+
+void ChromeLauncherController::OnShelfItemRemoved(int32_t index,
+                                                  const ash::ShelfItem& item) {
+  DCHECK(ash_util::IsRunningInMash()) << "Unexpected model synchronization";
+  DCHECK(!applying_remote_shelf_model_changes_) << "Unexpected model change";
+  DCHECK_GT(model_->item_count(), index) << "Models out of sync";
+  DCHECK_EQ(model_->items()[index].id, item.id) << "Models out of sync";
+  base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, true);
+  model_->RemoveItemAt(index);
+}
+
+void ChromeLauncherController::OnShelfItemMoved(int32_t start_index,
+                                                int32_t target_index) {
+  DCHECK(ash_util::IsRunningInMash()) << "Unexpected model synchronization";
+  DCHECK(!applying_remote_shelf_model_changes_) << "Unexpected model change";
+  DCHECK_GT(model_->item_count(), start_index) << "Models out of sync";
+  DCHECK_GT(model_->item_count(), target_index) << "Models out of sync";
+  base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, true);
+  model_->Move(start_index, target_index);
+}
+
+void ChromeLauncherController::OnShelfItemChanged(int32_t index,
+                                                  const ash::ShelfItem& item) {
+  DCHECK(ash_util::IsRunningInMash()) << "Unexpected model synchronization";
+  DCHECK(!applying_remote_shelf_model_changes_) << "Unexpected model change";
+  DCHECK_GT(model_->item_count(), index) << "Models out of sync";
+  DCHECK_EQ(model_->items()[index].id, item.id) << "Models out of sync";
+  base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, true);
+  model_->Set(index, item);
+}
+
+void ChromeLauncherController::OnShelfItemDelegateChanged(
+    const ash::ShelfID& id,
+    ash::mojom::ShelfItemDelegatePtr delegate) {
+  DCHECK(ash_util::IsRunningInMash()) << "Unexpected model synchronization";
+  DCHECK(!applying_remote_shelf_model_changes_) << "Unexpected model change";
+  base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, true);
+  if (delegate.is_bound())

[James Cook, 2017/05/30 22:47:48]

nit: curlies

[msw, 2017/05/31 16:55:22]

Done.

+    model_->SetShelfItemDelegate(id,
+                                 base::MakeUnique<ash::RemoteShelfItemDelegate>(
+                                     id, std::move(delegate)));
+  else
+    model_->SetShelfItemDelegate(id, nullptr);
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // ash::ShelfModelObserver:
 
 void ChromeLauncherController::ShelfItemAdded(int index) {
+  ash::ShelfItem item = model_->items()[index];
+  if (shelf_controller_ && !applying_remote_shelf_model_changes_ &&
+      chromeos::GetAshConfig() == ash::Config::MASH) {

[James Cook, 2017/05/30 22:47:48]

This (and the blocks below) is a little odd. So CLC is observing changes to its
own model and using that to report changes to ash? Naively I would expect code
in chrome to call functions on CLC, which would both update its model and send
mojo messages to ash.

Is that because code in chrome directly accesses CLC's ShelfModel instance? Or
because of the multiple updates done below?

[msw, 2017/05/31 16:55:22]

Yes, code in chrome directly accesses CLC's ShelfModel instance, some even still
uses ash::Shell::shelf_model() . I'll try to refine that later on by making
those Chrome callsites use CLC/ShelfController instead.

+    shelf_controller_->AddShelfItem(index, item);
+  }
+
   // Update the pin position preference as needed.
-  ash::ShelfItem item = model_->items()[index];
   if (ItemTypeIsPinned(item) && should_sync_pin_changes_)
     SyncPinPosition(item.id);
 
   // Fetch and update the icon for the app's item.
   const std::string& app_id = item.id.app_id;
   AppIconLoader* app_icon_loader = GetAppIconLoaderForApp(app_id);
   if (app_icon_loader) {
     app_icon_loader->FetchImage(app_id);
     app_icon_loader->UpdateImage(app_id);
   }
 
   // Update the item with any missing Chrome-specific info.
   if (item.type == ash::TYPE_APP || item.type == ash::TYPE_PINNED_APP) {
     bool needs_update = false;
     if (item.image.isNull()) {
       needs_update = true;
       item.image = extensions::util::GetDefaultAppIcon();
     }
     if (item.title.empty()) {
       needs_update = true;
       item.title = LauncherControllerHelper::GetAppTitle(profile(), app_id);
     }
     ash::ShelfItemStatus status = GetAppState(app_id);
     if (status != item.status && status != ash::STATUS_CLOSED) {
       needs_update = true;
       item.status = status;
     }
-    if (needs_update)
+    if (needs_update) {
+      // Ensure these changes are reported back to Ash.
+      base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, false);
       model_->Set(index, item);
+    }
   }
 
   // Construct a ShelfItemDelegate for the item if one does not yet exist.
   if (!model_->GetShelfItemDelegate(item.id)) {
+    // Ensure these changes are reported back to Ash.
+    base::AutoReset<bool> reset(&applying_remote_shelf_model_changes_, false);

[James Cook, 2017/05/30 22:47:48]

Aside: It's kind of a bummer that adding an item can result in 3 IPCs from
chrome to ash.

[msw, 2017/05/31 16:55:22]

Perhaps worth following up.

     model_->SetShelfItemDelegate(
         item.id, AppShortcutLauncherItemController::Create(item.id));
   }
 }
 
 void ChromeLauncherController::ShelfItemRemoved(
     int index,
     const ash::ShelfItem& old_item) {
+  if (shelf_controller_ && !applying_remote_shelf_model_changes_ &&
+      chromeos::GetAshConfig() == ash::Config::MASH) {
+    shelf_controller_->RemoveShelfItem(old_item.id);
+  }
+
   // Remove the pin position from preferences as needed.
   if (ItemTypeIsPinned(old_item) && should_sync_pin_changes_)
     RemovePinPosition(profile(), old_item.id);
 
   AppIconLoader* app_icon_loader = GetAppIconLoaderForApp(old_item.id.app_id);
   if (app_icon_loader)
     app_icon_loader->ClearImage(old_item.id.app_id);
 }
 
 void ChromeLauncherController::ShelfItemMoved(int start_index,
                                               int target_index) {
+  const ash::ShelfItem& item = model_->items()[target_index];
+  if (shelf_controller_ && !applying_remote_shelf_model_changes_ &&
+      chromeos::GetAshConfig() == ash::Config::MASH) {
+    shelf_controller_->MoveShelfItem(item.id, target_index);
+  }
+
   // Update the pin position preference as needed.
-  const ash::ShelfItem& item = model_->items()[target_index];
   DCHECK_NE(ash::TYPE_APP_LIST, item.type);
   if (ItemTypeIsPinned(item) && should_sync_pin_changes_)
     SyncPinPosition(item.id);
 }
 
 void ChromeLauncherController::ShelfItemChanged(
     int index,
     const ash::ShelfItem& old_item) {
+  const ash::ShelfItem& item = model_->items()[index];
+  if (shelf_controller_ && !applying_remote_shelf_model_changes_ &&
+      chromeos::GetAshConfig() == ash::Config::MASH) {
+    shelf_controller_->UpdateShelfItem(item);
+  }
+
   if (!should_sync_pin_changes_)
     return;
 
-  const ash::ShelfItem& item = model_->items()[index];
   // Add or remove the pin position from preferences as needed.
   if (!ItemTypeIsPinned(old_item) && ItemTypeIsPinned(item))
     SyncPinPosition(item.id);
   else if (ItemTypeIsPinned(old_item) && !ItemTypeIsPinned(item))
     RemovePinPosition(profile(), old_item.id);
 }
 
+void ChromeLauncherController::ShelfItemDelegateChanged(
+    const ash::ShelfID& id,
+    ash::ShelfItemDelegate* delegate) {
+  if (shelf_controller_ && !applying_remote_shelf_model_changes_ &&
+      chromeos::GetAshConfig() == ash::Config::MASH) {
+    shelf_controller_->SetShelfItemDelegate(
+        id, delegate ? delegate->CreateInterfacePtrAndBind()
+                     : ash::mojom::ShelfItemDelegatePtr());
+  }
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // ash::WindowTreeHostManager::Observer:
 
 void ChromeLauncherController::OnDisplayConfigurationChanged() {
   // In BOTTOM_LOCKED state, ignore the call of SetShelfBehaviorsFromPrefs.
   // Because it might be called by some operations, like crbug.com/627040
   // rotating screen.
   ash::Shelf* shelf = ash::Shelf::ForWindow(ash::Shell::GetPrimaryRootWindow());
   if (shelf->alignment() != ash::SHELF_ALIGNMENT_BOTTOM_LOCKED)
     SetShelfBehaviorsFromPrefs();
@@ skipping 10 matching lines @@
           : IDS_ASH_SHELF_APP_LIST_LAUNCHER_TITLE);
 
   const int app_list_index = model_->GetItemIndexForType(ash::TYPE_APP_LIST);
   DCHECK_GE(app_list_index, 0);
   ash::ShelfItem item = model_->items()[app_list_index];
   if (item.title != title) {
     item.title = title;
     model_->Set(app_list_index, item);
   }
 }