MozillaWiki - User contributions [en]

Sync

2026-07-01T18:54:15Z

Ddurst: added link to A-S sync overview

Sync is a storage service and set of client engines that allow clients to share information via a Mozilla Account. This data is stored on Mozilla’s storage server and is end-to-end encrypted; it is encrypted before it leaves the client and cannot be decrypted by Mozilla on the server side. This page should help you find any other information about Sync that users want or need.

=== For general users ===
* Sync at a high level: https://www.mozilla.org/firefox/features/sync/
* SUMO article on Sync with more details and examples: https://support.mozilla.org/kb/sync
* How to choose what Firefox information to sync: https://support.mozilla.org/kb/how-do-i-choose-what-information-sync-firefox

=== For more technical users ===
* Technical details on how Sync works and protects your privacy (2018): https://hacks.mozilla.org/2018/11/firefox-sync-privacy/
* Overview of Sync: https://mozilla.github.io/application-services/book/design/sync-overview.html
* Sync architecture diagrams: https://mozilla.github.io/application-services/book/design/components-strategy.html#high-level-firefox-sync-interactions
* Information on scoped keys involved in Sync and Mozilla Accounts: https://mozilla.github.io/ecosystem-platform/explanation/scoped-keys
* How devices register: https://mozilla.github.io/ecosystem-platform/relying-parties/how-tos/device-registration
* Sync system docs:
** [https://firefox-source-docs.mozilla.org/services/sync/index.html Firefox’s Sync integration] (Firefox source docs)
** [https://mozilla-services.github.io/syncstorage-rs/ Syncstorage-rs server] (mozilla-services.github.io docs)
** [https://mozilla-services.github.io/syncstorage-rs/tokenserver/tokenserver.html Token server] (mozilla-services.github.io docs)
** [https://mozilla.github.io/ecosystem-platform/api Mozilla Accounts API docs]

For more information on the system architecture of Sync, you can read the historical contents of [[CloudServices/Sync|this wiki]].

=== Found a bug? ===
Learn where to [[CloudServices/Sync#Report_Bugs|file bugs]].

Sync

2026-07-01T15:31:30Z

Ddurst: add link to CloudServices/Sync

Sync is a storage service and set of client engines that allow clients to share information via a Mozilla Account. This data is stored on Mozilla’s storage server and is end-to-end encrypted; it is encrypted before it leaves the client and cannot be decrypted by Mozilla on the server side. This page should help you find any other information about Sync that users want or need.

=== For general users ===
* Sync at a high level: https://www.mozilla.org/firefox/features/sync/
* SUMO article on Sync with more details and examples: https://support.mozilla.org/kb/sync
* How to choose what Firefox information to sync: https://support.mozilla.org/kb/how-do-i-choose-what-information-sync-firefox

=== For more technical users ===
* Technical details on how Sync works and protects your privacy (2018): https://hacks.mozilla.org/2018/11/firefox-sync-privacy/
* Sync architecture diagrams: https://mozilla.github.io/application-services/book/design/components-strategy.html#high-level-firefox-sync-interactions
* Information on scoped keys involved in Sync and Mozilla Accounts: https://mozilla.github.io/ecosystem-platform/explanation/scoped-keys
* How devices register: https://mozilla.github.io/ecosystem-platform/relying-parties/how-tos/device-registration
* Sync system docs:
** [https://firefox-source-docs.mozilla.org/services/sync/index.html Firefox’s Sync integration] (Firefox source docs)
** [https://mozilla-services.github.io/syncstorage-rs/ Syncstorage-rs server] (mozilla-services.github.io docs)
** [https://mozilla-services.github.io/syncstorage-rs/tokenserver/tokenserver.html Token server] (mozilla-services.github.io docs)
** [https://mozilla.github.io/ecosystem-platform/api Mozilla Accounts API docs]

For more information on the system architecture of Sync, you can read the historical contents of [[CloudServices/Sync|this wiki]].

=== Found a bug? ===
Learn where to [[CloudServices/Sync#Report_Bugs|file bugs]].

Sync

2026-07-01T15:23:38Z

Ddurst: created, removed redirect

Sync is a storage service and set of client engines that allow clients to share information via a Mozilla Account. This data is stored on Mozilla’s storage server and is end-to-end encrypted; it is encrypted before it leaves the client and cannot be decrypted by Mozilla on the server side. This page should help you find any other information about Sync that users want or need.

=== For general users ===
* Sync at a high level: https://www.mozilla.org/firefox/features/sync/
* SUMO article on Sync with more details and examples: https://support.mozilla.org/kb/sync
* How to choose what Firefox information to sync: https://support.mozilla.org/kb/how-do-i-choose-what-information-sync-firefox

=== For more technical users ===
* Technical details on how Sync works and protects your privacy (2018): https://hacks.mozilla.org/2018/11/firefox-sync-privacy/
* Sync architecture diagrams: https://mozilla.github.io/application-services/book/design/components-strategy.html#high-level-firefox-sync-interactions
* Information on scoped keys involved in Sync and Mozilla Accounts: https://mozilla.github.io/ecosystem-platform/explanation/scoped-keys
* How devices register: https://mozilla.github.io/ecosystem-platform/relying-parties/how-tos/device-registration
* Sync system docs:
** [https://firefox-source-docs.mozilla.org/services/sync/index.html Firefox’s Sync integration] (Firefox source docs)
** [https://mozilla-services.github.io/syncstorage-rs/ Syncstorage-rs server] (mozilla-services.github.io docs)
** [https://mozilla-services.github.io/syncstorage-rs/tokenserver/tokenserver.html Token server] (mozilla-services.github.io docs)
** [https://mozilla.github.io/ecosystem-platform/api Mozilla Accounts API docs]

=== Found a bug? ===
Learn where to [[CloudServices/Sync#Report_Bugs|file bugs]].

Services/Sync/Getting Started

2026-06-29T19:30:25Z

Ddurst: replaced Source Code section links with direct paths to searchfox

= Hacking =

== Source Code ==

Once you have a copy of the Mozilla source tree (read below for how to obtain a copy), you can find the core Sync source code in https://searchfox.org/firefox-main/source/services/sync

This is just the core JavaScript APIs and logic. Additional Sync code for integration with Firefox lives in https://searchfox.org/firefox-main/source/browser/base/content

Look for files with ''sync'' in their name. Files here define the integration between Firefox and Sync. This includes all the Sync UI.

Additionally, Firefox Accounts specific code lives in https://searchfox.org/firefox-main/source/services/fxaccounts

== Debugging Sync ==

If you are debugging Sync in your browser, the first thing you want to do is crank up the logging. In about:config, set the following preferences:

# Enable logging to Error Console
services.sync.log.appender.console Trace

# Enable logging to STDOUT
services.sync.log.appender.dump Trace

# Log full sync logs on sync success (typically they are only saved on failure)
services.sync.log.appender.file.logOnSuccess true

# Enable trace logging for engines
services.sync.log.logger.engine Trace

# (optional) Enable trace logging for all of sync (this is very verbose and will include all request bodies)
services.sync.log.logger Trace

Once you've updated those settings, restart Firefox for them to take effect.

If you are logging to STDOUT, you may want to set the environment variable ''MOZ_QUIET'' to silence a lot of spew from other parts of Firefox:

export MOZ_QUIET=1

You can view full sync logs by opening '''about:sync-log''' in Firefox. Read more about [[Firefox Sync extended logging]] for fetching successful sync event logfiles.

== Building Sync ==

You probably should build using an artifact build, as described [https://firefox-source-docs.mozilla.org/contributing/contribution_quickref.html#bootstrap-a-copy-of-the-firefox-source-code here].

After setting this up, you'll do `mach build` to perform a build, `mach run` to run Firefox, and `mach xpcshell-test /services/sync/tests/unit` to run the sync unit test suite. There's also a separate end-to-end test suite, TPS, which is documented [https://firefox-source-docs.mozilla.org/testing/tps/index.html here]. (For most changes it's sufficient that you run the unit tests.)

Depending on your OS, most changes will not require a rebuild to take effect, only restarting and rerunning via `mach run`.

= Using Bugzilla =

Every code change starts out as a bug in [https://bugzilla.mozilla.org Bugzilla] where the general approach can be discussed. The bug should eventually be assigned to somebody who will upload one or more patches for review. Code can only be reviewed by module owners and their peers; see [[Services/Process/Code_Review|code review policy]] for more information. If the review has been granted and all review comments have been addressed, the patches may be checked into [https://github.com/mozilla-firefox/firefox mozilla-central].

You probably also want to get up to speed on [http://bugzilla.mozilla.org Bugzilla] if you're not already.
* A good start is to go watch [http://vimeo.com/9205730 Jonath's "Bugzilla for Humans" video].
* Sync bugs are found in different places depending on which part of the system they affect. For the service side (syncstorage or tokenserver), bugs will be in [https://github.com/mozilla-services/syncstorage-rs|GitHub]. For the client side, you can find a list of components [CloudServices/Sync#Report_Bugs here].
* Don't forget to add a Bugzilla ID shortcut string to your Bugzilla [https://bugzilla.mozilla.org/userprefs.cgi?tab=account account preferences]. The current standard practice is to append "<whitespace>[:irc_nick]" to your Real Name field.
* You also want to watch the components relevant to your work so you automatically get emails for all bug changes in those components. The expected components where bugs will be filed are listed on [[CloudServices/Sync#Report_Bugs]].
* A useful Firefox add-on that makes life in Bugzilla a bit easier is [https://addons.mozilla.org/en-US/firefox/addon/bugzillajs/ Bugzilla Tweaks]. Highly recommended!



= Using Git =

Various projects exist as Git repositories.

== Configuring Git ==

If this is your first time using Git, you'll need for perform some one-time configuration:

# Configure your global name and email. These will be used for commit info.
$ git config --global user.name "John Doe"
$ git config --global user.email "johndoe@mozilla.com"

# Enable color output for all commands
$ git config --global color.branch auto
$ git config --global color.diff auto
$ git config --global color.grep auto
$ git config --global color.interactive auto
$ git config --global color.status auto
$ git config --global color.ui auto

# Highlight whitespace
$ git config --global core.whitespace "trailing-space,space-before-tab,tab-in-indent"

# Define your editor for commits, other tools
$ git config --global core.editor vim

If you find you have a slow git prompt, you may find the instructions [https://gist.github.com/thomcc/4c23eeed3b248394bffa0bff04f5c00b here] beneficial as well.



= Testing =

* [https://developer.mozilla.org/en/Writing_xpcshell-based_unit_tests Writing xpcshell-based unit testing].
* Sync tests are located at [https://searchfox.org/mozilla-central/source/services/sync/tests/unit/ /services/sync/tests/unit]
* [https://firefox-source-docs.mozilla.org/testing/tps/index.html TPS tests]



= Miscellany =

* You also want to grab a [http://nightly.mozilla.org/ Nightly] build of Firefox. Everybody in the company should be running a nightly build: it's a great way to find bugs before the code goes out to the general public. If you want to run against different profiles (which is useful for development), you will be interested in [https://developer.mozilla.org/en/Command_Line_Options two extra command flags]: "-P and --no-remote"
** -P forces the Profile Picker (You probably want to have more than one.)
** --no-remote allows multiple versions to run on one machine at the same time.

CloudServices/Sync/FxSync/FaviconSync

2026-06-26T20:37:42Z

Ddurst: updated indicator of bugs at the top

= Bugs =

* The (old and current) tracking bug: {{bug|428378}} (open)
* Initial Sync engine implementation: {{bug|675299}} (closed)
* Places changes: {{bug|674238}} (closed)

= Goals =

* Sync favicons for history and bookmarks
* Don't sync history favicons if only bookmark sync is enabled (viceversa not as problematic)

= Coordination =

Important to sync up with the [https://wiki.mozilla.org/Places:Plan Places plan], which involves some schema alterations. mak is keen to reduce space overhead, which will likely see timestamps drop to int32, eliminate or render numeric MIME type values, and store large icons outside of the DB. It would also be nice to unify expiration timestamps and lastModified in the proposed favicon store.

API work should be done in mozIAsyncFavicons, not nsIFaviconService. It's experimental, which means we have more leeway to make changes, and of course it's asynchronous.

= Proposal =

== Firefox (places.sqlite) ==
<pre>
moz_places
id
guid
url
favicon_id -------> foreign key to moz_favicons.id
...

moz_historyvisits
id
place_id ------> foreign key to moz_places.id
visit_date
...

moz_bookmarks
id
guid
type
fk ------> foreign key to moz_places.id
...

moz_favicons
id
url
data
mime_type
expiration
guid (NEW)
lastmodified (NEW? Integrate with expiration?)
</pre>

== Sync ==

<pre>
bookmarks
id (a.k.a. GUID)
bmkUri
...
faviconGUID (NEW)

history
id (a.k.a. GUID)
histUri
title
visits
faviconGUID (NEW)

favicons (NEW)
id (a.k.a. GUID)
url
data
mime_type
expiration?
</pre>

== Implementation ==

*Implement <code>favicons</code> engine with above data schema.
*Add <code>faviconGUID</code> property to bookmarks and history engines, it's synced as follows:

#Find favicon based on <code>faviconGUID</code> a. it exists. Go to 3. b. it doesn't exist. Go to 2.
#Create empty favicon entry with <code>id</code> and <code>guid</code>.
#Refer to favicon id in the <code>moz_places</code> entry.

=== More detailed plan ===

I propose a staged implementation, given dependencies on Places changes. Something a little like this:

# Extend bookmarks and history engines to track faviconURI. We do this instead of GUID as a trivial proof of concept, rather than waiting around.
# Implement favicon engine to sync favicons keyed by URI.
# Implement observers for nsINavHistoryObserver::onPageChanged/nsINavHistoryObserver::ATTRIBUTE_FAVICON to track bookmark/history changes on favicon alteration, and also poke the favicon tracker to ensure that changed favicons get synced up.
# Implement GUIDs for favicons, in line with the Places plan.
# Rejig favicon and other engines to use the GUID instead of the URI. This will, of course, be a breaking change (and we don't want to use URIs in production for privacy reasons), so this will be the first point at which this can be a user-facing feature.
# Reimplement bookmarks and favicons engines using async repository API.
# Switch to using mozIAsyncFavicons instead of nsIFaviconService.

== Questions/Observations ==

*Is a blank entry in moz_favicons (cf. step 2 above) ok?
*How should we model the expiration (if at all)?
*How to access favicon data? Raw SQL r+w? Extend mozIAsyncHistory?
** mozIAsyncFavicons. This API is ours to chop up and extend, with appropriate judgment.
*How can we be notified when a new favicon is added or an existing one is changed?
** Observers. See above.
* How do we tie into or interact with Places' favicon expiration events?
* It would seem to make sense to sync favicons before bookmarks, so as to have favicons present in the DB before they are linked to their bookmark record. We should also take care to keep toolbar/menu icons very much in the working set: synced first, and generally given priority. UX über alles!
** I disagree with that. It would be more useful to see people's bookmark toolbar/menu etc. populated with entries and then add the favicons quickly thereafter... Favicons could probably take considerably more time to sync than bookmarks... But as you say, that's something for UX to decide. --philikon
* Can this scheme easily be extended to work for things like site thumbnails?

Services/Sync1 5/FxASyncPairing

2026-06-26T20:34:59Z

Ddurst: added throw to https://mozilla.github.io/ecosystem-platform and obsoleted content

This page is a historical record that led to [https://mozilla.github.io/ecosystem-platform/relying-parties/tutorials/pairing Mozilla Accounts Pairing authentication].

{{ OBSOLETE_CONTENT }}

== Planning ==

The initial target for this project is to produce '''a demo of pairing two devices using a full-strength key during new account setup'''.

This is so that:

* we have flows to test with users
* we have a better idea of what needs to happen from an engineering point of view
* we can confirm that our approach can be implemented

It will not:

* be deployed to production
* be merged into the real repos
* provide the security / privacy guarantees of the final product

=== Other planning resources ===

* [https://etherpad.mozilla.org/NQHw02pTGv Per-component task breakdown for the real implementation]

== User stories / audience ==

Here are the reasons why users want pairing:

# As an enthusiast, I think that pairing is cool. After a simple ceremony, my things magically get copied from one device to the other.
# As a forgetful user, I want to sync my things without having to type a password.
# As a user, I am fed up with all of these companies requiring me to create accounts with them. I just want to sync my devices, I don't want a Firefox Account.
# '''As a user of Marketplace, I need to type my FxA password often on multiple devices and so my password may not be strong enough to protect my Sync data, which is a lot more personal than my purchase history.'''
# As a privacy wizard, I only want to store my data on Mozilla's servers if it's encrypted using a full-strength key and doesn't require trusting any intermediate servers, even if it means jumping through a few hoops.

The first two would likely involve big changes in how Firefox Accounts currently works and the assumptions it makes. A larger discussion needs to happen before we could prototype a solution for these stories. The last story would only address the needs of a small percentage of our users and so in the interest of increasing security for a large percentage of Firefox users, '''we will consider #4 to be our target audience'''.

== Out of scope ==

Some of the following things are interesting but currently out of scope:

* removing the need for a password in Firefox Accounts
* allowing unverified emails in FxA
* recovery of Sync data if one loses all devices and forgets password (i.e. ''class A'' data)
* escrow of full strength keys to protect against device loss and improper backup practices (e.g. trusted third party or social escrow)
* mitigating the delivery of tampered code to the browser (i.e validating the content server payload or moving it to the client)
* migrating existing Sync 1.1 users onto Sync 1.5 + pairing

== Pairing mechanisms ==

Here are the 4 key exchange mechanisms that have been considered to copy the full-strength key (required by the user story we selected) from the device that generated it to another:

* '''0-bit pairing''': Once a user has logged into their Firefox account on both devices, the class-B keys are used to authenticate a key-agreement protocol. The old device must ask the user for approval, then the full-strength key is pushed to the new device.
* '''Manual key entry''': Users can view or download the key on one device and either type it back onto the second device or import it from a file.
* '''[[Services/KeyExchange|J-PAKE]]''': This is the pairing mechanism that was used in [[Services/Sync|Sync 1.1]]. Pairing is initiated on the first device which displays an ephemeral code. That code must be entered on the second device. No need to type in an email address, all that's needed on the second device is the code.
* '''Barcode''': A way to exchange data from a device to a mobile phone equipped with a camera. There is no need to type anything since the barcode (most likely a 2D barcode or QR code) includes everything needed.
* '''Bluetooth''': Sending the Sync key to another device over [https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API Bluetooth]. This potentially involves enabling Bluetooth devices, making them discoverable and doing Bluetooth pairing before transfering the key.

Here's a comparison of these mechanisms:

{| class="wikitable"
|-
! Pairing mechanism !! Desktop-to-Desktop [1] !! Desktop-to-Mobile !! Desktop-to-Laptop !! Mobile-to-Desktop !! Mobile-to-Mobile !! Mobile-to-Laptop !! Laptop-to-Desktop !! Laptop-to-Mobile !! Laptop-to-Laptop !! Fully kC compliant !! Fully backed up [6]
|-
| Current FxA Sync || yes || yes || yes || yes || yes || yes || yes || yes || yes || no || yes [7]
|-
| 0-bit pairing || no || yes || yes || yes || yes || yes || yes || yes || yes || meh [4] || no
|-
| Manual key entry || yes || meh [2] || yes || meh [3] || meh [2] || meh [3] || yes || meh [2] || yes || yes || yes
|-
| J-PAKE || no || yes || yes || yes || yes || yes || yes || yes || yes || yes || no
|-
| Barcode || no || YES! || meh [5] || no || YES! || meh [5] || no || YES! || meh [5] || yes || no
|-
| Bluetooth || no || meh [8] || meh [8] || meh [8] || yes || yes || meh [8] || yes || yes || yes [9] || no
|}


# requires time shifting since devices may not be in physical proximity
# typing on mobile is not fun
# securely copying files out of a mobile is hard
# using the "kB channel" to copy kC reduces the strength of the key
# using a laptop camera to scan a QR code is hard
# user can recover their data after losing all devices
# users lose their data if they forget their password & lose all devices
# desktop computers frequently don't have Bluetooth or have it disabled
# we're assuming that the Bluetooth channel is confidential and authenticated


In order to cover all different types of pairing and to simplify the most common pairing case (desktop/laptop to mobile), '''we propose implementing: J-PAKE, manual key entry and barcodes.'''

== User flows ==

The following diagram shows all of the proposed pairing mechanisms:

[[File:Fxa-sync--full-strength key pairing.png|900px]]

which excludes the [[Media:Fxa-sync--0-bit pairing.png|0-bit pairing mechanism]].

This diagram expands on what ''opening the Sync settings on the second device'' would look like:

[[File:Sync_settings_on_second_device.png|900px]]

This is how all of the different pairing possibilities would work in practice:

{|class=wikitable
|-
! !! Desktop !! Laptop [1] !! Mobile [2] || ''no 2nd device'' [3]
|-
! Desktop || style="background-color: #FFFFFF;" | [[File:Device_pairing-Desktop-to-Desktop.png|250px|Desktop-to-Desktop]] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Desktop-to-Laptop.png|300px|Desktop-to-Laptop]] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Desktop-to-Mobile.png|200px|Desktop-to-Mobile]] || style="background-color: #FFFFFF;" | [[File:Device pairing-Desktop-only.png|200px|Desktop-only]]
|-
! Laptop [4] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Laptop-to-Desktop.png|300px|Laptop-to-Desktop]] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Laptop-to-Laptop.png|300px|Laptop-to-Laptop]] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Laptop-to-Mobile.png|200px|Laptop-to-Mobile]] || style="background-color: #FFFFFF;" | [[File:Device pairing-Laptop-only.png|200px|Laptop-only]]
|-
! Mobile [4] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Mobile-to-Desktop.png|250px|Mobile-to-Desktop]] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Mobile-to-Laptop.png|250px|Mobile-to-Laptop]] || style="background-color: #FFFFFF;" | [[File:Device_pairing-Mobile-to-Mobile.png|200px|Mobile-to-Mobile]] [5] || style="background-color: #FFFFFF;" | [[File:Device pairing-Mobile-only.png|150px|Mobile-only]] [6]
|}


# also includes tablets without a camera
# also includes tablets with a camera
# this is not pairing, it's just a backup
# also includes tablets
# scanning the QR code displayed on a phone screen can be hard (reflections, changes in screen orientation, etc.) so J-PAKE might be better in this case
# it is unclear how users will get the backup out of the phone since copying or printing files securely is not a solved problem on mobile


=== TODO ===

We need to think about these flows, though they may not be part of the first prototype:

* migrating an existing Sync 1.5 account from password-derived key (''class B'') to full-strength key (''class C'')
* pairing with a third device
* email notifications sent to confirm that new devices are paired
* warnings shown when switching from a password-derived key to a full-strength key
* warnings shown when users setup Sync with a single device and a full-strength key

== UX ==

===Top 5 Pairing Pros===
# No more typing long passwords
# Mobile users short passwords no longer an issue
# "Set it and forget it": no more repeated entries
# Anshin - the feeling of security: Users _feel_ like Mozilla protects their information and thus feel more comfortable using our (awesome) service
# Pairing increases the security of the data (failure point is no longer a low entropy, user created key
# Resetting your password doesn't render previous data inaccessible

===Top 5 Pairing Cons===
# Pairing is hard to understand - users might do it wrong (e.g pairing when they only have 1 device)
# Pairing is hard to understand - it's cognitively taxing: a minute spent on pairing is more taxing than a minute on Reddit
# Knowing when in the flow to introduce pairing is problematic
# Users may be frustrated at why the need a PW if there is pairing

QA/Sync/Test Plan/grinder tests/technical documentation

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/grinder tests/technical documentation to Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests/technical documentation: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests/technical documentation]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests/technical documentation

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/grinder tests/technical documentation to Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests/technical documentation: Old content

=== Testing Technologies ===
* Grinder
** This will be the main test harness. We will write scripts against it using jython and use its built in tools in order to distribute the tests to multiple load generators
** Advantages
*** Distributed (We can use multiple machines to hit a server)
*** Performant (No overhead of booting firefox)
*** Built with HTTP based testing in mind (ideal for REST services including SYNC and beyond)
* MongoDB
** A database with a REST api will be used for data verification. A percentage of requests will get stored in a Mongo database in effort to make sure that our data is accurate at all loads
** Advantages
*** Heavy - it is built to handle many reads/writes per second. Hopefully we won't be load testing MongoDB.
*** REST api we can perform the same steps to communicate with sync as we can to communicate with the database

=== Current Architecture ===
* load-auth.services
** Current load Target
** No Captcha
** No mechanism for creating users
* client[4-9].scl2.svc
** Runs grinder load generater
** Has jython installed
** Direct access to load-auth.services
* Console Controller (any linux/windows computer connected to MPT)
** Controls test execution
** Has created a reverse ssh tunnel into the above grinder client so that the clients can see the grinder console

See the following link for a graphical picture of how grinder systems are setup: [http://grinder.sourceforge.net/g3/getting-started.html#The+Grinder+processes| The Grinder Processes]
n.b. In terms of grinder lingo client[4-9].scl2.svc are agents with multiple workers each.

=== Scripts ===
* Two Modes
** Console mode (dispatched console)
** Command line (single run, for testing)
* Libraries
** Grinder 3
** Jython 2.5.2 (this is important, older versions won't work properly)
** Jyson 1.01 (json parser written in java for jython - only works on jython 2.5+)

n.b. In terms of grinder lingo client[4-9].scl2.svc are agents with multiple workers each.

QA/Sync/Test Plan/grinder tests

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/grinder tests to Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/grinder tests to Services/Sync/Server/Archived/QA/Sync/Test Plan/grinder tests: Old content

NOTE: This site is deprecated since we now have Funkload tests for Sync, AITC, and TokenServer.

== Overview ==
We would like to have a test framework that tests the sync servers for load and functionality. For this, we will use Grinder in order to mimic the action of many firefox clients simultaneously.

;We are trying to accomplish the following goals:
*Create a continuous baseline testing framework (tied to Jenkins)
*Be able to answer questions about current and future growth.
** How can our app fail now?
** What types of services can we support in the future?

== Test Cases ==
=== Questions Addressed By This System ===
;Load Testing
*How does the app fail under high load conditions? How does it fail?
**From a large data input?
**From a lot of connections?
*Which functions and potential use cases create a particularly high amount of load?
**High amounts of registration? (and corresponding initial sync?)
**Lots of empty requests? (as generated by instant sync?)
*Are any functions effected sooner by high load? (I.E. Are there any unexpected bottlenecks?)
*How do these services scale to
** More Features
** More Users

;Regression Testing
* Baseline tests on a sandboxed environemnt
** Did the code we just checked in have bugs that effect performance?
* Large scale weekly testing
** Are we confident this new release will work will in production?

=== Test scripts ===
The objective of these scripts is to match our use of the sync api as closely as possible to that of the firefox client. The [https://wiki.mozilla.org/Services/Sync/Server/API/Storage/1.1 Sync API] is a fairly general storage solution - the behavior of the firefox client needs to be mimicked. A client object has been created as a mechanism to mimick the actions of a firefox client in grinder. The following functions are used to manipulate the test client to preform tasks a server normally recieves.
* Create User
* Add Data - these functions simulate a user creating data
** Tabs
*** Tabs are a whole different system - they aren't stored in memory
** Bookmarks
** History
** Preferences
** Passwords
* Delete Data
* Sync - These functions simulate the client going to the sync server and performing the sync routine
** Standard Sync
** Mobile Sync (Takes data in chunks of 50, processes them, and then asks for more)
* Reset Sync Command (Clears DB and creates new records)
** Change sync key

New functions can be added as new services are rolled out. A lot of potential use cases will be able to be simulated by this system. For example a dupes test could be run by syncing the same data multiple times with serperate client objects.

=== Script use patterns ===
We currently have the ability to go through the logs and see how the sync server is being used. We can generate a profile based on this and do load testing that way. In addition, we can add scenarios that model other use cases. For example:
* A period with above normal registrations
* A period with high amounts of data payload
* Lots of small requests (what instant sync would give us)
A config file or some time of user interface will be required so that we can "turn knobs" to simulate different scenarios. The possibility to test different scenarios is limitless. One of the main uses for this down the road could be to test the potential impact of new services as they are developed.

== Technologies ==
=== Testing Technologies ===
* Grinder
** This will be the main test harness. We will write scripts against it using jython and use its built in tools in order to distribute the tests to multiple load generators
** Advantages
*** Distributed (We can use multiple machines to hit a server)
*** Performant (No overhead of booting firefox)
*** Built with HTTP based testing in mind (ideal for REST services including SYNC and beyond)
* MongoDB
** A database with a REST api will be used for data verification. A percentage of requests will get stored in a Mongo database in effort to make sure that our data is accurate at all loads
** Advantages
*** Heavy - it is built to handle many reads/writes per second. Hopefully we won't be load testing MongoDB.
*** REST api we can perform the same steps to communicate with sync as we can to communicate with the database

=== Important features of the sync system ===
* Load Balancer - Zeus
** Will protect us from connection overrun
** Questions about how it responds under high load condition and how firefox responds to that
** Extremely scalable (will likely never be a bottle neck)
* Back end application
** Currently in PHP, will be migrated to python
** Questions about through put of data
* Database Server
** Currently has a large cache (this means we need a lot of tests before we are truly in a production type environment)

QA/Sync/Test Plan/Test Level Summaries

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/Test Level Summaries to Services/Sync/Server/Archived/QA/Sync/Test Plan/Test Level Summaries: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/Test Level Summaries]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/Test Level Summaries

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/Test Level Summaries to Services/Sync/Server/Archived/QA/Sync/Test Plan/Test Level Summaries: Old content

= Overview =
Call out manual tests run for each level of Sync release train testing. Not intended to define test case steps to reproduce.

= Client =
Tests run for Sync as it is built into Firefox
== Smoketests ==
definition: This set of tests is run to ensure the most basic and essential sync features work correctly
* ensure setup of a new account through the wizard works correctly
* ensure sync of each data type engine completes successfully
* ensure deactivate this account works correctly

== Smoketests plus ==
definition: This is the above smoketests plus any tests related to bug fixes. ie. if bookmarks sync was touched, run all of the bookmarks sync basic functional tests.

== Basic Functional Tests ==
definition: This set of tests is run to ensure every sync feature works correctly. It is of greater depth and breadth than the smoketests.
* smoketests
* ensure adding and removing data for each engine syncs correctly
* ensure Fx UI pieces (Sync Icon, Tools Menu Item, Discoverability, etc) work correctly
* ensure about:sync-tabs (Tabs From Other Computers) page works correctly
* ensure each section of Sync Preferences (Options) works correctly
* ensure about:sync-log works correctly

= Servers =
Since several different servers are involved, when referring to the lists below, keep in mind the server type under test.

== Smoketests ==
definition: ensure the most basic and essential server features work correctly
* create a new sync account ((s)reg)
* add a client to existing account via the easy setup path. (pake)
* add a client to existing account via the reg path (don't have the other device with me). ((s)reg)
* delete an account (a.p. and (s)reg)

== Smoketests plus ==
definition: This is the above smoketests plus any tests related to bug fixes. ie. if easy setup was touched, run all of the easy setup basic functional tests.

== Basic Functional Tests ==
This set of tests is run to ensure every server feature works correctly. It is of greater depth and breadth than the smoketests.
* smoketests
* ensure all Manage Account items in Sync Preferences (options) work correctly (a.p. and (s)reg)
* Log in to and ensure all items of Account Portal (https://account.services.mozilla.com/) work correctly (a.p.)
* ensure timeout or cancel out of easy setup works correctly (pake)
* ensure failure paths in setup wizard work correctly. ie. Forgotten Password. ((s)reg)

QA/Sync/Test Plan/1.7

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.7 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.7: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/1.7]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/1.7

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.7 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.7: Old content

;1.7 Sync Test Plan

= Overview =

A point release of of Firefox Sync Extension. Primarily polish and performance release to get the add-on right up to snuff with Fx developments. Will also disable itself when on Fx with built in sync.

== Builds ==

*[https://addons.mozilla.org/en-US/firefox/addon/10868 Released Version via AMO] - When pushed live.
*[https://ftp.mozilla.org/pub/mozilla.org/labs/weave/development/1.7.x/ development version of the extension]

= Testing strategy =

*Verification, where possible, of noted bugs (delta to 1.6.3) - tracy:
** {{bug|637777}} ''verified''
 

== 1.7 ==
*Run Fx Sync [https://litmus.mozilla.org/run_tests.cgi?test_run_id=83 Litmus smoketests] cross platform:
**Win 7: 3.5.16 + sync 1.7 - tracy - '''Pass'''
**Win XP: 3.6.13 + sync 1.7 - tracy - '''Pass'''
**Linux: 3.5.16 + sync 1.7 - tracy - '''Pass'''
**Mac: 3.6.13 + sync 1.7 - tracy - '''Pass'''
**Fennec: 4.0b4 + sync 1.7 - tchung/AaronMT - '''Pass'''
**Litmus testing notes:
***

*Upgrade testing:
**Win 7: 3.5.16 + sync 1.5.1 -> sync 1.7 - tracy - '''Pass'''
**Linux: 3.5.16 + sync 1.6.3 -> sync 1.7 - tracy - '''Pass'''
**Mac: 3.6.13 + sync 1.6.3 -> sync 1.7 - tracy - '''Pass'''
**Fennec: 4.0b4 + sync 1.6.3 -> sync 1.7 - tchung/AaronMT - '''Pass'''

* Major Update testing
**Win XP: 3.6.13 + sync 1.7 -> Fx4rc1 - tracy - '''Pass'''
**Linux: 3.5.16 + sync 1.7 -> Fx4rc1 - tracy - '''Pass'''
**Mac: 3.6.13 + sync 1.7 -> Fx4rc1 - tracy - '''Pass'''
** revert back for each to ensure add-on becomes re-enabled. - '''Pass'''
**Upgrade testing notes:
***

*Locale testing (install and quick spotcheck)
**Win 7: de - tracy - '''Pass'''
**Linux: es-ES - tracy - '''Pass'''
**Mac: ja-JP - tracy - '''Pass'''
**Locale testing notes:
***

= Schedule =
* Builds to QA: 3/8/2011
* QA sign-off: 3/9/2011
* Release: 3/9/2011

QA/Sync/Test Plan/1.6.3

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.6.3 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.3: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.3]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.3

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.6.3 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.3: Old content

;1.6.3 Sync Test Plan

= Overview =

A point release of of Firefox Sync Extension. Primarily Places and performance related fixes.

== Builds ==

*[https://addons.mozilla.org/en-US/firefox/addon/10868 Released Version via AMO] - When pushed live.
*[https://ftp.mozilla.org/pub/mozilla.org/labs/weave/development/1.6.x/weave-1.6.3-dev.xpi development version of the extension]

= Testing strategy =

*Verification, where possible, of noted bugs (delta to 1.6.2) - tracy:
**{{Bug|627490}} - Bookmark sync: don't cache places IDs - '''qa-'''
**{{Bug|626796}} - Bookmark sync: restore from backup should trigger reupload - '''verified'''
**{{Bug|627497}} - Bookmark sync in Firefox 3.5/3.6: copied items need to get their own GUIDs - '''reopened'''
**{{Bug|610501}} - Places smart bookmarks are mishandled by Sync - '''verified'''
**{{Bug|609380}} - Password sync: don't add apply records with both a httpRealm and formSubmitURL or null/empty passwords
**{{Bug|620593}} - Username should allow leading and trailing whitespace '''verified'''
 

== 1.6.3-rel ==
*Run Fx Sync [https://litmus.mozilla.org/run_tests.cgi?test_run_id=83 Litmus smoketests] cross platform:
**Win XP: 3.6.13 + sync 1.6.3 - tracy '''Pass'''
**Linux: 3.5.16 + sync 1.6.3 - tracy '''Pass'''
**Mac: 3.6.13 + sync 1.6.3 - tracy '''Pass'''
**Litmus testing notes:
*** {{bug|627166}} - captcha dialog in some locales doesn't show Next button '''fix in 609160 was applied Fx trunk code not the extension'''

== 1.6.3b2 ==
*Run Fx Sync [https://litmus.mozilla.org/run_tests.cgi?test_run_id=83 Litmus smoketests] cross platform:
**Win 7: 3.5.16 + sync 1.6.3 - tracy '''Fail''' - ''with noted bug''
**Win XP: 3.6.13 + sync 1.6.3 - tracy '''Pass'''
**Linux: 3.5.16 + sync 1.6.3 - tracy '''Pass'''
**Mac: 3.6.13 + sync 1.6.3 - tracy '''Pass'''
**Fennec: 4.0b4 + sync 1.6.3 - aaron '''Pass'''
**Litmus testing notes:
***{{bug|631361}} - Sync failing with: bookmarks failed: NS_ERROR_ILLEGAL_VALUE JS ''(this was since mark WFM -unable to reproduce)''

*Upgrade testing:
**Win 7: 3.5.16 + sync 1.6.2 -> sync 1.6.3 - tracy '''Pass'''
**Win XP: 3.6.13 + sync 1.5.1 -> sync 1.6.3 - tracy '''Pass'''
**Linux: 3.5.16 + sync 1.5.1 -> sync 1.6.3 - tracy '''Pass'''
**Mac: 3.6.13 + sync 1.6.2 -> sync 1.6.3 - tracy '''Pass'''
**Fennec: 4.0b4 + sync 1.6.2 -> sync 1.6.3 - aaron '''Pass'''
**Upgrade testing notes:
***

*Locale testing (install and quick Smoketest)
**Win 7: de - tracy '''Pass'''
**Win XP: fr - tracy '''Pass''' - ''with noted bug''
**Linux: es-ES - tracy '''Pass'''
**Mac: ja-JP - tracy '''Pass''' - ''with noted bug''
**Locale testing notes:
*** {{bug|627166}} - captcha dialog in some locales doesn't show Next button

= Schedule =
* Builds to QA: 2011-02-03
* QA sign-off: morning of 2011-02-04
* Release: 2011-02-04

QA/Sync/Test Plan/1.6.2

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.6.2 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.2: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.2]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.2

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.6.2 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6.2: Old content

;1.6.2 Sync Test Plan

= Overview =

A point release of of Firefox Sync Extension. Primarily Places and performance related fixes.

== Builds ==

*[https://addons.mozilla.org/en-US/firefox/addon/10868 Released Version via AMO] - When pushed live.
*[https://ftp.mozilla.org/pub/mozilla.org/labs/weave/development/1.6.x/weave-1.6.2-dev.xpi development version of the extension]

= Testing strategy =

* Verification of noted bugs - tracy:
**{{Bug|621594}} - History sync: failure when title is null (verified)
**{{Bug|621489}} - Make sure to call _orderChildren even if _processIncoming fails (pending)
**{{Bug|597400}} - Form engine: item is undefined (verified)
**{{Bug|619162}} - meta.payload is undefined in WeaveSvc__remoteSetup
**{{Bug|623375}} - History sync: failure on javascript: URLs (verified)
**{{Bug|623418}} - Bookmark sync: don't record children in annotation (verified)
**{{Bug|618403}} - Orphan reparenting too aggressive, can lead to double bookmarks on storage version upgrade. (verified)
**{{Bug|623742}} - Addon UI: Add a device link goes to the wrong SUMO article (verified)

* Run Fx Sync [https://litmus.mozilla.org/run_tests.cgi?test_run_id=83 Litmus BFT's] cross platform:
** Win 7: 3.6.13 + sync 1.6.2 - tracy '''(Pass)'''
** Win XP: 3.5.16 + sync 1.6.2 - tracy '''(Pass)'''
** Linux: 3.6.13 + sync 1.6.2 - tracy '''(Pass)'''
** Mac: 3.6.13 + sync 1.6,2 - tracy '''(Pass)'''
** Fennec: 1.1 + sync 1.6.2 - tchung '''(PASS)'''
** Fennec: 4.0b3 + sync 1.6.2 (on desktop) - tchung '''(PASS)'''
** Litmus testing notes:
***
***

* Upgrade testing:
** Win 7: 3.6.13 + sync 1.6.1 -> sync 1.6.2 - tracy '''(Pass)'''
** Win XP: 3.5.16 + sync 1.5.1 -> sync 1.6.2 - tracy '''(Pass)'''
** Linux: 3.6.13 + sync 1.5.1 -> sync 1.6.2 - tracy '''(Pass)'''
** Mac: 3.6.13 + sync 1.6.1 -> sync 1.6.2 - tracy '''(Pass)'''
** Fennec: 1.1 + sync 1.6.1 -> sync 1.6.2 - tchung '''(PASS)'''
** Upgrade testing notes:
***
***

* Locale testing (install and quick Smoketest)
** Win 7: de - tracy '''(Pass)'''
** Win XP: fr - tracy '''(Pass)'''
** Linux: es-ES - tracy '''(Pass)'''
** Mac: ja-JP - tracy '''(Pass)''' - with noted bug
** Fennec: zh-CH - tchung '''(n/a)'''
** Locale testing notes:
*** {{bug|627166}} - captcha dialog in ja-JP doesn't show Next button
***

= Schedule =
* Builds to QA: 2011-01-18
* QA sign-off: morning of 2011-01-20
* Release: 2011-01-20

QA/Sync/Test Plan/1.6

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.6 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6]]

Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan/1.6 to Services/Sync/Server/Archived/QA/Sync/Test Plan/1.6: Old content

;1.6 Sync Test Plan

= Overview =

This release of Sync is on a critical path with Firefox 4, Fennec and Home. Two major areas of concern are simplified crypto and JPAKE. The former requiring a storage version bump. The later making a significant change in account setup and adding additional clients to use that account. We want to ensure both the new and old methods work and interact without disruption.

== Builds ==

*[https://addons.mozilla.org/en-US/firefox/addon/10868 Released Version via AMO]
*[https://ftp.mozilla.org/pub/mozilla.org/labs/weave/development/1.6.x/ beta versions of the extension]
*[http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/latest-mozilla-central/ latest minefield beta8pre builds]
* [https://ftp.mozilla.org/pub/mozilla.org/labs/weave/development/1.6.x/weave-1.6-dev.xpi Sync 1.6 release]

= Quick Testplan for 1.6 release =
* [https://ftp.mozilla.org/pub/mozilla.org/labs/weave/development/1.6.x/weave-1.6-dev.xpi Sync 1.6 release] Extension
** Please file bugs in Mozilla Services::Sync with whiteboard "[sync1.6]"
** The Easy Setup UI screen is '''not''' in the extension. Please use Fallback setup method.
* Run [https://litmus.mozilla.org/run_tests.cgi?test_run_id=83 Sync Litmus tests] on different platforms:
** Win 7: 3.6.13 + sync 1.6 '''tchung (PASS)'''
** Win 7: 4.0b7 + sync 1.6 '''tchung (PASS)'''
** Fennec: 1.1 + sync 1.6 '''tchung''' (PASS)'''
** Win XP: 3.5.16 + sync 1.6 '''tchung (PASS)'''
** Linux: 3.6.13 + sync 1.6 '''juanb (Pass)'''
** Mac: 3.6.13 + sync 1.6 '''juanb (Pass)'''
** Mac: 4.0b7 + sync 1.6 '''juanb (Pass)'''
*** At some point I saw this in the console, when having only tabs checkbox selected. It only happened on initial sync: Error: win.gFxWeaveGlue is undefined Source File: chrome://weave/content/firefox/tabs.js Line: 14
* Update tests,
** Win 7: 3.6.13 + sync 1.5.1 -> sync 1.6 '''tchung (PASS)'''
** Win 7: 4.0b7 (should get an error to [https://services.mozilla.com/update/ update to beta 8]) '''tchung (PASS)'''
** Fennec: 1.1 + sync 1.5.1 -> sync 1.6 '''tchung''' (PASS)'''
** Win XP: 3.5.16 + sync 1.5.1 -> sync 1.6 '''tchung (PASS)'''
** Linux: 3.6.13 + sync 1.5.1 -> sync 1.6 '''juanb (Pass)'''
** Mac: 3.6.13 + sync 1.5.1 -> sync 1.6 '''juanb (Pass)'''
** Mac: 4.0b7 (should get an error to [https://services.mozilla.com/update/ update to beta 8]) '''juanb (Pass)'''
* Notes/Bugs
** (tchung) results
*** Confirmed {{Bug|548819}} Weave utils.js produces error after syncing when trying to call onBeginUpdateBatch and onEndUpdateBatch
*** Filed {{Bug|620593}} Username should allow leading and trailing whitespace
*** Filed {{Bug|620591}} Exception thrown when updating to sync 1.6 on Fx3.5.16/Fx3.6.13

= Test Strategy =

* '''Pass''' - Server testing. (tracy, ops)
** passed QA against stage, but issues revealed in production.
* '''Desktop testing complete, waiting on Mobile''' - With the help of the Waverly team, we'll want to ensure the critical upgrade paths (due to crypto version bump) and JPAKE account setups work properly. This testing will be tracked on [https://spreadsheets.google.com/ccc?key=0AocUyLHteCtSdHNyLUVpUWpHdDlvWklwYmVaa2JMVXc&hl=en&authkey=CJHPjucM#gid=0 this spreadsheet] (Waverly, tracy and tony)
** [https://bugzilla.mozilla.org/show_bug.cgi?id=618042 Bug 618042] - Sync Key change fails - FIXED in 1.6b3
** [https://bugzilla.mozilla.org/show_bug.cgi?id=618336 Bug 618336] - '''Crummy experience adding latest storage version client to an existing storage version 3 client''' ''we've made support aware of this one''
** [https://bugzilla.mozilla.org/show_bug.cgi?id=618068 Bug 618068] - Cipher finalize failed on startup
* '''In progress''' - Bug fix verifications (tracy)
* '''Desktop testing complete, waiting on Mobile''' Run cross platform the funtional bfts (with particular focus on Bookmarks sync) for Fennec, Home, Firefox, and extension
** Fx4 (tracy)
*** Windows ''' Pass''' - I believe the captcha bug may be machine dependent. (couldn't repro on lab Win 7 machine)
*** Mac - '''Pass'''
*** Linux - '''Pass'''
** 1.6 extension on 3.5/6 (tracy)
*** Windows '''Pass'''
*** Mac - '''Pass'''
*** Linux - '''Pass'''
** Fennec (tony)
*** Fennec 1.1 (maemo) - '''Pass'''
*** Fennec 4.0b3 (android) - '''Pass'''
**** tests apply only with a desktop build+sync 1.6 for jpake setup
** Home (tony)
*** tests apply only with a desktop build+sync 1.6 for jpake setup
*** [https://wiki.mozilla.org/QA/Weave_Test_Plan/FirefoxHome/1.1_testplan test plan here]
** Bugs of note:
*** [https://bugzilla.mozilla.org/show_bug.cgi?id=564296 Bug 564296] - Form data deletes don't sync
*** [https://bugzilla.mozilla.org/show_bug.cgi?id=596399 Bug 564296] - Text input field not visible in captcha dialog.

* '''Pass''' - Ensure functionality of pages at Mozilla Services websites (eg. https://services.mozilla.com/) (tracy)
* '''Pass with untranslated strings''' l10n spot checks against a few tier 1 locales. (tracy) -
** not sure that these are actually expected to be complete. es-ES looked fine, however, de wasn't completely translated. [https://bugzilla.mozilla.org/show_bug.cgi?id=619796 bug 619796] - Connect portion of Sync Setup dialogs are untranslated
* unit tests on crossweave?
* Accessibility? (marco)
* host a sync testday after beta launches (not during all-hands, possibly 12/22) (tracy)

= Schedule Scoping =

* Targeting for release 2010-12-?? (when beta8 release for built-in and Extension)

QA/Sync/Test Plan

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan to Services/Sync/Server/Archived/QA/Sync/Test Plan: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Test Plan]]

Services/Sync/Server/Archived/QA/Sync/Test Plan

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Test Plan to Services/Sync/Server/Archived/QA/Sync/Test Plan: Old content

= Overview =
Outline Quality Assurance plan to adapt to structured development cycles for [https://wiki.mozilla.org/Services/Process/MergingBetweenBranches Sync client] and [https://wiki.mozilla.org/Services/Process/ServerReleaseProcess Sync Servers].
Both parts of Sync have moved to a weekly cycle of fixes and pushes. This plan shows how QA will handle those weekly trains.

= Client =
== Weekly client pushes of s-c to m-c ==
Sync client fixes are made on the services-central branch. Once per week, on Monday, those fixes will be handed off to QA for testing. Unless specifically required by dev/ops, testing of client fixes should occur against the stable production servers.

=== Testing strategy ===
* Verify fixes per bug STR's
* Run the set of manual [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests_plus smoketests plus] cross platforms to ensure basic Sync functionality has not regressed due to the new fixes.
* Against the Wednesday m-c (Nightly) build, re-verify fixes and run [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests smoketests] and [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Basic_Functional_Tests Basic Functional Test groups] related to current fixes to ensure no merge issues regressed Sync on Nightly channel

=== Schedule ===
* Builds to QA: Monday
* QA sign-off: EOD Tuesday
* s-c push to m-c: Tuesday EOD
* QA sign-off of m-c: Wednesday EOD

== Channel progression ==
Being a built into Firefox service, Sync will follow along with FxN

=== Schedule ===
The schedule follows the FxN schedule through the channel progression of releases.

=== Testing strategy ===
* Nightly - See the s-c to m-c push plan above.
* Aurora - Run Sync [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Basic_Functional_Tests Basic Functional Tests] one week prior the channel merge.
** note: handle specific direct landing to Aurora on a case by case basis.
* Beta - Run Sync [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests smoketests] post build.
* Release
** Run Sync [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests smoketests] on release candidate builds.
** Upgrade testing when available
** Major Update testing when available
** Locale testing - install and quick spot check a few Tier1 locales

= Servers =
Sync server fixes are made on the staging server(s). Once per week, on Wednesday, those fixes will be handed off to QA for testing. Testing for Sync server, registration server, PAKE server and Account Portal can be required for any or all of them depending on fixes going in that week. Note: per the release process docs, Crossweave and load testing will be performed by Server Ops as necessary. Testing approach to each piece is outlined below.

== Sync server ==
* Staging server is https://stage-auth.services.mozilla.com/
* Verify fixes per bug STR's
* Run the set of manual [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests_plus_2 smoketest plus] cross platforms to ensure basic Sync functionality has not regressed due to the new fixes.

== Registration Servers ==
* Staging server is https://stage-auth.services.mozilla.com/
* Verify fixes per bug STR's
* Run the set of manual [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests_plus_2 smoketests plus] cross platforms to ensure basic account registration functionality has not regressed due to the new fixes.

== PAKE Server ==
* Update about:config (restart required) services.sync.jpake.serverURL to https://stage-setup.services.mozilla.com/
* Verify fixes per bug STR's
* Run manual easy setup [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests_plus_2 smoketests plus] across devices to ensure functionality has not regressed due to the new fixes.

== Account Portal ==
* Stage Account Portal is https://stage-account.services.mozilla.com/
* Verify fixes per bug STR's
* Run the set of manual [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Smoketests_plus_2 smoketest plus] to ensure account management functionality has not regressed due to the new fixes.

=== Schedule ===
* Builds to QA: Wednesday
* QA sign-off: EOD Friday
* Push from stage to production will happen during the maintenance window on Mondays, 3-5pm Pacific time. (QA to be on hand for live spot checks to help verify the push was a success)

== Load Testing ==
* Working with ops team to improve grinder tests to better mimic real world conditions
* Detailed testing strategies and processes can be found here:[https://wiki.mozilla.org/QA/Sync/Test_Plan/grinder_tests Grinder Tests]

QA/Sync/Sync Server Install Ubuntu

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install Ubuntu to Services/Sync/Server/Archived/QA/Sync/Sync Server Install Ubuntu: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install Ubuntu]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install Ubuntu

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install Ubuntu to Services/Sync/Server/Archived/QA/Sync/Sync Server Install Ubuntu: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

Note: This site has been deprecated. See the following links:
https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_On_Ubuntu_10_04
https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_On_Ubuntu_11_04
https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_On_Ubuntu_11_10

= Notes for Installing Sync Server on Ubuntu 10.04 or 10.10 64bit with Python 2.6.5 =
REF: http://docs.services.mozilla.com/howtos/run-sync.html

== General Notes ==
* The "Building the server" steps can be repeated for each new build you want to test.
* Once it is running, you can point to it for your own Sync server.

* It is highly recommended that Python 2.6.6 be installed before proceeding with the Sync install.
* Python 2.7 appears to be compatible, but the pre-packaged installer assumes 2.6.6.
* Also, it is highly recommended that the developer tools are installed after installing Python 2.6.6.

== Installing the Developer Tools ==
To get a full development environment on the box, do the following:
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python2.6 distribute_setup.py
$ sudo easy_install-2.6 MoPyTools

== Keeping the build logs ==
Run the "make build" step as follows:
$ make build 1> buildlog.log 2> builderr.err

== Using Sqlite3 ==
If sqlite3 is to be used, the server-full/etc/sync.conf file must be edited to change the default location of the temp.db file. The default location is in /tmp, which will get wiped at each system boot/restart.

== Installing Sync Server, FireFox, and MySQL ==
* Required packages
** Python, python-dev, python-virtualenv
** sqlite3 or mysql
** mercurial

* Run the following to make sure everything is installed:
$sudo apt-get install python-dev mercurial sqlite3 python-virtualenv

* Verify the package installs and versions
$ which sqlite3
$ sqlite3 --version
$ which hg
$ hg --version
$ which python
$ python -V

* Install FireFox 5.01
By default Ubuntu comes with FireFox 3.6.18 (or similar). In order to use Sync Server, FireFox 5 should be installed. The following steps are probably overkill, but they do get FireFox installed
$ sudo add-apt-repository ppa:ubuntu-mozilla-security/ppa
$ sudo add-apt-repository ppa:mozillateam/firefox-stable
$ sudo apt-get update
$ sudo apt-get upgrade
$ which firefox

* Clone and Build the Sync Server
$ cd $home
$ hg clone https://hg.mozilla.org/services/server-full
$ cd server-full
$ make build

== Start the Sync Server ==
* Run the following command (see the wiki page) for more information
$ cd $home/server-full
$ bin/paster serve development.ini
or
$ nohup bin/paster serve development.ini 1>> syncserver.log 2>>syncserver.log &
While running, the Sync Server messages/events will print to STDOUT and STDERR.
This command will run the server outside of any login session and save STDOUT and STDERR to a log file.

* If the Server is running correctly, you should see something like this
Starting server in PID 3568.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

== Installing and Using MySQL Server ==
Run the following commands to install and configure the necessary packages
$ sudo apt-get install mysql-server
root pwd: set the password for root
$ sudo apt-get install libmysqlclient-dev

* Now install mysql-python
$bin/easy_install Mysql-Python

* Enter MySQL to set up a database for the Sync Server
$ mysql -u root -p
(enter the root password set above)
mysql> CREATE DATABASE syncdb;
mysql> \quit

* Edit the sync.conf file to use MySQL instead of sqlite3
$ cd server-full/etc
$ vi or vim or emacs sync.conf
Change both sqluri entries
sqluri = mysql://user:password@server/database
where "user" is the current user on this install
"password" is the mysql password for this user
"server" is just localhost
"database" is a default or new database for use with the Sync server

== Start the Sync Server ==
* Run the following command (see the wiki page) for more information
$ bin/paster serve development.ini
$ nohup bin/paster serve development.ini 1>> syncserver.log 2>>syncserver.log &
While running, the Sync Server messages/events will print to STDOUT and STDERR.
This command will run the server outside of any login session and save STDOUT and STDERR to a log file.

* If the Server is running correctly, you should see something like this
Starting server in PID 3568.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

= Restarting MySQL after System Restart =
* Possible lines for autostarting MySQL server on boot
$ sudo /etc/init.d/mysqld start ## use restart after update
## OR ##
$ sudo service mysqld start ## use restart after update
$ sudo chkconfig --levels 235 mysqld on

= Rebuilding and Deploying the Sync Server =
* Kill the Sync Server process
$ kill -9 <PID>
(Leave MySQL running)
* Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011)
* Repeat the build and deploy steps from above
* Make the necessary changes in the server-full/etc/sync.conf file:
* Change the sqluri entries
* Restart the server using the "nohup" command from above
* Test the service to verify everything is running correctly

For more advanced configurations, including web server support, please see the following documentation:
* http://docs.services.mozilla.com/howtos/run-sync.html
For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation:
* http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Sync Server Install On Ubuntu 11 10

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install On Ubuntu 11 10 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 10: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 10]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 10

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install On Ubuntu 11 10 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 10: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

== Installing Sync Server on Ubuntu 11.10 64-Bit ==

=== ISO Source ===
* http://releases.ubuntu.com/
* Example: http://releases.ubuntu.com/oneiric/ubuntu-11.10-desktop-amd64.iso

=== Using Python 2.7 ===
* The default version of Python on Ubuntu 11.10 is 2.7.x
* Sync Server assumes a python version of 2.6.6, but newer versions can be used for testing purposes.
* If you want to install a local copy of Python 2.6.6 to match the Sync Server requirements, you can follow these basic steps:
Install Python 2.6.6 in a local or public directory
Create a symbolic link from /usr/bin/python2.6 to the bin/python2.6 file in the local install folder
Example:
/usr/bin/python2.6 -> /home/mozilla/python2.6.6/bin/python2.6
Install the python virtualenv for 2.6.6
Create a symbolic link from /usr/bin/virtualenv-2.6 to the bin/virtualenv file in the install folder
Example:
/usr/bin/virtualenv-2.6 -> /home/mozilla/python2.6.6/bin/virtualenv

=== Pre-Installed Packages ===
The following applications should already be installed on Ubuntu 11.10:
* FireFox
* Python
* make
* gcc

$ firefox -V
Mozilla Firefox 5.0

$ python -V
Python 2.7.1+

$ which make
/usr/bin/make

$ make --version
GNU Make 3.81
Copyright (C) 2006 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This program built for x86_64-pc-linux-gnu

$ which gcc
/usr/bin/gcc

$ gcc --version
gcc (Ubuntu/Linaro 4.6.1-9ubuntu3) 4.6.1
Copyright (C) 2011 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

=== Required Packages ===
The following packages are required before installing Sync Server:
* Mecurial
* Sqlite3
* make
* gcc

The following packages are optional, but highly recommended:
* MySQL-Server
$ which hg; hg --version
$ which sqlite3; sqlite3 --version
$ which mysql; mysql --version

=== Install Python Tools and Developer Tools ===
$ cd $home
$ which python
/usr/bin/python
$ python -V
Python 2.7.1+

* So, you need to install the Python Tools, Developer Tools, and the virtualenv for 2.7
$ sudo apt-get install python-dev python-virtualenv

* And, then the rest of the Python Tools:
$ sudo apt-get install curl
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python distribute_setup.py
$ sudo easy_install-2.7 MoPyTools

=== Install Mercurial and Sqlite3 ===
* The sqlite3 install is good for quick testing the Sync Server.

$ which hg; hg --version
/usr/bin/hg
Mercurial Distributed SCM (version 1.9.1)
(see http://mercurial.selenic.com for more information)
Copyright (C) 2005-2011 Matt Mackall and others
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

$ which sqlite3; sqlite3 --version
/usr/bin/sqlite3
$ sqlite3 --version
3.7.7 2011-06-23 19:49:22 4374b7e83ea0a3fbc3691f9c0c936272862f32f2

=== Install MySQL-Server and the Client Library ===
* Install MySQL-Server and/or Client if you will not be using sqlite3
* Note: The client library install may actually be an optional step.
$ sudo apt-get install mysql-server
Note: installer should ask for a root password for MySQL-Server

$ which mysql; mysql --version
/usr/bin/mysql
mysql Ver 14.14 Distrib 5.1.61, for debian-linux-gnu (x86_64) using readline 6.2

$ ps aux | grep sql
mysql 15793 0.1 4.8 170304 24252 ? Ssl 16:43 0:00 /usr/sbin/mysqld

* And now the (optional) client library:
$ sudo apt-get install libmysqlclient-dev

=== Clone and Build the Sync Server ===
* Clone and build the Sync Server in your home directory, or in some other directory if it will be used by others:
$ cd $home
$ hg clone https://hg.mozilla.org/services/server-full
$ cd server-full
$ make build

* Finally, install MySQL-Python (harmless install if you using sqlite3):
$ cd server-full
$ bin/easy_install Mysql-Python

=== Configure the Sync Server for sqlite3 ===
* Configure server-full/etc/sync.conf to use sqlite3 for quick testing.
Change the default db file and directory in the sync.conf file:
$ cd server-full
$ vi etc/sync.conf
Change the following two lines:
From: sqluri = sqlite:////tmp/test.db
To: sqluri = sqlite:////home/<YOUR HOME>/sync.db
(or to some other directory outside of /tmp)

=== Start and Verify the Sync Server ===
* Open a terminal and start up the Sync Server (from the server-full directory)
$ cd server-full
$ bin/paster serve development.ini

* Verify the server is up and running:
Starting server in PID <SOME PID>.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

* Open a second terminal and check the Sync Server host using curl:
$ curl http://127.0.0.1:5000
This should return a 404 error if it is working correctly
(the 404 Not Found error will be within some html returned to STDOUT/STDERR)
Alternatively:
$ curl http://127.0.0.1:5000 > check.html

* From the first terminal you should see some server activity from this curl call, for example:
2012-04-17 17:31:17,643 INFO [syncserver] 127.0.0.1 - - [17/Apr/2012:17:31:17 -0700] "GET / HTTP/1.1" 404 154 "-" "curl/7.21.6 (x86_64-pc-linux-gnu) libcurl/7.21.6 OpenSSL/1.0.0e zlib/1.2.3.4 libidn/1.22 librtmp/2.3"
127.0.0.1 - - [17/Apr/2012:17:31:17 -0700] "GET / HTTP/1.1" 404 154 "-" "curl/7.21.6 (x86_64-pc-linux-gnu) libcurl/7.21.6 OpenSSL/1.0.0e zlib/1.2.3.4 libidn/1.22 librtmp/2.3"

* Check the Sync Server host using HTTP:
From an open browser:
http://127.0.0.1:5000/user/1.0/a
This should return a '0' to the browser if it is working correctly

* Again, you should see some server activity as a result of the http call:
2012-04-17 17:34:22,467 INFO [syncserver] 127.0.0.1 - - [17/Apr/2012:17:34:22 -0700] "GET /user/1.0/a HTTP/1.1" 200 1 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:11.0) Gecko/20100101 Firefox/11.0"
127.0.0.1 - - [17/Apr/2012:17:34:22 -0700] "GET /user/1.0/a HTTP/1.1" 200 1 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:11.0) Gecko/20100101 Firefox/11.0"

* Stop the Sync Server:
From the first terminal window:
Ctrl-C

=== Configure MySQL and the sync.conf file ===
* You can optionally use MySQL instead of sqlite3.
* Configure MySQL with a root password and add a test sync DB:
$ mysql -u root -p

* If your MySQL install does not already have a root password, do the following:
mysql> UPDATE mysql.user set Password=PASSWORD('myrootpwd') WHERE User='root';
mysql> FLUSH PRIVILEGES

* Now set up a sync db for testing:
mysql> CREATE DATABASE syncdb;
mysql> \quit

* Configure server-full/etc/sync.conf to use MySQL for testing:
$ cd server-full
$ vi etc/sync.conf
Change the following two lines:
From: sqluri = sqlite:////<YOUR DIR>/sync.db
To: sqluri = mysql://root:<ROOT PWD>@localhost/<DB NAME>
Example for root password of "myrootpwd" and sync DB on localhost (from above steps):
sqluri = mysql://root:myrootpwd@localhost/syncdb

* Restart the Sync Server:
$ bin/paster serve development.ini

* Notes: If you want to run the Sync Server outside of any login session, you can try the following:
$ nohup bin/paster server development.ini &

== Running the Sync 1.1 Tests ==
* Once the build is complete, you can run the test as follows.
* Note: the server does not need to be running.
* Note: this works for sqlite3 and mysql configurations.
$ make test

* If everything runs as expected, you should see the following:
bin/nosetests -s --with-xunit deps/server-core/services/tests
deps/server-reg/syncreg/tests deps/server-storage/syncstorage/tests
............................................................etc.......
----------------------------------------------------------------------
Ran 177 tests in 33.031s
OK

* The tests are located in the following directories:
** server-full/deps/*/*/tests
* Note: Remember to cleanup after the test by deleted some db files in /tmp
rm /tmp/sync.db /tmp/tests*.db

== Re-building and Re-deploying the Sync Server ==
* To re-build and re-deploy the sync server, you can try these steps:
Kill the Sync Server process
$ kill -9 <Sync Server PID>
(Leave MySQL running if you are using it)
Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ cd ..
(one level up from server-full directory)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011)
Repeat the build and deploy steps from above
Make the necessary changes in the server-full/etc/sync.conf file:
Change the sqluri entries
Restart the server

== Redeploying a Live Server ==
* The following steps can be used to redeploy a live sync server
$ cd /path/to/server-full
$ hg pull -uv
$ make build
$ apachectl graceful

* This should be sufficient, as "make build" will pull and update the repositories underneath the "deps" directory.
* There is also a "make update" target which will update only the dependent repositories, without rebuilding any of the third-party dependencies from PyPi.
* Also note that the Makefile will build the production channel by default, meaning this will not update you to the very latest checked-in changes but rather to the latest tags. If instead you want to deploy the very latest code, then use this line instead:
$ make build CHANNEL=dev

* NOTE: More specific redeployment ideas can be found on this great site:
** http://www.wenks.ch/fabian/mozilla-custom-sync-server/#Updating%20the%20Sync%20Server

== Using your Sync Server as a FireFox Sync Custom Host ==
* You can use your own Sync server as a custom host for FireFox Sync:
Start up your Sync Server (see instructions above)
Open the FireFox browser
Select Tools > Set Up Sync > Create a New Account
Fill in the necessary information for Login and Password
For the Server field, select Custom Host and type in the following
http://127.0.0.1:5000/
(make sure to include the trailing "/" character)
Click Next
* You should now be set up to sync using your custom host.
* Checking the terminal where you started the host, you should see sync messages similar to the following:
2012-04-17 17:55:14,433 INFO [syncserver] 127.0.0.1 - - [17/Apr/2012:17:55:14 -0700] "GET /user/1.0/a HTTP/1.1" 200 1 "-" "Firefox/11.0 FxSync/1.14.0.20120310010316.desktop"
127.0.0.1 - - [17/Apr/2012:17:55:14 -0700] "GET /user/1.0/a HTTP/1.1" 200 1 "-" "Firefox/11.0 FxSync/1.14.0.20120310010316.desktop"
2012-04-17 17:55:14,439 INFO [syncserver] 127.0.0.1 - - [17/Apr/2012:17:55:14 -0700] "GET /user/1.0/<YOUR USER ID> HTTP/1.1" 200 1 "-" "Firefox/11.0 FxSync/1.14.0.20120310010316.desktop"
127.0.0.1 - - [17/Apr/2012:17:55:14 -0700] "GET /user/1.0/<YOUR USER ID> HTTP/1.1" 200 1 "-" "Firefox/11.0 FxSync/1.14.0.20120310010316.desktop"
2012-04-17 17:55:14,446 INFO [syncserver] 127.0.0.1 - - [17/Apr/2012:17:55:14 -0700] "GET /misc/1.0/captcha_html HTTP/1.1" 404 175 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:11.0) Gecko/20100101 Firefox/11.0"
127.0.0.1 - - [17/Apr/2012:17:55:14 -0700] "GET /misc/1.0/captcha_html HTTP/1.1" 404 175 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:11.0) Gecko/20100101 Firefox/11.0"
2012-04-17 17:55:20,472 WARNI [syncserver] Unicode response returned from: syncreg.controllers.user - create_user
Unicode response returned from: syncreg.controllers.user - create_user
...etc...

* Extra credit: if you run your sync server behind a web service, it will be publicly available to other devices for some true syncing...

== For more information ==
* For more advanced configurations, including web server support, please see the following documentation: http://docs.services.mozilla.com/howtos/run-sync.html

* And another good site for installing/configuring sync server: http://www.wenks.ch/fabian/mozilla-custom-sync-server/

* For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation: http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Sync Server Install On Ubuntu 11 04

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install On Ubuntu 11 04 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 04: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 04]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 04

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install On Ubuntu 11 04 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 11 04: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

= Installing Sync Server on Ubuntu 11.04 64-Bit =

== ISO Source ==
http://releases.ubuntu.com/

Example: http://releases.ubuntu.com/natty/ubuntu-11.04-desktop-amd64.iso

== Using Python 2.7 ==
The default version of Python on Ubuntu 11.04 is 2.7.1+

Sync Server assumes a python version of 2.6.6, but newer versions can be used for testing purposes.

If you want to install a local copy of Python 2.6.6 to match the Sync Server requirements, you can follow these basic steps:

# Install Python 2.6.6 in a local or public directory
# Create a symbolic link from /usr/bin/python2.6 to the bin/python2.6 file in the local install folder
Example:
/usr/bin/python2.6 -> /home/mozilla/python2.6.6/bin/python2.6
# Install the python virtualenv for 2.6.6
# Create a symbolic link from /usr/bin/virtualenv-2.6 to the bin/virtualenv file in the install folder
Example:
/usr/bin/virtualenv-2.6 -> /home/mozilla/python2.6.6/bin/virtualenv

== Pre-Installed Packages ==
The following applications should already be installed on Ubuntu 11.04:
* FireFox
* Python
* make
* gcc

$ firefox -V
Mozilla Firefox 5.0
$ python -V
Python 2.7.1+
$ which make
/usr/bin/make
$ make --version
GNU Make 3.81
Copyright (C) 2006 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This program built for x86_64-pc-linux-gnu
$ which gcc
/usr/bin/gcc
$ gcc --version
gcc (Ubuntu/Linaro 4.5.2-8ubuntu4) 4.5.2
Copyright (C) 2010 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

== Required Packages ==
The following packages are required before installing Sync Server:
* Mecurial
* Sqlite3
* make
* gcc

The following packages are optional, but highly recommended:
* MySQL-Server

$ which hg
$ which sqlite3
$ which mysql

[[Media:Ubuntu11_04BeforeSnapshot.jpg]]

== Install Python Tools and Developer Tools ==
$ cd $home
$ which python
/usr/bin/python
$ python -V
Python 2.7.1+

So, you need to install the Python Tools, Developer Tools, and the virtualenv for 2.7

$ sudo apt-get install python-dev python-virtualenv

And, then the rest of the Python Tools:

$ sudo apt-get install curl
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python distribute_setup.py
$ sudo easy_install-2.7 MoPyTools

[[Media:Ubuntu11_04Output1.pdf]]

== Install Mercurial and Sqlite3 ==
The sqlite3 install is good for quick testing the Sync Server.

$ which hg
/usr/bin/hg
$ hg --version
Mercurial Distributed SCM (version 1.7.5)
(see http://mercurial.selenic.com for more information)
Copyright (C) 2005-2010 Matt Mackall and others
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
$ which sqlite3
/usr/bin/sqlite3
$ sqlite3 --version
3.7.4

[[Media:Ubuntu11_04Output2.pdf]]

== Install MySQL-Server and the Client Library ==

The client library install may actually be an optional step.

$ sudo apt-get install mysql-server
Note: installer should ask for a root password for MySQL-Server
$ which mysql
/usr/bin/mysql
$ mysql --version
mysql Ver 14.14 Distrib 5.1.54, for debian-linux-gnu (x86_64) using readline 6.2
$ ps aux | grep sql
mysql 15793 0.1 4.8 170304 24252 ? Ssl 16:43 0:00 /usr/sbin/mysqld
mozroot 15890 0.0 0.2 13124 1048 pts/0 S+ 16:45 0:00 grep --color=auto sql

And now the (optional) client library:

$ sudo apt-get install libmysqlclient-dev

[[Media:Ubuntu11_04Output3.pdf]]

== Clone and Build the Sync Server ==
Clone and build the Sync Server in your home directory, or in some other directory if it will be used by others:

$ cd $home
$ hg clone https://hg.mozilla.org/services/server-full
$ cd server-full
$ make build

[[Media:Ubuntu11_04ServerInstall1.jpg]]

Finally, install MySQL-Python:

$ cd server-full
$ bin/easy_install Mysql-Python

[[Media:Ubuntu11_104MySqlPython.jpg]]

== Configure the Sync Server for sqlite3 ==
Configure server-full/etc/sync.conf to use sqlite3 for quick testing.

Change the default db file and directory in the sync.conf file:
$ cd server-full
$ vi etc/sync.conf
Change the following two lines:
From: sqluri = sqlite:////tmp/test.db
To: sqluri = sqlite:////home/<YOUR HOME>/sync.db
(or to some other directory outside of /tmp)

== Start and Verify the Sync Server ==
Start up the Sync Server (from the server-full directory)

$ bin/paster serve development.ini

Verify the server is up and running:
Starting server in PID <SOME PID>.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

[[Media:Ubuntu11_04ServerStartup.jpg]]

Check the Sync Server host using curl:

Open a new terminal window:
$ curl http://127.0.0.1:5000
This should return a 404 error if it is working correctly
(the 404 Not Found error will be within some html returned to STDOUT/STDERR)
Alternatively:
$ curl http://127.0.0.1:5000 > check.html

Check the Sync Server host using HTTP:

From an open browser:
http://127.0.0.1:5000/user/1.0/a
This should return a '0' if it is working correctly

[[Media:Ubuntu11_04ServerTest.jpg]]

Both of these should generate Sync Server INFO messages to STDOUT/STDERR (from the terminal running Sync Server).

[[Media:Ubuntu11_04ServerINFOMessages.jpg]]

Stop the Sync Server:
From the first terminal window:
Ctrl-C

== Configure MySQL and the sync.conf file ==
Configure MySQL with a root password and add a test sync DB:
$ mysql -u root -p

If your MySQL install does not already have a root password, do the following:

mysql> UPDATE mysql.user set Password=PASSWORD('mozroot') WHERE User='root';
mysql> FLUSH PRIVILEGES

Now set up a sync db for testing:

mysql> CREATE DATABASE syncdb;
mysql> \quit

Configure server-full/etc/sync.conf to use MySQL for testing:

$ cd server-full
$ vi etc/sync.conf
Change the following two lines:
From: sqluri = sqlite:////<YOUR DIR>/sync.db
To: sqluri = mysql://root:<ROOT PWD>@localhost/<DB NAME>
Example for root password of "mozroot" and sync DB on localhaost (from above steps):
sqluri = mysql://root:mozroot@localhost/syncdb

Restart the Sync Server:

$ bin/paster serve development.ini

Notes: If you want to run the Sync Server outside of any login session, you can try the following:

$ nohup bin/paster server development.ini &

= Running the Sync 1.1 Tests =
* Once the build is complete, you can run the test as follows
$ make test
* If everything runs as expected, you should see the following:
bin/nosetests -s --with-xunit deps/server-core/services/tests
deps/server-reg/syncreg/tests deps/server-storage/syncstorage/tests
............................................................etc.......
----------------------------------------------------------------------
Ran 177 tests in 33.031s
OK
* The tests are located in the following directories:
** server-full/deps/*/*/tests
* Note: Remember to cleanup after the test by deleted some db files in /tmp
rm /tmp/sync.db /tmp/tests*.db

= Re-building and Re-deploying the Sync Server =
To re-build and re-deploy the sync server, you can try these steps:

Kill the Sync Server process
$ kill -9 <Sync Server PID>
(Leave MySQL running)
Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ cd ..
(one level up from server-full directory)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011
Repeat the build and deploy steps from above
Make the necessary changes in the server-full/etc/sync.conf file:
Change the sqluri entries
Restart the server

= Redeploying a Live Server =
* The following steps can be used to redeploy a live sync server
$ cd /path/to/server-full
$ hg pull -uv
$ make build
$ apachectl graceful

* This should be sufficient, as "make build" will pull and update the repositories underneath the "deps" directory.
* There is also a "make update" target which will update only the dependent repositories, without rebuilding any of the third-party dependencies from PyPi.
* Also note that the Makefile will build the production channel by default, meaning this will not update you to the very latest checked-in changes but rather to the latest tags. If instead you want to deploy the very latest code, then use this line instead:
$ make build CHANNEL=dev

* NOTE: More specific redeployment ideas can be found on this great site:
** http://www.wenks.ch/fabian/mozilla-custom-sync-server/#Updating%20the%20Sync%20Server

= For more information =
For more advanced configurations, including web server support, please see the following documentation: http://docs.services.mozilla.com/howtos/run-sync.html

For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation: http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Sync Server Install On Ubuntu 10 04

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install On Ubuntu 10 04 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 10 04: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 10 04]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 10 04

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install On Ubuntu 10 04 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install On Ubuntu 10 04: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

= Installing Sync Server on Ubuntu 10.10 64-bit=

== ISO Source ==
http://releases.ubuntu.com/

Example: http://releases.ubuntu.com/10.10/ubuntu-10.10-desktop-amd64.iso

== Pre-Installed Packages ==
The following applications should already be installed on Ubuntu 10.04 and 10.10:

$ firefox -V
Mozilla Firefox 3.6.18, Copyright (c) 1998 - 2011 mozilla.org
(So, this will need to be upgraded or manually installed to FireFox 5)
$ python -V
Python 2.6.6

== Required Packages ==
The following packages are required before installing Sync Server:
* Mecurial
* Sqlite3
* make
* gcc

The following packages are optional, but highly recommended:
* MySQL-Server

$ which hg
$ which sqlite3
$ which mysql

$ which make
/usr/bin/make
$ make --version
GNU Make 3.81
Copyright (C) 2006 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This program built for x86_64-pc-linux-gnu

$ which gcc
/usr/bin/gcc
$ gcc --version
gcc (Ubuntu/Linaro 4.4.4-14ubuntu5) 4.4.5
Copyright (C) 2010 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

[[Media:Ubuntu10_10BeforeSnapshot.jpg]]

== Initial/Required Installations ==
Upgrade to or manually install FireFox 5.01
Pulling the build from the Mozilla public releases site:
http://releases.mozilla.org/pub/mozilla.org/firefox/releases/5.0.1/linux-x86_64/en-US/firefox-5.0.1.tar.bz2
Install FireFox to your home directory or other public directory if you are not the only user...
$ cd $home
$ wget http://releases.mozilla.org/pub/mozilla.org/firefox/releases/5.0.1/linux-x86_64/en-US/firefox-5.0.1.tar.bz2
$ tar xvjf firefox-5.0.1.tar.bz2
$ cd firefox
$ which firefox
Compare that to
$ which ./firefox
$ firefox -V
Compare that to the following:
$ ./firefox -V

So, the recommendation is to either run FireFox 5 from its own directory, or add this directory to the front of your PATH.

Now, run firefox from this folder and verify it starts and the version is correct.
$ ./firefox

[[Media:Ubuntu10_10FireFoxInstall1.jpg]]

[[Media:Ubuntu10_10FireFoxInstall2.jpg]]

[[Media:Ubuntu10_10FireFoxInstall3.jpg]]

== Install Python Tools and Developer Tools ==
$ cd $home
$ which python
/usr/bin/python
$ python -V
Python 2.6.6

So, you need to install the Python Tools, Developer Tools, and the virtualenv for 2.6.6.

$ sudo apt-get install python-dev python-virtualenv

And, then the rest of the Python Tools:

$ sudo apt-get install curl
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python2.6 distribute_setup.py
$ sudo easy_install-2.6 MoPyTools

[[Media:Ubuntu10_10Output1.pdf]]

== Install Mercurial and Sqlite3 ==
The sqlite3 install is good for quick testing the Sync Server.

$ sudo apt-get install mercurial sqlite3
$ which hg
/usr/bin/hg
$ hg --version
Mercurial Distributed SCM (version 1.6.3)
Copyright (C) 2005-2010 Matt Mackall <mpm@selenic.com> and others
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
$ which sqlite3
/usr/bin/sqlite3
$ sqlite3 --version
3.7.2

[[Media:Ubuntu10_10Output2.pdf]]

== Install MySQL-Server and the Client Library ==
The client library install may actually be an optional step.

$ sudo apt-get install mysql-server
$ which mysql
/usr/bin/mysql
$ mysql --version
mysql Ver 14.14 Distrib 5.1.49, for debian-linux-gnu (x86_64) using readline 6.1
$ ps aux | grep sql
mysql 4234 0.2 4.7 188292 24196 ? Ssl 21:01 0:00 /usr/sbin/mysqld
mozroot 4323 0.0 0.1 8952 876 pts/0 S+ 21:02 0:00 grep --color=auto sql

And now the (optional) client library:

$ sudo apt-get install libmysqlclient-dev

[[Media:Ubuntu10_10Output3.pdf]]

== Clone and Build the Sync Server ==
Clone and build the Sync Server in your home directory, or in some other directory if it will be used by others:
$ cd $home
$ hg clone https://hg.mozilla.org/services/server-full
$ cd server-full
$ make build

[[Media:Ubuntu10_10ServerInstall1.jpg]]

Finally, install MySQL-Python

$ cd server-full
$ bin/easy_install Mysql-Python

[[Media:Ubuntu10_10MySqlPython.jpg]]

== Configure the Sync Server for sqlite3 ==
Configure server-full/etc/sync.conf to use sqlite3 for quick testing.

Change the default db file and directory in the sync.conf file:
$ cd server-full
$ vi etc/sync.conf
Change the following two lines:
From: sqluri = sqlite:////tmp/test.db
To: sqluri = sqlite:////home/<YOUR HOME>/sync.db
(or to some other directory outside of /tmp)

== Start and Verify the Sync Server ==
Start up the Sync Server (from the server-full directory)

$ bin/paster serve development.ini

Verify the server is up and running:
Starting server in PID <SOME PID>.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

[[Media:Ubuntu10_10ServerStartup.jpg]]

Check the Sync Server host using curl:

Open a new terminal window:
$ curl http://127.0.0.1:5000
This should return a 404 error if it is working correctly
(the 404 Not Found error will be within some html returned to STDOUT/STDERR)
Alternatively:
$ curl http://127.0.0.1:5000 > check.html

Check the Sync Server host using HTTP:

From an open browser:
http://127.0.0.1:5000/user/1.0/a
This should return a '0' if it is working correctly

Both of these should generate Sync Server INFO messages to STDOUT/STDERR (from the terminal running Sync Server).

[[Media:Ubuntu10_10ServerINFOMessages.jpg]]

Stop the Sync Server:
From the first terminal window:
type ctrl-c

== Configure MySQL and the sync.conf file ==
Configure MySQL with a root password and add a test sync DB:
$ mysql -u root -p

If your MySQL install does not already have a root password, do the following:

mysql> UPDATE mysql.user set Password=PASSWORD('mozroot') WHERE User='root';
mysql> FLUSH PRIVILEGES

Now set up a sync db for testing:

mysql> CREATE DATABASE syncdb;
mysql> \quit

Configure server-full/etc/sync.conf to use MySQL for testing:

$ cd server-full
$ vi etc/sync.conf
Change the following two lines:
From: sqluri = sqlite:////<YOUR DIR>/sync.db
To: sqluri = mysql://root:<ROOT PWD>@localhost/<DB NAME>
Example for root password of "mozroot" and sync DB on localhaost (from above steps):
sqluri = mysql://root:mozroot@localhost/syncdb

Restart the Sync Server:

$ bin/paster serve development.ini

Notes: If you want to run the Sync Server outside of any login session, you can try the following:

$ nohup bin/paster server development.ini &

= Running the Sync 1.1 Tests =
* Once the build is complete, you can run the test as follows
$ make test
* If everything runs as expected, you should see the following:
bin/nosetests -s --with-xunit deps/server-core/services/tests
deps/server-reg/syncreg/tests deps/server-storage/syncstorage/tests
............................................................etc.......
----------------------------------------------------------------------
Ran 177 tests in 33.031s
OK
* The tests are located in the following directories:
** server-full/deps/*/*/tests
* Note: Remember to cleanup after the test by deleted some db files in /tmp
rm /tmp/sync.db /tmp/tests*.db

= Re-building and Re-deploying the Sync Server =
To re-build and re-deploy the sync server, you can try these steps:

Kill the Sync Server process
$ kill -9 <Sync Server PID>
(Leave MySQL running)
Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ cd ..
(one level up from server-full directory)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011
Repeat the build and deploy steps from above
Make the necessary changes in the server-full/etc/sync.conf file:
Change the sqluri entries
Restart the server

= Redeploying a Live Server =
* The following steps can be used to redeploy a live sync server
$ cd /path/to/server-full
$ hg pull -uv
$ make build
$ apachectl graceful

* This should be sufficient, as "make build" will pull and update the repositories underneath the "deps" directory.
* There is also a "make update" target which will update only the dependent repositories, without rebuilding any of the third-party dependencies from PyPi.
* Also note that the Makefile will build the production channel by default, meaning this will not update you to the very latest checked-in changes but rather to the latest tags. If instead you want to deploy the very latest code, then use this line instead:
$ make build CHANNEL=dev

* NOTE: More specific redeployment ideas can be found on this great site:
** http://www.wenks.ch/fabian/mozilla-custom-sync-server/#Updating%20the%20Sync%20Server

= For more information =
For more advanced configurations, including web server support, please see the following documentation: http://docs.services.mozilla.com/howtos/run-sync.html

For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation: http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Sync Server Install Fedora

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install Fedora to Services/Sync/Server/Archived/QA/Sync/Sync Server Install Fedora: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install Fedora]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install Fedora

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install Fedora to Services/Sync/Server/Archived/QA/Sync/Sync Server Install Fedora: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

= Notes for Installing Sync Server on Fedora 15 =
REF: http://docs.services.mozilla.com/howtos/run-sync.html

== General Notes ==
* The "Building the server" steps can be repeated for each new build you want to test.
* Once it is running, you can point to it for your own Sync server.

* It is highly recommended that Python 2.6.6 be installed before proceeding with the Sync install.
* Python 2.7 appears to be compatible, but the pre-packaged installer assumes 2.6.6.
* Also, it is highly recommended that the developer tools are installed after installing Python 2.6.6.

== Installing the Developer Tools ==
To get a full development environment on the box, do the following:
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python2.6 distribute_setup.py
$ sudo easy_install-2.6 MoPyTools

== Keeping the build logs ==
Run the "make build" step as follows:
$ make build 1> buildlog.log 2> builderr.err

== Using Sqlite3 ==
If sqlite3 is to be used, the server-full/etc/sync.conf file must be edited to change the default location of the temp.db file. The default location is in /tmp, which will get wiped at each system boot/restart.

== Installing Sync Server ==
Assuming the prerequisites have been met, following the clone, build, and make steps from the link above.

== Configuring Sync Server to use MySQL ==
The Sync Server can be re-configured to use MySQL instead of Sqlite3.

* Install MySQL
$ sudo yum install mysql, mysql-devel, mysql-server
Note: mysql-python will also have to be installed since Fedora 15 does not pre-install this package.
$ cd server_full
$ bin/easy_install MySQL-Python

* Start MySQL
$ sudo /etc/init.d/mysqld start
(will ask for the root password, if set)
will show something like the following:
Server version: 5.5.13 MySQL Community Server (GPL)
or
mysql Ver 14.14 Distrib 5.5.14, for Linux (i686) using readline 5.1

* Run the following to enter mysql:
$ mysql -u root -p
There may be no password yet (in which case the password field is blank)

* If there is no password, run following to create one
mysql> UPDATE mysql.user set Password=PASSWORD('mozroot') WHERE User='root';
mysql> FLUSH PRIVILEGES
then
mysql> \quit

* While in mysql, create a database for use with SyncServer
mysql> CREATE DATABASE syncdb;
mysql> \quit

* Change two lines in the server-full/etc/sync.conf file
Original:
sqluri = sqlite:////tmp/test.db
Updated:
sqluri = mysql://user:password@server/database
where "user" is the current user on this install
"password" is the mysql password for this user
"server" is just localhost
"database" is a default or new database for use with the Sync server

== Start the Sync Server ==
* Run the following command (see the wiki page) for more information
$ bin/paster serve development.ini
or
$ nohup bin/paster serve development.ini 1>> syncserver.log 2>>syncserver.log &
While running, the Sync Server messages/events will print to STDOUT and STDERR.
This command will run the server outside of any login session and save STDOUT and STDERR to a log file.

* If the Server is running correctly, you should see something like this
Starting server in PID 3568.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

= Running the Sync 1.1 Tests =
* Once the build is complete, you can run the test as follows
$ make test
* If everything runs as expected, you should see the following:
bin/nosetests -s --with-xunit deps/server-core/services/tests
deps/server-reg/syncreg/tests deps/server-storage/syncstorage/tests
............................................................etc.......
----------------------------------------------------------------------
Ran 177 tests in 33.031s
OK
* The tests are located in the following directories:
** server-full/deps/*/*/tests
* Note: Remember to cleanup after the test by deleted some db files in /tmp
rm /tmp/sync.db /tmp/tests*.db

= Restarting MySQL after System Restart =
* Possible lines for autostarting MySQL server on boot
$ sudo /etc/init.d/mysqld start ## use restart after update
## OR ##
$ sudo service mysqld start ## use restart after update
$ sudo chkconfig --levels 235 mysqld on

= Rebuilding and Deploying the Sync Server =
* Kill the Sync Server process
$ kill -9 <PID>
(Leave MySQL running)
* Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011)
* Repeat the build and deploy steps from above
* Make the necessary changes in the server-full/etc/sync.conf file:
* Change the sqluri entries
* Restart the server using the "nohup" command from above
* Test the service to verify everything is running correctly

= Redeploying a Live Server =
* The following steps can be used to redeploy a live sync server
$ cd /path/to/server-full
$ hg pull -uv
$ make build
$ apachectl graceful

* This should be sufficient, as "make build" will pull and update the repositories underneath the "deps" directory.
* There is also a "make update" target which will update only the dependent repositories, without rebuilding any of the third-party dependencies from PyPi.
* Also note that the Makefile will build the production channel by default, meaning this will not update you to the very latest checked-in changes but rather to the latest tags. If instead you want to deploy the very latest code, then use this line instead:
$ make build CHANNEL=dev

* NOTE: More specific redeployment ideas can be found on this great site:
** http://www.wenks.ch/fabian/mozilla-custom-sync-server/#Updating%20the%20Sync%20Server

For more advanced configurations, including web server support, please see the following documentation:
* http://docs.services.mozilla.com/howtos/run-sync.html
For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation:
* http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Sync Server Install EL6

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install EL6 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install EL6: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install EL6]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install EL6

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install EL6 to Services/Sync/Server/Archived/QA/Sync/Sync Server Install EL6: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

= Notes for installing Sync Server on Red Hat Enterprise Linux 6 for 64-Bit systems =
REF: http://docs.services.mozilla.com/howtos/run-sync.html

== General Notes ==
* The "Building the server" steps can be repeated for each new build you want to test.
* Once it is running, you can point to it for your own Sync server.

* It is highly recommended that Python 2.6.6 be installed before proceeding with the Sync install.
* Python 2.7 appears to be compatible, but the pre-packaged installer assumes 2.6.6.
* Also, it is highly recommended that the developer tools are installed after installing Python 2.6.6.

== Installing the Developer Tools ==
To get a full development environment on the box, do the following:
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python2.6 distribute_setup.py
$ sudo easy_install-2.6 MoPyTools

== Keeping the build logs ==
Run the "make build" step as follows:
$ make build 1> buildlog.log 2> builderr.err

== Using Sqlite3 ==
If sqlite3 is to be used, the server-full/etc/sync.conf file must be edited to change the default location of the temp.db file. The default location is in /tmp, which will get wiped at each system boot/restart.

== Installing Sync Server ==
Assuming kernel version similar to the following 2.6.32-131.6.1.el6.x86_64 ... x86_64 x86_64 x86_64 GNU/Linux

== Pre-Installed Packages ==
The following packages were already installed by OPs on the sync6 VM:
* Python 2.6.6
* Sqlite3 3.6.20

== Required Packages ==
The following packages need to be installed. This should be a one-off, unless updates/upgrades are needed by the Sync Server code:
* Mercurial
* MySQL Server, Devel, etc.
* Make
* Virtualenv
* SetupTools
* Python virtualenv
* Python devel
* Gcc

== Installations ==
* Install Mercurial 1.4
$ sudo yum install mercurial
* Verify the installation:
$ hg --version

* Install MySQL Server 14.14
$ sudo yum install mysql-server
* Verify the installation:
$ mysql --version

* Install Gnu Make 3.81
$ sudo yum install make
* Verify the installation:
$ make -v

Note: For the more manual installation steps, using /usr/local/src as a working directory, although this can be any location you choose.

* Install SetupTools
$ cd /usr/local/src
$ sudo wget http://pypi.python.org/packages/source/s/setuptools/setuptools-0.6c11.tar.gz
$ sudo tar xzfv setuptools-0.6c11.tar.gz
$ cd setuptools-0.6c11
$ sudo python2.6 setup.py install

* Install Python virtualenv-1.6.4:
$ cd /usr/local/src
$ sudo wget http://pypi.python.org/packages/source/v/virtualenv/virtualenv-1.6.4.tar.gz
$ sudo tar xvfz virtualenv-1.6.4.tar.gz
$ cd virtualenv-1.6.4
$ sudo python2.6 setup.py install

* Install Python Devel for Python 2.6.6
$ sudo yum install python-devel-2.6.6-20.el6.x86_64

* Install GCC, which is required for MySQL-Python
$ cd /usr/local/src
$ sudo yum install gcc
* Verify the installation:
$ which gcc
returns the following
/usr/bin/gcc
$ gcc --version
returns the following
gcc (GCC) 4.4.5 20110214 (Red Hat 4.4.5-6)

* Start up MySQL
sudo /etc/init.d/mysqld start

* Configure MySQL with a password and a test DB for Sync.
mysql -u root -p
There may be no password (or a "blank" password)

* Two commands seems to work to change the password:
mysql> UPDATE mysql.user set Password=PASSWORD('mozroot') WHERE User='root';
mysql> FLUSH PRIVILEGES

* Create a test database for use with SyncServer
mysql> CREATE DATABASE syncdb;
mysql> \quit

Note: mysql-server install usually prints several lines that show how to do initial setup, so those steps could also be followed instead of the steps listed above.

* Next, clone and build the sync server (installing to an open folder for now: /opt/sync)
$ mkdir /opt/sync
$ cd /opt/sync
$ hg clone https://hg.mozilla.org/services/server-full
$ cd server-full
$ make build

* Install mysql-devel (which is a prereq for MySQL-Python)
$ sudo yum install mysql-devel

* Install MySQL-Python
$ cd /opt/sync/server-full
$ bin/easy_install MySQL-Python

* Configure server-full/etc/sync.conf to use MySQL
sqluri = mysql://user:password@server/database
where "user" is the current user on this install
"password" is the mysql password for this user
"server" is just localhost
"database" is a default or new database for use with the Sync server

= Running the Sync 1.1 Tests =
* Once the build is complete, you can run the test as follows
$ make test
* If everything runs as expected, you should see the following:
bin/nosetests -s --with-xunit deps/server-core/services/tests
deps/server-reg/syncreg/tests deps/server-storage/syncstorage/tests
............................................................etc.......
----------------------------------------------------------------------
Ran 177 tests in 33.031s
OK
* The tests are located in the following directories:
** server-full/deps/*/*/tests
* Note: Remember to cleanup after the test by deleted some db files in /tmp
rm /tmp/sync.db /tmp/tests*.db

= Starting the Sync Server =
* Run the following command (see the wiki page) for more information
$ bin/paster serve development.ini

* If the Server is running correctly, you should see something like this
Starting server in PID 3568.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

= Rebuilding and Deploying the Sync Server =
* Kill the Sync Server process
$ kill -9 <PID>
(Leave MySQL running)
* Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011)
* Repeat the build and deploy steps from above
* Make the necessary changes in the server-full/etc/sync.conf file:
* Change the sqluri entries
* Restart the server

= Redeploying a Live Server =
* The following steps can be used to redeploy a live sync server
$ cd /path/to/server-full
$ hg pull -uv
$ make build
$ apachectl graceful

* This should be sufficient, as "make build" will pull and update the repositories underneath the "deps" directory.
* There is also a "make update" target which will update only the dependent repositories, without rebuilding any of the third-party dependencies from PyPi.
* Also note that the Makefile will build the production channel by default, meaning this will not update you to the very latest checked-in changes but rather to the latest tags. If instead you want to deploy the very latest code, then use this line instead:
$ make build CHANNEL=dev

* NOTE: More specific redeployment ideas can be found on this great site:
** http://www.wenks.ch/fabian/mozilla-custom-sync-server/#Updating%20the%20Sync%20Server

For more advanced configurations, including web server support, please see the following documentation:
* http://docs.services.mozilla.com/howtos/run-sync.html
For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation:
* http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Sync Server Install CentOS

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install CentOS to Services/Sync/Server/Archived/QA/Sync/Sync Server Install CentOS: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Sync Server Install CentOS]]

Services/Sync/Server/Archived/QA/Sync/Sync Server Install CentOS

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Sync Server Install CentOS to Services/Sync/Server/Archived/QA/Sync/Sync Server Install CentOS: Old content

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

= Notes for Installing Sync Server on CentOS 6 =
REF: http://docs.services.mozilla.com/howtos/run-sync.html

== General Notes ==
* The "Building the server" steps can be repeated for each new build you want to test.
* Once it is running, you can point to it for your own Sync server.

* It is highly recommended that Python 2.6.6 be installed before proceeding with the Sync install.
* Python 2.7 appears to be compatible, but the pre-packaged installer assumes 2.6.6.
* Also, it is highly recommended that the developer tools are installed after installing Python 2.6.6.

== Installing the Developer Tools ==
To get a full development environment on the box, do the following:
$ curl -O http://python-distribute.org/distribute_setup.py
$ sudo python2.6 distribute_setup.py
$ sudo easy_install-2.6 MoPyTools

== Keeping the build logs ==
Run the "make build" step as follows:
$ make build 1> buildlog.log 2> builderr.err

== Using Sqlite3 ==
If sqlite3 is to be used, the server-full/etc/sync.conf file must be edited to change the default location of the temp.db file. The default location is in /tmp, which will get wiped at each system boot/restart.

== Installing Sync Server ==
These are the instructions for install Sync Server and FireFox on CentOS 6 64-bit OS

* The following packages will need to be installed:
** Mecurial
** sqlite3
** MySQL (optional - if you do not want to use Sqlite3)
** Python 2.6.6
** Python 2.6.6 virtualenv
** Python 2.6.6 SetupTools
** Python 2.6.6 Developer Tools

* Verify that sqlite was already installed
$ which sqlite3
$ sqlite3 --version

* Install the latest version of mercurial
$ yum install mercurial
$ which hg
$ hg --version
1.4

* Install the required development tools and libraries
$ yum groupinstall 'Development Tools' 'Development Libraries'
$ yum install tk-devel libjpeg-devel mysql-devel python-devel httpd-devel zlib-devel bzip2-devel

* Install Python 2.6.6 in $home (in case it is needed)
$ cd $home
$ sudo wget http://python.org/ftp/python/2.6.6/Python-2.6.6.tgz
$ sudo tar xzvf Python-2.6.6.tgz

* Build Python 2.6.6
$ cd $home/Python-2.6.6
$ sudo ./configure --prefix=/opt/python2.6 --enable-thread --enable-shared --enable-unicode=ucs4
$ sudo make
$ sudo make install

* Now clone and build the Sync Server
$ hg clone https://hg.mozilla.org/services/server-full
$ cd server-full
$ make build

* Start the Sync Server and verify it works properly
$ bin/paster serve development.ini
You should see something like this:
Starting server in PID 5952.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

* If the previous step isn't working, you may find that you need to run
$ python setup.py develop
* from the server-full directory, and then
$ make build
* and run
$ python setup.py develop
* in each of the three directories contained within the server-full/deps/ : server-core, server-reg, and server-storage. These seem to be services that the Sync Server relies on.

* Stop the server to continue the installations (if needed)
ctrl-c

* Install MySQL
MySQL, mysql-devel, and libmysqlclient-dev should already be installed on CentOS 6
$ which mysql
$ mysql --version
If need, you can just run the following:
$ yum install mysql-server, mysql-devel, and libmysqlclient-dev (or similar)

* Install MySQL-Python
Run the following:
$ cd $home
$ cd server-full
$ bin/easy_install Mysql-Python

* Verify mysql-server is running or start it up
$ sudo /etc/init.d/mysqld start

* Set the MySQL root/user password:
$ /usr/bin/mysqladmin -u root password 'new-password'
$ /usr/bin/mysqladmin -u root -h localhost.localdomain password 'new-password'
where 'new-password' is the password you have chosen for 'root'

* Ran the following to enter mysql:
$ mysql -u root -p
(password should be 'new-password' above)

* Create a database for use with SyncServer
mysql> CREATE DATABASE syncdb;
mysql>\quit

* Edit the server-full/etc/sync.conf file to use mysql instead of sqlite3
sqluri = mysql://user:password@server/database
where "user" is the current user on this install
"password" is the mysql password for this user
"server" is just localhost
"database" is a default or new database for use with the Sync server

* Start the Sync Server and verify it works properly
$ bin/paster serve deployment.ini
You should see something like this:
Starting server in PID 5952.
serving on 0.0.0.0:5000 view at http://127.0.0.1:5000

= Running the Sync 1.1 Tests =
* Once the build is complete, you can run the test as follows
$ make test
* If everything runs as expected, you should see the following:
bin/nosetests -s --with-xunit deps/server-core/services/tests
deps/server-reg/syncreg/tests deps/server-storage/syncstorage/tests
............................................................etc.......
----------------------------------------------------------------------
Ran 177 tests in 33.031s
OK
* The tests are located in the following directories:
** server-full/deps/*/*/tests
* Note: Remember to cleanup after the test by deleted some db files in /tmp
rm /tmp/sync.db /tmp/tests*.db

= Restarting MySQL after system boot/restart =
If needed, one of the following sets of steps can be followed
sudo /etc/init.d/mysqld start ## use restart after update
## OR ##
sudo service mysqld start ## use restart after update
sudo chkconfig --levels 235 mysqld on

= Downloading and Installing FireFox 5 =
By default CentOS 6 comes with FireFox 3.6. In order to use Sync Server, you should have FireFox 5.
$ cd $home
$ wget http://releases.mozilla.org/pub/mozilla.org/firefox/releases/5.0.1/linux-x86_64/en-US/firefox-5.0.1.tar.bz2
$ tar xvjf firefox-5.0.1.tar.bz2
$ cd firefox
$ ./firefox
Verify that FireFox runs properly and is version 5.01 or newer

= Rebuilding and Deploying the Sync Server =
* Kill the Sync Server process
$ kill -9 <PID>
(Leave MySQL running)
* Save the Sync Server directory and its contents
(this in case you want to keep various snapshots)
$ mv server-full server-full-<DATE>
(example: mv server-full server-full-08012011)
* Repeat the build and deploy steps from above
* Make the necessary changes in the server-full/etc/sync.conf file:
* Change the sqluri entries
* Restart the server using the "nohup" command from above
* Test the service to verify everything is running correctly

= Redeploying a Live Server =
* The following steps can be used to redeploy a live sync server
$ cd /path/to/server-full
$ hg pull -uv
$ make build
$ apachectl graceful

* This should be sufficient, as "make build" will pull and update the repositories underneath the "deps" directory.
* There is also a "make update" target which will update only the dependent repositories, without rebuilding any of the third-party dependencies from PyPi.
* Also note that the Makefile will build the production channel by default, meaning this will not update you to the very latest checked-in changes but rather to the latest tags. If instead you want to deploy the very latest code, then use this line instead:
$ make build CHANNEL=dev

* NOTE: More specific redeployment ideas can be found on this great site:
** http://www.wenks.ch/fabian/mozilla-custom-sync-server/#Updating%20the%20Sync%20Server

For more advanced configurations, including web server support, please see the following documentation:
* http://docs.services.mozilla.com/howtos/run-sync.html
For a more technical overview of Sync Server and an introduction to Mozilla Services, please see the following documentation:
* http://docs.services.mozilla.com

Back To ==> [[QA/Browser_Technologies/Services | Mozilla BT Services]]

QA/Sync/Native Android Test Plan

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Native Android Test Plan to Services/Sync/Server/Archived/QA/Sync/Native Android Test Plan: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Native Android Test Plan]]

Services/Sync/Server/Archived/QA/Sync/Native Android Test Plan

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Native Android Test Plan to Services/Sync/Server/Archived/QA/Sync/Native Android Test Plan: Old content

Outline of Quality Assurance plan to ensure each phase of Native Android Sync is of highest quality possible.[https://wiki.mozilla.org/Services/NativeSync Native Sync team page] and [].

= Client =
Native Android Sync is a stand alone apk that will be bundled with Fennec. As such many of its features are tied to the android system. It doesn't need Fennec to be running to be syncing.

=== Testing strategy ===
QA will keep up with phased releases of this feature as follows:

* Milestone 1 (Jan, 16, 2012)
** Ensure full Account Setup and J-PAKE slave are supported
** Ensure sync across multiple devices for History and Bookmarks
** L10n support (landed Dec 20th, but we won't be able to test until localizers do their thing)

* Milestone 2 (Jan 31)
** Ensure Milestone 1 features have not regressed
** Ensure Backoff and error handling are fully supported
** Ensure Passwords across multiple devices (may not make it, currently blocked by Fennec)

* Milestone 3 (Target with first native Fennec release March 30, 2012)
** Ensure M1 and M2 features have not regressed
** Verify any polish stability fixes.
** If ready, ensure BrowserID+Sync is supported.

=== Schedule ===
* Milestone 1
** Builds to QA by Jan 12, 2012
** Sign-off by Jan. 14, 2012
* Milestone 2
** Builds to QA by Jan. 27, 2012
** Sing-off by Jan. 39, 2012
* Milestone 3
** ??

=== notes ===
* Instant Sync is not supported because the system decides when to sync.
* This should work with most any android device. Though initially there will be issues with UI on tablets.

QA/Sync/Community/TestPlan/20121015/

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Community/TestPlan/20121015/ to Services/Sync/Server/Archived/QA/Sync/Community/TestPlan/20121015/: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Community/TestPlan/20121015/]]

Services/Sync/Server/Archived/QA/Sync/Community/TestPlan/20121015/

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Community/TestPlan/20121015/ to Services/Sync/Server/Archived/QA/Sync/Community/TestPlan/20121015/: Old content

= Sign off on Services Central development train =
Please see related [http://blog.mozilla.org/twalker/?p=33 blog post]. We need to sign-off on the [http://ftp.mozilla.org/pub/mozilla.org/firefox/tinderbox-builds/ latest service-central builds] by Monday Oct. 15th.

Here's how you can help:

* Install the latest services-central build from http://ftp.mozilla.org/pub/mozilla.org/firefox/tinderbox-builds/ for your platform(s)
* Backup your profile(s) or create new ones to test with.
* If you don't already have one, create an account at https://moztrap.mozilla.org/ so you can run the test cases under Run Tests > Products : Desktop Firefox > Versions : 19 > Runs Oct. 9-15, 2012 Sync Community Test Run of services-central. (currently there is a bug in Moztrap such that test cases are not displayed in the proper order. So take a moment in the test run to sort out what seems logical; run account setup cases first, then run the sync cases, tab cases and finally the error cases)
* If you don't already have one, create an account at https://bugzilla.mozilla.org so you can search for and/or file bugs
* cc me on any bugs you file or comment in.
* reach me via email at twalker@mozilla.com or in irc.mozilla.org in #sync

= Important links =
* [https://bugzilla.mozilla.org bugzilla]
* [https://moztrap.mozilla.org/ moztrap]
* services-central builds
** [http://ftp.mozilla.org/pub/mozilla.org/firefox/tinderbox-builds/services-central-win32/1349741375/ Windows]
** [http://ftp.mozilla.org/pub/mozilla.org/firefox/tinderbox-builds/services-central-macosx64/1349741375/ Mac]
** [http://ftp.mozilla.org/pub/mozilla.org/firefox/tinderbox-builds/services-central-linux/1349741375/ Linux]

= fixes on this train =
Most of these are qa- (which means there isn't a verifiable set of steps to reproduce the bug). Most of them are refactoring work. If any of these bugs look interesting, feel free to deep dive exploratory test in that area of sync.

{{bug|781946}} - Clean up notifications usage; r=rnewman 
{{bug|781952}} - Part 1: Refactor engine syncing logic out of service.js; r=rnewman 
{{bug|781952}} - Part 2: Move cluster management out of service.js; r=rnewman 
{{bug|781952}} - Part 3: Remove unused Service._updateCluster; r=rnewman 
{{bug|759130}} - Avoid duplicate accesskey in Sync preferences; r=gps 
{{bug|783437}} - Add conditions acceptance to token server client; r=rnewman 
{{bug|783721}} - Refactor User API service interaction; r=rnewman 
{{bug|785225}} - Part 1: Don't rely on Engines singleton in AddonsReconciler; r=rnewman 
{{bug|785225}} - Part 2: Minimize Engines singleton usage; r=rnewman 
{{bug|785225}} - Part 3: Don't expose ErrorHandler as a singleton; r=rnewman 
{{bug|785225}} - Part 4: Remove unused exports from Weave; change engine loading; r=rnewman 
{{bug|785225}} - Part 5: Partial removal of Clients singleton; r=rnewman 
{{bug|785225}} - Park 6: Move StorageCredentialsController to jpakeclient.js; r=rnewman 
{{bug|785225}} - Part 7: Bind SendCredentialsController to a Service instance; r=rnewman 
{{bug|785225}} - Part 8: Don't expose SyncScheduler as a singleton; r=rnewman 
{{bug|785225}} - Part 9: Refactor engines to not use singletons; r=rnewman 
{{bug|785225}} - Part 10: Reflect API changes in TPS; r=rnewman 
{{bug|785225}} - Part 11: Burninate trailing whitespace from tests; r=rnewman 
{{bug|786489}} - Part 1: Update serverURL and clusterURL through Service; r=rnewman 
{{bug|786489}} - Part 2: Change username through Identity not prefs; r=rnewman 
{{bug|787306}} - Fix bitrotted Sync UX code; r=rnewman 
{{bug|790397}} - set deleted = false for each record stored via PUT or POST. 
{{bug|787273}} - Part 1: Remove Records singleton; r=rnewman 
{{bug|787273}} - Part 2: Refactor Resource and Record to not rely on singletons; r=rnewman 
{{bug|787273}} - Part 3: Don't rely on Identity in SyncStorageRequest; r=rnewman 
{{bug|787273}} - Part 4: Refactor Identity to not be a singleton; r=rnewman 
{{bug|787273}} - Part 5: Remove the CollectionKeys singleton; r=rnewman 
{{bug|787273}} - Part 6: Remove Weave export from service.js; r=rnewman 
{{bug|787273}} - Part 7: Expose Status an an instance variable on Service; r=rnewman 
{{bug|787273}} - Part 8: Make TPS go through main.js for service instance; r=rnewman 
{{bug|787273}} - Part 9: Adjust frontend code to use main.js; r=rnewman 
{{bug|792990}} - Properly handle add-ons when resetting Sync; r=rnewman 
{{bug|792546}} - Part 1: Move rotary engine to a testing-only JS module; r=rnewman 
{{bug|792546}} - Part 2: Move fake services into testing-only JS module; r=rnewman 
{{bug|792546}} - Part 3: Move logging functions into standalone module; r=rnewman 
{{bug|792546}} - Part 4: Move utility functions to testing-only JS module; r=rnewman 
{{bug|792546}} - Part 5: Clean up excessive imports; r=rnewman 
{{bug|790822}} - Make ensureMillisecondsTimestamp convert to integer. r=gps

QA/Sync/Community/Action Plan

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Community/Action Plan to Services/Sync/Server/Archived/QA/Sync/Community/Action Plan: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Community/Action Plan]]

Services/Sync/Server/Archived/QA/Sync/Community/Action Plan

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Community/Action Plan to Services/Sync/Server/Archived/QA/Sync/Community/Action Plan: Old content

A high level guide on how to contribute to Firefox Sync Quality Assurance. Each level of contribution is generally outlined at [https://wiki.mozilla.org/QA/Sync/Community Sync QA Community]. Read on if you are a Sync user and interested in becoming at least a Casual Contributor if not an Active or Core Contributor.

= What is there to do? =
There is prolific growth in and production from the Mozilla Development Community. Mozilla QA needs your help to keep up with that growth and production. Firefox Sync QA is one area where you can make an impact. What follows are ways to take action and make an impact at each of the higher levels of the Sync QA Community.

''note: each item will eventually link to detailed instructions for that action item. If you are interested in something that isn't linked to details, please hunt me down and I'll make it priority to complete''

== [https://wiki.mozilla.org/QA/Sync/Community#Casual_Contributor Casual Contributor] ==
The easiest ways to contribute to the Firefox Sync Community are to take a few moments to do one or more of the following.

* Always submit any Firefox crash reports, especially if they happen around a Sync.
** What is [https://developer.mozilla.org/en-US/docs/Crash_reporting Crash Reporting]?
** By submitting crash data, our analyst will identify trends and get a workable bug on file for the developers to fix.
* Share your thoughts on Sync at [http://input.mozilla.org/en-US/feedback input.mozilla.org]. Understanding what our users enjoy using or not helps Mozilla make their products better.
* Look up or file a support ticket on an issue you have with Sync at [http://support.mozilla.org/en-US/home SUMO]. By observing how support issues are trending, Mozilla can identify top issues and correct them in our products or services.

Yes, it is that easy! Nothing too complicated or time consuming. Just take a moment to get involved.

== [https://wiki.mozilla.org/QA/Sync/Community#Active_Contributor Active Contributor] ==
Make a bigger impact by taking part directly with the regular flow of Sync QA. Below are some of the many ways to get involved.

* Get comfortable installing and using Firefox Sync on [http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/ Firefox builds] across all Channels; Nightly, Aurora, Beta and Release for Desktop and Mobile.
* Become skilled at working in bugzilla
** Triage Sync components UNCONFIRMED bugs
** Work through Sync QAWANTED lists
** Take part in Sync bug priority triage meetings
* Participate in sign-off activities for weekly release QA cycles for Desktop and Mobile Firefox to ensure Sync is ready to ship in Fx Betas.
* Participate in sign-off activities for weekly Sync client QA cycles of services-central development to ensure new fixes and features are fine to merge to Nightly
* Write manual test cases for MozTrap.
* Get involved with test case automation through the A-team.
* Participate in Sync Test Days.
* Respond to new contributor inquiries
* Partner with other contributors

The time and effort here is elevated quite a bit. Your contribution in time can be any where from 2 to 20 hours, or more, per week.

== [https://wiki.mozilla.org/QA/Sync/Community#Core_Contributor Core Contributor] ==
In addition to being an Active Contributor, a Core Contributor will organize, guide and teach others how to be great Active Community members.

* Mentor new contributors
* Write and maintain Sync test plans
* Monitor and drive bugzilla work
* Organize and facilitate Sync Test Days.
* Responsible for final Sync client sign-offs
* Determine and drive test case writing needs.

A core Contributor can expect to put 20 - 40 hours per week towards Sync QA. This work is often, but not exclusively, done by Mozilla employees.

= What's Next? =
Becoming a Casual Contributor is fairly self explanatory. However, if you want get more deeply involved in Firefox Sync QA by becoming an Active Contributor, you'll need some guidance from a Core Contributor to get you going.

QA/Sync/Community

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Community to Services/Sync/Server/Archived/QA/Sync/Community: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Community]]

Services/Sync/Server/Archived/QA/Sync/Community

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Community to Services/Sync/Server/Archived/QA/Sync/Community: Old content

An overview of the Firefox Sync Quality Assurance Community based on the larger [https://wiki.mozilla.org/Community Mozilla Community].

= Who Is In The Sync QA Community =
==Core Contributor==

A core contributor is someone who has a leadership position in Firefox Sync Quality Assurance.

* Examples: Desktop Sync QA lead, Mobile Sync QA lead, Sync Server QA lead, Sync QA community mentor

* Goal size: 4 - 6 people

* Mission impact: Core contributors make major impacts on Firefox Sync Quality Assurance through their contributions of time, skill and leadership.

==Active Contributor==

An active contributor is someone who has volunteered substantial time performing Firefox Sync Quality Assurance activities that involves interactions with others within the last 12 months.

* Examples: Active participation in Sync Test Days, someone who files bugs against Sync on Nightly builds, someone who does regular bugzilla work in Sync components, someone who helps with QA in Sync release cycles, etc.

* Goal size: 15 - 20 people

* Mission impact: Active contributors directly support Firefox Sync Quality Assurance through their contributions of time and skill and provide the Sync Team with the ability to move forward with a wide range projects.

==Casual Contributor==

A casual contributor is someone who has volunteered small amounts of time in an activity.

* Examples: Someone who has submitted feedback for Sync on input.mozilla.org, someone who filed a report about Sync on SUMO, someone who has submitted a Sync related crash report

* Estimated size: Tens of thousands of people

* Mission impact: In aggregate, casual contributors create real value for the improvement of Sync, spreading the word, providing decision-informing data and more.

==Supporter==

A supporter is someone who has shown an interest in Sync without having made a substantial contribution back to the community yet.

* Examples: Someone who has researched how to turn on full sync logging, someone who has read some of our QA wiki pages.

* Estimated size: Thousands of people?

* Mission impact: Supporters advance the mission just like users, but they've taken the additional step to start educating themselves about Mozilla and by definition they are aware of some ways to get more involved.

==User==

A user is someone who uses Firefox Sync products but may not be aware of Mozilla's mission or that there are volunteer opportunities they could get involved with.

* Example: Someone who uses Firefox Sync to improve their Mobile browsing experience

* Estimated size: Millions of people

* Mission impact: Users help advance our mission indirectly, although the people using our products may not be aware of how they are helping or that there even is a mission.

= Where Do you Fit In? =
If you're already a Firefox Sync user, the fact you are reading this has already moved you up a level from User to Supporter. If you'd like to learn more about how to get involved with the Sync Quality Assurance Community see the [https://wiki.mozilla.org/QA/Sync/Community/Action_Plan Sync QA Community Action Plan].

QA/Sync/Client/Sync Timers

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Client/Sync Timers to Services/Sync/Server/Archived/QA/Sync/Client/Sync Timers: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Client/Sync Timers]]

Services/Sync/Server/Archived/QA/Sync/Client/Sync Timers

2026-06-26T20:27:42Z

Ddurst: Ddurst moved page QA/Sync/Client/Sync Timers to Services/Sync/Server/Archived/QA/Sync/Client/Sync Timers: Old content

= 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.scheduler.activeInterval ==
* value = 600 seconds (10 minutes)
* value may be edited to a custom value of choice

== 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.

QA/Sync/Client/Codes and Headers

2026-06-26T20:27:41Z

Ddurst: Ddurst moved page QA/Sync/Client/Codes and Headers to Services/Sync/Server/Archived/QA/Sync/Client/Codes and Headers: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/Client/Codes and Headers]]

Services/Sync/Server/Archived/QA/Sync/Client/Codes and Headers

2026-06-26T20:27:41Z

Ddurst: Ddurst moved page QA/Sync/Client/Codes and Headers to Services/Sync/Server/Archived/QA/Sync/Client/Codes and Headers: Old content

= Purpose =
* A high level light weight document to explain client reaction to the various server headers and status codes
* 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

= Headers and status codes =
The servers send headers and/or status codes in conditional response to various Sync client requests. The Sync client responds to those codes in a variety of ways depending on its state.
* Headers - http://docs.services.mozilla.com/storage/apis-1.1.html#headers
* HTTP status codes - http://docs.services.mozilla.com/storage/apis-1.1.html#http-status-codes

= Client response to server communications =
== All 200 codes ==
Indicates success in processing a request. Sync should proceed normally.

== 401 code ==
Indicates username or password are invalid on this node. There are two possible sources and client reaction to them
* If the user's node has change, the current sync should abort and retry against the new node. This should be silent to the user.
* If the node hasn’t changed, the user’s password was changed. The client should present the error bar indicating the need for the user to update their password on that client. Preferences button takes the user to appropriate update password link.
== 404 code ==
Indicates a resource could not be found.
* ''How should the client react? (rnewman?)''
== All other 4XX codes ==
Will abort sync immediately. Error bar will be presented. User is on their own to resolve the problem. Note: this is a place where Syncorro could be immensely helpful.

== 503 code ==
Indicates server under maintenance. 99.9% of errors sent to the client are 503's.
=== Client Scenarios for handling 503 + Retry-After ===
* 1) When a "Sync Now" is performed by the user and a 503 + Retry-After is received.
** The sync will fail
** The client will present the error bar indicating the server is under maintenance and will try again later.
* 2) When an instant sync or a scheduled sync is triggered and a 503 + Retry-After is received.
** The sync will fail
** The client will not present an error bar
* In both cases:
** Logs will indicate a fuzzed syncInterval
** about:config services.sync.nextSync will be set to current time + syncInterval
** No previously scheduled syncs will occur
** No instant sync actions will trigger a sync during the back-off interval
** Another Sync will be tried again at the set nextSync time
** Subsequent failures and retries will be handled as above until a successful sync occurs or
** If a successful sync does not occur within 7 days, an error bar will be presented.
== Retry-After ==
The Retry-After header is used so that older clients (pre Fx10) will obey the back-off request. The response header sends a time (usually 300-900 seconds). This is the minimum time the client must wait until the next sync attempt. However, the client checks on its own state and calculates a "fuzzed" next sync interval that is always at least what the server requests. In most cases, the back off length of time will be notably longer.

== X-Weave-Backoff ==
This request will only be respected by Fx10 or newer. The response header sends a time (usually 300-900 seconds). This is the minimum time the client must wait until the next sync attempt. However, the client checks on its own state and calculates a "fuzzed" next sync interval that is always at least what the server requests. In most cases, the back off length of time will be notably longer.

The client will react to X-Weave-Backoff the same as if it had been sent a 503 + Retry-After noted in the scenarios above.

== X-If-Unmodified-Since ==
''client response detail needed''
== X-Weave-Alert ==
''client response detail needed''
== X-Weave-Timestamp ==
''client response detail needed''
== X-Weave-Records ==
''client response detail needed''

QA/Sync/

2026-06-26T20:27:41Z

Ddurst: Ddurst moved page QA/Sync/ to Services/Sync/Server/Archived/QA/Sync/: Old content

#REDIRECT [[Services/Sync/Server/Archived/QA/Sync/]]

Services/Sync/Server/Archived/QA/Sync/

2026-06-26T20:27:41Z

Ddurst: Ddurst moved page QA/Sync/ to Services/Sync/Server/Archived/QA/Sync/: Old content

== Sync Server Test Documents and Sites ==
* [https://wiki.mozilla.org/QA/Browser_Technologies/Services/Releases/SyncServer Sync Server Releases wiki]
* [https://wiki.mozilla.org/QA/Sync/Test_Plan Sync Client Test Plan]
* [https://wiki.mozilla.org/QA/Sync/Test_Plan#Servers Sync Server Test Plan (out of date)]
* [https://wiki.mozilla.org/QA/Sync/Test_Plan/grinder_tests Sync Server Grinder tests (out of date)]
* [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Client Sync Client Smoke Tests]
* [https://wiki.mozilla.org/QA/Sync/Test_Plan/Test_Level_Summaries#Servers Sync Server Smoke Tests (out of date)]

* [http://docs.services.mozilla.com/howtos/run-sync.html How to install the Sync Server]
* [https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_Fedora How to: Sync Server on Fedora]
* [https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_CentOS How to: Sync Server on CentOS]
* [https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_EL6 How to: Sync Server on RHEL]
* [https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_On_Ubuntu_10_04 How to: Sync Server on Ubuntu 10]
* [https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_On_Ubuntu_11_04 How to: Sync Server on Ubuntu 11.04]
* [https://wiki.mozilla.org/QA/Sync/Sync_Server_Install_On_Ubuntu_11_10 How to: Sync Server on Ubuntu 11.10 (this is the most current How To guide)]