VPR - Versioned Patient Repository

Install pre-commit hooks

pre-commit install

install rust locally if you want to test on local machine

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

start a new terminal to be able to use rust

Install protobuf compiler

brew install protobuf

Build

cargo build

Nuke Docs

As the docs run on a cache, you will likely need to nuke the docs if you remove files. Just manually run nuke docs cache (manual) from GitHub Actions.

Future: Database Projections

Note: The following database benchmarks and setup instructions are for planned future implementation of database projections (Postgres) and caching (Redis) for performance optimisation. The current system uses file-based storage only.

Time trial benchmarks

Preliminary benchmarks comparing Postgres vs Git for single entry operations:

• Postgres: 22.45 ops/sec
• Git: 8.11 ops/sec

Postgres is approximately 3 times faster for these operations.

Postgres setup (for future implementation)

brew install hyperfine
brew install postgresql@16
brew services start postgresql@16
PGURL="postgres://user:pass@localhost:5432/postgres" N=10000 ./file_db_time_trial.sh
createuser -s postgres || true
psql -U postgres -c "ALTER USER postgres WITH PASSWORD 'postgres';" || true

Test VPR server

With server reflection enabled (set VPR_ENABLE_REFLECTION=true), you can use:

grpcurl -plaintext -d '{}' localhost:50051 vpr.v1.VPR/Health

To get a reflection of the service:

grpcurl -plaintext localhost:50051 describe vpr.v1.VPR

You can check out endpoints specifics like this:

grpcurl -plaintext localhost:50051 describe .vpr.v1.CreatePatientReq

Or with the proto file (without reflection):

grpcurl -plaintext \
  -import-path crates/api/proto \
  -proto crates/api/proto/vpr/v1/vpr.proto \
  -d '{}' \
  localhost:50051 vpr.v1.VPR/Health

Note: Server reflection is disabled by default for security in production. Set VPR_ENABLE_REFLECTION=true to enable it.