Moved NavigationManagerImpl serialization out of CRWSessionController.

ios/web/web_state/web_state_impl.h

 // 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.
 
 #ifndef IOS_WEB_WEB_STATE_WEB_STATE_IMPL_H_
 #define IOS_WEB_WEB_STATE_WEB_STATE_IMPL_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <map>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/observer_list.h"
 #include "base/values.h"
 #import "ios/web/navigation/navigation_manager_delegate.h"
 #import "ios/web/navigation/navigation_manager_impl.h"
+#import "ios/web/navigation/navigation_manager_serialization_builder.h"
 #import "ios/web/public/java_script_dialog_callback.h"
 #include "ios/web/public/java_script_dialog_type.h"
 #import "ios/web/public/web_state/web_state.h"
 #import "ios/web/public/web_state/web_state_delegate.h"
 #include "url/gurl.h"
 
+@class CRWNavigationManagerSerialization;
 @class CRWWebController;
 @protocol CRWWebViewProxy;
 @class NSURLRequest;
 @class NSURLResponse;
 
 namespace net {
 class HttpResponseHeaders;
 }
 
 namespace web {
@@ skipping 17 matching lines @@
 //      (a) By @Tab, when creating a new Tab.
 //      (b) By @SessionWindow, when decoding a saved session.
 //      (c) By the Copy() method, below, used when marshalling a session
 //          in preparation for saving.
 //  - WebControllers are the eventual long-term owners of WebStateImpls.
 //  - SessionWindows are transient owners, passing ownership into WebControllers
 //    during session restore, and discarding owned copies of WebStateImpls after
 //    writing them out for session saves.
 class WebStateImpl : public WebState, public NavigationManagerDelegate {
  public:
+  // Constructor for WebStateImpls created for new sessions.
   WebStateImpl(BrowserState* browser_state);
+  // Constructor for WebStatesImpls created for deserialized sessions
+  WebStateImpl(BrowserState* browser_state,
+               CRWNavigationManagerSerialization* serialized_session);
   ~WebStateImpl() override;
 
   // Gets/Sets the CRWWebController that backs this object.
   CRWWebController* GetWebController();
   void SetWebController(CRWWebController* web_controller);
 
   // Gets or sets the delegate used to communicate with the web contents facade.
   WebStateFacadeDelegate* GetFacadeDelegate() const;
   void SetFacadeDelegate(WebStateFacadeDelegate* facade_delegate);
 
-  // Returns a WebStateImpl that doesn't have a browser context, web
-  // controller, or facade set, but which otherwise has the same state variables
-  // as the calling object (including copies of the NavigationManager and its
-  // attendant CRWSessionController).
-  // TODO(crbug.com/546377): Clean up this method.
-  WebStateImpl* CopyForSessionWindow();
-
   // Notifies the observers that a provisional navigation has started.
   void OnProvisionalNavigationStarted(const GURL& url);
 
   // Called when a navigation is committed.
   void OnNavigationCommitted(const GURL& url);
 
   // Notifies the observers that the URL hash of the current page changed.
   void OnUrlHashChanged();
 
   // Notifies the observers that the history state of the current page changed.
@@ skipping 106 matching lines @@
   bool IsWebUsageEnabled() const override;
   void SetWebUsageEnabled(bool enabled) override;
   bool ShouldSuppressDialogs() const override;
   void SetShouldSuppressDialogs(bool should_suppress) override;
   UIView* GetView() override;
   BrowserState* GetBrowserState() const override;
   void OpenURL(const WebState::OpenURLParams& params) override;
   void Stop() override;
   const NavigationManager* GetNavigationManager() const override;
   NavigationManager* GetNavigationManager() override;
+  CRWNavigationManagerSerialization* BuildSerializedNavigationManager()

[Eugene But (OOO till 7-30), 2017/01/25 19:24:30]

Is this analogue of WebContentsImpl::GetSessionStorageNamespaceMap?

[kkhorimoto, 2017/01/26 07:19:10]

Yes

+      override;
   CRWJSInjectionReceiver* GetJSInjectionReceiver() const override;
   void ExecuteJavaScript(const base::string16& javascript) override;
   void ExecuteJavaScript(const base::string16& javascript,
                          const JavaScriptResultCallback& callback) override;
   const std::string& GetContentLanguageHeader() const override;
   const std::string& GetContentsMimeType() const override;
   bool ContentIsHTML() const override;
   const base::string16& GetTitle() const override;
   bool IsLoading() const override;
   double GetLoadingProgress() const override;
@@ skipping 80 matching lines @@
 
   // Stores whether the web state is currently being destroyed.
   bool is_being_destroyed_;
 
   // The delegate used to pass state to the web contents facade.
   WebStateFacadeDelegate* facade_delegate_;
 
   // The CRWWebController that backs this object.
   base::scoped_nsobject<CRWWebController> web_controller_;
 
-  NavigationManagerImpl navigation_manager_;
+  // The NavigationManagerImpl that stores session info for this WebStateImpl.
+  std::unique_ptr<NavigationManagerImpl> navigation_manager_;
 
   // |web::WebUIIOS| object for the current page if it is a WebUI page that
   // uses the web-based WebUI framework, or nullptr otherwise.
   std::unique_ptr<web::WebUIIOS> web_ui_;
 
   // A list of observers notified when page state changes. Weak references.
   base::ObserverList<WebStateObserver, true> observers_;
 
   // All the WebStatePolicyDeciders asked for navigation decision. Weak
   // references.
@@ skipping 24 matching lines @@
   // any WeakPtrs to WebStateImpl are invalidated before its member variable's
   // destructors are executed, rendering them invalid.
   base::WeakPtrFactory<WebState> weak_factory_;
 
   // Mojo interface registry for this WebState.
   std::unique_ptr<service_manager::InterfaceRegistry> mojo_interface_registry_;
 
   // Image Fetcher used to images.
   std::unique_ptr<ImageDataFetcher> image_fetcher_;
 
+  // The serialization builder.
+  NavigationManagerSerializationBuilder serialization_builder_;

[Eugene But (OOO till 7-30), 2017/01/25 19:24:30]

Do we need this to be a member? Should this be a local variable instead?

[kkhorimoto, 2017/01/26 07:19:10]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(WebStateImpl);
 };
 
 }  // namespace web
 
 #endif  // IOS_WEB_WEB_STATE_WEB_STATE_IMPL_H_