433456 - mozIStorageFunction should be a [function]

Status: RESOLVED FIXED

(Toolkit :: Storage, defect)

Description

[:Mook]

mozIStorageFunction is, as its name states, a (callback) function; it has exactly one method and no attributes, and its sole purpose in life is to be a callback.

It should be tagged as [function] to be easier to use from JS.  There's seriously no point it not being one.

Comment 1

[Akshay Gupta]

Attachment: |function| added [Checkin: Comment 3 & 13]

Comment 2

[Shawn Wilsher :sdwilsh]

Comment on attachment 391591 [details] [diff] [review]
|function| added
[Checkin: Comment 3 & 13]

r=sdwilsh

Comment 3

[Serge Gautherie (:sgautherie)]

Comment on attachment 391591 [details] [diff] [review]
|function| added
[Checkin: Comment 3 & 13]


http://hg.mozilla.org/mozilla-central/rev/0dd522c0975c

"approval1.9.1.3=?":
Trivial, 0 risk.

Comment 4

[Nochum Sossonko [:Natch]]

Does the uuid need to be changed for this? If so, and maybe even if not, this isn't a trivial patch and can't be accepted on branch unless another interface is created, which probably isn't worth it...

Comment 5

[Daniel Veditz [:dveditz]]

Comment on attachment 391591 [details] [diff] [review]
|function| added
[Checkin: Comment 3 & 13]

Approved for 1.9.1.4, a=dveditz for release-drivers

Comment 6

[Serge Gautherie (:sgautherie)]

(In reply to comment #4)

> Does the uuid need to be changed for this? If so, and maybe even if not, this

To be explicit, this patch does _not_ change the uuid.

> isn't a trivial patch and can't be accepted on branch unless another interface
> is created, which probably isn't worth it...

Shawn, what about that? (I'm confused.)

Comment 7

[Shawn Wilsher :sdwilsh]

Someone said on irc that the uuid doesn't need to be changed - it's only looked at by xpconnect and it doesn't impact native code callers (who care about the uuid).

This patch is fine as is (hence the r+).

Comment 8

[Serge Gautherie (:sgautherie)]

To be explicit, I was asking for a confirmation that the patch was good for m-1.9.1...

Comment 9

[Eric Shepherd [:sheppy]]

How does this affect usage? Want to be sure I get this change properly documented. At immediate glance, it doesn't look like there's really much to do other than update the most recently updated version number in the doc.

Comment 10

[:Mook]

(In reply to comment #9)
> How does this affect usage?
In the example on the mozIStorageFunction page, it can now be written as:

dbConn.createFunction("square", 1, function(aArguments) let (value = aArguments.getInt32(0)) value * value );

You can now pass in a function directly, instead of an object with a onFunctionCall property; this is similar to how DOM event listeners can be functions, and not objects with a handleEvent property.

Comment 11

[Eric Shepherd [:sheppy]]

Thanks for the tip; now I understand what this means. I suspected that's what it was but needed to be sure, obviously.

Updated the doc here with a second, revised, sample; would appreciate it if someone could confirm that it looks right:

https://developer.mozilla.org/en/mozIStorageFunction

Comment 12

[Shawn Wilsher :sdwilsh]

Tweaked the code sample slightly to be a little more clear.

Comment 13

[Dão Gottwald [:dao]]

http://hg.mozilla.org/releases/mozilla-1.9.1/rev/3a325b21cbce

Comment 14

[Al Billings [:abillings - ex-MoCo]]

Verified checked into 1.9.1 for 1.9.1.4 by looking at source.