862601 - tabs module should have a getTabById() method

Status: RESOLVED INCOMPLETE

(Add-on SDK Graveyard :: General, defect, P3)

Description

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

When you have a tab's id value and you want to get that tab object, it'd be nice to not have to manually iterate through all open tabs, trying to match that id against each one.

It'd be nice if there was some convenience function called getTabById(id) or something like that as part of the high-level tabs module to do it for us.

Comment 1

[Jeff Griffiths]

Attachment: Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/973

Pointer to Github pull-request

Comment 2

[Jeff Griffiths (:canuckistani) (:⚡︎)]

The PR currently is WIP, need to test on Fennec.

Comment 3

[Erik Vold [:erikvold] (please needinfo? me)]

This ok with you Irakli?

Comment 4

[Erik Vold [:erikvold] (please needinfo? me)]

not `getTabById` -> `getById`

Comment 5

[Erik Vold [:erikvold] (please needinfo? me)]

or make the method an export from the tabs module separate from the tabs iterator.

Comment 6

[Erik Vold [:erikvold] (please needinfo? me)]

(In reply to Erik Vold [:erikvold] [:ztatic] from comment #5)
> or make the method an export from the tabs module separate from the tabs
> iterator.

hmm I guess this isn't possible.. the iterator is the export object..

Comment 7

[Jeff Griffiths (:canuckistani) (:⚡︎)]

The method name was Wes' original proposal, I have no strong opinion on getTabyId vs getById.

Comment 8

[Irakli Gozalishvili [:irakli] [:gozala] [@gozala]]

I'm fine with both `getTabyId` / `getById`. Although since it's exposed by tabs module tabs.getTabById feels like unnecessary repetition.

This also got me thinking that it maybe better to just add:

`tabs.get(handle) // => Tab`

to continue the style established lately. For now we could just support
string `id`'s, but in a future we can extend this to support `tabs.get(tabNode)`.

Alternatively we could go with `tabs.from(handle)` to match closer ES.next Array.from

Comment 9

[Erik Vold [:erikvold] (please needinfo? me)]

(In reply to Irakli Gozilalishvili [:irakli] [:gozala] [@gozala] from comment #8)
> I'm fine with both `getTabyId` / `getById`. Although since it's exposed by
> tabs module tabs.getTabById feels like unnecessary repetition.
> 
> This also got me thinking that it maybe better to just add:
> 
> `tabs.get(handle) // => Tab`
> 
> to continue the style established lately. For now we could just support
> string `id`'s, but in a future we can extend this to support
> `tabs.get(tabNode)`.

+1 for `get`, good idea!

Comment 10

[Erik Vold [:erikvold] (please needinfo? me)]

(In reply to Irakli Gozilalishvili [:irakli] [:gozala] [@gozala] from comment #8)
> Alternatively we could go with `tabs.from(handle)` to match closer ES.next
> Array.from

From my google searches it seems like Array.from converts array like things to a real array.

Comment 11

[Erik Vold [:erikvold] (please needinfo? me)]

Can we leave this to a 3rd party module?

Comment 12

[Jeff Griffiths (:canuckistani) (:⚡︎)]

Someone could certainly write and publish a module that does this - I think it makes more sense for it to be in the tabs module but I also see that people aren't screaming for it.

Comment 13

[Firefox Bug Husbandry Bot]

https://bugzilla.mozilla.org/show_bug.cgi?id=1399562