summaryrefslogtreecommitdiffstats
path: root/remote/shared/messagehandler/test/browser/browser_session_data_update_contexts.js
blob: 711df1fc56b8e57a5347d3981354a0e9a3be11c9 (plain)
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
/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

const TEST_PAGE = "https://example.com/document-builder.sjs?html=tab";

const { assertUpdate, createSessionDataUpdate, getUpdates } =
  SessionDataUpdateHelpers;

// Test session data update scenarios involving 2 browsing contexts, and using
// the TopBrowsingContext ContextDescriptor type.
add_task(async function test_session_data_update_contexts() {
  const tab1 = gBrowser.selectedTab;
  await loadURL(tab1.linkedBrowser, TEST_PAGE);
  const browsingContext1 = tab1.linkedBrowser.browsingContext;

  const root = createRootMessageHandler("session-data-update-contexts");

  info("Add several items over 2 separate updates for all contexts");
  await root.updateSessionData([
    createSessionDataUpdate(["text-1"], "add", "category1"),
  ]);
  await root.updateSessionData([
    createSessionDataUpdate(["text-2"], "add", "category1"),
    createSessionDataUpdate(["text-3"], "add", "category1"),
  ]);

  info("Check we processed two distinct updates in browsingContext 1");
  let processedUpdates = await getUpdates(root, browsingContext1);
  is(processedUpdates.length, 2);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-1", "text-2", "text-3"],
    "category1"
  );

  info("Open a new tab on the same test URL");
  const tab2 = await addTab(TEST_PAGE);
  const browsingContext2 = tab2.linkedBrowser.browsingContext;

  processedUpdates = await getUpdates(root, browsingContext2);
  is(processedUpdates.length, 1);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-1", "text-2", "text-3"],
    "category1"
  );

  info("Add two items: one globally and one in a single context");
  await root.updateSessionData([
    createSessionDataUpdate(["text-4"], "add", "category1"),
    createSessionDataUpdate(["text-5"], "add", "category1", {
      type: ContextDescriptorType.TopBrowsingContext,
      id: browsingContext2.browserId,
    }),
  ]);

  processedUpdates = await getUpdates(root, browsingContext1);
  is(processedUpdates.length, 3);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-1", "text-2", "text-3", "text-4"],
    "category1"
  );

  processedUpdates = await getUpdates(root, browsingContext2);
  is(processedUpdates.length, 2);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-1", "text-2", "text-3", "text-4", "text-5"],
    "category1"
  );

  info("Remove two items: one globally and one in a single context");
  await root.updateSessionData([
    createSessionDataUpdate(["text-1"], "remove", "category1"),
    createSessionDataUpdate(["text-5"], "remove", "category1", {
      type: ContextDescriptorType.TopBrowsingContext,
      id: browsingContext2.browserId,
    }),
  ]);

  processedUpdates = await getUpdates(root, browsingContext1);
  is(processedUpdates.length, 4);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4"],
    "category1"
  );

  processedUpdates = await getUpdates(root, browsingContext2);
  is(processedUpdates.length, 3);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4"],
    "category1"
  );

  info(
    "Add session data item to all contexts and remove this event for one context (2 steps)"
  );

  info("First step: add an item to browsingContext1");
  await root.updateSessionData([
    createSessionDataUpdate(["text-6"], "add", "category1", {
      type: ContextDescriptorType.TopBrowsingContext,
      id: browsingContext1.browserId,
    }),
  ]);

  info(
    "Second step: remove the item from browsingContext1, and add it globally"
  );
  await root.updateSessionData([
    createSessionDataUpdate(["text-6"], "remove", "category1", {
      type: ContextDescriptorType.TopBrowsingContext,
      id: browsingContext1.browserId,
    }),
    createSessionDataUpdate(["text-6"], "add", "category1"),
  ]);

  processedUpdates = await getUpdates(root, browsingContext1);
  is(processedUpdates.length, 6);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4", "text-6"],
    "category1"
  );

  processedUpdates = await getUpdates(root, browsingContext2);
  is(processedUpdates.length, 4);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4", "text-6"],
    "category1"
  );

  info(
    "Remove the event, which has also an individual subscription, for all contexts (2 steps)"
  );

  info("First step: Add the same item for browsingContext1 and globally");
  await root.updateSessionData([
    createSessionDataUpdate(["text-7"], "add", "category1", {
      type: ContextDescriptorType.TopBrowsingContext,
      id: browsingContext1.browserId,
    }),
    createSessionDataUpdate(["text-7"], "add", "category1"),
  ]);
  processedUpdates = await getUpdates(root, browsingContext1);
  is(processedUpdates.length, 7);
  // We will find text-7 twice here, the module is responsible for not applying
  // the same session data item twice. Each item corresponds to a different
  // descriptor which matched browsingContext1.
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4", "text-6", "text-7", "text-7"],
    "category1"
  );

  processedUpdates = await getUpdates(root, browsingContext2);
  is(processedUpdates.length, 5);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4", "text-6", "text-7"],
    "category1"
  );

  info("Second step: Remove the item globally");
  await root.updateSessionData([
    createSessionDataUpdate(["text-7"], "remove", "category1"),
  ]);

  processedUpdates = await getUpdates(root, browsingContext1);
  is(processedUpdates.length, 8);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4", "text-6", "text-7"],
    "category1"
  );

  processedUpdates = await getUpdates(root, browsingContext2);
  is(processedUpdates.length, 6);
  assertUpdate(
    processedUpdates.at(-1),
    ["text-2", "text-3", "text-4", "text-6"],
    "category1"
  );

  root.destroy();

  gBrowser.removeTab(tab2);
});