1331735 - Create an API on nsIWebNavigation that allows to pass arguments without changing the signature of the function

Status: NEW

(Core :: DOM: Security, defect, P3)

Description

[Christoph Kerschbaumer [:ckerschb]]

> As suggested within 
> https://bugzilla.mozilla.org/show_bug.cgi?id=1329032#c18
> we need a sane API for nsIWebNavigation that allows to pass various arguments without changing the signature of the function.

For the longer-term fix, I think we should strongly consider a more JS-friendly API here (in a followup) so we don't have to keep adding arguments and deciding whether they're optional or not, etc.  I was going to suggest we simply add a way to pass in an nsIDocShellLoadInfo, but then I realized that there's no reason to force JS consumers to create such a beast.  A plausible scriptable API for this would look like this in xpidl:

  void thisAPINeedsASaneName(in AString aURI, [optiona] in jsval aOptions);

plus a webidl dictionary definition that we use to pull things out of the aOptions object (throwing when a non-object is passed) and then create an nsIDocShellLoadInfo from on the C++ side.  A consumer of the API will then do:

  webnav.thisAPINeedsASaneName(myURI, { triggeringPrincipal: whatever });

etc, only passing in the options they want non-default behavior for.

Comment 1

[Boris Zbarsky [:bzbarsky]]

> throwing when a non-object is passed

More precisely if what's passed is (!isObject() && !isNullOrUndefined()).