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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { MessageHandlerRegistry } = ChromeUtils.importESModule(
"chrome://remote/content/shared/messagehandler/MessageHandlerRegistry.sys.mjs"
);
const { RootMessageHandler } = ChromeUtils.importESModule(
"chrome://remote/content/shared/messagehandler/RootMessageHandler.sys.mjs"
);
const { SessionData } = ChromeUtils.importESModule(
"chrome://remote/content/shared/messagehandler/sessiondata/SessionData.sys.mjs"
);
const TEST_PAGE = "http://example.com/document-builder.sjs?html=tab";
add_task(async function test_sessionData() {
info("Navigate the initial tab to the test URL");
const tab1 = gBrowser.selectedTab;
await loadURL(tab1.linkedBrowser, TEST_PAGE);
const sessionId = "sessionData-test";
const rootMessageHandlerRegistry = new MessageHandlerRegistry(
RootMessageHandler.type
);
const rootMessageHandler = rootMessageHandlerRegistry.getOrCreateMessageHandler(
sessionId
);
ok(rootMessageHandler, "Valid ROOT MessageHandler created");
const sessionData = rootMessageHandler.sessionData;
ok(
sessionData instanceof SessionData,
"ROOT MessageHandler has a valid sessionData"
);
let sessionDataSnapshot = await getSessionDataFromContent();
is(sessionDataSnapshot.size, 0, "session data is empty");
info("Store a string value in session data");
sessionData.updateSessionData([
{
method: "add",
moduleName: "fakemodule",
category: "testCategory",
contextDescriptor: contextDescriptorAll,
values: ["value-1"],
},
]);
sessionDataSnapshot = await getSessionDataFromContent();
is(sessionDataSnapshot.size, 1, "session data contains 1 session");
ok(sessionDataSnapshot.has(sessionId));
let snapshot = sessionDataSnapshot.get(sessionId);
ok(Array.isArray(snapshot));
is(snapshot.length, 1);
const stringDataItem = snapshot[0];
checkSessionDataItem(
stringDataItem,
"fakemodule",
"testCategory",
ContextDescriptorType.All,
"value-1"
);
info("Store a number value in session data");
sessionData.updateSessionData([
{
method: "add",
moduleName: "fakemodule",
category: "testCategory",
contextDescriptor: contextDescriptorAll,
values: [12],
},
]);
snapshot = (await getSessionDataFromContent()).get(sessionId);
is(snapshot.length, 2);
const numberDataItem = snapshot[1];
checkSessionDataItem(
numberDataItem,
"fakemodule",
"testCategory",
ContextDescriptorType.All,
12
);
info("Store a boolean value in session data");
sessionData.updateSessionData([
{
method: "add",
moduleName: "fakemodule",
category: "testCategory",
contextDescriptor: contextDescriptorAll,
values: [true],
},
]);
snapshot = (await getSessionDataFromContent()).get(sessionId);
is(snapshot.length, 3);
const boolDataItem = snapshot[2];
checkSessionDataItem(
boolDataItem,
"fakemodule",
"testCategory",
ContextDescriptorType.All,
true
);
info("Remove one value");
sessionData.updateSessionData([
{
method: "remove",
moduleName: "fakemodule",
category: "testCategory",
contextDescriptor: contextDescriptorAll,
values: [12],
},
]);
snapshot = (await getSessionDataFromContent()).get(sessionId);
is(snapshot.length, 2);
checkSessionDataItem(
snapshot[0],
"fakemodule",
"testCategory",
ContextDescriptorType.All,
"value-1"
);
checkSessionDataItem(
snapshot[1],
"fakemodule",
"testCategory",
ContextDescriptorType.All,
true
);
info("Remove all values");
sessionData.updateSessionData([
{
method: "remove",
moduleName: "fakemodule",
category: "testCategory",
contextDescriptor: contextDescriptorAll,
values: ["value-1", true],
},
]);
snapshot = (await getSessionDataFromContent()).get(sessionId);
is(snapshot.length, 0, "Session data is now empty");
info("Add another value before destroy");
sessionData.updateSessionData([
{
method: "add",
moduleName: "fakemodule",
category: "testCategory",
contextDescriptor: contextDescriptorAll,
values: ["value-2"],
},
]);
snapshot = (await getSessionDataFromContent()).get(sessionId);
is(snapshot.length, 1);
checkSessionDataItem(
snapshot[0],
"fakemodule",
"testCategory",
ContextDescriptorType.All,
"value-2"
);
sessionData.destroy();
sessionDataSnapshot = await getSessionDataFromContent();
is(sessionDataSnapshot.size, 0, "session data should be empty again");
});
add_task(async function test_sessionDataRootOnlyModule() {
const sessionId = "sessionData-test-rootOnly";
const rootMessageHandler = createRootMessageHandler(sessionId);
ok(rootMessageHandler, "Valid ROOT MessageHandler created");
await BrowserTestUtils.loadURI(
gBrowser,
"https://example.com/document-builder.sjs?html=tab"
);
const windowGlobalCreated = rootMessageHandler.once("message-handler-event");
info("Test that adding SessionData items works the root module");
// Updating the session data on the root message handler should not cause
// failures for other message handlers if the module only exists for root.
await rootMessageHandler.addSessionData({
moduleName: "rootOnly",
category: "session_data_root_only",
contextDescriptor: {
type: ContextDescriptorType.All,
},
values: [true],
});
await windowGlobalCreated;
ok(true, "Window global has been initialized");
let sessionDataReceivedByRoot = await rootMessageHandler.handleCommand({
moduleName: "rootOnly",
commandName: "getSessionDataReceived",
destination: {
type: RootMessageHandler.type,
},
});
is(sessionDataReceivedByRoot.length, 1);
is(sessionDataReceivedByRoot[0].category, "session_data_root_only");
is(sessionDataReceivedByRoot[0].added.length, 1);
is(sessionDataReceivedByRoot[0].added[0], true);
is(
sessionDataReceivedByRoot[0].contextDescriptor.type,
ContextDescriptorType.All
);
info("Now test that removing items also works on the root module");
await rootMessageHandler.removeSessionData({
moduleName: "rootOnly",
category: "session_data_root_only",
contextDescriptor: {
type: ContextDescriptorType.All,
},
values: [true],
});
sessionDataReceivedByRoot = await rootMessageHandler.handleCommand({
moduleName: "rootOnly",
commandName: "getSessionDataReceived",
destination: {
type: RootMessageHandler.type,
},
});
is(sessionDataReceivedByRoot.length, 2);
is(sessionDataReceivedByRoot[1].category, "session_data_root_only");
is(sessionDataReceivedByRoot[1].removed.length, 1);
is(sessionDataReceivedByRoot[1].removed[0], true);
is(
sessionDataReceivedByRoot[1].contextDescriptor.type,
ContextDescriptorType.All
);
rootMessageHandler.destroy();
});
function checkSessionDataItem(item, moduleName, category, contextType, value) {
is(item.moduleName, moduleName, "Data item has the expected module name");
is(item.category, category, "Data item has the expected category");
is(
item.contextDescriptor.type,
contextType,
"Data item has the expected context type"
);
is(item.value, value, "Data item has the expected value");
}
function getSessionDataFromContent() {
return SpecialPowers.spawn(gBrowser.selectedBrowser, [], () => {
const { readSessionData } = ChromeUtils.importESModule(
"chrome://remote/content/shared/messagehandler/sessiondata/SessionDataReader.sys.mjs"
);
return readSessionData();
});
}
|
