webRequest.onBeforeSendHeaders callback response requestHeaders not optional in 7.0.0 #20751

binux · 2019-10-25T21:24:29Z

Preflight Checklist

I have read the Contributing Guidelines for this project.
I agree to follow the Code of Conduct that this project adheres to.
I have searched the issue tracker for an issue that matches the one I want to file, without success.

Issue Details

Electron Version:
- v7.0.0
Operating System:
- macOS
Last Known Working Electron version:
- v6.1.2

Expected Behavior

Additional headers sent without changes as documented
https://github.com/electron/electron/blob/v7.0.0/docs/api/web-request.md

https://github.com/electron/electron/blob/v7.0.0/docs/api/web-request.md

<head></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">{
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3",
    "Accept-Encoding": "gzip, deflate, br",
    "Accept-Language": "en-GB",
    "Addition-Header": "hello world",
    "Host": "httpbin.org",
    "Sec-Fetch-Mode": "navigate",
    "Sec-Fetch-Site": "none",
    "Sec-Fetch-User": "?1",
    "Upgrade-Insecure-Requests": "1",
    "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.146 Electron/6.1.2 Safari/537.36"
  }
}
</pre></body>

Actual Behavior

Additional headers removed and not sent to server.

<head></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">{
  "headers": {
    "Accept-Encoding": "gzip, deflate, br",
    "Accept-Language": "en-GB",
    "Host": "httpbin.org",
    "Sec-Fetch-Mode": "navigate",
    "Sec-Fetch-Site": "none",
    "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3905.1 Electron/7.0.0 Safari/537.36"
  }
}
</pre></body>

To Reproduce

run following snippet:
https://gist.github.com/binux/3c2023793e1bf1ff03a8fcb24b026162

electron electron_bug.webRequest.onBeforeSendHeaders.js

Additional Information

Workaround will be change callback as callback({ requestHeaders: details.requestHeaders }).

The text was updated successfully, but these errors were encountered:

sandeep1995 · 2019-11-26T08:20:47Z

I am trying to connect to a local WebSocket server.
For connecting to the WebSocket server, I need to set the Origin header to be null

I was on electron 4.2.x, it was working fine then. I tried upgrading to electron 7.1.1, it's not working now.

I am using the following code

session.defaultSession.webRequest.onBeforeSendHeaders(
  {
    urls: [
      '*://*/*',
    ],
  },
  (details, callback) => {
    let reqHeaders = Object.assign({}, details.requestHeaders, {
      Origin: null,
    });
    callback({
      cancel: false,
      requestHeaders: reqHeaders,
    });
  }
);

vladimiry · 2019-11-26T08:29:39Z

@sandeep1995 I'd suggest trying 7.1.2+, see #20923 for details.

jalanga · 2019-11-28T11:13:57Z

@vladimiry on 7.1.2, onBeforeSendHeaders is not called, at leas I can't find an output in console after a console.log. The header CCC is not sent, neither the origin. Any suggestions please?

  session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback) => {
    details.requestHeaders.Origin = constants.originHeader;
    details.requestHeaders.CCC = '1';
    callback({
      cancel: false,
      requestHeaders: details.requestHeaders
    });
  });

sandeep1995 · 2019-11-28T17:53:45Z

I am still not able to connect to a local WebSocket server from the renderer as I could not modify the Origin

I tried 7.1.2 and even electron 8.0.0-beta.3. Still no luck.

vladimiry · 2019-11-28T18:49:23Z

@sandeep1995 origin header is being successfully modified here https://github.com/vladimiry-playground/electron-quick-start-cors-issue/blob/357c37682d5f881d76a7be94c995edc7d22c35ac/main.js#L70 using electron@v7.1.2

sandeep1995 · 2019-11-28T18:58:53Z

@vladimiry Maybe that is because you are trying to modify for an XHR request.
I am trying for a WebSocket (wss://) request.

According to my investigation, it seems like it's a bug on the Chromium side.
https://bugs.chromium.org/p/chromium/issues/detail?id=1011108

vladimiry · 2019-11-28T19:02:50Z

Got it, so I overlooked the websockets use.

danielweck · 2020-06-05T15:10:18Z

I filed a similar issue for Electron v8 and WebRequest.onBeforeSendHeaders (WebRequest.onHeadersReceived seems to "do the right thing" as per the documentation and previous Electron versions' behaviour).
I provided a Gist to reproduce the issue in the console, and compare onBeforeSendHeaders vs. onHeadersReceived:
#23988

danielweck · 2020-06-05T15:30:43Z

According to my tests with Electron Fiddle, version 6.1.2 is not affected, but versions 10.0.0-beta.2, 9.0.2, 8.3.1 and 7.3.1 are affected, so this seems like a regression from version 6 to 7+.
See: #23988

binux · 2020-09-06T01:22:30Z

NOTE: the workaround callback({ requestHeaders: details.requestHeaders }) will cause the request header reordered when sent to target website, which might be used as a fingerprint to detect electron.

There is an other workaround callback(undefined) wouldn't have this issue if you just want to peek on the headers sent. (you have to specifically send undefined here, otherwise will get a TypeError: Insufficient number of arguments. error.

sofianguy added 7-1-x bug 🪲 platform/macOS labels Nov 6, 2019

sofianguy added this to Unsorted Issues in 7.2.x Nov 6, 2019

electron-triage added the 10-x-y label Mar 9, 2021

dsanders11 mentioned this issue Jun 20, 2021

fix: properly handle optional requestHeaders with onBeforeSendHeaders #29798

Merged

4 tasks

zcbenz closed this as completed in #29798 Jun 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

webRequest.onBeforeSendHeaders callback response requestHeaders not optional in 7.0.0 #20751

webRequest.onBeforeSendHeaders callback response requestHeaders not optional in 7.0.0 #20751

binux commented Oct 25, 2019

sandeep1995 commented Nov 26, 2019

vladimiry commented Nov 26, 2019

jalanga commented Nov 28, 2019

sandeep1995 commented Nov 28, 2019

vladimiry commented Nov 28, 2019

sandeep1995 commented Nov 28, 2019 •

edited

vladimiry commented Nov 28, 2019

danielweck commented Jun 5, 2020

danielweck commented Jun 5, 2020 •

edited

binux commented Sep 6, 2020

webRequest.onBeforeSendHeaders callback response requestHeaders not optional in 7.0.0 #20751

webRequest.onBeforeSendHeaders callback response requestHeaders not optional in 7.0.0 #20751

Comments

binux commented Oct 25, 2019

Preflight Checklist

Issue Details

Expected Behavior

Actual Behavior

To Reproduce

Additional Information

sandeep1995 commented Nov 26, 2019

vladimiry commented Nov 26, 2019

jalanga commented Nov 28, 2019

sandeep1995 commented Nov 28, 2019

vladimiry commented Nov 28, 2019

sandeep1995 commented Nov 28, 2019 • edited

vladimiry commented Nov 28, 2019

danielweck commented Jun 5, 2020

danielweck commented Jun 5, 2020 • edited

binux commented Sep 6, 2020

sandeep1995 commented Nov 28, 2019 •

edited

danielweck commented Jun 5, 2020 •

edited