browser/components/sessionstore/test/browser_history_cap.js

changeset 0
6474c204b198
equal deleted inserted replaced
-1:000000000000 0:5fc0b46a63fd
1 /* Any copyright is dedicated to the Public Domain.
2 * http://creativecommons.org/publicdomain/zero/1.0/ */
3
4 "use strict";
5
6 /**
7 * This test ensures that the preferences (added in bug 943339) that control how
8 * many back and forward button session history entries we store work correctly.
9 *
10 * It adds a number of entries to the session history, restores them and checks
11 * that the restored state matches the preferences.
12 */
13
14 add_task(function *test_history_cap() {
15 const baseURL = "http://example.com/browser_history_cap#"
16 const maxEntries = 9; // The number of generated session history entries.
17 const middleEntry = 4; // The zero-based index of the middle entry.
18
19 const maxBack1 = 2; // The history cap settings used for the first test,
20 const maxFwd1 = 3; // where maxBack1 + 1 + maxFwd1 < maxEntries.
21
22 const maxBack2 = 5; // The history cap settings used for the other tests,
23 const maxFwd2 = 5; // where maxBack2 + 1 + maxFwd2 > maxEntries.
24
25 // Set the relevant preferences for the first test.
26 gPrefService.setIntPref("browser.sessionhistory.max_entries", maxEntries);
27 gPrefService.setIntPref("browser.sessionstore.max_serialize_back", maxBack1);
28 gPrefService.setIntPref("browser.sessionstore.max_serialize_forward", maxFwd1);
29
30 // Make sure the settings we modify are reset afterward.
31 registerCleanupFunction(() => {
32 gPrefService.clearUserPref("browser.sessionhistory.max_entries");
33 gPrefService.clearUserPref("browser.sessionstore.max_serialize_back");
34 gPrefService.clearUserPref("browser.sessionstore.max_serialize_forward");
35 });
36
37 let tab = gBrowser.addTab();
38 let browser = tab.linkedBrowser;
39 yield promiseBrowserLoaded(browser);
40
41 // Generate the tab state entries and set the one-based
42 // tab-state index to the middle session history entry.
43 let tabState = {entries: [], index: middleEntry + 1};
44 for (let i = 0; i < maxEntries; i++) {
45 tabState.entries.push({url: baseURL + i});
46 }
47
48 info("Testing situation where only a subset of session history entries should be restored.");
49
50 ss.setTabState(tab, JSON.stringify(tabState));
51 yield promiseTabRestored(tab);
52 SyncHandlers.get(tab.linkedBrowser).flush();
53
54 let restoredTabState = JSON.parse(ss.getTabState(tab));
55 is(restoredTabState.entries.length, maxBack1 + 1 + maxFwd1,
56 "The expected number of session history entries was restored.");
57 is(restoredTabState.index, maxBack1 + 1, "The restored tab-state index is correct");
58
59 let indexURLOffset = middleEntry - (restoredTabState.index - 1);
60 for (let i = 0; i < restoredTabState.entries.length; i++) {
61 is(restoredTabState.entries[i].url, baseURL + (i + indexURLOffset),
62 "URL of restored entry matches the expected URL.");
63 }
64
65 // Set the relevant preferences for the other tests.
66 gPrefService.setIntPref("browser.sessionstore.max_serialize_back", maxBack2);
67 gPrefService.setIntPref("browser.sessionstore.max_serialize_forward", maxFwd2);
68
69 info("Testing situation where all of the entries in the session history should be restored.");
70
71 ss.setTabState(tab, JSON.stringify(tabState));
72 yield promiseTabRestored(tab);
73 SyncHandlers.get(tab.linkedBrowser).flush();
74
75 restoredTabState = JSON.parse(ss.getTabState(tab));
76 is(restoredTabState.entries.length, maxEntries,
77 "The expected number of session history entries was restored.");
78 is(restoredTabState.index, middleEntry + 1, "The restored tab-state index is correct");
79
80 for (let i = middleEntry - 2; i <= middleEntry + 2; i++) {
81 is(restoredTabState.entries[i].url, baseURL + i,
82 "URL of restored entry matches the expected URL.");
83 }
84
85 info("Testing situation where only the 1 + maxFwd2 oldest entries should be restored.");
86
87 // Set the one-based tab-state index to the oldest session history entry.
88 tabState.index = 1;
89
90 ss.setTabState(tab, JSON.stringify(tabState));
91 yield promiseTabRestored(tab);
92 SyncHandlers.get(tab.linkedBrowser).flush();
93
94 restoredTabState = JSON.parse(ss.getTabState(tab));
95 is(restoredTabState.entries.length, 1 + maxFwd2,
96 "The expected number of session history entries was restored.");
97 is(restoredTabState.index, 1, "The restored tab-state index is correct");
98
99 for (let i = 0; i <= 2; i++) {
100 is(restoredTabState.entries[i].url, baseURL + i,
101 "URL of restored entry matches the expected URL.");
102 }
103
104 info("Testing situation where only the maxBack2 + 1 newest entries should be restored.");
105
106 // Set the one-based tab-state index to the newest session history entry.
107 tabState.index = maxEntries;
108
109 ss.setTabState(tab, JSON.stringify(tabState));
110 yield promiseTabRestored(tab);
111 SyncHandlers.get(tab.linkedBrowser).flush();
112
113 restoredTabState = JSON.parse(ss.getTabState(tab));
114 is(restoredTabState.entries.length, maxBack2 + 1,
115 "The expected number of session history entries was restored.");
116 is(restoredTabState.index, maxBack2 + 1, "The restored tab-state index is correct");
117
118 indexURLOffset = (maxEntries - 1) - maxBack2;
119 for (let i = maxBack2 - 2; i <= maxBack2; i++) {
120 is(restoredTabState.entries[i].url, baseURL + (i + indexURLOffset),
121 "URL of restored entry matches the expected URL.");
122 }
123
124 gBrowser.removeTab(tab);
125 });

mercurial