985812 - Figure out the type of ActivityRequestHandler.source

Status: RESOLVED FIXED

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

Description

[(no longer active)]

Over in bug 903873, I'm converting this interface to WebIDL.  The original design of this interface <https://wiki.mozilla.org/WebAPI/WebActivities#Proposed_API> uses the ActivityOptions dictionary as the type of this property, which is disallowed in WebIDL for the reasons Boris explained in bug 903873 comment 6.

The question to answer here is: "Whether the consumers of this API want the same object every time they call this getter or whether they want a new object."

I don't see any reason why they would want a new object every time, and a quick look through the consumers of this API seems to suggest that they don't care.  One thing to note about this interface is that it's currently used to wrap the argument passed to the activity system message, which means that none of our internal code uses the same instance of this object more than once.

Fabrice, you were the implementer of this API.  What's your take on this?  I'm happy to write a patch based on what we decide here.

Comment 1

[(no longer active)]

Actually needinfo-ing Fabrice!  Please see comment 0.

Comment 2

[[:fabrice] Fabrice Desré]

We agreed on irc to return the same object.

Comment 3

[Boris Zbarsky [:bzbarsky]]

Frozen, or not?

Comment 4

[[:fabrice] Fabrice Desré]

Frozen is fine.

Comment 5

[(no longer active)]

Attachment: Make a ActivityRequestHandler.source a pure cached frozen dictionary; r=bzbarsky

Comment 6

[Boris Zbarsky [:bzbarsky]]

Comment on attachment 8395084 [details] [diff] [review]
Make a ActivityRequestHandler.source a pure cached frozen dictionary; r=bzbarsky

r=me, but document in the "source" getter that we have to keep cloning it because it has an "any" member that WebIDL would otherwise pass through unchanged and hence hand a COW to the web page?

Comment 7

[(no longer active)]

https://hg.mozilla.org/integration/mozilla-inbound/rev/8043163876f9

Comment 8

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/8043163876f9