1140395 - Deprecate old keywords API

Status: RESOLVED FIXED

(Toolkit :: Places, defect)

Description

[Marco Bonardo [:mak]]

we must convert keywords API consumers, and deprecate the existing API.
This is a tracking bug for that work.

Comment 1

[Marco Bonardo [:mak]]

we can deprecate getURIForKeyword immediately

we can deprecate get/setPostDataForBookmark after PlacesTransactions are enabled.
http://mxr.mozilla.org/mozilla-central/search?string=postdataforbookmark

set/getKeywordForBookmark has too many consumers yet, included Sync, PlacesTransactions and some UI pieces.
http://mxr.mozilla.org/mozilla-central/search?string=keywordForBookmark

We should at least edit comments for those methods to indicate deprecation, even if we won't warn to the console for now.

Comment 2

[Tim Taubert [:ttaubert] (inactive)]

Marco, should we remove this bug from "Milestone 1"? If this depends on bug 1148461 then we can't possibly deprecate the keywords API anytime soon, right?

Comment 3

[Marco Bonardo [:mak]]

once the dependencies are done, in this bug i'll mark the "plausible" deprecations, and we'll mark it as fixed.
The fact we have 1 pending dependency is minor.

Comment 4

[Marco Bonardo [:mak]]

I can start working on this, there's nothing blocking since for a couple APIs we can only mark deprecation in the idl javadoc.

Comment 5

[Marco Bonardo [:mak]]

Attachment: patch v1

Comment 6

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/8ab920db907c

Comment 7

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

https://hg.mozilla.org/mozilla-central/rev/8ab920db907c

Comment 8

[Lawrence Mandel [:lmandel] (use needinfo)]

Release Note Request (optional, but appreciated)
[Why is this notable]: Deprecated API, consumers need to update to new API
[Suggested wording]: Places Keywords API deprecated
[Links (documentation, blog post, etc)]:

mak - I'd like to not this to gain some visibility for this change but we really need some documentation about the change including how to use the new API. Do you have a reference to documentation about the new API?

Comment 9

[Marco Bonardo [:mak]]

all the documentation so far is inline:
http://mxr.mozilla.org/mozilla-central/source/toolkit/components/places/PlacesUtils.jsm#2030

I will try to create a new page on MDN for it.

Comment 10

[Marco Bonardo [:mak]]

this is the MDN page I created:
https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Using_the_Places_keywords_API

Rethinking about this though, I'm not sure this is worth a relnote. It will be worth to relnote once we consider the bookmarks API (that includes this one) deprecated, let'say when bug 1141547 will be fixed.
The fact is the keywords feature is something very specific to Firefox, and more particularly to a single feature of the Awesomebar. I'd not expect developers to be very interested into it, unless they are working on a very specific keywords add-on (but I'd not be sure what that could do). The main access point for this API is "Add a keyword for this search" contextual option...

Comment 11

[Sylvestre Ledru [:Sylvestre]]

Relnotes in bug 1141547

Comment 12

[Michal Čaplygin [:myf]]

Headsup: seems like this change created possibility to "lose" keyword in manager: Bug 1198294

Comment 13

[Marco Bonardo [:mak]]

not lost, unreachable. It's actually not due to the API but due to legacy code using the old API...
bug 1150678 is aimed to solve most issues.