search

mozilla / releases_insights

Parse various sources (hg log, apis, crashes…) to get some insights on past releases such as uplifts per beta, top crash signatures per nightly…
Mozilla Public License 2.0
27 stars 8 forks source link

readme

Tests

Release Insights / Firefox Trains Dashboard

This is the code behind the https://whattrainisitnow.com domain.

This application gives the status of Firefox Destop Releases: when do we ship the next release, what are the upcoming milestones for our future Firefox releases, what are the main data points for our past releases.

There are different views and I also added a public JSON API, these endpoints are documented here:

https://whattrainisitnow.com/about/

Requirements:

The requirements are very simple, no database, no framework.

The application is set up by default to be deployed on Heroku with Apache but there is no need to install Apache for development work, the PHP built-in development server is fine for that purpose.

Installation

  1. Clone this repository
  2. Install dependencies: composer install
  3. Start the PHP development server in a terminal either by launching the ./run bash script or with this command:
    php -S localhost:8082 -t public/

The website will be available at http://localhost:8082

If you have intalled the npm package browser-sync (sudo npm install -g browser-sync) and want to use it, start with the ./run -browser-sync command, it will launch the website at http://localhost:3000 and any change to a file in the repository will automatically refresh the page in the browser. Note that this workflow will break if you make back-end changes that prevent the front-end from loading.

If you want to set the site up with an Apache virtual host, make it point to the public folder and make sure that the cache folder is writable by Apache.

Running with Docker

It's possible to use Docker to run in a containerised environment.

Build or update the image using:

docker build -t fx-trains .

and run it with

docker run --rm -p 8000:8000 fx-trains

The image is configured to listen on port 8000.

Dockerflow

Dockerflow is supported; with version.json optionally generated from build-time variables:

docker build . -t fx-trains \
  --build-arg source=https://github.com/mozilla/releases_insights \
  --build-arg version= \
  --build-arg commit=$( git rev-parse HEAD ) \
  --build-arg build=

Testing and CI

We use Pest for unit testing, PHPStan for static analysis and custom scripts for basic functional scripts. We have CI via Github Actions to ensure all tests are passing.

All tests can be launched via Composer action scripts:

composer test:all       # Run all tests
composer test:api       # Run functional tests of external JSON API points
composer test:content   # Run functional tests of pages + external JSON API points
composer test:coverage  # Run unit tests, only display coverage (requires the Xdebug extension)
composer test:lint      # Run linter to ensure all PHP files are valid
composer test:pages     # Run basic functional tests of all pages
composer test:static    # Run PHPStan static analysis
composer test:unit      # Run unit tests
composer test:unitcov   # Run unit tests + code coverage (requires the Xdebug extension)

You can also run locally all the tests we run in CI with the ./run tests command.

You can check if the local state of the branch is in production with the ./run status command.

If you want to contribute a patch to an existing class, please make sure that unit tests pass and add tests for new methods.

Bugs

Warning If you find a bug, please open an issue here or on [Bugzilla][https://bugzilla.mozilla.org/enter_bug.cgi?product=Websites&component=whattrainisitnow.com].

If the application is malfunctionning, the most likely solution is to either flush the cache folder or to restart it as the restart flushes the cache. This application fetches and mixes a lot of remote source of data so it mainly depends on these resources to behave correctly.

Production playbook

This application relies on external data from mozilla architecture.

If these external sources are unavailable or sending malformed data, they might cause application bugs or even 500 errors.

List of external sources that the app is pulling data from:

The list of domains used to get data is listed at this API endpoint: https://whattrainisitnow.com/api/external/

Emptying the mutable data in the cache folder (either via the composer cache:clear command or by doing rm cache/*.cache ; rm -rf cache/twig/*) should fix any issue caused by external data sources listed above being unavailable and/or providing bogus data.

Restarting the app should solve most problems on production.

If the app is slow, this is likely to be because the app can't write to the cache folder and makes multiple http requests to external servers for every page load. Make sure that the cache folder is writable by the web server.

This app is on GCP with Nginx. The deployment servers are:

Should you want to create those tags easily, here are bash functions that generate and push them:

# Tag and push to https://stage.whattrainisitnow.nonprod.webservices.mozgcp.net
function train_stage()
{
    DATETIME=`date -u +%Y-%m-%d_%H-%M-%S`
    git tag -a stage-$DATETIME -m "Staged release $DATETIME"
    echo "Staged release $DATETIME created."
    git push origin stage-$DATETIME
}

# Tag and push to https://whattrainisitnow.com
function train_ship()
{
    DATETIME=`date -u +%Y-%m-%d_%H-%M-%S`
    git tag -a release-$DATETIME -m "Release $DATETIME"
    echo "Release $DATETIME created."
    git push origin release-$DATETIME
}

As you can see above, we use a timestamp variant and not a number for tags as we push daily (multiple times). Deployment time is about 5mn.

We also keep a test version of the app on Heroku at https://fx-trains.herokuapp.com used for demos.

If there is a dependabot PR for a security vulnerability on a single dependency, merge it and redeploy:

composer update
git add composer.lock
git commit -m "Dependencies update"
git push

The dependabot PR will autoclose.