[ios] TabIdTabHelper

ios/chrome/browser/tabs/tab.mm

 // Copyright 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.
 
 #import "ios/chrome/browser/tabs/tab.h"
 
 #import <CoreLocation/CoreLocation.h>
 #import <UIKit/UIKit.h>
 
 #include <utility>
@@ skipping 82 matching lines @@
 #import "ios/chrome/browser/ui/overscroll_actions/overscroll_actions_controller.h"
 #import "ios/chrome/browser/ui/prerender_delegate.h"
 #import "ios/chrome/browser/ui/reader_mode/reader_mode_checker.h"
 #import "ios/chrome/browser/ui/reader_mode/reader_mode_controller.h"
 #include "ios/chrome/browser/ui/ui_util.h"
 #import "ios/chrome/browser/web/auto_reload_bridge.h"
 #import "ios/chrome/browser/web/external_app_launcher.h"
 #import "ios/chrome/browser/web/navigation_manager_util.h"
 #import "ios/chrome/browser/web/passkit_dialog_provider.h"
 #include "ios/chrome/browser/web/print_observer.h"
+#import "ios/chrome/browser/web/tab_id_tab_helper.h"
 #import "ios/chrome/browser/xcallback_parameters.h"
 #include "ios/chrome/grit/ios_strings.h"
 #import "ios/web/navigation/navigation_item_impl.h"
 #import "ios/web/navigation/navigation_manager_impl.h"
 #include "ios/web/public/favicon_status.h"
 #include "ios/web/public/favicon_url.h"
 #include "ios/web/public/interstitials/web_interstitial.h"
 #include "ios/web/public/load_committed_details.h"
 #import "ios/web/public/navigation_manager.h"
 #include "ios/web/public/referrer.h"
@@ skipping 35 matching lines @@
 NSString* const kTabClosingCurrentDocumentNotificationForCrashReporting =
     @"kTabClosingCurrentDocumentNotificationForCrashReporting";
 
 NSString* const kTabUrlKey = @"url";
 
 namespace {
 class TabHistoryContext;
 class FaviconDriverObserverBridge;
 class TabInfoBarObserver;
 
-// The key under which the Tab ID is stored in the WebState's serializable user
-// data.
-NSString* const kTabIDKey = @"TabID";
-
 // Name of histogram for recording the state of the tab when the renderer is
 // terminated.
 const char kRendererTerminationStateHistogram[] =
     "Tab.StateAtRendererTermination";
 
 // Referrer used for clicks on article suggestions on the NTP.
 const char kChromeContentSuggestionsReferrer[] =
     "https://www.googleapis.com/auth/chrome-content-suggestions";
 
 // Enum corresponding to UMA's TabForegroundState, for
@@ skipping 247 matching lines @@
                                            infobars::InfoBar* new_infobar) {
   // Update snapshots after the infobar has been replaced.
   [owner_ updateSnapshotWithOverlay:YES visibleFrameOnly:YES];
 }
 
 }  // anonymous namespace
 
 @implementation Tab
 
 @synthesize browserState = _browserState;
-@synthesize tabId = tabId_;
+@dynamic tabId;

[marq (ping after 24h), 2017/06/23 08:46:29]

You only need @dynamic when no implementation of the property is provided in
this implementation; @dynamic is an assurance to the complier that some other
code will handle accessing the property.

For this change, just deleting the @synthesize line is sufficient.

[edchin, 2017/06/23 16:24:21]

Done.

 @synthesize useGreyImageCache = useGreyImageCache_;
 @synthesize isPrerenderTab = _isPrerenderTab;
 @synthesize isLinkLoadingPrerenderTab = isLinkLoadingPrerenderTab_;
 @synthesize isVoiceSearchResultsTab = _isVoiceSearchResultsTab;
 @synthesize passwordController = passwordController_;
 @synthesize overscrollActionsController = _overscrollActionsController;
 @synthesize readerModeController = readerModeController_;
 @synthesize overscrollActionsControllerDelegate =
     overscrollActionsControllerDelegate_;
 @synthesize passKitDialogProvider = passKitDialogProvider_;
@@ skipping 168 matching lines @@
       net::UnescapeRule::SPACES, nullptr, nullptr, nullptr);
   return base::SysUTF16ToNSString(urlText);
 }
 
 - (NSString*)tabId {
   if (!self.webState) {
     // Tab can outlive WebState, in which case Tab is not valid anymore and
     // tabId should be nil.
     return nil;
   }
-
-  if (tabId_)
-    return tabId_;
-
-  web::SerializableUserDataManager* userDataManager =
-      web::SerializableUserDataManager::FromWebState(self.webState);
-  NSString* tabId = base::mac::ObjCCast<NSString>(
-      userDataManager->GetValueForSerializationKey(kTabIDKey));
-
-  if (!tabId || ![tabId length]) {
-    tabId = [[NSUUID UUID] UUIDString];
-    userDataManager->AddSerializableData(tabId, kTabIDKey);
-  }
-
-  tabId_ = [tabId copy];
-  return tabId_;
+  return base::SysUTF8ToNSString(
+      TabIDTabHelper::FromWebState(self.webState)->tab_id());

[rohitrao (ping after 24h), 2017/06/23 11:10:27]

Is the TabID always used as an NSString?  If so, should we just store that in
the helper instead of a std::string?

[edchin, 2017/06/23 16:24:21]

My original intent is to be consistent with ios/web (which prefers std::string
over NSString)
since this class derives from an ios/web class. However, looking at other recent
subclasses of web::WebStateUserData, it is precedented to use NSString.
I have updated this to use NSString.

 }
 
 - (web::WebState*)webState {
   return _webStateImpl;
 }
 
 - (void)fetchFavicon {
   const GURL& url = self.visibleURL;
   if (!url.is_valid())
     return;
@@ skipping 1186 matching lines @@
 
 - (TabModel*)parentTabModel {
   return _parentTabModel;
 }
 
 - (FormInputAccessoryViewController*)inputAccessoryViewController {
   return _inputAccessoryViewController;
 }
 
 @end