summaryrefslogtreecommitdiffstats
path: root/dom/serviceworkers/test/test_streamfilter.html
blob: 7367fb8b84e4667e0009c4336e090a9574b15b4f (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
195
196
197
198
199
200
201
202
203
204
205
206
207
<!DOCTYPE HTML>
<html>
<head>
  <meta charset="utf-8">
  <title>
    Test StreamFilter-monitored responses for ServiceWorker-intercepted requests
  </title>
  <script src="/tests/SimpleTest/SimpleTest.js"></script>
  <script src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <link rel="stylesheet" href="/tests/SimpleTest/test.css"/>
</head>
<body>
<script>
// eslint-disable-next-line mozilla/no-addtask-setup
add_task(async function setup() {
  SimpleTest.waitForExplicitFinish();

  await SpecialPowers.pushPrefEnv({
    set: [
      ["dom.serviceWorkers.exemptFromPerDomainMax", true],
      ["dom.serviceWorkers.enabled", true],
      ["dom.serviceWorkers.testing.enabled", true],
    ],
  });

  const registration = await navigator.serviceWorker.register(
    "streamfilter_worker.js"
  );

  SimpleTest.registerCleanupFunction(async function unregisterRegistration() {
    await registration.unregister();
  });

  await new Promise(resolve => {
    const serviceWorker = registration.installing;

    serviceWorker.onstatechange = () => {
      if (serviceWorker.state == "activated") {
        resolve();
      }
    };
  });

  ok(navigator.serviceWorker.controller, "Page is controlled");
});

async function getExtension() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      permissions: ["webRequest", "webRequestBlocking", "<all_urls>"],
    },

    // This WebExtension only proxies a response's data through a StreamFilter;
    // it doesn't modify the data itself in any way.
    background() {
      class FilterWrapper {
        constructor(requestId) {
          const filter = browser.webRequest.filterResponseData(requestId);
          const arrayBuffers = [];

          filter.onstart = () => {
            browser.test.sendMessage("start");
          };

          filter.ondata = ({ data }) => {
            arrayBuffers.push(data);
          };

          filter.onstop = () => {
            browser.test.sendMessage("stop");
            new Blob(arrayBuffers).arrayBuffer().then(buffer => {
              filter.write(buffer);
              filter.close();
            });
          };

          filter.onerror = () => {
            // We only ever expect a redirect error here.
            browser.test.assertEq(filter.error, "ServiceWorker fallback redirection");
            browser.test.sendMessage("error");
          };
        }
      }

      browser.webRequest.onBeforeRequest.addListener(
        details => {
          new FilterWrapper(details.requestId);
        },
        {
          urls: ["<all_urls>"],
          types: ["xmlhttprequest"],
        },
        ["blocking"]
      );
    },
  });

  await extension.startup();
  return extension;
}

const streamFilterServerUrl = `${location.origin}/tests/dom/serviceworkers/test/streamfilter_server.sjs`;

const requestUrlForServerQueryString = "syntheticResponse=0";

// streamfilter_server.sjs is expected to respond to a request to this URL.
const requestUrlForServer = `${streamFilterServerUrl}?${requestUrlForServerQueryString}`;

const requestUrlForServiceWorkerQueryString = "syntheticResponse=1";

// streamfilter_worker.js is expected to respond to a request to this URL.
const requestUrlForServiceWorker = `${streamFilterServerUrl}?${requestUrlForServiceWorkerQueryString}`;

// startNetworkerRequestFn must be a function that, when called, starts a
// network request and returns a promise that resolves after the request
// completes (or fails). This function will return the value that that promise
// resolves with (or throw if it rejects).
async function observeFilteredNetworkRequest(startNetworkRequestFn, promises) {
  const networkRequestPromise = startNetworkRequestFn();
  await Promise.all(promises);
  return networkRequestPromise;
}

// Returns a promise that resolves with the XHR's response text.
function callXHR(requestUrl, promises) {
  return observeFilteredNetworkRequest(() => {
    return new Promise((resolve, reject) => {
      const xhr = new XMLHttpRequest();
      xhr.onload = () => {
        resolve(xhr.responseText);
      };
      xhr.onerror = reject;
      xhr.open("GET", requestUrl);
      xhr.send();
    });
  }, promises);
}

// Returns a promise that resolves with the Fetch's response text.
function callFetch(requestUrl, promises) {
  return observeFilteredNetworkRequest(() => {
    return fetch(requestUrl).then(response => response.text());
  }, promises);
}

// The expected response text is always the query string (without the leading
// "?") of the request URL.
add_task(async function callXhrExpectServerResponse() {
  info(`Performing XHR at ${requestUrlForServer}...`);
  let extension = await getExtension();
  is(
    await callXHR(requestUrlForServer, [
      extension.awaitMessage("start"),
      extension.awaitMessage("error"),
      extension.awaitMessage("stop"),
    ]),
    requestUrlForServerQueryString,
    "Server-supplied response for XHR completed successfully"
  );
  await extension.unload();
});

add_task(async function callXhrExpectServiceWorkerResponse() {
  info(`Performing XHR at ${requestUrlForServiceWorker}...`);
  let extension = await getExtension();
  is(
    await callXHR(requestUrlForServiceWorker, [
      extension.awaitMessage("start"),
      extension.awaitMessage("stop"),
    ]),
    requestUrlForServiceWorkerQueryString,
    "ServiceWorker-supplied response for XHR completed successfully"
  );
  await extension.unload();
});

add_task(async function callFetchExpectServerResponse() {
  info(`Performing Fetch at ${requestUrlForServer}...`);
  let extension = await getExtension();
  is(
    await callFetch(requestUrlForServer, [
      extension.awaitMessage("start"),
      extension.awaitMessage("error"),
      extension.awaitMessage("stop"),
    ]),
    requestUrlForServerQueryString,
    "Server-supplied response for Fetch completed successfully"
  );
  await extension.unload();
});

add_task(async function callFetchExpectServiceWorkerResponse() {
  info(`Performing Fetch at ${requestUrlForServiceWorker}...`);
  let extension = await getExtension();
  is(
    await callFetch(requestUrlForServiceWorker, [
      extension.awaitMessage("start"),
      extension.awaitMessage("stop"),
    ]),
    requestUrlForServiceWorkerQueryString,
    "ServiceWorker-supplied response for Fetch completed successfully"
  );
  await extension.unload();
});
</script>
</body>
</html>