+ +

Contributing

This document aims to get you started with contributing to Synapse!

1. Who can contribute to Synapse?

Everyone is welcome to contribute code to matrix.org +projects, provided that they are willing to +license their contributions under the same license as the project itself. We +follow a simple 'inbound=outbound' model for contributions: the act of +submitting an 'inbound' contribution means that the contributor agrees to +license the code under the same terms as the project's overall 'outbound' +license - in our case, this is almost always Apache Software License v2 (see +LICENSE).

2. What do I need?

If you are running Windows, the Windows Subsystem for Linux (WSL) is strongly +recommended for development. More information about WSL can be found at +https://docs.microsoft.com/en-us/windows/wsl/install. Running Synapse natively +on Windows is not officially supported.

The code of Synapse is written in Python 3. To do pretty much anything, you'll need a recent version of Python 3. Your Python also needs support for virtual environments. This is usually built-in, but some Linux distributions like Debian and Ubuntu split it out into its own package. Running sudo apt install python3-venv should be enough.

Synapse can connect to PostgreSQL via the psycopg2 Python library. Building this library from source requires access to PostgreSQL's C header files. On Debian or Ubuntu Linux, these can be installed with sudo apt install libpq-dev.

The source code of Synapse is hosted on GitHub. You will also need a recent version of git.

For some tests, you will need a recent version of Docker.

3. Get the source.

The preferred and easiest way to contribute changes is to fork the relevant +project on GitHub, and then create a pull request to ask us to pull your +changes into our repo.

Please base your changes on the develop branch.

git clone git@github.com:YOUR_GITHUB_USER_NAME/synapse.git
+git checkout develop
+

If you need help getting started with git, this is beyond the scope of the document, but you +can find many good git tutorials on the web.

4. Install the dependencies

Once you have installed Python 3 and added the source, please open a terminal and +setup a virtualenv, as follows:

cd path/where/you/have/cloned/the/repository
+python3 -m venv ./env
+source ./env/bin/activate
+pip install wheel
+pip install -e ".[all,dev]"
+pip install tox
+

This will install the developer dependencies for the project.

5. Get in touch.

Join our developer community on Matrix: #synapse-dev:matrix.org!

6. Pick an issue.

Fix your favorite problem or perhaps find a Good First Issue +to work on.

7. Turn coffee into code and documentation!

There is a growing amount of documentation located in the +docs +directory, with a rendered version available online. +This documentation is intended primarily for sysadmins running their +own Synapse instance, as well as developers interacting externally with +Synapse. +docs/development +exists primarily to house documentation for +Synapse developers. +docs/admin_api houses documentation +regarding Synapse's Admin API, which is used mostly by sysadmins and external +service developers.

Synapse's code style is documented here. Please follow +it, including the conventions for the sample configuration +file.

We welcome improvements and additions to our documentation itself! When +writing new pages, please +build docs to a book +to check that your contributions render correctly. The docs are written in +GitHub-Flavoured Markdown.

Some documentation also exists in Synapse's GitHub +Wiki, although this is primarily +contributed to by community authors.

8. Test, test, test!

While you're developing and before submitting a patch, you'll +want to test your code.

Run the linters.

The linters look at your code and do two things:

ensure that your code follows the coding style adopted by the project;
catch a number of errors in your code.

The linter takes no time at all to run as soon as you've downloaded the dependencies into your python virtual environment.

source ./env/bin/activate
+./scripts-dev/lint.sh
+

Note that this script will modify your files to fix styling errors. +Make sure that you have saved all your files.

If you wish to restrict the linters to only the files changed since the last commit +(much faster!), you can instead run:

source ./env/bin/activate
+./scripts-dev/lint.sh -d
+

Or if you know exactly which files you wish to lint, you can instead run:

source ./env/bin/activate
+./scripts-dev/lint.sh path/to/file1.py path/to/file2.py path/to/folder
+

Run the unit tests (Twisted trial).

The unit tests run parts of Synapse, including your changes, to see if anything +was broken. They are slower than the linters but will typically catch more errors.

source ./env/bin/activate
+trial tests
+

If you wish to only run some unit tests, you may specify +another module instead of tests - or a test class or a method:

source ./env/bin/activate
+trial tests.rest.admin.test_room tests.handlers.test_admin.ExfiltrateData.test_invite
+

If your tests fail, you may wish to look at the logs (the default log level is ERROR):

less _trial_temp/test.log
+

To increase the log level for the tests, set SYNAPSE_TEST_LOG_LEVEL:

SYNAPSE_TEST_LOG_LEVEL=DEBUG trial tests
+

By default, tests will use an in-memory SQLite database for test data. For additional +help with debugging, one can use an on-disk SQLite database file instead, in order to +review database state during and after running tests. This can be done by setting +the SYNAPSE_TEST_PERSIST_SQLITE_DB environment variable. Doing so will cause the +database state to be stored in a file named test.db under the trial process' +working directory. Typically, this ends up being _trial_temp/test.db. For example:

SYNAPSE_TEST_PERSIST_SQLITE_DB=1 trial tests
+

The database file can then be inspected with:

sqlite3 _trial_temp/test.db
+

Note that the database file is cleared at the beginning of each test run. Thus it +will always only contain the data generated by the last run test. Though generally +when debugging, one is only running a single test anyway.

Running tests under PostgreSQL

Invoking trial as above will use an in-memory SQLite database. This is great for +quick development and testing. However, we recommend using a PostgreSQL database +in production (and indeed, we have some code paths specific to each database). +This means that we need to run our unit tests against PostgreSQL too. Our CI does +this automatically for pull requests and release candidates, but it's sometimes +useful to reproduce this locally.

To do so, configure Postgres and run trial with the +following environment variables matching your configuration:

SYNAPSE_POSTGRES to anything nonempty
SYNAPSE_POSTGRES_HOST
SYNAPSE_POSTGRES_USER
SYNAPSE_POSTGRES_PASSWORD

For example:

export SYNAPSE_POSTGRES=1
+export SYNAPSE_POSTGRES_HOST=localhost
+export SYNAPSE_POSTGRES_USER=postgres
+export SYNAPSE_POSTGRES_PASSWORD=mydevenvpassword
+trial
+

Prebuilt container

Since configuring PostgreSQL can be fiddly, we can make use of a pre-made +Docker container to set up PostgreSQL and run our tests for us. To do so, run

scripts-dev/test_postgresql.sh
+

Any extra arguments to the script will be passed to tox and then to trial, +so we can run a specific test in this container with e.g.

scripts-dev/test_postgresql.sh tests.replication.test_sharded_event_persister.EventPersisterShardTestCase
+

The container creates a folder in your Synapse checkout called +.tox-pg-container and uses this as a tox environment. The output of any +trial runs goes into _trial_temp in your synapse source directory — the same +as running trial directly on your host machine.

Run the integration tests (Sytest).

The integration tests are a more comprehensive suite of tests. They +run a full version of Synapse, including your changes, to check if +anything was broken. They are slower than the unit tests but will +typically catch more errors.

The following command will let you run the integration test with the most common +configuration:

$ docker run --rm -it -v /path/where/you/have/cloned/the/repository\:/src:ro -v /path/to/where/you/want/logs\:/logs matrixdotorg/sytest-synapse:buster
+

This configuration should generally cover your needs. For more details about other configurations, see documentation in the SyTest repo.

Run the integration tests (Complement).

Complement is a suite of black box tests that can be run on any homeserver implementation. It can also be thought of as end-to-end (e2e) tests.

It's often nice to develop on Synapse and write Complement tests at the same time. +Here is how to run your local Synapse checkout against your local Complement checkout.

(checkout complement alongside your synapse checkout)

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh
+

To run a specific test file, you can pass the test name at the end of the command. The name passed comes from the naming structure in your Complement tests. If you're unsure of the name, you can do a full run and copy it from the test output:

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh TestBackfillingHistory
+

To run a specific test, you can specify the whole name structure:

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh TestBackfillingHistory/parallel/Backfilled_historical_events_resolve_with_proper_state_in_correct_order
+

Access database for homeserver after Complement test runs.

If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse:

In your Complement test comment out defer deployment.Destroy(t) and replace with defer time.Sleep(2 * time.Hour) to keep the homeserver running after the tests complete
Start the Complement tests
Find the name of the container, docker ps -f name=complement_ (this will filter for just the Compelement related Docker containers)
Access the container replacing the name with what you found in the previous step: docker exec -it complement_1_hs_with_application_service.hs1_2 /bin/bash
Install sqlite (database driver), apt-get update && apt-get install -y sqlite3
Then run sqlite3 and open the database .open /conf/homeserver.db (this db path comes from the Synapse homeserver.yaml)

9. Submit your patch.

Once you're happy with your patch, it's time to prepare a Pull Request.

To prepare a Pull Request, please:

verify that all the tests pass, including the coding style;
sign off your contribution;
git push your commit to your fork of Synapse;
on GitHub, create the Pull Request;
add a changelog entry and push it to your Pull Request;
for most contributors, that's all - however, if you are a member of the organization matrix-org, on GitHub, please request a review from matrix.org / Synapse Core.
if you need to update your PR, please avoid rebasing and just add new commits to your branch.

Changelog

All changes, even minor ones, need a corresponding changelog / newsfragment +entry. These are managed by Towncrier.

To create a changelog entry, make a new file in the changelog.d directory named +in the format of PRnumber.type. The type can be one of the following:

feature
bugfix
docker (for updates to the Docker image)
doc (for updates to the documentation)
removal (also used for deprecations)
misc (for internal-only changes)

This file will become part of our changelog at the next +release, so the content of the file should be a short description of your +change in the same style as the rest of the changelog. The file can contain Markdown +formatting, and should end with a full stop (.) or an exclamation mark (!) for +consistency.

Adding credits to the changelog is encouraged, we value your +contributions and would like to have you shouted out in the release notes!

For example, a fix in PR #1234 would have its changelog entry in +changelog.d/1234.bugfix, and contain content like:

+
The security levels of Florbs are now validated when received +via the /federation/florb endpoint. Contributed by Jane Matrix.
+

If there are multiple pull requests involved in a single bugfix/feature/etc, +then the content for each changelog.d file should be the same. Towncrier will +merge the matching files together into a single changelog entry when we come to +release.

How do I know what to call the changelog file before I create the PR?

Obviously, you don't know if you should call your newsfile +1234.bugfix or 5678.bugfix until you create the PR, which leads to a +chicken-and-egg problem.

There are two options for solving this:

+
Open the PR without a changelog file, see what number you got, and then +add the changelog file to your branch (see Updating your pull +request), or:
+
+
Look at the list of all +issues/PRs, add one to the +highest number you see, and quickly open the PR before somebody else claims +your number.
+
This +script +might be helpful if you find yourself doing this a lot.
+

Sorry, we know it's a bit fiddly, but it's really helpful for us when we come +to put together a release!

Debian changelog

Changes which affect the debian packaging files (in debian) are an +exception to the rule that all changes require a changelog.d file.

In this case, you will need to add an entry to the debian changelog for the +next release. For this, run the following command:

dch
+

This will make up a new version number (if there isn't already an unreleased +version in flight), and open an editor where you can add a new changelog entry. +(Our release process will ensure that the version number and maintainer name is +corrected for the release.)

If your change affects both the debian packaging and files outside the debian +directory, you will need both a regular newsfragment and an entry in the +debian changelog. (Though typically such changes should be submitted as two +separate pull requests.)

Sign off

In order to have a concrete record that your contribution is intentional +and you agree to license it under the same terms as the project's license, we've adopted the +same lightweight approach that the Linux Kernel +submitting patches process, +Docker, and many other +projects use: the DCO (Developer Certificate of Origin: +http://developercertificate.org/). This is a simple declaration that you wrote +the contribution or otherwise have the right to contribute it to Matrix:

Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+

If you agree to this for your contribution, then all that's needed is to +include the line in your commit or pull request comment:

Signed-off-by: Your Name <your@email.example.org>
+

We accept contributions under a legally identifiable name, such as +your name on government documentation or common-law names (names +claimed by legitimate usage or repute). Unfortunately, we cannot +accept anonymous contributions at this time.

Git allows you to add this signoff automatically when using the -s +flag to git commit, which uses the name and email set in your +user.name and user.email git configs.

10. Turn feedback into better code.

Once the Pull Request is opened, you will see a few things:

our automated CI (Continuous Integration) pipeline will run (again) the linters, the unit tests, the integration tests and more;
one or more of the developers will take a look at your Pull Request and offer feedback.

From this point, you should:

Look at the results of the CI pipeline. +
- If there is any error, fix the error.
+
If a developer has requested changes, make these changes and let us know if it is ready for a developer to review again.
Create a new commit with the changes. +
- Please do NOT overwrite the history. New commits make the reviewer's life easier.
- Push this commits to your Pull Request.
+
Back to 1.

Once both the CI and the developers are happy, the patch will be merged into Synapse and released shortly!

11. Find a new issue.

By now, you know the drill!

Notes for maintainers on merging PRs etc

There are some notes for those with commit access to the project on how we +manage git here.

Conclusion

That's it! Matrix is a very open and collaborative project as you might expect +given our obsession with open communication. If we're going to successfully +matrix together all the fragmented communication technologies out there we are +reliant on contributions and collaboration from the community to do so. So +please get involved - and we hope you have as much fun hacking on Matrix as we +do!

+ +

Synapse database schema files

Synapse's database schema is stored in the synapse.storage.schema module.

Logical databases

Synapse supports splitting its datastore across multiple physical databases (which can +be useful for large installations), and the schema files are therefore split according +to the logical database they apply to.

At the time of writing, the following "logical" databases are supported:

state - used to store Matrix room state (more specifically, state_groups, +their relationships and contents).
main - stores everything else.

Additionally, the common directory contains schema files for tables which must be +present on all physical databases.

Synapse schema versions

Synapse manages its database schema via "schema versions". These are mainly used to +help avoid confusion if the Synapse codebase is rolled back after the database is +updated. They work as follows:

+
The Synapse codebase defines a constant synapse.storage.schema.SCHEMA_VERSION +which represents the expectations made about the database by that version. For +example, as of Synapse v1.36, this is 59.
+
+
The database stores a "compatibility version" in +schema_compat_version.compat_version which defines the SCHEMA_VERSION of the +oldest version of Synapse which will work with the database. On startup, if +compat_version is found to be newer than SCHEMA_VERSION, Synapse will refuse to +start.
+
Synapse automatically updates this field from +synapse.storage.schema.SCHEMA_COMPAT_VERSION.
+
+
Whenever a backwards-incompatible change is made to the database format (normally +via a delta file), synapse.storage.schema.SCHEMA_COMPAT_VERSION is also updated +so that administrators can not accidentally roll back to a too-old version of Synapse.
+

Generally, the goal is to maintain compatibility with at least one or two previous +releases of Synapse, so any substantial change tends to require multiple releases and a +bit of forward-planning to get right.

As a worked example: we want to remove the room_stats_historical table. Here is how it +might pan out.

+
Replace any code that reads from room_stats_historical with alternative +implementations, but keep writing to it in case of rollback to an earlier version. +Also, increase synapse.storage.schema.SCHEMA_VERSION. In this +instance, there is no existing code which reads from room_stats_historical, so +our starting point is:
+
v1.36.0: SCHEMA_VERSION=59, SCHEMA_COMPAT_VERSION=59
+
+
Next (say in Synapse v1.37.0): remove the code that writes to +room_stats_historical, but don’t yet remove the table in case of rollback to +v1.36.0. Again, we increase synapse.storage.schema.SCHEMA_VERSION, but +because we have not broken compatibility with v1.36, we do not yet update +SCHEMA_COMPAT_VERSION. We now have:
+
v1.37.0: SCHEMA_VERSION=60, SCHEMA_COMPAT_VERSION=59.
+
+
Later (say in Synapse v1.38.0): we can remove the table altogether. This will +break compatibility with v1.36.0, so we must update SCHEMA_COMPAT_VERSION accordingly. +There is no need to update synapse.storage.schema.SCHEMA_VERSION, since there is no +change to the Synapse codebase here. So we end up with:
+
v1.38.0: SCHEMA_VERSION=60, SCHEMA_COMPAT_VERSION=60.
+

If in doubt about whether to update SCHEMA_VERSION or not, it is generally best to +lean towards doing so.

Full schema dumps

In the full_schemas directories, only the most recently-numbered snapshot is used +(54 at the time of writing). Older snapshots (eg, 16) are present for historical +reference only.

Building full schema dumps

If you want to recreate these schemas, they need to be made from a database that +has had all background updates run.

To do so, use scripts-dev/make_full_schema.sh. This will produce new +full.sql.postgres and full.sql.sqlite files.

Ensure postgres is installed, then run:

./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/
+

NB at the time of writing, this script predates the split into separate state/main +databases so will require updates to handle that correctly.

Delta files

Delta files define the steps required to upgrade the database from an earlier version. +They can be written as either a file containing a series of SQL statements, or a Python +module.

Synapse remembers which delta files it has applied to a database (they are stored in the +applied_schema_deltas table) and will not re-apply them (even if a given file is +subsequently updated).

Delta files should be placed in a directory named synapse/storage/schema/<database>/delta/<version>/. +They are applied in alphanumeric order, so by convention the first two characters +of the filename should be an integer such as 01, to put the file in the right order.

SQL delta files

These should be named *.sql, or — for changes which should only be applied for a +given database engine — *.sql.posgres or *.sql.sqlite. For example, a delta which +adds a new column to the foo table might be called 01add_bar_to_foo.sql.

Note that our SQL parser is a bit simple - it understands comments (-- and /*...*/), +but complex statements which require a ; in the middle of them (such as CREATE TRIGGER) are beyond it and you'll have to use a Python delta file.

Python delta files

For more flexibility, a delta file can take the form of a python module. These should +be named *.py. Note that database-engine-specific modules are not supported here – +instead you can write if isinstance(database_engine, PostgresEngine) or similar.

A Python delta module should define either or both of the following functions:

import synapse.config.homeserver
+import synapse.storage.engines
+import synapse.storage.types
+
+
+def run_create(
+    cur: synapse.storage.types.Cursor,
+    database_engine: synapse.storage.engines.BaseDatabaseEngine,
+) -> None:
+    """Called whenever an existing or new database is to be upgraded"""
+    ...
+
+def run_upgrade(
+    cur: synapse.storage.types.Cursor,
+    database_engine: synapse.storage.engines.BaseDatabaseEngine,
+    config: synapse.config.homeserver.HomeServerConfig,
+) -> None:
+    """Called whenever an existing database is to be upgraded."""
+    ...
+

Boolean columns

Boolean columns require special treatment, since SQLite treats booleans the +same as integers.

There are three separate aspects to this:

+
Any new boolean column must be added to the BOOLEAN_COLUMNS list in +scripts/synapse_port_db. This tells the port script to cast the integer +value from SQLite to a boolean before writing the value to the postgres +database.
+
+
Before SQLite 3.23, TRUE and FALSE were not recognised as constants by +SQLite, and the IS [NOT] TRUE/IS [NOT] FALSE operators were not +supported. This makes it necessary to avoid using TRUE and FALSE +constants in SQL commands.
+
For example, to insert a TRUE value into the database, write:
+
```
txn.execute("INSERT INTO tbl(col) VALUES (?)", (True, ))
+
```
+
+
Default values for new boolean columns present a particular +difficulty. Generally it is best to create separate schema files for +Postgres and SQLite. For example:
+
```
# in 00delta.sql.postgres:
+ALTER TABLE tbl ADD COLUMN col BOOLEAN DEFAULT FALSE;
+
```
+
```
# in 00delta.sql.sqlite:
+ALTER TABLE tbl ADD COLUMN col BOOLEAN DEFAULT 0;
+
```
+
Note that there is a particularly insidious failure mode here: the Postgres +flavour will be accepted by SQLite 3.22, but will give a column whose +default value is the string "FALSE" - which, when cast back to a boolean +in Python, evaluates to True.
+

+ +