6.6 KiB

Raw Permalink Blame History

Contributing to semaphore

Building

Semaphore requires Node.js and Yarn.

To build Semaphore for production, first install dependencies:

yarn --production --pure-lockfile

Then build:

yarn build

Then run:

PORT=4002 node server.js

Docker

To build a Docker image for production:

docker build .
docker run -d -p 4002:4002 [your-image]

Now Semaphore is running at localhost:4002.

docker-compose

Alternatively, use docker-compose to build and serve the image for production:

docker-compose up --build -d

The image will build and start, then detach from the terminal running at localhost:4002.

Updating

To keep your version of Semaphore up to date, you can use git to check out the latest tag:

git checkout $(git tag -l | sort -Vr | head -n 1)

Exporting

Semaphore is a static site. When you run yarn build, static files will be written to __sapper__/export.

It is not recommended to directly expose these files when self-hosting. Instead, you should use node server.js (e.g. with an nginx or Apache proxy in front). This adds several things you don't get from the raw static files:

CSP headers (important for security)
Certain dynamic routes (less important because of Service Worker managing routing, but certain things could break if Service Workers are disabled in the user's browser)

Installing

To install with dev dependencies, run:

yarn

Dev server

To run a dev server with hot reloading:

yarn run dev

Now it's running at localhost:4002.

Linux users: for file changes to work, you'll probably want to run export CHOKIDAR_USEPOLLING=1 because of this issue.

Linting

semaphore uses JavaScript Standard Style.

Lint:

yarn run lint

Automatically fix most linting issues:

yarn run lint-fix

Integration tests

Integration tests use TestCafé and a live local Mastodon instance running on localhost:3000.

Running integration tests

The integration tests require running Mastodon itself, meaning the Mastodon development guide is relevant here. In particular, you'll need a recent version of Ruby, Redis, and Postgres running. For a full list of deps, see bin/setup-mastodon-in-travis.sh.

Run integration tests, using headless Chrome by default:

npm test

Run tests for a particular browser:

BROWSER=chrome yarn run test-browser
BROWSER=chrome:headless yarn run test-browser
BROWSER=firefox yarn run test-browser
BROWSER=firefox:headless yarn run test-browser
BROWSER=safari yarn run test-browser
BROWSER=edge yarn run test-browser

If the script isn't able to set up the Postgres database, try running:

sudo su - postgres

Then:

psql -d template1 -c "CREATE USER semaphore WITH PASSWORD 'semaphore' CREATEDB;"

Testing in development mode

In separate terminals:

1. Run a Mastodon dev server:

yarn run run-mastodon

2. Run a Semaphore dev server:

yarn run dev

3. Run a debuggable TestCafé instance:

npx testcafe --debug-mode chrome tests/spec

Test conventions

The tests have a naming convention:

0xx-test-name.js: tests that don't modify the Mastodon database (read-only)
1xx-test-name.js: tests that do modify the Mastodon database (read-write)

In principle the 0- tests don't have to worry about clobbering each other, whereas the 1- ones do.

Mastodon used for testing

There are two parts to the Mastodon data used for testing:

A Postgres dump and a tgz containing the media files, located in fixtures
A script that populates the Mastodon backend with test data (restore-mastodon-data.js).

The reason we don't use a Postgres dump for everything is that Mastodon will ignore changes made after a certain period of time, and we don't want our tests to randomly start breaking one day. Running the script ensures that statuses, favorites, boosts, etc. are all "fresh".

Updating the test data

You probably don't want to do this, as the 0xx tests are pretty rigidly defined against the test data. Write a 1xx test instead and insert what you need on-the-fly.

If you really need to, though, you can either:

Add new test data to mastodon-data.js

Comment out await restoreMastodonData() in run-mastodon.js
Make your changes manually to the live Mastodon
Run the steps in the next section to back it up to fixtures/

Updating the Mastodon version

Run rm -fr mastodon to clear out all Mastodon data
Comment out await restoreMastodonData() in run-mastodon.js to avoid actually populating the database with statuses/favorites/etc.
Update the GIT_TAG in mastodon-config.js to whatever you want
If the Ruby version changed (check Mastodon's .ruby-version), install it and update RUBY_VERSION in mastodon-config.js as well as the Ruby version in .github/workflows.
Run yarn run-mastodon
Run yarn backup-mastodon-data to overwrite the data in fixtures/
Uncomment await restoreMastodonData() in run-mastodon.js
Commit all changed files
Run rm -fr mastodon/ and yarn run run-mastodon to confirm everything's working

Check mastodon.log if you have any issues.

Note that we also run db:migrate just to play it safe, but updating the fixtures/ should make that a no-op.

Unit tests

There are also some unit tests that run in Node using Mocha. You can find them in tests/unit and run them using yarn run test-unit.

Debug build

To disable minification in a production build (for debugging purposes), you can run:

DEBUG=1 yarn build

Debugging Webpack

The Webpack Bundle Analyzer report.html and stats.json are available publicly via e.g.:

This is also available locally after yarn run build at .sapper/client/report.html.

Deploying

This section only applies to beta.semaphore.social and semaphore.social, not if you're hosting your own version of Semaphore.

The site uses Vercel. The main branch publishes to beta.semaphore.social and the production branch deploys to semaphore.social.

Architecture

See Architecture.md.

Internationalization

See Internationalization.md.

6.6 KiB Raw Permalink Blame History