1360723 - Rename ContentParent::TransmitPermissionsFor() to ContentParent::AboutToLoadDocumentForChild()

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, enhancement)

Description

[(no longer active)]

This gives the method a better name, and it makes it more obvious that it's a good place to stick in code in the parent process that needs to run as soon as possible when we know we're about to load a document for the child process.

Comment 1

[(no longer active)]

Attachment: Rename ContentParent::TransmitPermissionsFor() to ContentParent::AboutToLoadDocumentForChild()

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/4dea825d159b
Rename ContentParent::TransmitPermissionsFor() to ContentParent::AboutToLoadDocumentForChild(); r=mystor

Comment 3

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8863048 [details] [diff] [review]
Rename ContentParent::TransmitPermissionsFor() to ContentParent::AboutToLoadDocumentForChild()

>+  // This function is called when we are about to load a document from an
>+  // HTTP(S), FTP or wyciwyg channel for a content process.  It is a useful
>+  // place to start to kick off work as early as possible in response to such
>+  // document loads.
>+  nsresult AboutToLoadDocumentForChild(nsIChannel* aChannel);

If this is really called for http(s), FTP or wyciwyg only, and not for example file channel, please call this something else.
This is very confusing name now.

And even if file is handled, this would be error prone since people will forget to deal with cases like data: or srcdoc (which live in child side).

Comment 4

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

https://hg.mozilla.org/mozilla-central/rev/4dea825d159b

Comment 5

[(no longer active)]

(In reply to Olli Pettay [:smaug] from comment #3)
> Comment on attachment 8863048 [details] [diff] [review]
> Rename ContentParent::TransmitPermissionsFor() to
> ContentParent::AboutToLoadDocumentForChild()
> 
> >+  // This function is called when we are about to load a document from an
> >+  // HTTP(S), FTP or wyciwyg channel for a content process.  It is a useful
> >+  // place to start to kick off work as early as possible in response to such
> >+  // document loads.
> >+  nsresult AboutToLoadDocumentForChild(nsIChannel* aChannel);
> 
> If this is really called for http(s), FTP or wyciwyg only, and not for
> example file channel, please call this something else.
> This is very confusing name now.

Hmm, what do you suggest as a better name?  AboutToLoadHttpFtpWyciwygDocumentForChild?  I can't think of anything better.

Comment 6

[Olli Pettay [:smaug][[e-mail]]]

I could live with that, even though it is quite long. But at least it doesn't hint that
all the document loads go through that method.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/f4ad40ab582e
follow-up: Rename ContentParent::AboutToLoadDocumentForChild to ContentParent::AboutToLoadHttpFtpWyciwygDocumentForChild

Comment 8

[Iris Hsiao [:ihsiao]]

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