8
edits
Services/Sync/Getting Started: Difference between revisions
→Configuring Git: m
(→Configuring Git: m) |
|||
| (10 intermediate revisions by 5 users not shown) | |||
| Line 7: | Line 7: | ||
/services/sync/ | /services/sync/ | ||
You can view this online at https://hg.mozilla.org/ | You can view this online at https://hg.mozilla.org/mozilla-unified/file/default/services/sync | ||
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 14: | Line 14: | ||
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 | |||
/services/fxaccounts | |||
== Debugging Sync == | == Debugging Sync == | ||
| Line 20: | Line 24: | ||
# Enable logging to Error Console | # Enable logging to Error Console | ||
services.sync.log.appender.console | services.sync.log.appender.console Trace | ||
# Enable logging to STDOUT | # Enable logging to STDOUT | ||
services.sync.log.appender.dump | 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. | ||
| Line 38: | 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]. | |||
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) | |||
Depending on your OS, most changes will not require a rebuild to take effect, only restarting and rerunning via `mach run`. | |||
= 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 | 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]. | ||
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. | 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. | ||
| Line 83: | Line 75: | ||
= Using Mercurial = | = Using Mercurial = | ||
Note: This section may be outdated. | |||
Mozilla's development process is very much patch driven. [https://developer.mozilla.org/En/Developer_Guide/Source_Code Mozilla uses Mercurial] (as well as git for some projects) as the version control system. [https://developer.mozilla.org/en/Mercurial_queues Mercurial Patch Queues], although a bit awkward to use at times, fit this process rather well. It is recommended you familiarize yourself with them and use them. | Mozilla's development process is very much patch driven. [https://developer.mozilla.org/En/Developer_Guide/Source_Code Mozilla uses Mercurial] (as well as git for some projects) as the version control system. [https://developer.mozilla.org/en/Mercurial_queues Mercurial Patch Queues], although a bit awkward to use at times, fit this process rather well. It is recommended you familiarize yourself with them and use them. | ||
== Configuration == | == Configuration == | ||
| Line 126: | Line 118: | ||
== Landing patches == | == Landing patches == | ||
You have items in a patch queue that you'd like to push to | 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 | === Make sure mozilla-central is open and green === | ||
Check [https:// | Check [https://treeherder.mozilla.org treeherder]. | ||
=== Make sure your tree is up to date === | === Make sure your tree is up to date === | ||
| Line 168: | Line 160: | ||
=== Run tests === | === Run tests === | ||
Now is a great time to run tests, because this is the state in which | Now is a great time to run tests, because this is the state in which mozilla-central will be after you push. If you apply a <tt>tests</tt> patch to re-enable disabled tests, ''make sure you pop it when you're done''. | ||
=== Finish the applied patches === | === Finish the applied patches === | ||
| Line 188: | 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. | 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. | ||
The | |||
== Configuring Git == | == Configuring Git == | ||
| Line 199: | Line 189: | ||
$ git config --global user.name "John Doe" | $ git config --global user.name "John Doe" | ||
$ git config --global user.email "johndoe@mozilla.com" | $ git config --global user.email "johndoe@mozilla.com" | ||
# Enable color output for all commands | # Enable color output for all commands | ||
$ git config --global color.branch auto | $ git config --global color.branch auto | ||
| Line 207: | Line 197: | ||
$ git config --global color.status auto | $ git config --global color.status auto | ||
$ git config --global color.ui auto | $ git config --global color.ui auto | ||
# Highlight whitespace | # Highlight whitespace | ||
$ git config --global core.whitespace "trailing-space,space-before-tab,tab-in-indent" | $ git config --global core.whitespace "trailing-space,space-before-tab,tab-in-indent" | ||
# Define your editor for commits, other tools | # Define your editor for commits, other tools | ||
$ git config --global core.editor vim | $ 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. | |||
= Repositories = | = Repositories = | ||
Getting a checkout of a large Mercurial repository can be a pain if you're remote. Nobody wants to wait 6 hours while Python drools on its shoes. The answer is '''bundles'''. [https://developer.mozilla.org/en/Mozilla_Source_Code_%28Mercurial%29 Follow the directions]. | Getting a checkout of a large Mercurial repository can be a pain if you're remote. Nobody wants to wait 6 hours while Python drools on its shoes. The answer is '''bundles'''. [https://developer.mozilla.org/en/Mozilla_Source_Code_%28Mercurial%29 Follow the directions]. More information on bundles is available [https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Source_Code/Mercurial/Bundles here]. | ||
[https:// | |||
== mozilla-central == | == mozilla-central == | ||
mozilla-central is the repository for Firefox and the base repository for other Mozilla-based applications. | 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. | ||
== Try server == | == Try server == | ||
To push to try, teave your changes as applied mq patches. Then run: | To push to try, teave your changes as applied mq patches. Then run: | ||
| Line 258: | Line 220: | ||
hg push -f ssh://hg.mozilla.org/try/ | hg push -f ssh://hg.mozilla.org/try/ | ||
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. | |||
[https://developer.mozilla.org/en/Writing_xpcshell-based_unit_tests Writing xpcshell-based unit 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-US/docs/Mozilla/Projects/TPS_Tests TPS Tests] | |||
= Collaboration = | = Collaboration = | ||
| Line 287: | Line 253: | ||
} | } | ||
{ | { | ||
comment = "Public channel for | comment = "Public channel for FxA"; | ||
name = "# | name = "#fxa"; | ||
chatnet = "mozilla"; | chatnet = "mozilla"; | ||
} | } | ||
} | } | ||
= Miscellany = | = Miscellany = | ||