1263140 - Fix notified button name in SDK native-options module

Status: RESOLVED FIXED

Description

[Luca Greco [:rpl]]

Unfortunately the jetpack test suite didn't catched that in the changes introduced by Bug 1167246 the name of the button is now used in a closure and the command handler of the add-on preferences button will notify the wrong preference name if the button is not the last element of the preferences array.

Comment 1

[Luca Greco [:rpl]]

Created attachment 8739411 [details]
MozReview Request: Bug 1263140 - fix notified button name in SDK native-options module. r=mossop

Review commit: https://reviewboard.mozilla.org/r/45263/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/45263/

Comment 2

[Dave Townsend [:mossop] (he/him)]

Comment on attachment 8739411 [details]
MozReview Request: Bug 1263140 - fix notified button name in SDK native-options module. r=mossop

https://reviewboard.mozilla.org/r/45263/#review41755

::: addon-sdk/source/lib/sdk/preferences/native-options.js:136
(Diff revision 1)
>  // dynamically injects inline options into about:addons page at runtime
>  // NOTE: on Firefox Desktop the about:addons page is a xul page document,
>  // on Firefox for Android the about:addons page is an xhtml page, to support both
>  // the XUL xml namespace have to be enforced.
>  function injectOptions({ preferences, preferencesBranch, document, parent, id }) {
>    for (let { name, type, hidden, title, description, label, options, on, off } of preferences) {

Can you instead make this

    preferences.forEach(({name, type, hidden, title, description, label, options, on, off}) => {
    ...
    });

That should solve the issue and make sure it doesn't catch us elsewhere.

Comment 3

[Luca Greco [:rpl]]

(In reply to Dave Townsend [:mossop] from comment #2)
> Comment on attachment 8739411 [details]
> MozReview Request: Bug 1263140 - fix notified button name in SDK
> native-options module. r?mossop
> 
> https://reviewboard.mozilla.org/r/45263/#review41755
> 
> ::: addon-sdk/source/lib/sdk/preferences/native-options.js:136
> (Diff revision 1)
> >  // dynamically injects inline options into about:addons page at runtime
> >  // NOTE: on Firefox Desktop the about:addons page is a xul page document,
> >  // on Firefox for Android the about:addons page is an xhtml page, to support both
> >  // the XUL xml namespace have to be enforced.
> >  function injectOptions({ preferences, preferencesBranch, document, parent, id }) {
> >    for (let { name, type, hidden, title, description, label, options, on, off } of preferences) {
> 
> Can you instead make this
> 
>     preferences.forEach(({name, type, hidden, title, description, label,
> options, on, off}) => {
>     ...
>     });
> 
> That should solve the issue and make sure it doesn't catch us elsewhere.

sure, and I like it more than my proposed one.

Comment 4

[Luca Greco [:rpl]]

Comment on attachment 8739411 [details]
MozReview Request: Bug 1263140 - fix notified button name in SDK native-options module. r=mossop

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/45263/diff/1-2/

Comment 5

[Luca Greco [:rpl]]

https://reviewboard.mozilla.org/r/45263/#review41755

> Can you instead make this
> 
>     preferences.forEach(({name, type, hidden, title, description, label, options, on, off}) => {
>     ...
>     });
> 
> That should solve the issue and make sure it doesn't catch us elsewhere.

Patch updated as suggested in the review comment.

Comment 6

[Luca Greco [:rpl]]

Pushed to try:
- https://treeherder.mozilla.org/#/jobs?repo=try&revision=87d9d53ffc8c

Comment 7

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/6553edb04f02

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/6553edb04f02