63cb612908 | ||
---|---|---|
.circleci | ||
.vscode | ||
_scripts | ||
docs | ||
packages | ||
test | ||
.gitignore | ||
.nvmrc | ||
AUTHORS | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
README.md | ||
lerna.json | ||
mysql_servers.json | ||
package-lock.json | ||
package.json | ||
release.sh | ||
renovate.json | ||
servers.json |
README.md
Firefox Accounts
The Firefox Accounts (fxa) monorepo
Getting Started
-
Manually install the system dependencies for OS X or Ubuntu. Note that WSL is required for development work on Windows.
-
Clone this repository.
git clone https://github.com/mozilla/fxa.git
-
Run:
cd fxa npm install
-
Visit 127.0.0.1:3030.
Use the PM2 tool to stop and start the servers, and read server logs.
To start all servers with mysql database
./pm2 start mysql_servers.json
To start all servers with memory
-
./pm2 start servers.json
The most common commands are:
-
./pm2 kill
- stop all servers. -
./pm2 status
- display running servers. -
./pm2 logs
- logs for all servers (note: this must be used to verify accounts). -
./pm2 logs 1
- display logs for process1
. -
./pm2 stop 1
- stop process1
. -
./pm2 restart 1
- restart process1
. -
More commands in the PM2 Readme.
-
When you want to fetch the latest changes to all servers:
npm run update
Contributing
See the separate CONTRIBUTING.md to learn how to contribute.
Workflow
This is an example workflow for fxa.
After installing fxa the servers should automatically start up. Use ./pm2 status
command to check the status of the servers:
To avoid wasting computer resources while not working on FxA make sure to stop the servers using ./pm2 kill
.
Once you are back working on FxA just use the ./pm2 start servers.json
command to bring the servers back up. Keep in mind that the memory store will restart and all your database data will be brand new.
Verifying email and viewing logs
Use the ./pm2 logs
command to get the logs of all servers. You may also use ./pm2 logs [id]
to just see the logs for that particular server.
When you signup for an account using the form on 127.0.0.1:3030/signup
the (mailer) logs will print out the verification link that you need to copy paste into your browser to verify your account locally:
If you get an error
status for any of the servers please verify that you installed all required dependencies. Otherwise file an issue on this repository.
Dependencies
Required developer dependencies: Git, node.js 10+ with npm 6, Python 2.6+, Java 8+, Rust nightly+, libgmp, graphicsmagick, docker, grunt, gcloud CLI
OS X (with Brew):
Xcode and OS X Command Line Tools are required, install it and verify that command line tools installed:
xcode-select --install
then:
sudo easy_install pip && sudo pip install virtualenv
Ubuntu:
sudo apt-get install build-essential git libgmp3-dev graphicsmagick python-virtualenv python-dev pkg-config libssl-dev curl openjdk-11-jre firefox
Follow the Docker CE instructions to install Docker.
Docker commands require sudo, to avoid it, follow steps below:
- Add the docker group if it doesn't already exist
sudo groupadd docker
- Add the connected user $USER to the docker group
sudo gpasswd -a $USER docker
- Restart the docker daemon
sudo service docker restart
Installing Node.js
We currently use Node 10. See https://nodejs.org
Alternatively, the Node Version Manager makes working with different versions of Node easy.
nvm install 10
nvm alias default 10
Installing Java
Java is used to run Selenium functional tests
OS X:
Download from java.com/en/download/
Installing Rust
Rust Nightly is used for the fxa-email-service
Ubuntu and OS X
curl https://sh.rustup.rs -sSf | sh
Once the installer begins:
- Select "2) Customize installation"
- Leave "Default host triple" blank, hit "enter"
- Type "nightly" for "Default toolchain"
- Type "y" for "Modify PATH variable?"
- Select "1) Proceed with installation"
Installing grunt
npm install -g grunt-cli
Firefox Custom Profile
Use npm start
to start Firefox with local server configurations.
Available options:
FXA_ENV=local
orlatest
orstable
orstage
(NOTE:local
is default).FXA_E10S=true
- add this flag to turn on E10S. (NOTE:false
by default).FXA_DESKTOP_CONTEXT
-context=
value. (NOTE:fx_desktop_v2
is default).FIREFOX_BIN=/Applications/FirefoxNightly.app/Contents/MacOS/firefox-bin npm start
FIREFOX_DEBUGGER=true
- open Browser Toolbox on start (NOTE:false
by default for speed).
Functional Tests
The following requires the JDK and tests the local servers only.
To run all functional tests:
npm test
Note that as of 2019-07-08, running this command at the project root will fail (see issue #725). Instead, run the command in the server that needs to be tested.
To run a specific test or tests whose name matches part of a search string:
node tests/intern.js --suites=all --grep="Test string to search for"
Android debugging
The following technique works with any Android application and can also be used for Firefox for Android (making the Firefox for Android section optional).
Simply forward the following ports from the host machine to the Android device:
adb reverse tcp:3030 tcp:3030 # Content server
adb reverse tcp:9000 tcp:9000 # Auth server
adb reverse tcp:9010 tcp:9010 # OAuth server
adb reverse tcp:1111 tcp:1111 # Profile server
adb reverse tcp:5000 tcp:5000 # Sync server
Then run ./pm2 start servers.json
and get to work!
Firefox for Android
Skip this if you are not working on Firefox for Android and FxA.
You can test sync locally in Firefox for Android using an emulator or a device on the same network. These docs were tested with the Genymotion simulator.
- Install Firefox on the device or emulator.
- Run
npm run start-android
this will: stop all local FxA servers, create a local PM2 configuration and rerun the servers.
The script will tell you which IP to use to work with FxA.
Follow the instructions of the script to update values in about:config
.
Firefox for iOS
Skip this if you are not working on Firefox for iOS and FxA.
You can test sync locally in Firefox iOS using the XCode simulator. Follow the steps at github.com/mozilla/firefox-ios and setup firefox-ios build locally. Currently there is no way to dynamically switch servers in Firefox for iOS, to use local servers you need to run the script below:
FIREFOX_IOS_HOME=<path_to_firefox_ios_project> npm run config-fxios
After the script you need to rebuild firefox-ios.
Running with MailDev
If you want to inspect emails, you can run fxa with MailDev.
Install
npm install maildev -g
Run
./pm2 start servers.json
./pm2 stop 0
Once services have started, you can start MailDev on port 9999. You might have to start MailDev with sudo permissions.
sudo maildev -s 9999
All emails sent can be viewed from http://localhost:1080.