Additions to Activities to allow resource management

athena/content/web_activity.cc

 // 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.
 
 #include "athena/content/web_activity.h"
 
 #include "athena/activity/public/activity_manager.h"
 #include "athena/input/public/accelerator_manager.h"
 #include "content/public/browser/native_web_keyboard_event.h"
 #include "content/public/browser/web_contents.h"
@@ skipping 98 matching lines @@
   }
 
   views::WebView* web_view_;
   bool reserved_accelerator_enabled_;
   scoped_ptr<AcceleratorManager> accelerator_manager_;
   views::UnhandledKeyboardEventHandler unhandled_keyboard_event_handler_;
 
   DISALLOW_COPY_AND_ASSIGN(WebActivityController);
 };
 
-// A web view for athena's web activity.
+// A web view for athena's web activity. Note that AthenaWebView will create its
+// own content so that it can eject and reload it.
 class AthenaWebView : public views::WebView {
  public:
   AthenaWebView(content::BrowserContext* context)
-      : views::WebView(context), controller_(new WebActivityController(this)) {}
-  virtual ~AthenaWebView() {}
+      : views::WebView(context), controller_(new WebActivityController(this)) {
+    // We create the first web contents ourselves to allow us to replace it
+    // later on.
+    SetWebContents(WebContents::Create(WebContents::CreateParams(context)));
+    // TODO(skuhne): Add content observer to detect renderer crash and set
+    // content status to unloaded if that happens.
+  }
+  virtual ~AthenaWebView() {
+    // |WebView| does not own the content, so we need to destroy it here.
+    WebContents* current_contents = web_view_->GetWebContents();
+    web_view_->SetWebContents(NULL);
+    delete current_contents;
+  }
 
   void InstallAccelerators() { controller_->InstallAccelerators(); }
 
+  void EvictContent() {
+    WebContents* old_contents = GetWebContents();
+    evicted_web_contents_.reset(
+        WebContents::Create(WebContents::CreateParams(
+            old_contents->profile())));
+    evicted_web_contents_->GetController().CopyStateFrom(
+        old_contents->GetController());
+    SetContents(WebContents::Create(WebContents::CreateParams(
+        old_contents->profile())));
+    delete old_contents;
+    // As soon as the new contents becomes visible, it should reload.
+    // TODO(skuhne): This breaks script connections with other activities.
+    // Even though this is the same technique as used by the TabStripModel,
+    // we might want to address this cleaner since we are more likely to
+    // run into this state. by unloading.
+  }
+
+  void ReloadContent() {
+    CHECK(evicted_web_contents_.get());
+    WebContents* null_contents = GetWebContents();
+    SetContents(evicted_web_contents_.release());
+    delete null_contents;
+  }
+
+  // Check if the content got evicted.
+  bool IsContentEvicted() { return !evicted_web_contents_.get(); }
+
  private:
   // WebContentsDelegate:
   virtual bool PreHandleKeyboardEvent(
       content::WebContents* source,
       const content::NativeWebKeyboardEvent& event,
       bool* is_keyboard_shortcut) OVERRIDE {
     return controller_->PreHandleKeyboardEvent(
         source, event, is_keyboard_shortcut);
   }
 
   virtual void HandleKeyboardEvent(
       content::WebContents* source,
       const content::NativeWebKeyboardEvent& event) OVERRIDE {
     controller_->HandleKeyboardEvent(source, event);
   }
 
   scoped_ptr<WebActivityController> controller_;
 
+  // If the activity got evicted, this is the web content which holds the known
+  // state of the content before eviction.
+  scoped_ptr<content::WebContents> evicted_web_contents_;
+
+
   DISALLOW_COPY_AND_ASSIGN(AthenaWebView);
 };
 
 }  // namespace
 
 WebActivity::WebActivity(content::BrowserContext* browser_context,
                          const GURL& url)
-    : browser_context_(browser_context), url_(url), web_view_(NULL) {
+    : browser_context_(browser_context),
+      url_(url),
+      web_view_(NULL),
+      last_requested_state_(ACTIVITY_UNLOAD) {
 }
 
 WebActivity::~WebActivity() {
+  // It is not required to change the activity state to UNLOADED - unless we
+  // would add state observers.
 }
 
 ActivityViewModel* WebActivity::GetActivityViewModel() {
   return this;
 }
 
+void WebActivity::SetCurrentState(ActivityStateTranstion state) {
+  switch (state) {
+    case ACTIVITY_LOAD:
+      // By clearing the overview mode image we allow the content to be shown.
+      overview_mode_image_ = gfx::ImageSkia();
+      if (web_view_->IsContentEvicted()) {
+        DCHECK_EQ(ACTIVITY_UNLOAD, last_requested_state_);
+        web_view_->ReloadContent();
+      }
+      Observe(web_view_->GetWebContents());
+      break;
+    case ACTIVITY_DEEP_SLEEP_1:
+      DCHECK_EQ(ACTIVITY_LOAD, last_requested_state_);
+      // TODO(skuhne): Do this. As soon as the new resource management is
+      // agreed upon - or remove otherwise.
+      break;
+    case ACTIVITY_DEEP_SLEEP_2:
+      DCHECK_EQ(ACTIVITY_DEEP_SLEEP_1, last_requested_state_);
+      // TODO(skuhne): Do this. As soon as the new resource management is
+      // agreed upon - or remove otherwise.
+      break;
+    case ACTIVITY_UNLOAD:
+      DCHECK_NE(ACTIVITY_UNLOAD, last_requested_state_);
+      Observe(NULL);
+      web_view_->EvictContent();

[Jun Mukai, 2014/06/26 19:48:01]

Can we just discard web_view_ itself instead of implementing EvictContent?

[Mr4D (OOO till 08-26), 2014/06/26 20:25:39]

Well... WebView is used by another instance (the one who calls
"GetContentsView"). As such I kept it alive.

Note: I was actually even considering to use it to show the content for
navigation.

Last but not least - this follows the way the TabModel uses it.

That all said - sure, we can of course do it that way. I did not complete my
investigation of how to do this with applications and there we might have to do
something like that (since the ShellWindow has a reference to the WebView which
we possibly cannot simply break) .

But my main concern is to agree on the general SW structure - the "how it is
done in the end" might still change.

[Jun Mukai, 2014/06/26 21:45:26]

Okay, doing the same approach as TabModel sounds promising. I also want oshima
to review this though.

+      break;
+  }
+  // Remember the last requested state.
+  last_requested_state_ = state;
+}
+
+ActivityState WebActivity::GetCurrentState() {
+  if (!web_view_ || web_view_->IsContentEvicted()) {
+    DCHECK_EQ(ACTIVITY_UNLOAD, last_requested_state_);
+    return ACTIVITY_STATE_UNLOADED;
+  }
+
+  switch(last_requested_state_) {
+    case ACTIVITY_LOAD:
+      if (web_view_->IsDrawn())
+        return ACTIVITY_STATE_VISIBLE;
+      /*
+      // TODO(skuhne): AudioStreamMonitor is currently a part of Chrome and
+      // needs to be moved some levels up.
+        WebContents* contents = web_view_->
+        AudioStreamMonitor* const audio_stream_monitor =
+            AudioStreamMonitor::FromWebContents(contents);
+        if (audio_stream_monitor && audio_stream_monitor->WasRecentlyAudible())
+          return ACTIVITY_STATE_ACTIVE;
+      */
+      return ACTIVITY_STATE_HIDDEN;
+    case ACTIVITY_DEEP_SLEEP_1:
+      return ACTIVITY_DEEP_SLEEP_1;
+    case ACTIVITY_DEEP_SLEEP_2:
+      return ACTIVITY_DEEP_SLEEP_2;
+    case ACTIVITY_UNLOAD:
+      return ACTIVITY_STATE_UNLOADED;
+  }
+}
+
 void WebActivity::Init() {
   DCHECK(web_view_);
-  static_cast<AthenaWebView*>(web_view_)->InstallAccelerators();
+  web_view_->InstallAccelerators();
 }
 
 SkColor WebActivity::GetRepresentativeColor() {
   // TODO(sad): Compute the color from the favicon.
   return SK_ColorGRAY;
 }
 
 base::string16 WebActivity::GetTitle() {
   return web_view_->GetWebContents()->GetTitle();
 }
 
 views::View* WebActivity::GetContentsView() {
   if (!web_view_) {
     web_view_ = new AthenaWebView(browser_context_);
     web_view_->LoadInitialURL(url_);
-    Observe(web_view_->GetWebContents());
+    SetCurrentState(ACTIVITY_LOAD);
+    // Reset the overview mode image.
+    overview_mode_image_ = gfx::ImageSkia();
   }
   return web_view_;
 }
 
 void WebActivity::TitleWasSet(content::NavigationEntry* entry,
                               bool explicit_set) {
   ActivityManager::Get()->UpdateActivity(this);
 }
 
 void WebActivity::DidUpdateFaviconURL(
     const std::vector<content::FaviconURL>& candidates) {
   ActivityManager::Get()->UpdateActivity(this);
 }
 
 }  // namespace athena