[Mac][MD User Menu] Revamped signin/sync error surfacing UI

chrome/browser/ui/cocoa/profiles/profile_chooser_controller.mm

 // Copyright 2014 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.
 
 #import "chrome/browser/ui/cocoa/profiles/profile_chooser_controller.h"
 
 #import <Carbon/Carbon.h>  // kVK_Return.
 #import <Cocoa/Cocoa.h>
 #include <stddef.h>
 
@@ skipping 14 matching lines @@
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/profiles/profile_metrics.h"
 #include "chrome/browser/profiles/profile_window.h"
 #include "chrome/browser/profiles/profiles_state.h"
 #include "chrome/browser/signin/chrome_signin_helper.h"
 #include "chrome/browser/signin/profile_oauth2_token_service_factory.h"
 #include "chrome/browser/signin/signin_error_controller_factory.h"
 #include "chrome/browser/signin/signin_manager_factory.h"
 #include "chrome/browser/signin/signin_promo.h"
 #include "chrome/browser/signin/signin_ui_util.h"
+#include "chrome/browser/sync/profile_sync_service_factory.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_commands.h"
 #include "chrome/browser/ui/browser_list.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/chrome_pages.h"
 #include "chrome/browser/ui/chrome_style.h"
 #import "chrome/browser/ui/cocoa/browser_window_utils.h"
 #import "chrome/browser/ui/cocoa/info_bubble_view.h"
 #import "chrome/browser/ui/cocoa/info_bubble_window.h"
 #include "chrome/browser/ui/cocoa/profiles/signin_view_controller_delegate_mac.h"
 #import "chrome/browser/ui/cocoa/profiles/user_manager_mac.h"
 #include "chrome/browser/ui/singleton_tabs.h"
 #include "chrome/browser/ui/user_manager.h"
 #include "chrome/browser/ui/webui/signin/login_ui_service.h"
 #include "chrome/browser/ui/webui/signin/login_ui_service_factory.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/url_constants.h"
 #include "chrome/grit/chromium_strings.h"
 #include "chrome/grit/generated_resources.h"
+#include "components/browser_sync/browser/profile_sync_service.h"
 #include "components/prefs/pref_service.h"
 #include "components/signin/core/browser/profile_oauth2_token_service.h"
 #include "components/signin/core/browser/signin_manager.h"
 #include "components/signin/core/browser/signin_metrics.h"
 #include "components/signin/core/common/profile_management_switches.h"
+#include "components/sync_driver/sync_error_controller.h"
 #include "content/public/browser/native_web_keyboard_event.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
 #include "google_apis/gaia/oauth2_token_service.h"
 #include "grit/theme_resources.h"
 #include "skia/ext/skia_utils_mac.h"
 #import "third_party/google_toolbox_for_mac/src/AppKit/GTMUILocalizerAndLayoutTweaker.h"
 #import "ui/base/cocoa/cocoa_base_utils.h"
@@ skipping 855 matching lines @@
 // triggered by right-clicking the avatar button; in the material design user
 // menu, this appears as part of the user menu. Returns the yOffset
 // corresponding to after the profile switcher buttons.
 - (CGFloat)buildFastUserSwitcherViewWithProfiles:(NSArray*)otherProfiles
                                        atYOffset:(CGFloat)yOffset
                                      inContainer:(NSView*)container;
 
 // Builds the regular profile chooser view.
 - (void)buildProfileChooserViewWithProfileView:(NSView*)currentProfileView
                                   tutorialView:(NSView*)tutorialView
+                                 syncErrorView:(NSView*)syncErrorView
                                  otherProfiles:(NSArray*)otherProfiles
                                      atYOffset:(CGFloat)yOffset
                                    inContainer:(NSView*)container
-                                   showLock:(bool)showLock;
+                                      showLock:(bool)showLock;
 
 // Builds the profile chooser view.
 - (NSView*)buildProfileChooserView;
 
 - (NSView*)buildTutorialViewIfNeededForItem:(const AvatarMenu::Item&)item;
 
 // Builds a tutorial card with a title label using |titleMessage|, a content
 // label using |contentMessage|, a link using |linkMessage|, and a button using
 // |buttonMessage|. If |stackButton| is YES, places the button above the link.
 // Otherwise places both on the same row with the link left aligned and button
 // right aligned. On click, the link would execute |linkAction|, and the button
 // would execute |buttonAction|. It sets |tutorialMode_| to the given |mode|.
 - (NSView*)tutorialViewWithMode:(profiles::TutorialMode)mode
                    titleMessage:(NSString*)titleMessage
                  contentMessage:(NSString*)contentMessage
                     linkMessage:(NSString*)linkMessage
                   buttonMessage:(NSString*)buttonMessage
                     stackButton:(BOOL)stackButton
                  hasCloseButton:(BOOL)hasCloseButton
                      linkAction:(SEL)linkAction
                    buttonAction:(SEL)buttonAction;
 
+// Builds a header for signin and sync error surfacing on the user menu.
+- (NSView*)buildSyncErrorViewIfNeeded;
+- (NSView*)buildSyncErrorViewWithContent:(int)contentStringId
+                          buttonStringId:(int)buttonStringId
+                            buttonAction:(SEL)buttonAction;
+
 // Builds a tutorial card to introduce an upgrade user to the new avatar menu if
 // needed. |tutorial_shown| indicates if the tutorial has already been shown in
 // the previous active view. |avatar_item| refers to the current profile.
 - (NSView*)buildWelcomeUpgradeTutorialView:(const AvatarMenu::Item&)item;
 
 // Builds a tutorial card to inform the user about right-click user switching if
 // needed.
 - (NSView*)buildRightClickTutorialView;
 
 // Builds a tutorial card to have the user confirm the last Chrome signin,
@@ skipping 188 matching lines @@
     accountIdToRemove_ = SigninManagerFactory::GetForProfile(
         browser_->profile())->GetAuthenticatedAccountId();
   } else {
     DCHECK(ContainsKey(currentProfileAccounts_, tag));
     accountIdToRemove_ = currentProfileAccounts_[tag];
   }
 
   [self initMenuContentsWithView:profiles::BUBBLE_VIEW_MODE_ACCOUNT_REMOVAL];
 }
 
+- (IBAction)showSignoutView:(id)sender {
+  chrome::ShowSettingsSubPage(browser_, chrome::kSignOutSubPage);
+}
+
+- (IBAction)showSignoutSigninView:(id)sender {
+  if (ProfileSyncServiceFactory::GetForProfile(browser_->profile()))
+    ProfileSyncService::SyncEvent(ProfileSyncService::STOP_FROM_OPTIONS);
+  SigninManagerFactory::GetForProfile(browser_->profile())
+      ->SignOut(signin_metrics::USER_CLICKED_SIGNOUT_SETTINGS,
+                signin_metrics::SignoutDelete::IGNORE_METRIC);
+  [self showSigninUIForMode:profiles::BUBBLE_VIEW_MODE_GAIA_SIGNIN];
+}
+
 - (IBAction)showAccountReauthenticationView:(id)sender {
   DCHECK(!isGuestSession_);
   [self showSigninUIForMode:profiles::BUBBLE_VIEW_MODE_GAIA_REAUTH];
 }
 
+- (IBAction)showUpdateChromeView:(id)sender {
+  chrome::OpenUpdateChromeDialog(browser_);
+}
+
+- (IBAction)showSyncPassphraseSetupView:(id)sender {
+  chrome::ShowSettingsSubPage(browser_, chrome::kSyncSetupSubPage);
+}
+
 - (IBAction)removeAccount:(id)sender {
   DCHECK(!accountIdToRemove_.empty());
   ProfileOAuth2TokenServiceFactory::GetForProfile(browser_->profile())
       ->RevokeCredentials(accountIdToRemove_);
   [self postActionPerformed:ProfileMetrics::PROFILE_DESKTOP_MENU_REMOVE_ACCT];
   accountIdToRemove_.clear();
 
   [self initMenuContentsWithView:profiles::BUBBLE_VIEW_MODE_ACCOUNT_MANAGEMENT];
 }
 
@@ skipping 214 matching lines @@
     if (!switches::IsMaterialDesignUserMenu())
       yOffset = [self addSeparatorToContainer:container atYOffset:yOffset];
   }
 
   [container setFrameSize:NSMakeSize(GetFixedMenuWidth(), yOffset)];
   return yOffset;
 }
 
 - (void)buildProfileChooserViewWithProfileView:(NSView*)currentProfileView
                                   tutorialView:(NSView*)tutorialView
+                                 syncErrorView:(NSView*)syncErrorView
                                  otherProfiles:(NSArray*)otherProfiles
                                      atYOffset:(CGFloat)yOffset
                                    inContainer:(NSView*)container
-                                   showLock:(bool)showLock {
+                                      showLock:(bool)showLock {
   if (switches::IsMaterialDesignUserMenu())
     yOffset += kRelatedControllVerticalSpacing;
 
   // Option buttons.
   NSRect rect = NSMakeRect(0, yOffset, GetFixedMenuWidth(), 0);
   NSView* optionsView =
       switches::IsMaterialDesignUserMenu()
           ? [self createMaterialDesignOptionsViewWithFrame:rect
                                                   showLock:showLock]
           : [self createOptionsViewWithRect:rect showLock:showLock];
@@ skipping 22 matching lines @@
     [disclaimerContainer setFrameOrigin:NSMakePoint(0, yOffset)];
     [container addSubview:disclaimerContainer];
     yOffset = NSMaxY([disclaimerContainer frame]);
 
     if (!switches::IsMaterialDesignUserMenu()) {
       yOffset += kSmallVerticalSpacing;
       yOffset = [self addSeparatorToContainer:container atYOffset:yOffset];
     }
   }
 
+  const AvatarMenu::Item& item =
+      avatarMenu_->GetItemAt(avatarMenu_->GetActiveProfileIndex());
   if (viewMode_ == profiles::BUBBLE_VIEW_MODE_ACCOUNT_MANAGEMENT) {
-    NSView* currentProfileAccountsView = [self
-        createCurrentProfileAccountsView:NSMakeRect(0, yOffset,
-                                                    GetFixedMenuWidth(), 0)];
-    [container addSubview:currentProfileAccountsView];
-    yOffset = NSMaxY([currentProfileAccountsView frame]);
+    if (item.signed_in) {
+      NSView* currentProfileAccountsView = [self
+          createCurrentProfileAccountsView:NSMakeRect(0, yOffset,
+                                                      GetFixedMenuWidth(), 0)];
+      [container addSubview:currentProfileAccountsView];
+      yOffset = NSMaxY([currentProfileAccountsView frame]);
 
-    yOffset = [self addSeparatorToContainer:container atYOffset: yOffset];
+      yOffset = [self addSeparatorToContainer:container atYOffset:yOffset];
+    } else {
+      // This is the case when the user selects the sign out option in the user
+      // menu upon encountering unrecoverable errors. Afterwards, the profile
+      // chooser view is shown instead of the account management view.
+      viewMode_ = profiles::BUBBLE_VIEW_MODE_FAST_PROFILE_CHOOSER;
+    }
   }
 
   // Active profile card.
   if (currentProfileView) {
     const CGFloat verticalSpacing = switches::IsMaterialDesignUserMenu()
                                         ? kRelatedControllVerticalSpacing
                                         : kVerticalSpacing;
     yOffset += verticalSpacing;
     [currentProfileView setFrameOrigin:NSMakePoint(0, yOffset)];
     [container addSubview:currentProfileView];
     yOffset = NSMaxY([currentProfileView frame]) + verticalSpacing;
   }
 
+  if (syncErrorView) {
+    yOffset = [self addSeparatorToContainer:container atYOffset:yOffset];
+    [syncErrorView setFrameOrigin:NSMakePoint(0, yOffset)];
+    [container addSubview:syncErrorView];
+    yOffset = NSMaxY([syncErrorView frame]);
+  }
+
   if (tutorialView) {
     [tutorialView setFrameOrigin:NSMakePoint(0, yOffset)];
     [container addSubview:tutorialView];
     yOffset = NSMaxY([tutorialView frame]);
     //TODO(mlerman): update UMA stats for the new tutorials.
   } else {
     tutorialMode_ = profiles::TUTORIAL_MODE_NONE;
   }
 
   [container setFrameSize:NSMakeSize(GetFixedMenuWidth(), yOffset)];
 }
 
 - (NSView*)buildProfileChooserView {
   base::scoped_nsobject<NSView> container(
       [[NSView alloc] initWithFrame:NSZeroRect]);
 
   NSView* tutorialView = nil;
+  NSView* syncErrorView = nil;
   NSView* currentProfileView = nil;
   base::scoped_nsobject<NSMutableArray> otherProfiles(
       [[NSMutableArray alloc] init]);
   // Local and guest profiles cannot lock their profile.
   bool showLock = false;
   bool isFastProfileChooser =
       viewMode_ == profiles::BUBBLE_VIEW_MODE_FAST_PROFILE_CHOOSER;
   if (isFastProfileChooser) {
     // The user is using right-click switching, no need to tell them about it.
     PrefService* localState = g_browser_process->local_state();
     localState->SetBoolean(
         prefs::kProfileAvatarRightClickTutorialDismissed, true);
   }
 
   // Loop over the profiles in reverse, so that they are sorted by their
   // y-coordinate, and separate them into active and "other" profiles.
   for (int i = avatarMenu_->GetNumberOfItems() - 1; i >= 0; --i) {
     const AvatarMenu::Item& item = avatarMenu_->GetItemAt(i);
     if (item.active) {
-      if (viewMode_ == profiles::BUBBLE_VIEW_MODE_PROFILE_CHOOSER) {
+      if (switches::IsMaterialDesignUserMenu()) {
+        syncErrorView = [self buildSyncErrorViewIfNeeded];
+      } else if (viewMode_ == profiles::BUBBLE_VIEW_MODE_PROFILE_CHOOSER) {
         tutorialView = [self buildTutorialViewIfNeededForItem:item];
       }
       currentProfileView =
           switches::IsMaterialDesignUserMenu()
               ? [self createMaterialDesignCurrentProfileView:item]
               : [self createCurrentProfileView:item];
       showLock = item.signed_in &&
           profiles::IsLockAvailable(browser_->profile());
     } else {
       [otherProfiles addObject:[self createOtherProfileView:i]];
     }
   }
   if (!currentProfileView)  // Guest windows don't have an active profile.
     currentProfileView = [self createGuestProfileView];
 
   // |yOffset| is the next position at which to draw in |container|
   // coordinates. Add a pixel offset so that the bottom option buttons don't
   // overlap the bubble's rounded corners.
   CGFloat yOffset = 1;
 
   if (isFastProfileChooser) {
     if (!switches::IsMaterialDesignUserMenu()) {
       [self buildFastUserSwitcherViewWithProfiles:otherProfiles.get()
                                         atYOffset:yOffset
                                       inContainer:container];
     }
   } else {
     [self buildProfileChooserViewWithProfileView:currentProfileView
                                     tutorialView:tutorialView
+                                   syncErrorView:syncErrorView
                                    otherProfiles:otherProfiles.get()
                                        atYOffset:yOffset
                                      inContainer:container
-                                     showLock:showLock];
+                                        showLock:showLock];
   }
 
   return container.autorelease();
 }
 
 - (NSView*)buildSigninConfirmationView {
   ProfileMetrics::LogProfileNewAvatarMenuSignin(
       ProfileMetrics::PROFILE_AVATAR_MENU_SIGNIN_VIEW);
 
   NSString* titleMessage = l10n_util::GetNSString(
@@ skipping 242 matching lines @@
 
   [GTMUILocalizerAndLayoutTweaker sizeToFitFixedWidthTextField:titleLabel];
   [container addSubview:titleLabel];
   yOffset = NSMaxY([titleLabel frame]) + kVerticalSpacing;
 
   [container setFrameSize:NSMakeSize(GetFixedMenuWidth(), yOffset)];
   [container setFrameOrigin:NSZeroPoint];
   return container.autorelease();
 }
 
+- (NSView*)buildSyncErrorViewIfNeeded {
+  ProfileSyncService* service =
+      ProfileSyncServiceFactory::GetForProfile(browser_->profile());
+
+  // The order or priority is going to be: 1. Unrecoverable errors.
+  // 2. Auth errors. 3. Protocol errors. 4. Passphrase errors.
+  if (service && service->HasUnrecoverableError()) {

[groby-ooo-7-16, 2016/07/22 23:53:16]

It seems a ton of this logic is shared with the Views implementation...

+    // An unrecoverable error is sometimes accompanied by an actionable error.
+    // If an actionable error is not set to be UPGRADE_CLIENT, then show a
+    // generic unrecoverable error message.
+    ProfileSyncService::Status status;
+    service->QueryDetailedSyncStatus(&status);
+    if (status.sync_protocol_error.action != syncer::UPGRADE_CLIENT) {
+      // Display different messages and buttons for managed accounts.
+      if (SigninManagerFactory::GetForProfile(browser_->profile())
+              ->IsSignoutProhibited()) {
+        // For a managed user, the user is directed to the signout
+        // confirmation dialogue in the settings page.
+        return [self buildSyncErrorViewWithContent:
+                         IDS_SYNC_ERROR_USER_MENU_SIGNOUT_MESSAGE
+                                    buttonStringId:
+                                        IDS_SYNC_ERROR_USER_MENU_SIGNOUT_BUTTON
+                                      buttonAction:@selector(showSignoutView:)];
+      }
+      // For a non-managed user, we sign out on the user's behalf and prompt
+      // the user to sign in again.
+      return [self
+          buildSyncErrorViewWithContent:
+              IDS_SYNC_ERROR_USER_MENU_SIGNIN_AGAIN_MESSAGE
+                         buttonStringId:
+                             IDS_SYNC_ERROR_USER_MENU_SIGNIN_AGAIN_BUTTON
+                           buttonAction:@selector(showSignoutSigninView:)];
+    }
+  }
+
+  // Check for an auth error.
+  if (HasAuthError(browser_->profile())) {
+    return [self
+        buildSyncErrorViewWithContent:IDS_SYNC_ERROR_USER_MENU_SIGNIN_MESSAGE
+                       buttonStringId:IDS_SYNC_ERROR_USER_MENU_SIGNIN_BUTTON
+                         buttonAction:@selector(
+                                          showAccountReauthenticationView:)];
+  }
+
+  // Check for sync errors if the sync service is enabled.
+  if (service) {
+    // Check for an actionable UPGRADE_CLIENT error.
+    ProfileSyncService::Status status;
+    service->QueryDetailedSyncStatus(&status);
+    if (status.sync_protocol_error.action == syncer::UPGRADE_CLIENT) {
+      return [self
+          buildSyncErrorViewWithContent:IDS_SYNC_ERROR_USER_MENU_UPGRADE_MESSAGE
+                         buttonStringId:IDS_SYNC_ERROR_USER_MENU_UPGRADE_BUTTON
+                           buttonAction:@selector(showUpdateChromeView:)];
+    }
+
+    // Check for a sync passphrase error.
+    SyncErrorController* sync_error_controller =
+        service->sync_error_controller();
+    if (sync_error_controller && sync_error_controller->HasError()) {
+      return [self
+          buildSyncErrorViewWithContent:
+              IDS_SYNC_ERROR_USER_MENU_PASSPHRASE_MESSAGE
+                         buttonStringId:
+                             IDS_SYNC_ERROR_USER_MENU_PASSPHRASE_BUTTON
+                           buttonAction:@selector(
+                                            showSyncPassphraseSetupView:)];
+    }
+  }
+
+  // There is no error.
+  return nil;
+}
+
+- (NSView*)buildSyncErrorViewWithContent:(int)contentStringId
+                          buttonStringId:(int)buttonStringId
+                            buttonAction:(SEL)buttonAction {
+  base::scoped_nsobject<NSView> container(
+      [[NSView alloc] initWithFrame:NSMakeRect(0, 0, GetFixedMenuWidth(), 0)]);
+  CGFloat iconSize = 20.0;
+  CGFloat xOffset = kHorizontalSpacing + iconSize + 12.0;
+  CGFloat availableWidth = GetFixedMenuWidth() - xOffset - kHorizontalSpacing;
+  CGFloat yOffset = 20.0;
+
+  // Adds an action button for resolving the error at the bottom.
+  base::scoped_nsobject<NSButton> resolveErrorButton(
+      [[BlueLabelButton alloc] initWithFrame:NSZeroRect]);
+  [resolveErrorButton setTitle:l10n_util::GetNSString(buttonStringId)];
+  [resolveErrorButton setTarget:self];
+  [resolveErrorButton setAction:buttonAction];
+  [resolveErrorButton setAlignment:NSCenterTextAlignment];
+  [resolveErrorButton sizeToFit];
+  [resolveErrorButton setFrameOrigin:NSMakePoint(xOffset, yOffset)];
+  [container addSubview:resolveErrorButton];
+  yOffset = NSMaxY([resolveErrorButton frame]) + kVerticalSpacing;
+
+  // Adds the error message content.
+  NSTextField* contentLabel =
+      BuildLabel(l10n_util::GetNSString(contentStringId),
+                 NSMakePoint(xOffset, yOffset), nil);
+  [contentLabel setFrameSize:NSMakeSize(availableWidth, 0)];
+  [GTMUILocalizerAndLayoutTweaker sizeToFitFixedWidthTextField:contentLabel];
+  [container addSubview:contentLabel];
+  yOffset = NSMaxY([contentLabel frame]) + 4;
+
+  // Adds the title for the error card.
+  NSTextField* titleLabel =
+      BuildLabel(l10n_util::GetNSString(IDS_SYNC_ERROR_USER_MENU_TITLE),
+                 NSMakePoint(xOffset, yOffset),
+                 skia::SkColorToCalibratedNSColor(gfx::kGoogleRed700));
+  [titleLabel setFrameSize:NSMakeSize(availableWidth, 0)];
+  [GTMUILocalizerAndLayoutTweaker sizeToFitFixedWidthTextField:titleLabel];
+  [container addSubview:titleLabel];
+  yOffset = NSMaxY([titleLabel frame]);
+
+  // Adds the sync problem icon.
+  base::scoped_nsobject<NSImageView> syncProblemIcon([[NSImageView alloc]
+      initWithFrame:NSMakeRect(kHorizontalSpacing, yOffset - iconSize, iconSize,
+                               iconSize)]);
+  [syncProblemIcon setImage:NSImageFromImageSkia(gfx::CreateVectorIcon(
+                                gfx::VectorIconId::SYNC_PROBLEM, iconSize,
+                                gfx::kGoogleRed700))];
+  [container addSubview:syncProblemIcon];
+
+  [container
+      setFrameSize:NSMakeSize(GetFixedMenuWidth(), yOffset + kVerticalSpacing)];
+  return container.autorelease();
+}
+
 - (NSView*)createCurrentProfileView:(const AvatarMenu::Item&)item {
   base::scoped_nsobject<NSView> container([[NSView alloc]
       initWithFrame:NSZeroRect]);
 
   CGFloat xOffset = kHorizontalSpacing;
   CGFloat yOffset = 0;
   CGFloat availableTextWidth = GetFixedMenuWidth() - 2 * kHorizontalSpacing;
   CGFloat maxAvailableTextWidth = GetFixedMenuWidth() - kHorizontalSpacing;
 
   // Profile options. This can be a link to the accounts view, the profile's
@@ skipping 938 matching lines @@
 }
 
 - (bool)shouldShowGoIncognito {
   bool incognitoAvailable =
       IncognitoModePrefs::GetAvailability(browser_->profile()->GetPrefs()) !=
           IncognitoModePrefs::DISABLED;
   return incognitoAvailable && !browser_->profile()->IsGuestSession();
 }
 
 @end