*** DEPRECATED ****

The Replicache Diff Server has been deprecated: its use is no longer recommended and it will not be supported at all after March'21.

See https://js.replicache.dev/ for how to set Replicache up without the Diff Server.

Replicache Diff Server

This repository implements the Replicache Diff Server. See Replicache for more information. See the contributing guide there for contributing information.

Build

cd ~/work
git clone https://github.com/rocicorp/diff-server
cd diff-server
go build ./cmd/diffs
go test ./...

Run (Development Mode)

./diffs serve --db=/tmp/diffs-data --account-db=/tmp/diffs-accounts --enable-inject

# Pull from a Client View served from http://localhost:8000/replicache-client-view (replace clientViewURL as appropriate):
curl -H "Authorization: sandbox" -d '{"version": 3, "clientID":"c1", "baseStateID":"00000000000000000000000000000000", "checksum":"00000000", "clientViewURL":  "http://localhost:8000/replicache-client-view"}' http://localhost:7001/pull

# Or inject a clientview...
curl  -H "Authorization: sandbox" -d '{"clientID":"c1", "clientViewResponse":{"clientView":{"foo":"bar"},"lastTransactionID":"2"}}' http://localhost:7001/inject
# ... and then pull it (allowing localhost clientview fetch to fail):
curl -H "Authorization: sandbox" -d '{"version": 3, "clientID":"c1", "baseStateID":"00000000000000000000000000000000", "checksum":"00000000", "clientViewURL":  "http://localhost:8000/replicache-client-view"}' http://localhost:7001/pull

Deploy

now deploy
now deploy --prod

... or just check in a new commit, it will autodeploy.

Release

1. Bump version:

go get github.com/rocicorp/repc/tool/bump
bump --root=. diff-server <semver>
# push to github and merge
# pull merged commit
git tag v<semver>
git push origin v<semver>
# update release notes on github

2. Build release binaries:

./tools/release.sh

3. Find the new tag on https://github.com/rocicorp/diff-server/releases and edit it.
4. Upload diffs and noms artifacts generated in previous step (found in build/).
5. Save the release.

Done. Customers can now run tools/build.sh to get the new version as described here.

Debug in production

# Get noms: https://github.com/attic-labs/noms#install
# db spec below is something like aws:replicant/aa-replicant2/<accountid>
# This only works if you have proper AWS credentials, obv.

# delete client
noms ds -d <db-spec>::<client-id>

# chain diffs 
noms log <db spec>::client/<client id>

# chain
noms log --oneline <db spec>::client/<client id> | cut -d' ' -f1 | xargs -I{} noms show <db spec>::#{}

# see the value
noms log <db spec>::client/<client id>.value.data@target