A sync server implemented in go to communicate with Brave sync clients using components/sync/protocol/sync.proto. Current Chromium version for sync protocol buffer files used in this repo is Chromium 116.0.5845.183.
This server supports endpoints as bellow.
- The
POST /v2/command/
endpoint handles Commit and GetUpdates requests from sync clients and return corresponding responses both in protobuf format. Detailed of requests and their corresponding responses are defined inschema/protobuf/sync_pb/sync.proto
. Sync clients are responsible for generating valid access tokens and present them to the server in the Authorization header of requests.
Currently we use dynamoDB as the datastore, the schema could be found in schema/dynamodb/table.json
.
- Install Go 1.22
- Install GolangCI-Lint
- Install gowrap
- Clone this repo
- Install protobuf protocol compiler if you need to compile protobuf files, which could be built using
make protobuf
. - Build via
make
- Clone this repo
- Run
make docker
- Run
make docker-up
- To connect to your local server from a Brave browser client use
--sync-url="https://localhost:8295/v2"
- For running unit tests, run
make docker-test
- Copy the
.proto
files fromcomponents/sync/protocol
inchromium
toschema/protobuf/sync_pb
ingo-sync
. - Copy the
.proto
files fromcomponents/sync/protocol
inbrave-core
toschema/protobuf/sync_pb
ingo-sync
. - Run
make repath-proto
to set correct import paths in.proto
files. - Run
make proto-go-module
to add thego_module
option to.proto
files. - Run
make protobuf
to generate the Go code from.proto
definitions.
The instrumented datastore and redis interfaces are generated, providing integration with Prometheus. The following will re-generate the instrumented code, required when updating protocl definitions:
make instrumented
Changes to datastore/datastore.go
or cache/cache.go
should be followed with the above command.