Bug 597315 Part 2 (session restore) - Frameset history does not work properly when restoring a tab [r=dietrich, a=blocking2.0:betaN+]

browser/components/sessionstore/src/nsSessionStore.js

@@ -1583,6 +1583,7 @@ SessionStoreService.prototype = {
       entry.cacheKey = cacheKey.data;
     }
     entry.ID = aEntry.ID;
+    entry.docshellID = aEntry.docshellID;
     
     if (aEntry.referrerURI)
       entry.referrer = aEntry.referrerURI.spec;
@@ -2698,7 +2699,12 @@ SessionStoreService.prototype = {
 
       didStartLoad = true;
       try {
-        browser.webNavigation.gotoIndex(activeIndex);
+        // In order to work around certain issues in session history, we need to
+        // force session history to update its internal index and call reload
+        // instead of gotoIndex. c.f. bug 597315
+        browser.webNavigation.sessionHistory.getEntryAtIndex(activeIndex, true);
+        browser.webNavigation.sessionHistory.
+          QueryInterface(Ci.nsISHistory_2_0_BRANCH).reloadCurrentEntry();
       }
       catch (ex) {
         // ignore page load errors
@@ -2813,6 +2819,9 @@ SessionStoreService.prototype = {
       shEntry.ID = id;
     }
 
+    if (aEntry.docshellID)
+      shEntry.docshellID = aEntry.docshellID;
+
     if (aEntry.stateData) {
       shEntry.stateData = aEntry.stateData;
     }

browser/components/sessionstore/test/browser/Makefile.in

@@ -122,6 +122,13 @@ _BROWSER_TEST_FILES = \
 	browser_586068-cascaded_restore.js \
 	browser_589246.js \
 	browser_590268.js \
+	browser_597315.js \
+	browser_597315_index.html \
+	browser_597315_a.html \
+	browser_597315_b.html \
+	browser_597315_c.html \
+	browser_597315_c1.html \
+	browser_597315_c2.html \
 	browser_600545.js \
 	browser_607016.js \
 	$(NULL)

browser/components/sessionstore/test/browser/browser_597315.js

@@ -0,0 +1,95 @@
+/* ***** 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 sessionstore test code.
+ *
+ * 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):
+ * Paul O’Shannessy <paul@oshannessy.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 ***** */
+
+Cu.import("resource://gre/modules/Services.jsm");
+let ss = Cc["@mozilla.org/browser/sessionstore;1"].
+         getService(Ci.nsISessionStore);
+
+function test() {
+  /** Test for Bug 597315 - Frameset history does not work properly when restoring a tab **/
+  waitForExplicitFinish();
+
+  let testURL = getRootDirectory(gTestPath) + "browser_597315_index.html";
+  let tab = gBrowser.addTab(testURL);
+  gBrowser.selectedTab = tab;
+
+  waitForLoadsInBrowser(tab.linkedBrowser, 4, function() {
+    let browser_b = tab.linkedBrowser.contentDocument.getElementsByTagName("frame")[1];
+    let document_b = browser_b.contentDocument;
+    let links = document_b.getElementsByTagName("a");
+
+    // We're going to click on the first link, so listen for another load event
+    waitForLoadsInBrowser(tab.linkedBrowser, 1, function() {
+      waitForLoadsInBrowser(tab.linkedBrowser, 1, function() {
+
+        gBrowser.removeTab(tab);
+        // wait for 4 loads again...
+        let newTab = ss.undoCloseTab(window, 0);
+
+        waitForLoadsInBrowser(newTab.linkedBrowser, 4, function() {
+          gBrowser.goBack();
+          waitForLoadsInBrowser(newTab.linkedBrowser, 1, function() {
+
+            let expectedURLEnds = ["a.html", "b.html", "c1.html"];
+            let frames = newTab.linkedBrowser.contentDocument.getElementsByTagName("frame");
+            for (let i = 0; i < frames.length; i++) {
+              is(frames[i].contentDocument.location,
+                 getRootDirectory(gTestPath) + "browser_597315_" + expectedURLEnds[i],
+                 "frame " + i + " has the right url");
+            }
+            gBrowser.removeTab(newTab);
+            executeSoon(finish);
+          });
+        });
+      });
+      EventUtils.sendMouseEvent({type:"click"}, links[1], browser_b.contentWindow);
+    });
+    EventUtils.sendMouseEvent({type:"click"}, links[0], browser_b.contentWindow);
+  });
+}
+
+// helper function
+function waitForLoadsInBrowser(aBrowser, aLoadCount, aCallback) {
+  let loadCount = 0;
+  aBrowser.addEventListener("load", function(aEvent) {
+    if (++loadCount < aLoadCount)
+      return;
+
+    aBrowser.removeEventListener("load", arguments.callee, true);
+    aCallback();
+  }, true);
+}

browser/components/sessionstore/test/browser/browser_597315_a.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    I'm A!
+  </body>
+</html>

browser/components/sessionstore/test/browser/browser_597315_b.html

@@ -0,0 +1,10 @@
+<html>
+  <body>
+    I'm B!<br/>
+    <a target="c" href="browser_597315_c1.html">click me first</a><br/>
+    <a target="c" href="browser_597315_c2.html">then click me</a><br/>
+    Close this tab.<br/>
+    Restore this tab.<br/>
+    Click back.<br/>
+  </body>
+</html>

browser/components/sessionstore/test/browser/browser_597315_c.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    I'm C!
+  </body>
+</html>

browser/components/sessionstore/test/browser/browser_597315_c1.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    I'm C1!
+  </body>
+</html>

browser/components/sessionstore/test/browser/browser_597315_c2.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    I'm C2!
+  </body>
+</html>

browser/components/sessionstore/test/browser/browser_597315_index.html

@@ -0,0 +1,10 @@
+<html>
+  <frameset cols="20%,80%">
+    <frameset rows="30%,70%">
+      <frame src="browser_597315_a.html"/>
+      <frame src="browser_597315_b.html"/>
+    </frameset>
+    <frame src="browser_597315_c.html" name="c"/>
+  </frameset>
+</html>
+