go/sliding-sync
go/sliding-sync
1
0
Fork 0
mirror of https://github.com/matrix-org/sliding-sync.git synced 2025-03-10 13:37:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add developers' cheat sheet to README

Browse Source 
Because I will forget this
This commit is contained in:
David Robertson 2023-05-02 16:08:28 +01:00
parent 1c5d918718
commit c4d5a0664f
No known key found for this signature in database
GPG Key ID: 903ECE108A39DEDD
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -130,3 +130,29 @@ To debug **why the proxy is using 100% CPU**, run:
wget -O 'profile.pprof' 'http://localhost:6060/debug/pprof/profile?seconds=10'
```
Then send `profile.pprof` to someone who will then run `go tool pprof -http :5656 profile.pprof` and typically view the flame graph: View -> Flame Graph.
### Developers' cheat sheet
Sanity check everything builds:
```shell
go build ./cmd/syncv3
go list ./... | xargs -n1 go test -c -o /dev/null
```
Run all unit and integration tests:
```shell
go test -p 1 -count 1 $(go list ./... | grep -v tests-e2e) -timeout 120s
```
Run end-to-end tests:
```shell
# Run each line in a separate terminal windows. Will need to `docker login`
# to ghcr and pull the image.
docker run --rm -e "SYNAPSE_COMPLEMENT_DATABASE=sqlite" -e "SERVER_NAME=synapse" -p 8888:8008 ghcr.io/matrix-org/synapse-service:v1.72.0
(dropdb syncv3_test || true) && createdb syncv3_test && go build ./cmd/syncv3 && SYNCV3_SERVER=http://localhost:8888 SYNCV3_DB="user=$(whoami) dbname=syncv3_test sslmode=disable" SYNCV3_SECRET=secret SYNCV3_BINDADDR=0.0.0.0:8844 SYNCV3_ADDR='http://localhost:8844' SYNCV3_DEBUG=1 ./syncv3
SYNCV3_SERVER=http://localhost:8888 SYNCV3_ADDR=http://localhost:8844 go test ./tests-e2e -count=1 -v
```