Services/Sync/Getting Started - Revision history

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

2026-06-29T19:30:25Z

replaced Source Code section links with direct paths to searchfox

← Older revision		Revision as of 19:30, 29 June 2026
Line 3:		Line 3:
	== Source Code ==		== 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:		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

	~~/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

	~~You can view this online at https://searchfox.org/firefox-main/source/~~

	This is just the core JavaScript APIs and logic. Additional Sync code for integration with Firefox lives in:

	/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.		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		Additionally, Firefox Accounts specific code lives in https://searchfox.org/firefox-main/source/services/fxaccounts

	/services/fxaccounts

	== Debugging Sync ==		== Debugging Sync ==

Ddurst: Add link to Firefox Sync extended logging

2026-06-26T19:03:11Z

Add link to Firefox Sync extended logging

← Older revision		Revision as of 19:03, 26 June 2026
Line 44:		Line 44:
	export MOZ_QUIET=1		export MOZ_QUIET=1

	You can view full sync logs by opening '''about:sync-log''' in Firefox.		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 ==		== Building Sync ==
Line 220:		Line 220:
	= Testing =		= 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://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]

	~~[https://firefox-source-docs.mozilla.org/testing/tps/index.html TPS Tests]~~
	<!--		<!--
	= Collaboration =		= Collaboration =

Ddurst: Edit out QA and email lists that are no longer relevant

2026-06-26T18:45:41Z

Edit out QA and email lists that are no longer relevant

← Older revision		Revision as of 18:45, 26 June 2026
Line 60:		Line 60:
	You probably also want to get up to speed on [http://bugzilla.mozilla.org Bugzilla] if you're not already.		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].		* 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]].		* 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.		* 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. ~~One way to do this is to add the default QA contact for each component to the list of users you~~ are ~~watching in Bugzilla.~~		* 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]].
	** Open the [~~https:~~/~~/bugzilla.mozilla.org/describecomponents.cgi list of products and components~~]
	** In another tab go to your Bugzilla [https://bugzilla.mozilla.org/userprefs.cgi?tab=email email preferences]
	** At the bottom of the page under the <b>User Watching</b> section there is an input form that takes a comma separated list of email addresses
	** If you're working on server side components, you will want to add at least:
	*** core-server@services.bugs
	*** sync-server@services.~~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!		* 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!

Ddurst: Remove chunk about Mercurial in the Using Git section, change link to mozilla-central to be https://github.com/mozilla-firefox/firefox

2026-06-26T15:37:43Z

Remove chunk about Mercurial in the Using Git section, change link to mozilla-central to be https://github.com/mozilla-firefox/firefox

← Older revision		Revision as of 15:37, 26 June 2026
Line 56:		Line 56:
	= Using Bugzilla =		= 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 [~~http~~://hg.~~mozilla.org~~/mozilla-~~central~~ mozilla-central].		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.		You probably also want to get up to speed on [http://bugzilla.mozilla.org Bugzilla] if you're not already.
Line 180:		Line 180:
	= Using Git =		= Using Git =

	Various projects exist as Git repositories instead of Mercurial repositories. Even when projects are officially hosted in Mercurial, Git mirrors are maintained. The mozilla-central mirror is available at https://github.com/mozilla/gecko-dev, however we recommend that you use https://github.com/glandium/git-cinnabar/wiki/Mozilla:-A-git-workflow-for-Gecko-development to set up a local git repository that tracks mozilla central. If you already have a gecko-dev clone, you can use [https://github.com/glandium/git-cinnabar/wiki/Mozilla:-Using-a-git-clone-of-gecko%E2%80%90dev-to-push-to-mercurial this guide] to configure it to push to hg using git-cinnabar.		Various projects exist as Git repositories.

	== Configuring Git ==		== Configuring Git ==

Ddurst: Updates in general, commenting out a lot of hg and IRC References

2026-04-28T20:54:33Z

Updates in general, commenting out a lot of hg and IRC References

← Older revision		Revision as of 20:54, 28 April 2026
Line 7:		Line 7:
	/services/sync/		/services/sync/

	You can view this online at https://~~hg.mozilla~~.org/~~mozilla~~-~~unified/file/default~~/~~services~~/~~sync~~		You can view this online at https://searchfox.org/firefox-main/source/

	This is just the core JavaScript APIs and logic. Additional Sync code for integration with Firefox lives in:		This is just the core JavaScript APIs and logic. Additional Sync code for integration with Firefox lives in:
Line 48:		Line 48:
	== Building Sync ==		== Building Sync ==

	~~Sync code is almost exclusively JavaScript, and so you~~ probably should build using an artifact build, as described [https://~~developer~~.mozilla.org/en-~~US/docs/Mozilla/Developer_guide/Build_Instructions/Artifact_builds~~ here].		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://~~developer~~.mozilla.org/~~en-US~~/~~docs~~/~~Mozilla/Projects/TPS_Tests~~ here]. (For most changes ~~its~~ sufficient you run the unit tests)		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`.		Depending on your OS, most changes will not require a rebuild to take effect, only restarting and rerunning via `mach run`.
Line 56:		Line 56:
	= Using Bugzilla =		= 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/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 [http://hg.mozilla.org/mozilla-central mozilla-central].		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 [http://hg.mozilla.org/mozilla-central mozilla-central].

	~~For server code written in Python, Tarek has provided a useful tool called [https://bitbucket.org/tarek/flake8 flake8] which does Python style checks against your code~~.

	You probably also want to get up to speed on [http://bugzilla.mozilla.org Bugzilla] if you're not already.		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].		* A good start is to go watch [http://vimeo.com/9205730 Jonath's "Bugzilla for Humans" video].
	* ~~Our~~ bugs are ~~currently under "Other Products"~~, ~~"Mozilla Services" or just bookmark "~~[https://~~bugzilla~~.mozilla~~.org~~/~~enter_bug~~.~~cgi?product=Mozilla%20Services Add~~ a ~~bug]" and "~~[~~https:~~/~~/bugzilla.mozilla.org/describecomponents.cgi?product=Mozilla%20Services Browse bugs~~]".		* 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.		* 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 easiest~~ way to do this is to add the default QA contact for each component to the list of users ~~your~~ are watching in Bugzilla		* You also want to watch the components relevant to your work so you automatically get emails for all bug changes in those components. One way to do this is to add the default QA contact for each component to the list of users you are watching in Bugzilla.
	** Open the [https://bugzilla.mozilla.org/describecomponents.cgi~~?product=Mozilla%20Services~~ list of ~~Services~~ components]		** Open the [https://bugzilla.mozilla.org/describecomponents.cgi list of products and components]
	** In another tab go to your Bugzilla [https://bugzilla.mozilla.org/userprefs.cgi?tab=email email preferences]		** In another tab go to your Bugzilla [https://bugzilla.mozilla.org/userprefs.cgi?tab=email email preferences]
	** At the bottom of the page under the <b>User Watching</b> section there is an input form that takes a comma separated list of email addresses		** At the bottom of the page under the <b>User Watching</b> section there is an input form that takes a comma separated list of email addresses
Line 71:		Line 69:
	*** core-server@services.bugs		*** core-server@services.bugs
	*** sync-server@services.bugs		*** sync-server@services.bugs
	* A useful Firefox add-on that makes life in Bugzilla a bit easier is [https://addons.mozilla.org/en-Us/firefox/addon/~~bugzilla-tweaks~~/ Bugzilla Tweaks]. Highly recommended!		* 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 Mercurial =		= Using Mercurial =

Line 177:		Line 176:

	hg push		hg push
			-->

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

			<!--
	= Repositories =		= Repositories =

Line 212:		Line 213:
	== mozilla-central ==		== mozilla-central ==

	mozilla-central is the repository for Firefox and the base repository for other Mozilla-based applications. Sync code used to live in a repository named services-central, however currently all client side sync code for Desktop Firefox and Firefox for Android lives in mozilla-central.		mozilla-central is the repository for Firefox.

	== Try server ==		== Try server ==
Line 221:		Line 222:

	Alternatively, you can push to try using `mach try`, which works for both `git` and `hg` users (assuming git users are using git cinnabar), and is recommended for both.		Alternatively, you can push to try using `mach try`, which works for both `git` and `hg` users (assuming git users are using git cinnabar), and is recommended for both.
			-->

	= Testing =		= Testing =
Line 227:		Line 228:
	[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://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://~~developer~~.mozilla.org/~~en-US/docs~~/~~Mozilla~~/~~Projects/TPS_Tests~~ TPS Tests]		[https://firefox-source-docs.mozilla.org/testing/tps/index.html TPS Tests]
			<!--
	= Collaboration =		= Collaboration =

Line 258:		Line 259:
	}		}
	}		}
			-->

	= Miscellany =		= Miscellany =

Tcsc: /* Configuring Git */ m

2018-02-08T16:11:33Z

Configuring Git: m

← Older revision		Revision as of 16:11, 8 February 2018
Line 205:		Line 205:

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

	~~After setting up~~

	= Repositories =		= Repositories =

Tcsc: /* Make sure -central is open and green */ minor edit, fix a typo

2018-02-08T16:10:50Z

Make sure -central is open and green: minor edit, fix a typo

← Older revision		Revision as of 16:10, 8 February 2018
Line 120:		Line 120:
	You have items in a patch queue that you'd like to push to m-c. Here's the thorough set of steps to follow to get them into the tree (assuming you have commit access, of course). It's recommended that you use autoland via mozreview, or flag bugs as having checkin-needed instead.		You have items in a patch queue that you'd like to push to m-c. Here's the thorough set of steps to follow to get them into the tree (assuming you have commit access, of course). It's recommended that you use autoland via mozreview, or flag bugs as having checkin-needed instead.

	=== Make sure -central is open and green ===		=== Make sure mozilla-central is open and green ===

	Check [https://treeherder.mozilla.org treeherder].		Check [https://treeherder.mozilla.org treeherder].

Tcsc: Various updates

2018-02-08T16:09:27Z

Various updates

Show changes

Tcsc: /* Building Sync */ Update

2018-02-08T15:47:22Z

Building Sync: Update

← Older revision		Revision as of 15:47, 8 February 2018
Line 48:		Line 48:
	== Building Sync ==		== Building Sync ==

	~~The party line to rebuild the tree after making changes~~ is ~~to run~~:		Sync code is almost exclusively JavaScript, and so you probably should build using an artifact build, as described [https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Artifact_builds here].

	~~$ make~~ -~~f client~~.mk		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://developer.mozilla.org/en-US/docs/Mozilla/Projects/TPS_Tests here]. (For most changes its sufficient you run the unit tests)
	~~or from the object directory~~:
	~~$ make~~ -~~sj8~~

	~~However, this is slow. If you have simply changed a JS file in ''services/sync/'', it is sufficient to run the following from~~ your ~~object directory:~~		Depending on your OS, most changes will not require a rebuild to take effect, only restarting and rerunning via `mach run`.

	~~$ make -sj8 -C services/sync~~

	~~The xpcshell tests will pick up changes immediately. However~~, ~~if you launch Firefox, your~~ changes ~~'''won't''' be reflected. For that, you'll also need to~~ rebuild ~~the browser component:~~

	~~$ make -sj8 -C services/sync && make -sj8 -C browser~~

	~~A handy alias~~ to ~~have around is:~~

	~~$ alias sync-launch make -sj8 -C services/sync && make -sj8 -C browser && dist/bin/firefox -no-remote -ProfileManager~~

	Or, ~~on OS X:~~

	~~$ alias sync-launch make -sj8 -C services/sync && make -sj8 -C browser && dist/NightlyDebug~~.~~app/Contents/MacOS/ -no-remote -ProfileManager~~

	= Using Bugzilla =		= Using Bugzilla =

Tcsc: /* Debugging Sync */ Update logging information

2018-02-08T15:41:23Z

Debugging Sync: Update logging information

← Older revision		Revision as of 15:41, 8 February 2018
Line 24:		Line 24:

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

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

	# Log full sync logs on sync success (typically they are only saved on failure)		# Log full sync logs on sync success (typically they are only saved on failure)
	services.sync.log.appender.file.logOnSuccess true		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.		Once you've updated those settings, restart Firefox for them to take effect.