How khoadinhnguyen/restaurantos works
RestaurantOS is a distributed restaurant-chain ordering system. A client request enters the gateway, which routes it to a region; the region processes orders against its own stock and database. If a region is unreachable, the gateway can park the order for later delivery. Region events reach HQ asynchronously for reporting. The simulation prepares and replays order data, injects failures, and checks outcomes. The README documents failover and cross-region queries, but the supplied tree has no coordinator module; those capabilities are shown at the documented level. Some service wiring is unsampled, so edges are limited to shown code or README statements.
Main entry points: app.py Gateway API · orders.py Order Transactions · worker.py Relay Worker · bootstrap.py Cluster Bootstrap
Components 27
Gateway and Routing
- Gateway API
src/restaurantos/gateway/app.py - Region Directory
src/restaurantos/gateway/directory.py - Order Routing
src/restaurantos/gateway/orders.py - Menu and Vendors
src/restaurantos/gateway/menu_publish.py
Regional Operations
- Order Transactions
src/restaurantos/region/orders.py - Order Status
src/restaurantos/region/status.py - Regional Menu
src/restaurantos/region/menu.py - Regional Stock
src/restaurantos/region/stock.py - Region Database
- Live Standby
HQ and Replication
- Holding Queue
src/restaurantos/relay/holding.py - HQ Database
- Relay Worker
src/restaurantos/relay/worker.py - Region Outbox
src/restaurantos/relay/outbox.py - HQ Event Apply
src/restaurantos/relay/hq_apply.py - Cross-Region Queries
src/restaurantos/gateway/summary.py
Simulation and Validation
- Cluster Bootstrap
src/restaurantos/sim/bootstrap.py - Dataset Loading
src/restaurantos/sim/loading.py - Replay Data Cache
src/restaurantos/sim/replaydata.py - Order Playback
src/restaurantos/sim/playback.py - Fault Injection
src/restaurantos/sim/toxiproxy.py - Outcome Checks
src/restaurantos/sim/datacheck.py
Shared Runtime
- Primary Failover
- DB Connectivity
src/restaurantos/common/db.py - Cluster Model
src/restaurantos/common/cluster.py - Shared Contracts
src/restaurantos/common/models.py
Other components
- Order Client
Connections 30
- Order Client → Gateway API: sends requests
- Gateway API → Region Directory: routes vendors
src/restaurantos/gateway/app.py - Gateway API → Order Routing: handles orders
src/restaurantos/gateway/app.py - Order Routing → Order Transactions: places order
src/restaurantos/gateway/orders.py - Order Routing → Holding Queue: parks unreachable
- Order Transactions → Region Database: commits order
src/restaurantos/region/orders.py - Order Status → Region Database: reads status
- Regional Menu → Region Database: serves menu
- Regional Stock → Region Database: updates stock
- Region Database → Live Standby: streams replication
- Primary Failover → Live Standby: promotes standby
- Primary Failover → Region Database: advances epoch
- Order Transactions → Region Outbox: writes event
src/restaurantos/region/orders.py - Relay Worker → Region Outbox: reads pending
src/restaurantos/relay/worker.py - Relay Worker → HQ Event Apply: applies batch
src/restaurantos/relay/worker.py - HQ Event Apply → HQ Database: writes events
- Gateway API → Cross-Region Queries: serves summaries
src/restaurantos/gateway/app.py - Cross-Region Queries → HQ Database: queries regions
- Gateway API → Menu and Vendors: publishes menu
src/restaurantos/gateway/app.py - Cluster Bootstrap → Dataset Loading: loads dataset
src/restaurantos/sim/bootstrap.py - Dataset Loading → Replay Data Cache: builds cache
src/restaurantos/sim/replaydata.py - Order Playback → Replay Data Cache: streams orders
src/restaurantos/sim/playback.py - Order Playback → Gateway API: posts orders
src/restaurantos/sim/playback.py - Cluster Bootstrap → Fault Injection: configures faults
src/restaurantos/sim/bootstrap.py - Outcome Checks → Dataset Loading: checks loaded data
src/restaurantos/sim/datacheck.py - Cluster Bootstrap → Outcome Checks: validates setup
src/restaurantos/sim/bootstrap.py - Gateway API → DB Connectivity: uses pools
src/restaurantos/gateway/app.py - Relay Worker → DB Connectivity: opens pools
src/restaurantos/relay/worker.py - DB Connectivity → Cluster Model: builds connection info
src/restaurantos/common/db.py - Order Transactions → Shared Contracts: uses order models
src/restaurantos/region/orders.py