1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/browser/components/sessionstore/test/browser_history_cap.js Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,125 @@
1.4 +/* Any copyright is dedicated to the Public Domain.
1.5 + * http://creativecommons.org/publicdomain/zero/1.0/ */
1.6 +
1.7 +"use strict";
1.8 +
1.9 +/**
1.10 + * This test ensures that the preferences (added in bug 943339) that control how
1.11 + * many back and forward button session history entries we store work correctly.
1.12 + *
1.13 + * It adds a number of entries to the session history, restores them and checks
1.14 + * that the restored state matches the preferences.
1.15 + */
1.16 +
1.17 +add_task(function *test_history_cap() {
1.18 + const baseURL = "http://example.com/browser_history_cap#"
1.19 + const maxEntries = 9; // The number of generated session history entries.
1.20 + const middleEntry = 4; // The zero-based index of the middle entry.
1.21 +
1.22 + const maxBack1 = 2; // The history cap settings used for the first test,
1.23 + const maxFwd1 = 3; // where maxBack1 + 1 + maxFwd1 < maxEntries.
1.24 +
1.25 + const maxBack2 = 5; // The history cap settings used for the other tests,
1.26 + const maxFwd2 = 5; // where maxBack2 + 1 + maxFwd2 > maxEntries.
1.27 +
1.28 + // Set the relevant preferences for the first test.
1.29 + gPrefService.setIntPref("browser.sessionhistory.max_entries", maxEntries);
1.30 + gPrefService.setIntPref("browser.sessionstore.max_serialize_back", maxBack1);
1.31 + gPrefService.setIntPref("browser.sessionstore.max_serialize_forward", maxFwd1);
1.32 +
1.33 + // Make sure the settings we modify are reset afterward.
1.34 + registerCleanupFunction(() => {
1.35 + gPrefService.clearUserPref("browser.sessionhistory.max_entries");
1.36 + gPrefService.clearUserPref("browser.sessionstore.max_serialize_back");
1.37 + gPrefService.clearUserPref("browser.sessionstore.max_serialize_forward");
1.38 + });
1.39 +
1.40 + let tab = gBrowser.addTab();
1.41 + let browser = tab.linkedBrowser;
1.42 + yield promiseBrowserLoaded(browser);
1.43 +
1.44 + // Generate the tab state entries and set the one-based
1.45 + // tab-state index to the middle session history entry.
1.46 + let tabState = {entries: [], index: middleEntry + 1};
1.47 + for (let i = 0; i < maxEntries; i++) {
1.48 + tabState.entries.push({url: baseURL + i});
1.49 + }
1.50 +
1.51 + info("Testing situation where only a subset of session history entries should be restored.");
1.52 +
1.53 + ss.setTabState(tab, JSON.stringify(tabState));
1.54 + yield promiseTabRestored(tab);
1.55 + SyncHandlers.get(tab.linkedBrowser).flush();
1.56 +
1.57 + let restoredTabState = JSON.parse(ss.getTabState(tab));
1.58 + is(restoredTabState.entries.length, maxBack1 + 1 + maxFwd1,
1.59 + "The expected number of session history entries was restored.");
1.60 + is(restoredTabState.index, maxBack1 + 1, "The restored tab-state index is correct");
1.61 +
1.62 + let indexURLOffset = middleEntry - (restoredTabState.index - 1);
1.63 + for (let i = 0; i < restoredTabState.entries.length; i++) {
1.64 + is(restoredTabState.entries[i].url, baseURL + (i + indexURLOffset),
1.65 + "URL of restored entry matches the expected URL.");
1.66 + }
1.67 +
1.68 + // Set the relevant preferences for the other tests.
1.69 + gPrefService.setIntPref("browser.sessionstore.max_serialize_back", maxBack2);
1.70 + gPrefService.setIntPref("browser.sessionstore.max_serialize_forward", maxFwd2);
1.71 +
1.72 + info("Testing situation where all of the entries in the session history should be restored.");
1.73 +
1.74 + ss.setTabState(tab, JSON.stringify(tabState));
1.75 + yield promiseTabRestored(tab);
1.76 + SyncHandlers.get(tab.linkedBrowser).flush();
1.77 +
1.78 + restoredTabState = JSON.parse(ss.getTabState(tab));
1.79 + is(restoredTabState.entries.length, maxEntries,
1.80 + "The expected number of session history entries was restored.");
1.81 + is(restoredTabState.index, middleEntry + 1, "The restored tab-state index is correct");
1.82 +
1.83 + for (let i = middleEntry - 2; i <= middleEntry + 2; i++) {
1.84 + is(restoredTabState.entries[i].url, baseURL + i,
1.85 + "URL of restored entry matches the expected URL.");
1.86 + }
1.87 +
1.88 + info("Testing situation where only the 1 + maxFwd2 oldest entries should be restored.");
1.89 +
1.90 + // Set the one-based tab-state index to the oldest session history entry.
1.91 + tabState.index = 1;
1.92 +
1.93 + ss.setTabState(tab, JSON.stringify(tabState));
1.94 + yield promiseTabRestored(tab);
1.95 + SyncHandlers.get(tab.linkedBrowser).flush();
1.96 +
1.97 + restoredTabState = JSON.parse(ss.getTabState(tab));
1.98 + is(restoredTabState.entries.length, 1 + maxFwd2,
1.99 + "The expected number of session history entries was restored.");
1.100 + is(restoredTabState.index, 1, "The restored tab-state index is correct");
1.101 +
1.102 + for (let i = 0; i <= 2; i++) {
1.103 + is(restoredTabState.entries[i].url, baseURL + i,
1.104 + "URL of restored entry matches the expected URL.");
1.105 + }
1.106 +
1.107 + info("Testing situation where only the maxBack2 + 1 newest entries should be restored.");
1.108 +
1.109 + // Set the one-based tab-state index to the newest session history entry.
1.110 + tabState.index = maxEntries;
1.111 +
1.112 + ss.setTabState(tab, JSON.stringify(tabState));
1.113 + yield promiseTabRestored(tab);
1.114 + SyncHandlers.get(tab.linkedBrowser).flush();
1.115 +
1.116 + restoredTabState = JSON.parse(ss.getTabState(tab));
1.117 + is(restoredTabState.entries.length, maxBack2 + 1,
1.118 + "The expected number of session history entries was restored.");
1.119 + is(restoredTabState.index, maxBack2 + 1, "The restored tab-state index is correct");
1.120 +
1.121 + indexURLOffset = (maxEntries - 1) - maxBack2;
1.122 + for (let i = maxBack2 - 2; i <= maxBack2; i++) {
1.123 + is(restoredTabState.entries[i].url, baseURL + (i + indexURLOffset),
1.124 + "URL of restored entry matches the expected URL.");
1.125 + }
1.126 +
1.127 + gBrowser.removeTab(tab);
1.128 +});
