Firefox/RemoteSettings: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Add missing title)
(Update the URL for the List of Firefox features powered by RemoteSettings. See https://bugzilla.mozilla.org/show_bug.cgi?id=2004506#c1.)
 
(13 intermediate revisions by 2 users not shown)
Line 2: Line 2:


'''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.
'''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-collection")
  .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 =
= Key Features =
Line 36: Line 14:
* Single endpoint for polling for changes
* Single endpoint for polling for changes
* Client synchronization (diff based, local db)
* Client synchronization (diff based, local db)
* Client-side target filtering (JEXL a-la Normandy)
* Client Telemetry
* Client Telemetry
* Robust protocol (retry, precondition headers, backoff, …)


= Use Cases =
<pre>
const { RemoteSettings } = ChromeUtils.import("resource://services-settings/remote-settings.js", {});


== Main bucket ==
RemoteSettings("my-collection")
  .on("sync", (e) => {
    // e.data.current = [ Record, Record, ... ]
  });
</pre>


{|class="wikitable"
= Resources =
! 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
|}


== Fennec ==
* [https://remote-settings.readthedocs.io Tutorials, screencasts and FAQ]
 
* [https://firefox-source-docs.mozilla.org/main/latest/services/common/services/RemoteSettings.html API client docs] (How to use RemoteSettings in Gecko)
{|class="wikitable"
* [https://mana.mozilla.org/wiki/pages/viewpage.action?pageId=66655528 OPs and staff documentation]  (How to create new collections etc.)
! List
* [https://mozilla.github.io/remote-settings-permissions/ List of Firefox features powered by RemoteSettings]
! Bucket
* [https://bugzilla.mozilla.org/buglist.cgi?product=Cloud%20Services&component=Server%3A%20Remote%20Settings&resolution=---&list_id=14124423 RemoteSettings server bugs list]
! Collection
* [https://bugzilla.mozilla.org/buglist.cgi?product=Firefox&component=Remote%20Settings%20Client&resolution=---&list_id=14124425 RemoteSettings client bugs list]
! Description
* [https://github.com/mozilla/remote-settings Project milestones]
|-
|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
|}
 
See https://bugzilla.mozilla.org/show_bug.cgi?id=1201059
 
== Security state ==
 
{|class="wikitable"
! List
! Bucket
! Collection
! Description
|-
|Cert intermediates constraints
|<code>security-state</code>
|<code>intermediates</code>
|https://bugzilla.mozilla.org/show_bug.cgi?id=1361118
|}
 
== Certificates Pinning ==
 
{|class="wikitable"
! List
! Bucket
! Collection
! Description
|-
|Certificates pinning (HPKP)
|<code>pinning</code>
|<code>pins</code>
|https://bugzilla.mozilla.org/show_bug.cgi?id=787133
|}
 
 
== Blocklists ==
 
The goal is to replace the current system — based on a single XML file downloaded everyday — by several collections.
 
{|class="wikitable"
! List
! 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
|}
 
=== Transition from XML to RemoteSettings ===
 
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.


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/)
== RemoteSettings DevTools ==


* '''phase 1: DONE''': Both mechanisms run in parallel but only the legacy one will be used.
An addon is available to diagnose remote settings synchronization and state. See https://github.com/mozilla/remote-settings-devtools
* '''phase 2: DONE''': The source of truth for blocklist is Kinto but produces the same XML as the legacy one.
* '''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.

Latest revision as of 19:12, 8 December 2025

Firefox Remote Settings

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.

Key Features

  • 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-side target filtering (JEXL a-la Normandy)
  • Client Telemetry
  • Robust protocol (retry, precondition headers, backoff, …)
const { RemoteSettings } = ChromeUtils.import("resource://services-settings/remote-settings.js", {});

RemoteSettings("my-collection")
  .on("sync", (e) => {
    // e.data.current = [ Record, Record, ... ]
  });

Resources

RemoteSettings DevTools

An addon is available to diagnose remote settings synchronization and state. See https://github.com/mozilla/remote-settings-devtools

Retrieved from "https://wiki.mozilla.org/index.php?title=Firefox/RemoteSettings&oldid=1255888"