QA/Sync/Client/Sync Timers: Difference between revisions

From MozillaWiki
< QA‎ | Sync
Jump to navigation Jump to search
mNo edit summary
(fixed name of variable, commented out the other outdated variables for now, some appear to be removed, some renamed. If you know the other variable names, please add!)
Line 28: Line 28:


= Sync Client Timers and Schedulers =
= Sync Client Timers and Schedulers =
The Sync client has several configurations, found in about:config, that control "how often" syncs are triggered. Below are a list of those configurations and how they affect Syncs timing behavior.
The Sync client has a configuration, found in about:config, that controls "how often" syncs are triggered. Below is that configuration and how it affects Syncs timing behavior.
<!--
== services.sync.scheduler.singleDeviceInterval ==
== services.sync.scheduler.singleDeviceInterval ==
This config is followed only for sync accounts that have a single device connected.
This config is followed only for sync accounts that have a single device connected.
Line 41: Line 41:
* value = 90 seconds
* value = 90 seconds
* client behavior - Whenever a new item is synced to a client (from the cloud/other client), the next sync will occur in 90 seconds.  
* client behavior - Whenever a new item is synced to a client (from the cloud/other client), the next sync will occur in 90 seconds.  
 
-->
== services.sync.scheduler.activeInterval ==
== services.sync.syncInterval ==
* value = 600 seconds (10 minutes)
* value = 600 seconds (10 minutes)
* client behavior - If the user is active (meaning user is browsing, but not triggering instant syncs or crossing score threshold), then next sync will occur in 10 minutes  
* client behavior - If the user is active (meaning user is browsing, but not triggering instant syncs or crossing score threshold), then next sync will occur in 10 minutes  


== services.sync.syncThreshold ==
*
*
<!--
== services.sync.scheduler.idleTime ==
== services.sync.scheduler.idleTime ==
* value = 300 seconds (5 minutes)
* value = 300 seconds (5 minutes)
Line 52: Line 56:
== services.sync.scheduler.idleInterval ==
== services.sync.scheduler.idleInterval ==
* value = 3600 seconds (1 hour)
* value = 3600 seconds (1 hour)
* client behavior - if the user becomes idle, as in above idleTime, the next sync occurs in one hour from time of becoming idle.  
* client behavior - if the user becomes idle, as in above idleTime, the next sync occurs in one hour from time of becoming idle. -->
== ==
Notes:
Notes:
* Returning from idle will trigger an instant sync.
* Returning from idle will trigger an instant sync.

Revision as of 14:03, 28 July 2023

Purpose

  • A high level light weight document to explain client syncing timers/schedulers
  • This document is not intended as guide for planning or development. It is also not intended to detail programming code.
  • This page is a 'Living Document.' It will change. It is intended to reflect functionality of production Sync servers and Sync client on mozilla-central. As such, it will need to be maintained to keep up with functional changes as they occur.

Questions and Comments

  • Please feel free to add information requests inline (or fill gaps yourself)
  • If you have questions or comments regarding this document, contact:
 Tracy Walker
 twalker@mozilla.com
 irc: tracy

Instant Sync Triggers

Bookmarks

The following activities will cause a sync to be triggered instantly (100ms after triggering activity is compete)

  • Add a new bookmark
  • Delete a bookmark
  • alter a bookmark

Passwords

The following activities will cause a sync to be triggered instantly (100ms after triggering activity is compete)

  • Add a new password
  • Delete a password
  • update a password

Notes for instant syncs:

  • Instant syncs will set the next scheduled timer per possible configurations below.

Sync Client Timers and Schedulers

The Sync client has a configuration, found in about:config, that controls "how often" syncs are triggered. Below is that configuration and how it affects Syncs timing behavior.

services.sync.syncInterval

  • value = 600 seconds (10 minutes)
  • client behavior - If the user is active (meaning user is browsing, but not triggering instant syncs or crossing score threshold), then next sync will occur in 10 minutes

services.sync.syncThreshold

Notes:

  • Returning from idle will trigger an instant sync.