1909474 - webRequest.getSecurityInfo() options parameter is documented as optional but cannot be optional

Status: RESOLVED FIXED

(WebExtensions :: Request Handling, defect, P3)

Description

[Rob Wu [:robwu]]

options parameter documented as optional: https://searchfox.org/mozilla-central/rev/de46cd99a7d1634058b511a3f546a970763e5048/toolkit/components/extensions/schemas/web_request.json#469,479-480

Implementation has (requestId, options = {}):

• https://searchfox.org/mozilla-central/rev/de46cd99a7d1634058b511a3f546a970763e5048/toolkit/components/extensions/parent/ext-webRequest.js#199
• https://searchfox.org/mozilla-central/rev/de46cd99a7d1634058b511a3f546a970763e5048/toolkit/components/extensions/webrequest/SecurityInfo.sys.mjs#58
  • and expects options to be an object later, e.g. when checking for options.certificateChain

options = {} only converts an omitted options to {} if options is undefined. But the Schema validator converts missing options to null instead, which prevents this from working.

Consequently, a call to browser.webRequest.getSecurityInfo(requestId) without options parameter results in an (async) error.

Comment 1

[Rob Wu [:robwu]]

Attachment: Bug 1909474 - Treat options in getSecurityInfo as optional

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8f712579adcb
Treat options in getSecurityInfo as optional r=rpl

Comment 3

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/8f712579adcb

Comment 4

[rbloor]

Could I clarify what documentation is required here? We already document this as optional e.g. "object. An object which may contain any of the following properties, all optional:" Or is the requirement a release note to state that this now behaviors as documented?

Comment 5

[Rob Wu [:robwu]]

The options object itself should also be marked as optional on MDN ({{optional_inline}}), at https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webRequest/getSecurityInfo#options

The BCD should mention that the option is optional since 130.

Comment 6

[rbloor]

Changes ready for review:

• (Content) webRequest.getSecurityInfo options parameter optional #35345
• (BCD) webRequest.getSecurityInfo options parameter optional #24056