api-web-request-spec.ts 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  1. import { expect } from 'chai';
  2. import * as http from 'node:http';
  3. import * as http2 from 'node:http2';
  4. import * as qs from 'node:querystring';
  5. import * as path from 'node:path';
  6. import * as fs from 'node:fs';
  7. import * as url from 'node:url';
  8. import * as WebSocket from 'ws';
  9. import { ipcMain, protocol, session, WebContents, webContents } from 'electron/main';
  10. import { AddressInfo, Socket } from 'node:net';
  11. import { listen, defer } from './lib/spec-helpers';
  12. import { once } from 'node:events';
  13. import { ReadableStream } from 'node:stream/web';
  14. const fixturesPath = path.resolve(__dirname, 'fixtures');
  15. describe('webRequest module', () => {
  16. const ses = session.defaultSession;
  17. const server = http.createServer((req, res) => {
  18. if (req.url === '/serverRedirect') {
  19. res.statusCode = 301;
  20. res.setHeader('Location', 'http://' + req.rawHeaders[1]);
  21. res.end();
  22. } else if (req.url === '/contentDisposition') {
  23. res.writeHead(200, [
  24. 'content-disposition',
  25. Buffer.from('attachment; filename=aa中aa.txt').toString('binary')
  26. ]);
  27. const content = req.url;
  28. res.end(content);
  29. } else {
  30. res.setHeader('Custom', ['Header']);
  31. let content = req.url;
  32. if (req.headers.accept === '*/*;test/header') {
  33. content += 'header/received';
  34. }
  35. if (req.headers.origin === 'http://new-origin') {
  36. content += 'new/origin';
  37. }
  38. res.end(content);
  39. }
  40. });
  41. let defaultURL: string;
  42. let http2URL: string;
  43. const certPath = path.join(fixturesPath, 'certificates');
  44. const h2server = http2.createSecureServer({
  45. key: fs.readFileSync(path.join(certPath, 'server.key')),
  46. cert: fs.readFileSync(path.join(certPath, 'server.pem'))
  47. }, async (req, res) => {
  48. if (req.method === 'POST') {
  49. const chunks = [];
  50. for await (const chunk of req) chunks.push(chunk);
  51. res.end(Buffer.concat(chunks).toString('utf8'));
  52. } else {
  53. res.end('<html></html>');
  54. }
  55. });
  56. before(async () => {
  57. protocol.registerStringProtocol('cors', (req, cb) => cb(''));
  58. defaultURL = (await listen(server)).url + '/';
  59. await new Promise<void>((resolve) => {
  60. h2server.listen(0, '127.0.0.1', () => resolve());
  61. });
  62. http2URL = `https://127.0.0.1:${(h2server.address() as AddressInfo).port}/`;
  63. console.log(http2URL);
  64. });
  65. after(() => {
  66. server.close();
  67. h2server.close();
  68. protocol.unregisterProtocol('cors');
  69. });
  70. let contents: WebContents;
  71. // NB. sandbox: true is used because it makes navigations much (~8x) faster.
  72. before(async () => {
  73. contents = (webContents as typeof ElectronInternal.WebContents).create({ sandbox: true });
  74. // const w = new BrowserWindow({webPreferences: {sandbox: true}})
  75. // contents = w.webContents
  76. await contents.loadFile(path.join(fixturesPath, 'pages', 'fetch.html'));
  77. });
  78. after(() => contents.destroy());
  79. async function ajax (url: string, options = {}) {
  80. return contents.executeJavaScript(`ajax("${url}", ${JSON.stringify(options)})`);
  81. }
  82. describe('webRequest.onBeforeRequest', () => {
  83. afterEach(() => {
  84. ses.webRequest.onBeforeRequest(null);
  85. });
  86. const cancel = (details: Electron.OnBeforeRequestListenerDetails, callback: (response: Electron.CallbackResponse) => void) => {
  87. callback({ cancel: true });
  88. };
  89. it('can cancel the request', async () => {
  90. ses.webRequest.onBeforeRequest(cancel);
  91. await expect(ajax(defaultURL)).to.eventually.be.rejected();
  92. });
  93. it('can filter URLs', async () => {
  94. const filter = { urls: [defaultURL + 'filter/*'] };
  95. ses.webRequest.onBeforeRequest(filter, cancel);
  96. const { data } = await ajax(`${defaultURL}nofilter/test`);
  97. expect(data).to.equal('/nofilter/test');
  98. await expect(ajax(`${defaultURL}filter/test`)).to.eventually.be.rejected();
  99. });
  100. it('can filter URLs and types', async () => {
  101. const filter1: Electron.WebRequestFilter = { urls: [defaultURL + 'filter/*'], types: ['xhr'] };
  102. ses.webRequest.onBeforeRequest(filter1, cancel);
  103. const { data } = await ajax(`${defaultURL}nofilter/test`);
  104. expect(data).to.equal('/nofilter/test');
  105. await expect(ajax(`${defaultURL}filter/test`)).to.eventually.be.rejected();
  106. const filter2: Electron.WebRequestFilter = { urls: [defaultURL + 'filter/*'], types: ['stylesheet'] };
  107. ses.webRequest.onBeforeRequest(filter2, cancel);
  108. expect((await ajax(`${defaultURL}nofilter/test`)).data).to.equal('/nofilter/test');
  109. expect((await ajax(`${defaultURL}filter/test`)).data).to.equal('/filter/test');
  110. });
  111. it('receives details object', async () => {
  112. ses.webRequest.onBeforeRequest((details, callback) => {
  113. expect(details.id).to.be.a('number');
  114. expect(details.timestamp).to.be.a('number');
  115. expect(details.webContentsId).to.be.a('number');
  116. expect(details.webContents).to.be.an('object');
  117. expect(details.webContents!.id).to.equal(details.webContentsId);
  118. expect(details.frame).to.be.an('object');
  119. expect(details.url).to.be.a('string').that.is.equal(defaultURL);
  120. expect(details.method).to.be.a('string').that.is.equal('GET');
  121. expect(details.resourceType).to.be.a('string').that.is.equal('xhr');
  122. expect(details.uploadData).to.be.undefined();
  123. callback({});
  124. });
  125. const { data } = await ajax(defaultURL);
  126. expect(data).to.equal('/');
  127. });
  128. it('receives post data in details object', async () => {
  129. const postData = {
  130. name: 'post test',
  131. type: 'string'
  132. };
  133. ses.webRequest.onBeforeRequest((details, callback) => {
  134. expect(details.url).to.equal(defaultURL);
  135. expect(details.method).to.equal('POST');
  136. expect(details.uploadData).to.have.lengthOf(1);
  137. const data = qs.parse(details.uploadData[0].bytes.toString());
  138. expect(data).to.deep.equal(postData);
  139. callback({ cancel: true });
  140. });
  141. await expect(ajax(defaultURL, {
  142. method: 'POST',
  143. body: qs.stringify(postData)
  144. })).to.eventually.be.rejected();
  145. });
  146. it('can redirect the request', async () => {
  147. ses.webRequest.onBeforeRequest((details, callback) => {
  148. if (details.url === defaultURL) {
  149. callback({ redirectURL: `${defaultURL}redirect` });
  150. } else {
  151. callback({});
  152. }
  153. });
  154. const { data } = await ajax(defaultURL);
  155. expect(data).to.equal('/redirect');
  156. });
  157. it('does not crash for redirects', async () => {
  158. ses.webRequest.onBeforeRequest((details, callback) => {
  159. callback({ cancel: false });
  160. });
  161. await ajax(defaultURL + 'serverRedirect');
  162. await ajax(defaultURL + 'serverRedirect');
  163. });
  164. it('works with file:// protocol', async () => {
  165. ses.webRequest.onBeforeRequest((details, callback) => {
  166. callback({ cancel: true });
  167. });
  168. const fileURL = url.format({
  169. pathname: path.join(fixturesPath, 'blank.html').replace(/\\/g, '/'),
  170. protocol: 'file',
  171. slashes: true
  172. });
  173. await expect(ajax(fileURL)).to.eventually.be.rejected();
  174. });
  175. it('can handle a streaming upload', async () => {
  176. // Streaming fetch uploads are only supported on HTTP/2, which is only
  177. // supported over TLS, so...
  178. session.defaultSession.setCertificateVerifyProc((req, cb) => cb(0));
  179. defer(() => {
  180. session.defaultSession.setCertificateVerifyProc(null);
  181. });
  182. const contents = (webContents as typeof ElectronInternal.WebContents).create({ sandbox: true });
  183. defer(() => contents.close());
  184. await contents.loadURL(http2URL);
  185. ses.webRequest.onBeforeRequest((details, callback) => {
  186. callback({});
  187. });
  188. const result = await contents.executeJavaScript(`
  189. const stream = new ReadableStream({
  190. async start(controller) {
  191. controller.enqueue('hello world');
  192. controller.close();
  193. },
  194. }).pipeThrough(new TextEncoderStream());
  195. fetch("${http2URL}", {
  196. method: 'POST',
  197. body: stream,
  198. duplex: 'half',
  199. }).then(r => r.text())
  200. `);
  201. expect(result).to.equal('hello world');
  202. });
  203. it('can handle a streaming upload if the uploadData is read', async () => {
  204. // Streaming fetch uploads are only supported on HTTP/2, which is only
  205. // supported over TLS, so...
  206. session.defaultSession.setCertificateVerifyProc((req, cb) => cb(0));
  207. defer(() => {
  208. session.defaultSession.setCertificateVerifyProc(null);
  209. });
  210. const contents = (webContents as typeof ElectronInternal.WebContents).create({ sandbox: true });
  211. defer(() => contents.close());
  212. await contents.loadURL(http2URL);
  213. function makeStreamFromPipe (pipe: any): ReadableStream {
  214. const buf = new Uint8Array(1024 * 1024 /* 1 MB */);
  215. return new ReadableStream({
  216. async pull (controller) {
  217. try {
  218. const rv = await pipe.read(buf);
  219. if (rv > 0) {
  220. controller.enqueue(buf.subarray(0, rv));
  221. } else {
  222. controller.close();
  223. }
  224. } catch (e) {
  225. controller.error(e);
  226. }
  227. }
  228. });
  229. }
  230. ses.webRequest.onBeforeRequest(async (details, callback) => {
  231. const chunks = [];
  232. for await (const chunk of makeStreamFromPipe((details.uploadData[0] as any).body)) { chunks.push(chunk); }
  233. callback({});
  234. });
  235. const result = await contents.executeJavaScript(`
  236. const stream = new ReadableStream({
  237. async start(controller) {
  238. controller.enqueue('hello world');
  239. controller.close();
  240. },
  241. }).pipeThrough(new TextEncoderStream());
  242. fetch("${http2URL}", {
  243. method: 'POST',
  244. body: stream,
  245. duplex: 'half',
  246. }).then(r => r.text())
  247. `);
  248. // NOTE: since the upload stream was consumed by the onBeforeRequest
  249. // handler, it can't be used again to upload to the actual server.
  250. // This is a limitation of the WebRequest API.
  251. expect(result).to.equal('');
  252. });
  253. });
  254. describe('webRequest.onBeforeSendHeaders', () => {
  255. afterEach(() => {
  256. ses.webRequest.onBeforeSendHeaders(null);
  257. ses.webRequest.onSendHeaders(null);
  258. });
  259. it('receives details object', async () => {
  260. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  261. expect(details.requestHeaders).to.be.an('object');
  262. expect(details.requestHeaders['Foo.Bar']).to.equal('baz');
  263. callback({});
  264. });
  265. const { data } = await ajax(defaultURL, { headers: { 'Foo.Bar': 'baz' } });
  266. expect(data).to.equal('/');
  267. });
  268. it('can change the request headers', async () => {
  269. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  270. const requestHeaders = details.requestHeaders;
  271. requestHeaders.Accept = '*/*;test/header';
  272. callback({ requestHeaders: requestHeaders });
  273. });
  274. const { data } = await ajax(defaultURL);
  275. expect(data).to.equal('/header/received');
  276. });
  277. it('can change the request headers on a custom protocol redirect', async () => {
  278. protocol.registerStringProtocol('no-cors', (req, callback) => {
  279. if (req.url === 'no-cors://fake-host/redirect') {
  280. callback({
  281. statusCode: 302,
  282. headers: {
  283. Location: 'no-cors://fake-host'
  284. }
  285. });
  286. } else {
  287. let content = '';
  288. if (req.headers.Accept === '*/*;test/header') {
  289. content = 'header-received';
  290. }
  291. callback(content);
  292. }
  293. });
  294. // Note that we need to do navigation every time after a protocol is
  295. // registered or unregistered, otherwise the new protocol won't be
  296. // recognized by current page when NetworkService is used.
  297. await contents.loadFile(path.join(__dirname, 'fixtures', 'pages', 'fetch.html'));
  298. try {
  299. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  300. const requestHeaders = details.requestHeaders;
  301. requestHeaders.Accept = '*/*;test/header';
  302. callback({ requestHeaders: requestHeaders });
  303. });
  304. const { data } = await ajax('no-cors://fake-host/redirect');
  305. expect(data).to.equal('header-received');
  306. } finally {
  307. protocol.unregisterProtocol('no-cors');
  308. }
  309. });
  310. it('can change request origin', async () => {
  311. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  312. const requestHeaders = details.requestHeaders;
  313. requestHeaders.Origin = 'http://new-origin';
  314. callback({ requestHeaders: requestHeaders });
  315. });
  316. const { data } = await ajax(defaultURL);
  317. expect(data).to.equal('/new/origin');
  318. });
  319. it('can capture CORS requests', async () => {
  320. let called = false;
  321. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  322. called = true;
  323. callback({ requestHeaders: details.requestHeaders });
  324. });
  325. await ajax('cors://host');
  326. expect(called).to.be.true();
  327. });
  328. it('resets the whole headers', async () => {
  329. const requestHeaders = {
  330. Test: 'header'
  331. };
  332. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  333. callback({ requestHeaders: requestHeaders });
  334. });
  335. ses.webRequest.onSendHeaders((details) => {
  336. expect(details.requestHeaders).to.deep.equal(requestHeaders);
  337. });
  338. await ajax(defaultURL);
  339. });
  340. it('leaves headers unchanged when no requestHeaders in callback', async () => {
  341. let originalRequestHeaders: Record<string, string>;
  342. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  343. originalRequestHeaders = details.requestHeaders;
  344. callback({});
  345. });
  346. ses.webRequest.onSendHeaders((details) => {
  347. expect(details.requestHeaders).to.deep.equal(originalRequestHeaders);
  348. });
  349. await ajax(defaultURL);
  350. });
  351. it('works with file:// protocol', async () => {
  352. const requestHeaders = {
  353. Test: 'header'
  354. };
  355. let onSendHeadersCalled = false;
  356. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  357. callback({ requestHeaders: requestHeaders });
  358. });
  359. ses.webRequest.onSendHeaders((details) => {
  360. expect(details.requestHeaders).to.deep.equal(requestHeaders);
  361. onSendHeadersCalled = true;
  362. });
  363. await ajax(url.format({
  364. pathname: path.join(fixturesPath, 'blank.html').replace(/\\/g, '/'),
  365. protocol: 'file',
  366. slashes: true
  367. }));
  368. expect(onSendHeadersCalled).to.be.true();
  369. });
  370. });
  371. describe('webRequest.onSendHeaders', () => {
  372. afterEach(() => {
  373. ses.webRequest.onSendHeaders(null);
  374. });
  375. it('receives details object', async () => {
  376. ses.webRequest.onSendHeaders((details) => {
  377. expect(details.requestHeaders).to.be.an('object');
  378. });
  379. const { data } = await ajax(defaultURL);
  380. expect(data).to.equal('/');
  381. });
  382. });
  383. describe('webRequest.onHeadersReceived', () => {
  384. afterEach(() => {
  385. ses.webRequest.onHeadersReceived(null);
  386. });
  387. it('receives details object', async () => {
  388. ses.webRequest.onHeadersReceived((details, callback) => {
  389. expect(details.statusLine).to.equal('HTTP/1.1 200 OK');
  390. expect(details.statusCode).to.equal(200);
  391. expect(details.responseHeaders!.Custom).to.deep.equal(['Header']);
  392. callback({});
  393. });
  394. const { data } = await ajax(defaultURL);
  395. expect(data).to.equal('/');
  396. });
  397. it('can change the response header', async () => {
  398. ses.webRequest.onHeadersReceived((details, callback) => {
  399. const responseHeaders = details.responseHeaders!;
  400. responseHeaders.Custom = ['Changed'] as any;
  401. callback({ responseHeaders: responseHeaders });
  402. });
  403. const { headers } = await ajax(defaultURL);
  404. expect(headers).to.to.have.property('custom', 'Changed');
  405. });
  406. it('can change response origin', async () => {
  407. ses.webRequest.onHeadersReceived((details, callback) => {
  408. const responseHeaders = details.responseHeaders!;
  409. responseHeaders['access-control-allow-origin'] = ['http://new-origin'] as any;
  410. callback({ responseHeaders: responseHeaders });
  411. });
  412. const { headers } = await ajax(defaultURL);
  413. expect(headers).to.to.have.property('access-control-allow-origin', 'http://new-origin');
  414. });
  415. it('can change headers of CORS responses', async () => {
  416. ses.webRequest.onHeadersReceived((details, callback) => {
  417. const responseHeaders = details.responseHeaders!;
  418. responseHeaders.Custom = ['Changed'] as any;
  419. callback({ responseHeaders: responseHeaders });
  420. });
  421. const { headers } = await ajax('cors://host');
  422. expect(headers).to.to.have.property('custom', 'Changed');
  423. });
  424. it('does not change header by default', async () => {
  425. ses.webRequest.onHeadersReceived((details, callback) => {
  426. callback({});
  427. });
  428. const { data, headers } = await ajax(defaultURL);
  429. expect(headers).to.to.have.property('custom', 'Header');
  430. expect(data).to.equal('/');
  431. });
  432. it('does not change content-disposition header by default', async () => {
  433. ses.webRequest.onHeadersReceived((details, callback) => {
  434. expect(details.responseHeaders!['content-disposition']).to.deep.equal([' attachment; filename="aa中aa.txt"']);
  435. callback({});
  436. });
  437. const { data, headers } = await ajax(defaultURL + 'contentDisposition');
  438. const disposition = Buffer.from('attachment; filename=aa中aa.txt').toString('binary');
  439. expect(headers).to.to.have.property('content-disposition', disposition);
  440. expect(data).to.equal('/contentDisposition');
  441. });
  442. it('follows server redirect', async () => {
  443. ses.webRequest.onHeadersReceived((details, callback) => {
  444. const responseHeaders = details.responseHeaders;
  445. callback({ responseHeaders: responseHeaders });
  446. });
  447. const { headers } = await ajax(defaultURL + 'serverRedirect');
  448. expect(headers).to.to.have.property('custom', 'Header');
  449. });
  450. it('can change the header status', async () => {
  451. ses.webRequest.onHeadersReceived((details, callback) => {
  452. const responseHeaders = details.responseHeaders;
  453. callback({
  454. responseHeaders: responseHeaders,
  455. statusLine: 'HTTP/1.1 404 Not Found'
  456. });
  457. });
  458. const { headers } = await ajax(defaultURL);
  459. expect(headers).to.to.have.property('custom', 'Header');
  460. });
  461. });
  462. describe('webRequest.onResponseStarted', () => {
  463. afterEach(() => {
  464. ses.webRequest.onResponseStarted(null);
  465. });
  466. it('receives details object', async () => {
  467. ses.webRequest.onResponseStarted((details) => {
  468. expect(details.fromCache).to.be.a('boolean');
  469. expect(details.statusLine).to.equal('HTTP/1.1 200 OK');
  470. expect(details.statusCode).to.equal(200);
  471. expect(details.responseHeaders!.Custom).to.deep.equal(['Header']);
  472. });
  473. const { data, headers } = await ajax(defaultURL);
  474. expect(headers).to.to.have.property('custom', 'Header');
  475. expect(data).to.equal('/');
  476. });
  477. });
  478. describe('webRequest.onBeforeRedirect', () => {
  479. afterEach(() => {
  480. ses.webRequest.onBeforeRedirect(null);
  481. ses.webRequest.onBeforeRequest(null);
  482. });
  483. it('receives details object', async () => {
  484. const redirectURL = defaultURL + 'redirect';
  485. ses.webRequest.onBeforeRequest((details, callback) => {
  486. if (details.url === defaultURL) {
  487. callback({ redirectURL: redirectURL });
  488. } else {
  489. callback({});
  490. }
  491. });
  492. ses.webRequest.onBeforeRedirect((details) => {
  493. expect(details.fromCache).to.be.a('boolean');
  494. expect(details.statusLine).to.equal('HTTP/1.1 307 Internal Redirect');
  495. expect(details.statusCode).to.equal(307);
  496. expect(details.redirectURL).to.equal(redirectURL);
  497. });
  498. const { data } = await ajax(defaultURL);
  499. expect(data).to.equal('/redirect');
  500. });
  501. });
  502. describe('webRequest.onCompleted', () => {
  503. afterEach(() => {
  504. ses.webRequest.onCompleted(null);
  505. });
  506. it('receives details object', async () => {
  507. ses.webRequest.onCompleted((details) => {
  508. expect(details.fromCache).to.be.a('boolean');
  509. expect(details.statusLine).to.equal('HTTP/1.1 200 OK');
  510. expect(details.statusCode).to.equal(200);
  511. });
  512. const { data } = await ajax(defaultURL);
  513. expect(data).to.equal('/');
  514. });
  515. });
  516. describe('webRequest.onErrorOccurred', () => {
  517. afterEach(() => {
  518. ses.webRequest.onErrorOccurred(null);
  519. ses.webRequest.onBeforeRequest(null);
  520. });
  521. it('receives details object', async () => {
  522. ses.webRequest.onBeforeRequest((details, callback) => {
  523. callback({ cancel: true });
  524. });
  525. ses.webRequest.onErrorOccurred((details) => {
  526. expect(details.error).to.equal('net::ERR_BLOCKED_BY_CLIENT');
  527. });
  528. await expect(ajax(defaultURL)).to.eventually.be.rejected();
  529. });
  530. });
  531. describe('WebSocket connections', () => {
  532. it('can be proxyed', async () => {
  533. // Setup server.
  534. const reqHeaders : { [key: string] : any } = {};
  535. const server = http.createServer((req, res) => {
  536. reqHeaders[req.url!] = req.headers;
  537. res.setHeader('foo1', 'bar1');
  538. res.end('ok');
  539. });
  540. const wss = new WebSocket.Server({ noServer: true });
  541. wss.on('connection', function connection (ws) {
  542. ws.on('message', function incoming (message) {
  543. if (message === 'foo') {
  544. ws.send('bar');
  545. }
  546. });
  547. });
  548. server.on('upgrade', function upgrade (request, socket, head) {
  549. const pathname = require('node:url').parse(request.url).pathname;
  550. if (pathname === '/websocket') {
  551. reqHeaders[request.url!] = request.headers;
  552. wss.handleUpgrade(request, socket as Socket, head, function done (ws) {
  553. wss.emit('connection', ws, request);
  554. });
  555. }
  556. });
  557. // Start server.
  558. const { port } = await listen(server);
  559. // Use a separate session for testing.
  560. const ses = session.fromPartition('WebRequestWebSocket');
  561. // Setup listeners.
  562. const receivedHeaders : { [key: string] : any } = {};
  563. ses.webRequest.onBeforeSendHeaders((details, callback) => {
  564. details.requestHeaders.foo = 'bar';
  565. callback({ requestHeaders: details.requestHeaders });
  566. });
  567. ses.webRequest.onHeadersReceived((details, callback) => {
  568. const pathname = require('node:url').parse(details.url).pathname;
  569. receivedHeaders[pathname] = details.responseHeaders;
  570. callback({ cancel: false });
  571. });
  572. ses.webRequest.onResponseStarted((details) => {
  573. if (details.url.startsWith('ws://')) {
  574. expect(details.responseHeaders!.Connection[0]).be.equal('Upgrade');
  575. } else if (details.url.startsWith('http')) {
  576. expect(details.responseHeaders!.foo1[0]).be.equal('bar1');
  577. }
  578. });
  579. ses.webRequest.onSendHeaders((details) => {
  580. if (details.url.startsWith('ws://')) {
  581. expect(details.requestHeaders.foo).be.equal('bar');
  582. expect(details.requestHeaders.Upgrade).be.equal('websocket');
  583. } else if (details.url.startsWith('http')) {
  584. expect(details.requestHeaders.foo).be.equal('bar');
  585. }
  586. });
  587. ses.webRequest.onCompleted((details) => {
  588. if (details.url.startsWith('ws://')) {
  589. expect(details.error).be.equal('net::ERR_WS_UPGRADE');
  590. } else if (details.url.startsWith('http')) {
  591. expect(details.error).be.equal('net::OK');
  592. }
  593. });
  594. const contents = (webContents as typeof ElectronInternal.WebContents).create({
  595. session: ses,
  596. nodeIntegration: true,
  597. webSecurity: false,
  598. contextIsolation: false
  599. });
  600. // Cleanup.
  601. after(() => {
  602. contents.destroy();
  603. server.close();
  604. ses.webRequest.onBeforeRequest(null);
  605. ses.webRequest.onBeforeSendHeaders(null);
  606. ses.webRequest.onHeadersReceived(null);
  607. ses.webRequest.onResponseStarted(null);
  608. ses.webRequest.onSendHeaders(null);
  609. ses.webRequest.onCompleted(null);
  610. });
  611. contents.loadFile(path.join(fixturesPath, 'api', 'webrequest.html'), { query: { port: `${port}` } });
  612. await once(ipcMain, 'websocket-success');
  613. expect(receivedHeaders['/websocket'].Upgrade[0]).to.equal('websocket');
  614. expect(receivedHeaders['/'].foo1[0]).to.equal('bar1');
  615. expect(reqHeaders['/websocket'].foo).to.equal('bar');
  616. expect(reqHeaders['/'].foo).to.equal('bar');
  617. });
  618. });
  619. });