How signalapp/signal-server works
Project Type & Purpose
• This is Signal-Server: a backend service (Java/Dropwizard) that powers Signal messenger. It exposes HTTP/REST and gRPC endpoints, a WebSocket tunnel, handles authentication, message persistence, push notifications, attachments, backups, and payments integrations.
File Structure & Key Modules
• Top-level Maven modules:
• api-doc: an OpenAPI extension plugin
• integration-tests: end-to-end test suite
• service: the core Dropwizard application
• websocket-resources: reusable WebSocket resource provider library
• In service/src/main/java:
• controllers: HTTP‐JSON/GraphQL bridges (Jersey resources)
• grpc: gRPC service implementations & interceptors
• websocket: WebSocket handshake + tunnel server
• auth: authentication filters (REST & gRPC)
• storage: DynamoDB data stores & Redis message cache scripts
• push: APNs/FCM push manager
• attachments: GCS/S3/Tus providers
• config: service-level configuration classes
• workers & scheduler: cron‐style background jobs (backups, metrics, cleanup)
• subscriptions & payments: Braintree/Stripe/Google Play billing clients
• gcp/pubsub: Google Pub/Sub publishers for notifications
• External dependencies signaled by configuration/*Configuration classes: DynamoDB, Redis Cluster, Pub/Sub, TURN servers (Cloudflare), metrics (Datadog), S3, secure storage.
a. & Represent Main Components
• Clients: Mobile apps (iOS/Android), Web clients
• Entry Points:
• HTTP REST/Jersey (Dropwizard)
• gRPC server
• WebSocket tunnel server
• Core Services:
• Authentication Layer (REST filters & gRPC interceptors)
• Rate limiting & Spam checks
• Controllers / gRPC handlers
• Message persistence (Redis cache → DynamoDB)
• Attachment service (Tus/GCS/S3)
• Push service (APNs, FCM)
• Subscription & Payment service (Braintree GraphQL, Stripe, Google)
• Key distribution & verification (Key Transparency client)
• TURN server credential manager (Cloudflare)
• Data Stores & Middleware:
• DynamoDB tables
• Redis cluster (pub/sub & cache)
• Google Pub/Sub
• Secret store & dynamic config
• Background Workers:
• Job Scheduler (Quartz/Virt Threads)
• Backup/cleanup commands
• Metrics exporters (Micrometer → Datadog)
b. Relationships & Data Flows
• Auth filters precede controllers; controllers call storage and push layers
• Message flow: REST/gRPC → MessagePersister → Redis → DynamoDB
• Push flow: Controller → PushNotificationManager → APNs/FCM
• Attachment flow: Controller → AttachmentGenerator → GCS/S3
• Payment flow: Controller → Braintree/Stripe client → external payment gateway
• Key transparency & TURN credentials are fetched on demand via external service clients
• Background job flow: Scheduler → Worker commands → database/Redis modifications
c. Architectural Patterns & Principles
• Layered architecture: presentation (controllers), service (business logic), data (storage)
• Asynchronous pub/sub for message delivery (Redis, Pub/Sub)
• Modularization: distinct packages for auth, grpc, controllers, storage, push, subscriptions
• Configuration-driven and discoverable services (Dropwizard “Discoverable” modules via META-INF/services)
• Resilience: circuit breakers around external calls, fault-tolerant Redis & HTTP clients
• Secure channels: Noise protocol in gRPC/WebSocket net layer
d. Call Out Major Technologies & Frameworks
• Java 17 (or later) with Maven
• Dropwizard (HTTP, Jackson, Jetty)
• gRPC + Protobuf definitions
• Redis (Lettuce client, Lua scripts)
• AWS DynamoDB, S3, GCS
• Google Pub/Sub
• Cloudflare TURN service
• Micrometer / Datadog metrics
• APNs / FCM push
• Braintree GraphQL, Stripe & Google Play billing