summaryrefslogtreecommitdiffstats
path: root/browser/base/content/test/tabs/helper_origin_attrs_testing.js
blob: 5c7938bacabc917d65fa3056251f6e03f4937d57 (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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const NUM_USER_CONTEXTS = 3;

var xulFrameLoaderCreatedListenerInfo;

function initXulFrameLoaderListenerInfo() {
  xulFrameLoaderCreatedListenerInfo = {};
  xulFrameLoaderCreatedListenerInfo.numCalledSoFar = 0;
}

function handleEvent(aEvent) {
  if (aEvent.type != "XULFrameLoaderCreated") {
    return;
  }
  // Ignore <browser> element in about:preferences and any other special pages
  if ("gBrowser" in aEvent.target.ownerGlobal) {
    xulFrameLoaderCreatedListenerInfo.numCalledSoFar++;
  }
}

async function openURIInRegularTab(uri, win = window) {
  info(`Opening url ${uri} in a regular tab`);

  initXulFrameLoaderListenerInfo();
  win.gBrowser.addEventListener("XULFrameLoaderCreated", handleEvent);

  let tab = await BrowserTestUtils.openNewForegroundTab(win.gBrowser, uri);
  info(
    `XULFrameLoaderCreated was fired ${xulFrameLoaderCreatedListenerInfo.numCalledSoFar} time(s) for ${uri} in regular tab`
  );

  is(
    xulFrameLoaderCreatedListenerInfo.numCalledSoFar,
    1,
    "XULFrameLoaderCreated fired correct number of times"
  );

  win.gBrowser.removeEventListener("XULFrameLoaderCreated", handleEvent);
  return { tab, uri };
}

async function openURIInContainer(uri, win, userContextId) {
  info(`Opening url ${uri} in user context ${userContextId}`);
  initXulFrameLoaderListenerInfo();
  win.gBrowser.addEventListener("XULFrameLoaderCreated", handleEvent);

  let tab = BrowserTestUtils.addTab(win.gBrowser, uri, {
    userContextId,
  });
  is(
    tab.getAttribute("usercontextid"),
    userContextId.toString(),
    "New tab has correct user context id"
  );

  let browser = tab.linkedBrowser;

  await BrowserTestUtils.browserLoaded(browser, false, uri);
  info(
    `XULFrameLoaderCreated was fired ${xulFrameLoaderCreatedListenerInfo.numCalledSoFar}
     time(s) for ${uri} in container tab ${userContextId}`
  );

  is(
    xulFrameLoaderCreatedListenerInfo.numCalledSoFar,
    1,
    "XULFrameLoaderCreated fired correct number of times"
  );

  win.gBrowser.removeEventListener("XULFrameLoaderCreated", handleEvent);

  return { tab, user_context_id: userContextId, uri };
}

async function openURIInPrivateTab(uri) {
  info(
    `Opening url ${
      uri ? uri : "about:privatebrowsing"
    } in a private browsing tab`
  );
  let win = await BrowserTestUtils.openNewBrowserWindow({
    private: true,
    waitForTabURL: "about:privatebrowsing",
  });
  if (!uri) {
    return { tab: win.gBrowser.selectedTab, uri: "about:privatebrowsing" };
  }
  initXulFrameLoaderListenerInfo();
  win.gBrowser.addEventListener("XULFrameLoaderCreated", handleEvent);

  const browser = win.gBrowser.selectedTab.linkedBrowser;
  let prevRemoteType = browser.remoteType;
  let loaded = BrowserTestUtils.browserLoaded(browser, false, uri);
  BrowserTestUtils.loadURIString(browser, uri);
  await loaded;
  let currRemoteType = browser.remoteType;

  info(
    `XULFrameLoaderCreated was fired ${xulFrameLoaderCreatedListenerInfo.numCalledSoFar} time(s) for ${uri} in private tab`
  );

  if (
    SpecialPowers.Services.appinfo.sessionHistoryInParent &&
    currRemoteType == prevRemoteType &&
    uri == "about:blank"
  ) {
    // about:blank page gets flagged for being eligible to go into bfcache
    // and thus we create a new XULFrameLoader for these pages
    is(
      xulFrameLoaderCreatedListenerInfo.numCalledSoFar,
      1,
      "XULFrameLoaderCreated fired correct number of times"
    );
  } else {
    is(
      xulFrameLoaderCreatedListenerInfo.numCalledSoFar,
      currRemoteType == prevRemoteType ? 0 : 1,
      "XULFrameLoaderCreated fired correct number of times"
    );
  }

  win.gBrowser.removeEventListener("XULFrameLoaderCreated", handleEvent);
  return { tab: win.gBrowser.selectedTab, uri };
}

function initXulFrameLoaderCreatedCounter(aXulFrameLoaderCreatedListenerInfo) {
  aXulFrameLoaderCreatedListenerInfo.numCalledSoFar = 0;
}

// Expected remote types for the following tests:
// browser/base/content/test/tabs/browser_navigate_through_urls_origin_attributes.js
// browser/base/content/test/tabs/browser_origin_attrs_in_remote_type.js
function getExpectedRemoteTypes(gFissionBrowser, numPagesOpen) {
  var remoteTypes;
  if (gFissionBrowser) {
    remoteTypes = [
      "webIsolated=https://example.com",
      "webIsolated=https://example.com^userContextId=1",
      "webIsolated=https://example.com^userContextId=2",
      "webIsolated=https://example.com^userContextId=3",
      "webIsolated=https://example.com^privateBrowsingId=1",
      "webIsolated=https://example.org",
      "webIsolated=https://example.org^userContextId=1",
      "webIsolated=https://example.org^userContextId=2",
      "webIsolated=https://example.org^userContextId=3",
      "webIsolated=https://example.org^privateBrowsingId=1",
    ];
  } else {
    remoteTypes = Array(numPagesOpen * 2).fill("web"); // example.com and example.org
  }
  remoteTypes = remoteTypes.concat(Array(numPagesOpen * 2).fill(null)); // about: pages
  return remoteTypes;
}