857429 - Remove and deprecate methods in PlacesUtils.backups, depending on add-on usage

Status: RESOLVED FIXED

(Toolkit :: Places, defect)

Description

[Raymond Lee [:raymondlee]]

Bug 855638 would handle calls within mozilla-central.  This bug is to remove PlacesUtils.backups and deprecate methods which depends on add-on usage.

Comment 1

[Raymond Lee [:raymondlee]]

Here are the addons using PlacesUtils.backups.

https://addons.mozilla.org/en-US/firefox/addon/stumbleupon/?src=search
/138/content/stumbleuponOverlay.js
line 3298 -- if(PlacesUtils && PlacesUtils.backups)
line 3301 -- name = PlacesUtils.backups.getFilenameForDate();

https://addons.mozilla.org/en-US/thunderbird/addon/wat-webapplicationtab/?src=search
/55713/chrome/content/places/places.js
line 409 -- let backupFiles = PlacesUtils.backups.entries;
line 415 -- let backupDate = PlacesUtils.backups.getDateForFile(backupFiles[i]);
line 439 -- let backupFiles = PlacesUtils.backups.entries;
line 521 -- fp.defaultString = PlacesUtils.backups.getFilenameForDate();
line 524 -- PlacesUtils.backups.saveBookmarksToJSONFile(fp.file);

https://addons.mozilla.org/en-US/firefox/addon/bookmark-favicon-changer/?src=search
/300259/chrome/content/module.jsm
line 136 -- // Hook function PlacesUtils.backups.saveBookmarksToJSONFile in PlacesUtils.jsm for embeding favicon data into JSON file
line 139 -- this.saveBookmarksToJSONFile = PlacesUtils.backups.saveBookmarksToJSONFile;
line 140 -- PlacesUtils.backups.saveBookmarksToJSONFile = function()

Comment 2

[Raymond Lee [:raymondlee]]

Attachment: v1

This patch depends on the patch for bug 855638.

Comment 3

[Marco Bonardo [:mak]]

I think there's a simpler solution, that is to make PlacesUtils.backups a getter (with a Deprecated.warning stating PlacesUtils.backups is deprecated) returning PlacesBackups

Comment 4

[Raymond Lee [:raymondlee]]

Attachment: v2

Comment 5

[Marco Bonardo [:mak]]

Comment on attachment 738554 [details] [diff] [review]
v2

Review of attachment 738554 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks

::: toolkit/components/places/PlacesUtils.jsm
@@ +1749,5 @@
>     * Helper to create and manage backups.
>     */
> +  get backups() {
> +    Deprecated.warning(
> +      "backups is deprecated and will be removed in a future version",

I'd say "PlacesUtils.backups", otherwise just "backups" is too generic

Comment 6

[Raymond Lee [:raymondlee]]

Attachment: Patch for check-in

(In reply to Marco Bonardo [:mak] from comment #5)
> Comment on attachment 738554 [details] [diff] [review]
> v2
> 
> Review of attachment 738554 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> Thanks
> 
> ::: toolkit/components/places/PlacesUtils.jsm
> @@ +1749,5 @@
> >     * Helper to create and manage backups.
> >     */
> > +  get backups() {
> > +    Deprecated.warning(
> > +      "backups is deprecated and will be removed in a future version",
> 
> I'd say "PlacesUtils.backups", otherwise just "backups" is too generic

Updated

Passed try
https://tbpl.mozilla.org/?tree=Try&rev=d561a0a922c7

Comment 7

[Raymond Lee [:raymondlee]]

Attachment: Patch for check-in

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/09f59fe2c63a

Comment 9

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/09f59fe2c63a