Firefox/RemoteSettings: Difference between revisions

Firefox/RemoteSettings (view source)

Revision as of 13:31, 26 April 2018

1,630 bytes added , 26 April 2018

no edit summary

Mleplatre

14

edits

@@ Line 1: / Line 1: @@
 = Firefox Remote Settings =
-- [https://mana.mozilla.org/wiki/pages/viewpage.action?pageId=66655528 OPs and staff documentation]  (How to create new collections etc.)
+'''Remote Settings''' is a Mozilla service that makes it easy to manage evergreen settings data in Firefox. [[Firefox/Kinto]] is used for syncing of data. A simple API is available in Firefox for accessing the synchronized data.
+<pre>
+const { RemoteSettings } = ChromeUtils.import("resource://services-common/remote-settings.js", {});
+RemoteSettings("my-key")
+  .on("sync", (e) => {
+    // e.data.current = [ Record, Record, ... ]
+  });
+</pre>
+= Resources =
+* [https://firefox-source-docs.mozilla.org/services/common/services/RemoteSettings.html API client docs] (How to use RemoteSettings in Gecko)
+* [https://mana.mozilla.org/wiki/pages/viewpage.action?pageId=66655528 OPs and staff documentation]  (How to create new collections etc.)
+* [https://bugzilla.mozilla.org/buglist.cgi?product=Cloud%20Services&component=Server%3A%20Remote%20Settings&resolution=---&list_id=14124423 RemoteSettings server bugs list]
+* [https://bugzilla.mozilla.org/buglist.cgi?product=Firefox&component=Remote%20Settings%20Client&resolution=---&list_id=14124425 RemoteSettings client bugs list]
+* [https://github.com/mozilla/remote-settings Project milestones]
+== about:remotesettings ==
+A tool is available to diagnose remote settings synchronization and state. See https://github.com/leplatrem/aboutremotesettings
 = Key Features =
-- TBD
+* Admin UI (generated from data schema)
+* Data history
+* Preview data (QA)
+* Sign-off (review)
+* File attachments
+* Email notifications
+* Content signature (Autograph integration)
+* Single endpoint for polling for changes
+* Client synchronization (diff based, local db)
+* Client Telemetry
-== Fennec assets catalog ==
+= Use Cases =
+== Main bucket ==
+{|class="wikitable"
+! List
+! Collection
+! Description
+|-
+|Activity Stream Tippytop
+|<code>tippytop</code>
+|Hi-res icons for Topsites in Activity Stream
+|-
+|Focus experiments
+|<code>focus-experiments</code>
+|A/B testing of Focus features
+|}
-The goal is to remove the static assets (fonts, hyphenation dicts, etc.) from the distribution package and download them asynchronously using an online Kinto catalog, on the '''remote settings instance'''.
+== Fennec ==
 {|class="wikitable"
@@ Line 15: / Line 62: @@
 ! Bucket
 ! Collection
+! Description
 |-
-|Download catalog
+|Assets catalog
 |<code>fennec</code>
 |<code>catalog</code>
+|The goal is to remove the static assets (fonts, hyphenation dicts, etc.) from the distribution package and download them asynchronously using a remote catalog
+|-
+|Experiments
+|<code>fennec</code>
+|<code>experiments</code>
+|A/B testing of Fennec features
 |}
@@ Line 29: / Line 83: @@
 ! Bucket
 ! Collection
+! Description
 |-
 |Cert intermediates constraints
 |<code>security-state</code>
 |<code>intermediates</code>
+|https://bugzilla.mozilla.org/show_bug.cgi?id=1361118
 |}
@@ Line 41: / Line 97: @@
 ! Bucket
 ! Collection
+! Description
 |-
-|Certificates pinning
+|Certificates pinning (HPKP)
 |<code>pinning</code>
 |<code>pins</code>
+|https://bugzilla.mozilla.org/show_bug.cgi?id=787133
 |}
@@ Line 50: / Line 108: @@
 == Blocklists ==
-The goal is to replace the current system — based on a single XML file downloaded everyday — by several Kinto collections on the '''remote settings instance'''.
+The goal is to replace the current system — based on a single XML file downloaded everyday — by several collections.
 {|class="wikitable"
@@ Line 57: / Line 114: @@
 ! Bucket
 ! Collection
+! Description
 |-
 |OneCRL
 |<code>blocklists</code>
 |<code>certificates</code>
+|SSL certificates blocking / invalidation
 |-
 |Add-ons
 |<code>blocklists</code>
 |<code>addons</code>
+|Malicious blocked extensions
 |-
 |Plugins
 |<code>blocklists</code>
 |<code>plugins</code>
+|Unstable/malicious plugins
 |-
 |Gfx
 |<code>blocklists</code>
 |<code>gfx</code>
-|-
+|Unstable graphical drivers
-|HPKP
-|<code>pinnings</code>
-|<code>pings</code>
 |}
-See https://bugzilla.mozilla.org/show_bug.cgi?id=1197707
+=== Transition from XML to RemoteSettings ===
-=== Transition ===
+Currently the blocklist system relies on a big XML file that is downloaded every day. It contains block entries for certificates to be revoked, addons and plugins to be disabled, and gfx environments that cause problems or crashes.
-Currently the blocklist system relies on a big XML file that is downloaded every day. It contains block entries for certificates to be revoked, addons and plugins to be disabled, and gfx environments that cause problems or crashes. Everything is managed via the Addons server.
 Firefox (and derivatives like Thunderbird, Seamonkey, ...) downloads it on an URL that contains client information (eg. https://blocklist.addons.mozilla.org/blocklist/3/%7Bec8030f7-c20a-464f-9b0e-13a3a9e97384%7D/44.0a1/)
-Using the same XPCOM notification callback, the new mechanism will [https://dxr.mozilla.org/mozilla-central/rev/fc15477ce628599519cb0055f52cc195d640dc94/toolkit/mozapps/extensions/nsBlocklistService.js#632-642 synchronize the local copy of each collection from the remote server].
-If changes are available, the local copy of the data will be updated and content signature verified.
 * '''phase 1: DONE''': Both mechanisms run in parallel but only the legacy one will be used.
 * '''phase 2: DONE''': The source of truth for blocklist is Kinto but produces the same XML as the legacy one.
-* '''phase 3''': Eventually, [https://bugzilla.mozilla.org/show_bug.cgi?id=1257565 blocking mechanism will rely on the data managed via JSON], and the old XML client will be decommissioned.
+* '''phase 3''': The nsBlocklistService should become asynchronous in order to be able to fetch info from remote settings local database
+* '''phase 4''': Eventually, [https://bugzilla.mozilla.org/show_bug.cgi?id=1257565 blocking mechanism will rely on RemoteSettings] entirely and the old XML client will be decommissioned.