1880160 - Handler function threw an exception: TypeError: channel.visitRequestHeaders is not a function

Status: RESOLVED FIXED

(Remote Protocol :: WebDriver BiDi, defect, P2)

Description

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Running the following code in the WebDriver BiDi client results in an error within the NetworkUtils.sys.mjs module.

async function evaluate(context, expression, options = {}) {
  const { awaitPromise = true } = options;

  const res = await sendCommand("script.evaluate", {
    expression,
    target: { context },
    awaitPromise,
  });

  return res.result.result;
}

function sleep(time = 1000) {
  return new Promise(resolve => window.setTimeout(resolve, time));
}

(async function () {
  await sendCommand("session.new", { capabilities: {} });
  let res = await sendCommand("browsingContext.getTree", {});
  let context = res.result.contexts[0].context;

  await sendCommand("session.subscribe", { events: ["network"] });

  await sendCommand("browsingContext.navigate", {
    context,
    url: "https://self-signed.badssl.com/",
    wait: "none",
  });

  await sleep(5000);
})()

The error as raised:

Handler function threw an exception: TypeError: channel.visitRequestHeaders is not a function
Stack: fetchRequestHeadersAndCookies@resource://devtools/shared/network-observer/NetworkUtils.sys.mjs:411:11
NetworkEventRecord@chrome://remote/content/shared/listeners/NetworkEventRecord.sys.mjs:63:25
#onNetworkEvent@chrome://remote/content/shared/listeners/NetworkListener.sys.mjs:101:12
#createNetworkEvent@resource://devtools/shared/network-observer/NetworkObserver.sys.mjs:740:48
@resource://devtools/shared/network-observer/NetworkObserver.sys.mjs:536:31
makeInfallible/<@resource://devtools/shared/DevToolsInfaillibleUtils.sys.mjs:43:22
inheritAttribute@chrome://global/content/customElements.js:375:18
attributeChangedCallback@chrome://global/content/customElements.js:315:16
setIcon@chrome://browser/content/tabbrowser.js:1010:16
setIconFromLink@resource:///actors/LinkHandlerParent.sys.mjs:161:16
receiveMessage@resource:///actors/LinkHandlerParent.sys.mjs:60:14
Line: 411, column: 11

Interestingly in NetworkObserver.sys.mjs:740 we run the following code for a nsIFileChannel:

fileActivity.owner = this.#onNetworkEvent({}, channel);

But why do we run this code? Why is this a file channel? I cannot actually debug because adding the debugger statement around those lines and having the browser toolbox open crashes Firefox immediately.

Julian could you please check? This blocks at least one Puppeteer test.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Maybe a regression from bug 1870580?

Comment 2

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Ok, this seems to come from running aTab.setAttribute("iconloadingprincipal", aLoadingPrincipal); which most likely sets the tab icon. That's why we have a file channel.

With a Nightly build that doesn't have the change from bug 1870580 yet, the Puppeteer test still fails. So it's not related.

Comment 3

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Valetin, could you team please have a look at this issue. It's massively spamming the log and makes it harder to investigate test failures for jobs using WebDriver BiDi. Thanks!

Comment 4

[Valentin Gosu [:valentin] (he/him)]

It seems pretty clear that this is related with bug 1870580.
I can't figure out from the patch what's wrong, but we should be able to avoid the error by checking if the channel QIs to nsIHttpChannel before calling visitRequestHeaders ?

Comment 5

[Julian Descottes [:jdescottes]]

I will take a look and see how we should handle those channels in BiDi. File channels don't support the same APIs as HTTP channels, so we might just skip them until we fully support them in Bug 1826210

Comment 6

[BugBot [:suhaib / :marco/ :calixte]]

Set release status flags based on info from the regressing bug 1870580

Comment 7

[Julian Descottes [:jdescottes]]

Attachment: Bug 1880160 - [bidi] Ignore file channels in BiDi network listener

File channels do not support the same APIs as other channels and make the NetworkEventRecord throw.
Support should be added in Bug 1826210.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ae5e73b7bdee
[bidi] Ignore file channels in BiDi network listener r=webdriver-reviewers,Sasha

Comment 9

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/ae5e73b7bdee

Comment 10

[Julian Descottes [:jdescottes]]

Comment on attachment 9382233 [details]
Bug 1880160 - [bidi] Ignore file channels in BiDi network listener

Beta/Release Uplift Approval Request

• User impact if declined: When listening to network events with WebDriver BiDi, a lot of errors will pollute the stdout.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): We don't really have an automated test to check that the logs are no longer polluted with random errors, but the modified code only impacts WebDriver BiDi clients and is simply ignoring a new type of network channel, which we don't support correctly yet.
• String changes made/needed:
• Is Android affected?: No

Comment 11

[Dianna Smith [:diannaS]]

Comment on attachment 9382233 [details]
Bug 1880160 - [bidi] Ignore file channels in BiDi network listener

Approved for 124.0b4

Comment 12

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/191e1e128ea8