1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 0.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/0.0/.
import os
import sys
# add this directory to the path
sys.path.append(os.path.dirname(__file__))
from session_store_test_case import SessionStoreTestCase
def inline(title):
return f"data:text/html;charset=utf-8,<html><head><title>{title}</title></head><body></body></html>"
class TestSessionRestore(SessionStoreTestCase):
"""
Test that the sidebar and its attributes are restored on reopening of window.
"""
def setUp(self):
super(TestSessionRestore, self).setUp(
startup_page=1,
include_private=False,
restore_on_demand=True,
test_windows=set(
[
(
inline("lorem ipsom"),
inline("dolor"),
),
]
),
)
def test_restore_sidebar_open(self):
self.assertEqual(
len(self.marionette.chrome_window_handles),
1,
msg="Should have 1 window open.",
)
self.marionette.execute_async_script(
"""
const resolve = arguments[0];
let window = BrowserWindowTracker.getTopWindow()
window.SidebarController.show("viewHistorySidebar").then(() => {
let sidebarBox = window.document.getElementById("sidebar-box")
sidebarBox.style.width = "100px";
}).then(resolve);
"""
)
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow()
return !window.document.getElementById("sidebar-box").hidden;
"""
),
True,
"Sidebar is open before window is closed.",
)
self.marionette.restart()
self.marionette.set_context("chrome")
self.assertEqual(
len(self.marionette.chrome_window_handles),
1,
msg="Windows from last session have been restored.",
)
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow()
return !window.document.getElementById("sidebar-box").hidden;
"""
),
True,
"Sidebar has been restored.",
)
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow()
return window.document.getElementById("sidebar-box").style.width;
"""
),
"100px",
"Sidebar width been restored.",
)
self.assertEqual(
self.marionette.execute_script(
"""
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
SessionStore: "resource:///modules/sessionstore/SessionStore.sys.mjs",
});
let state = SessionStore.getCurrentState();
return state.windows[0].sidebar.command;
"""
),
"viewHistorySidebar",
"Correct sidebar category has been restored.",
)
def test_restore_sidebar_closed(self):
self.marionette.execute_async_script(
"""
const resolve = arguments[0];
let window = BrowserWindowTracker.getTopWindow()
window.SidebarController.show("viewHistorySidebar").then(() => {
let sidebarBox = window.document.getElementById("sidebar-box")
sidebarBox.style.width = "100px";
window.SidebarController.toggle();
}).then(resolve);
"""
)
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow()
return window.document.getElementById("sidebar-box").hidden;
"""
),
True,
"Sidebar is hidden before window is closed.",
)
self.marionette.restart()
self.marionette.set_context("chrome")
self.assertEqual(
len(self.marionette.chrome_window_handles),
1,
msg="Windows from last session have been restored.",
)
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow()
return window.document.getElementById("sidebar-box").hidden;
"""
),
True,
"Sidebar is hidden on session restore.",
)
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow()
return window.document.getElementById("sidebar-box").style.width;
"""
),
"100px",
"Sidebar width has been restored.",
)
def test_restore_for_always_show(self):
self.marionette.execute_script(
"""
Services.prefs.setBoolPref("sidebar.revamp", true);
// Always show is only available with vertical tabs
Services.prefs.setBoolPref("sidebar.verticalTabs", true);
Services.prefs.setBoolPref("sidebar.animation.enabled", false);
Services.prefs.setStringPref("sidebar.visibility", "always-show");
"""
)
self.marionette.restart()
self.marionette.set_context("chrome")
self.assertEqual(
len(self.marionette.chrome_window_handles),
1,
msg="Should have 1 window open.",
)
self.assertTrue(
self.marionette.execute_script(
"""
const window = BrowserWindowTracker.getTopWindow();
return window.SidebarController.sidebarMain.expanded;
"""
),
"Sidebar is expanded before window is closed.",
)
self.marionette.restart()
self.marionette.execute_async_script(
"""
let resolve = arguments[0];
let { BrowserInitState } = ChromeUtils.importESModule("resource:///modules/BrowserGlue.sys.mjs");
BrowserInitState.startupIdleTaskPromise.then(resolve);
"""
)
self.assertTrue(
self.marionette.execute_script(
"""
const window = BrowserWindowTracker.getTopWindow();
return window.SidebarController.sidebarMain.expanded;
"""
),
"Sidebar expanded state has been restored.",
)
def test_restore_for_hide_sidebar(self):
self.marionette.execute_script(
"""
Services.prefs.setBoolPref("sidebar.revamp", true);
Services.prefs.setStringPref("sidebar.visibility", "hide-sidebar");
"""
)
self.marionette.restart()
self.marionette.set_context("chrome")
self.assertEqual(
len(self.marionette.chrome_window_handles),
1,
msg="Should have 1 window open.",
)
self.assertFalse(
self.marionette.execute_script(
"""
const window = BrowserWindowTracker.getTopWindow();
return window.SidebarController.sidebarContainer.hidden;
"""
),
"Sidebar is visible before window is closed.",
)
self.marionette.restart()
self.assertFalse(
self.marionette.execute_script(
"""
const window = BrowserWindowTracker.getTopWindow();
return window.SidebarController.sidebarContainer.hidden;
"""
),
"Sidebar visibility state has been restored.",
)
def test_restore_sidebar_open_from_backup_pref(self):
self.marionette.execute_script(
"""
Services.prefs.setBoolPref("sidebar.revamp", true);
Services.prefs.setBoolPref("browser.privatebrowsing.autostart", true);
"""
)
self.marionette.restart()
self.marionette.set_context("chrome")
# Open the history panel.
self.marionette.execute_async_script(
"""
let resolve = arguments[0];
let window = BrowserWindowTracker.getTopWindow();
window.SidebarController.show("viewHistorySidebar").then(resolve);
"""
)
# Restart the browser.
self.marionette.restart()
self.marionette.execute_async_script(
"""
let resolve = arguments[0];
let { BrowserInitState } = ChromeUtils.importESModule("resource:///modules/BrowserGlue.sys.mjs");
BrowserInitState.startupIdleTaskPromise.then(resolve);
"""
)
# Check to see if the history panel was restored.
self.assertEqual(
self.marionette.execute_script(
"""
let window = BrowserWindowTracker.getTopWindow();
return window.SidebarController.currentID;
"""
),
"viewHistorySidebar",
"Correct sidebar category has been restored.",
)
def test_upgrade_profile_and_restore_sidebar_from_backup_pref(self):
# Bug 1963549 - Sidebar bookmarks no longer open automatically since the last update.
self.marionette.execute_script(
"""
Services.prefs.setIntPref("browser.migration.version", 154);
Services.xulStore.setValue(
AppConstants.BROWSER_CHROME_URL,
"sidebar-box",
"checked",
"true"
);
"""
)
self.test_restore_sidebar_open_from_backup_pref()
|
