1458827 - Add debugging tips to developer documentation

Status: RESOLVED FIXED

(Firefox :: Remote Settings Client, enhancement)

Description

[Mathieu Leplatre [:leplatrem]]

Debugging tips like:

- How to trigger a sync manually
- How to inspect local databases

:mythmon  pointed out that Bug 1445160 has landed, making databases made from JSMs accessible to the storage inspector in the Browser Toolbox.

To get there, go to Tools > Developer > Browser Toolbox (or ctrl+shift+alt+i). In the storage inspector,  DB is listed under "Indexed DB > chrome > "

Comment 1

[Mathieu Leplatre [:leplatrem]]

Also, Gijs pointed out that the `.get({ filters: { enabled: true } })` was not a good example.

`.get({ filters: { property: "value" } })` would be better.

Comment 2

[Mathieu Leplatre [:leplatrem]]

Attachment: Bug 1458827 - Add more information about RemoteSettings for developers

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

Comment 3

[Ethan Glasser-Camp (:glasserc)]

Comment on attachment 8972943 [details]
Bug 1458827 - Add more information about RemoteSettings for developers

https://reviewboard.mozilla.org/r/241492/#review247328

Looks great! Highly polished, very mature.

Comment 4

[:Gijs (he/him)]

Comment on attachment 8972943 [details]
Bug 1458827 - Add more information about RemoteSettings for developers

https://reviewboard.mozilla.org/r/241492/#review247524

Thanks!

::: services/common/docs/RemoteSettings.rst:201
(Diff revision 1)
> +
> +.. code-block:: js
> +
> +    const BlocklistClients = ChromeUtils.import("resource://services-common/blocklist-clients.js", {});
> +
> +    BlocklistClients.initialize();

Is this sync or async?

Comment 5

[Mathieu Leplatre [:leplatrem]]

Comment on attachment 8972943 [details]
Bug 1458827 - Add more information about RemoteSettings for developers

https://reviewboard.mozilla.org/r/241492/#review247524

> Is this sync or async?

This is sync
(see https://searchfox.org/mozilla-central/rev/c0d81882c7941c4ff13a50603e37095cdab0d1ea/services/common/blocklist-clients.js#136-171)

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a9c753c1bb5d
Add more information about RemoteSettings for developers r=Gijs,glasserc

Comment 7

[Natalia Csoregi [:nataliaCs]]

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