syncv3

README

sync-v3

Run an experimental sync v3 server using an existing Matrix account. This is possible because, for the most part, v3 sync is a strict subset of v2 sync.

An implementation of MSC3575.

Proxy version to MSC API specification:

• Version 0.1.x: 2022/04/01
  • First release
• Version 0.2.x: 2022/06/09
  • Reworked where lists and ops are situated in the response JSON. Added new filters like room_name_like. Added slow_get_all_rooms. Standardised on env vars for configuring the proxy. Persist access tokens, encrypted with SYNCV3_SECRET.
• Version 0.3.x: 2022/08/05
  • Spaces support, txn_id support.
• Version 0.4.x 2022/08/23
  • Support for tags and not_tags.
• Version 0.5.x 2022/10/04
  • Support for joined_count and invited_count.
  • No support for resolve_tombstones yet.

Usage

Requires Postgres 13+.

$ createdb syncv3
$ echo -n "$(openssl rand -hex 32)" > .secret # this MUST remain the same throughout the lifetime of the database created above.
$ go build ./cmd/syncv3
$ SYNCV3_SECRET=$(cat .secret) SYNCV3_SERVER="https://matrix-client.matrix.org" SYNCV3_DB="user=$(whoami) dbname=syncv3 sslmode=disable" SYNCV3_BINDADDR=0.0.0.0:8008 ./syncv3

Then visit http://localhost:8008/client/ (with trailing slash) and paste in the access_token for any account on -server.

When you hit the Sync button nothing will happen initially, but you should see:

INF Poller: v2 poll loop started ip=::1 since= user_id=@kegan:matrix.org

Wait for the first initial v2 sync to be processed (this can take minutes!) and then v3 APIs will be responsive.

Helm

You need a postgres instance. If you have one already, skip this. Else:

$ helm repo add bitnami https://charts.bitnami.com/bitnami 
$ helm install psql bitnami/postgresql

Then create a YAML file:

# values.yml
databaseHost: "psql-postgresql.myproxy.svc.cluster.local"
databasePasswordSecretName: "psql-postgresql"
databasePasswordSecretKey: "postgres-password"
databaseUser: "postgres"
databaseName: "postgres"
targetHomeserver: "https://myhomeserver.example"
ingress:
    annotateFor: "nginx"
    hostName: "myproxy.test"

To install via Helm:

$ helm repo add sliding-sync https://matrix-org.github.io/sliding-sync/
$ helm install myproxy -f values.yml sliding-sync/sliding-sync

How can I help?

At present, the best way to help would be to run a local v3 server pointed at a busy account and just leave it and a client running in the background. Look at it occasionally and submit any issues you notice. You can save console logs by right-clicking -> Save As.

Please run the server with SYNCV3_DEBUG=1 set. This will force the server to panic when assertions fail rather than just log them.

Documentation

Index

• Variables
• func Init(destHomeserver, postgresURI, secret string)
• func NewSyncV2Pollers(destHomeserver, postgresURI, secret string, opts Opts) *handler2.Handler
• func NewSyncV3Handler(destHomeserver, postgresURI, secret string, opts Opts) http.Handler
• func RunSyncV3Server(h http.Handler, bindAddr, destV2Server string)
• func Setup(destHomeserver, postgresURI, secret string, opts Opts) (*handler2.Handler, *handler.SyncLiveHandler)
• type HandlerError
  • func (e *HandlerError) Error() string
  • func (e HandlerError) JSON() []byte
• type Opts

Variables

var Version string

Functions

func Init

func Init(destHomeserver, postgresURI, secret string)

Init stores required for the proxy e.g CREATE TABLE

func NewSyncV2Pollers

func NewSyncV2Pollers(destHomeserver, postgresURI, secret string, opts Opts) *handler2.Handler

func NewSyncV3Handler

func NewSyncV3Handler(destHomeserver, postgresURI, secret string, opts Opts) http.Handler

func RunSyncV3Server

func RunSyncV3Server(h http.Handler, bindAddr, destV2Server string)

RunSyncV3Server is the main entry point to the server

func Setup

func Setup(destHomeserver, postgresURI, secret string, opts Opts) (*handler2.Handler, *handler.SyncLiveHandler)

Setup both components.

Types

type HandlerError

type HandlerError struct {
	StatusCode int
	Err        error
}

func (*HandlerError) Error

func (e *HandlerError) Error() string

func (HandlerError) JSON

func (e HandlerError) JSON() []byte

type Opts

type Opts struct {
	Debug                bool
	AddPrometheusMetrics bool
	// if true, publishing messages will block until the consumer has consumed it.
	// Assumes a single producer and a single consumer.
	TestingSynchronousPubsub bool
}