1634127 - Remove the file path behavior from RemoteSetting's download() method

Status: RESOLVED FIXED

(Firefox :: Remote Settings Client, task)

Description

[Rob Wu [:robwu]]

The current implementation of download() of RemoteSettings downloads has several issues:

• If the record is lost, the downloaded file will linger in the user's profile directory.
• It does not support use cases where the API client wants to preserve the metadata and attachment content past the lifetime of the record in the collection.
• Every API client is either encouraged to use the download() with path semantics, or use downloadAsBytes and roll their own storage mechanism.

A replacement was introduced in bug 1620621, in:

• https://phabricator.services.mozilla.com/D72416
• https://phabricator.services.mozilla.com/D72417

I renamed the current method to downloadToDisk and introduced a new download method with extra parameters. The input parameters are backwards-compatible. For backwards-compatibility, the new method calls downloadToDisk unless a new option useCache:true is passed.
The only difference are their return types: downloadToDisk returns a file path, whereas the new download returns an object with the attachment content in an ArrayBuffer, together with its associated record.

If all callers are updated to work with the new behavior, then the old downloadToDisk method can be removed.

Comment 1

[Mathieu Leplatre [:leplatrem]]

Attachment: Bug 1634127 - Download attachments in IndexedDB by default r?robwu

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c43b947f03b0
Download attachments in IndexedDB by default r=necko-reviewers,robwu,dragana

Comment 3

[Marian-Vasile Laza]

Backed out changeset c43b947f03b0 (Bug 1634127) for causing newtab failures.
Backout link
Push with failures
Failure Log

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e1b7056e7529
Download attachments in IndexedDB by default r=necko-reviewers,robwu,dragana

Comment 5

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/e1b7056e7529