Bug 589324 - Switch-to-Tab after Session Restore does not respect Tab Candy grouping [r=dietrich, a=blocking2.0]

browser/base/content/browser-tabview.js

@@ -61,8 +61,21 @@ let TabView = {
         getService(Ci.nsISessionStore);
 
     let data = this._sessionstore.getWindowValue(window, this._visibilityID);
-    if (data && data == "true")
+    if (data && data == "true") {
       this.show();
+    } else {
+      let self = this;
+      // if a tab is changed from hidden to unhidden and the iframe is not 
+      // initialized, load the iframe and setup the tab.
+      this._tabShowEventListener = function (event) {
+        if (!self._window)
+          self._initFrame(function() {
+            self._window.UI.onTabSelect(gBrowser.selectedTab);
+          });
+      };
+      gBrowser.tabContainer.addEventListener(
+        "TabShow", this._tabShowEventListener, true);
+    }
   },
 
   // ----------
@@ -97,8 +110,12 @@ let TabView = {
           self._sessionstore.setWindowValue(window, self._visibilityID, data);
         }
       }
-      
       Services.obs.addObserver(observer, "quit-application-requested", false);
+
+      if (this._tabShowEventListener) {
+        gBrowser.tabContainer.removeEventListener(
+          "TabShow", this._tabShowEventListener, true);
+      }
     }
   },
 

browser/base/content/test/browser_visibleTabs.js

@@ -60,6 +60,13 @@ function test() {
   gBrowser.selectedTab = testTab;
   gBrowser.showOnlyTheseTabs([testTab]);
 
+  // if the tabview frame is initialized, we need to move the orignal tab to
+  // another group; otherwise, selecting a tab would make all three tabs in 
+  // the same group to display.
+  let tabViewWindow = TabView.getContentWindow();
+  if (tabViewWindow)
+    tabViewWindow.GroupItems.moveTabToGroupItem(origTab, null);
+
   visible = gBrowser.visibleTabs;
   is(visible.length, 2, "2 tabs should be visible including the pinned");
   is(visible[0], pinned, "first is pinned");

browser/base/content/test/tabview/Makefile.in

@@ -48,6 +48,7 @@ _BROWSER_FILES = \
                  browser_tabview_bug580412.js \
                  browser_tabview_bug587043.js \
                  browser_tabview_bug587990.js \
+                 browser_tabview_bug589324.js \
                  browser_tabview_bug590606.js \
                  browser_tabview_bug591706.js \
                  browser_tabview_bug594176.js \
@@ -70,6 +71,7 @@ _BROWSER_FILES = \
                  browser_tabview_startup_transitions.js \
                  browser_tabview_undo_group.js \
                  browser_tabview_firstrun_pref.js \
+                 dummy_page.html \
                  head.js \
                  search1.html \
                  search2.html \

browser/base/content/test/tabview/browser_tabview_bug580412.js

@@ -59,6 +59,7 @@ function onTabViewWindowLoaded() {
 //    "There's currently 40 px between the first group and second group");
 
   let endGame = function() {
+    contentWindow.UI.reset();
     let onTabViewHidden = function() {
       window.removeEventListener("tabviewhidden", onTabViewHidden, false);
       ok(!TabView.isVisible(), "TabView is shown");
@@ -73,7 +74,6 @@ function onTabViewWindowLoaded() {
   }
   
   let part1 = function() {
-//    contentWindow.UI.reset();
     // move down 20 so we're far enough away from the top.
     checkSnap(currentActiveGroup, 0, 20, contentWindow, function(snapped){
       ok(!snapped,"Move away from the edge");
@@ -94,6 +94,8 @@ function onTabViewWindowLoaded() {
     });
   }
 
+  currentActiveGroup.setPosition(40, 40, true);
+  currentActiveGroup.arrange({animate: false});
   part1();
 }
 

browser/base/content/test/tabview/browser_tabview_bug589324.js

@@ -0,0 +1,127 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is bug 589324 test.
+ *
+ * The Initial Developer of the Original Code is
+ * Mozilla Foundation.
+ * Portions created by the Initial Developer are Copyright (C) 2010
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * Raymond Lee <raymond@appcoast.com>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+function test() {
+  const DUMMY_PAGE_URL = "http://mochi.test:8888/browser/browser/base/content/test/tabview/dummy_page.html";
+  const DUMMY_PAGE_URL_2 = "http://mochi.test:8888/";
+
+  let ss = Cc["@mozilla.org/browser/sessionstore;1"].getService(Ci.nsISessionStore);
+  waitForExplicitFinish();
+
+  // open a new window and setup the window state.
+  let newWin = openDialog(getBrowserURL(), "_blank", "chrome,all,dialog=no");
+  newWin.addEventListener("load", function(event) {
+    this.removeEventListener("load", arguments.callee, false);
+
+    let newState = {
+      windows: [{
+        tabs: [{
+          entries: [{ url: DUMMY_PAGE_URL }],
+          hidden: true,
+          attributes: {},
+          extData: {
+            "tabview-tab":
+              '{"bounds":{"left":21,"top":29,"width":204,"height":153},' +
+              '"userSize":null,"url":"' + DUMMY_PAGE_URL + '","groupID":1,' + 
+              '"imageData":null,"title":null}'
+          }
+        },{
+          entries: [{ url: DUMMY_PAGE_URL_2 }],
+          hidden: false,
+          attributes: {},
+          extData: {
+            "tabview-tab": 
+              '{"bounds":{"left":315,"top":29,"width":111,"height":84},' + 
+              '"userSize":null,"url":"' + DUMMY_PAGE_URL_2 + '","groupID":2,' + 
+              '"imageData":null,"title":null}'
+          },
+        }],
+        selected:2,
+        _closedTabs: [],
+        extData: {
+          "tabview-groups": '{"nextID":3,"activeGroupId":2}',
+          "tabview-group": 
+            '{"1":{"bounds":{"left":15,"top":5,"width":280,"height":232},' + 
+            '"userSize":null,"locked":{},"title":"","id":1},' + 
+            '"2":{"bounds":{"left":309,"top":5,"width":267,"height":226},' + 
+            '"userSize":null,"locked":{},"title":"","id":2}}',
+          "tabview-ui": '{"pageBounds":{"left":0,"top":0,"width":788,"height":548}}'
+        }, sizemode:"normal"
+      }]
+    };
+    ss.setWindowState(newWin, JSON.stringify(newState), true);
+
+    let firstTab = newWin.gBrowser.tabs[0];
+    let secondTab = newWin.gBrowser.tabs[1];
+
+    // wait until the first tab is fully loaded
+    let browser = newWin.gBrowser.getBrowserForTab(firstTab);
+    let onLoad = function() {
+      browser.removeEventListener("load", onLoad, true);
+
+      is(browser.currentURI.spec, DUMMY_PAGE_URL, 
+         "The url of first tab url is dummy_page.html");
+
+      // check the hidden state of both tabs.
+      ok(firstTab.hidden, "The first tab is hidden");
+      ok(!secondTab.hidden, "The second tab is not hidden");
+      is(secondTab, newWin.gBrowser.selectedTab, "The second tab is selected");
+
+      // when the second tab is hidden, the iframe should be initialized and 
+      // the first tab should be visible.
+      let onTabHide = function() {
+        newWin.gBrowser.tabContainer.addEventListener("TabHide", onTabHide, true);
+
+        ok(newWin.TabView.getContentWindow(), "");
+
+        ok(!firstTab.hidden, "The first tab is not hidden");
+        is(firstTab, newWin.gBrowser.selectedTab, "The first tab is selected");
+        ok(secondTab.hidden, "The second tab is hidden");
+
+        // clean up and finish
+        newWin.close();
+
+        finish();
+      };
+      newWin.gBrowser.tabContainer.addEventListener("TabHide", onTabHide, true);
+
+      // switch to another tab
+      newWin.switchToTabHavingURI(DUMMY_PAGE_URL);
+    }
+    browser.addEventListener("load", onLoad, true);
+  }, false);
+}

browser/base/content/test/tabview/dummy_page.html

@@ -0,0 +1,8 @@
+<html>
+<head>
+<title>This is a dummy test page</title>
+</head>
+<body>
+<p>This is a dummy test page</p>
+</body>
+</html>