How pranavnadda/url-shortner works
This is a URL-shortening API with owned-link management, redirects, rate limiting, and asynchronous click analytics. Its primary flow creates a validated short code, persists it, then resolves incoming codes through Caffeine, Redis, and Postgres before returning the configured redirect; active redirects offer clicks without blocking the response. The graph preserves key generation, API-key security, and analytics query/ingestion stages. Source-index references and README statements support the shown relationships; unsampled implementation details are not expanded.
Main entry points: LinkService.java Link Service · RedirectCache.java Layered Cache · RedirectService.java Redirect Service · UrlController.java URL API
Components 25
API and Security
- URL API
src/main/java/dev/urlshortener/web/UrlController.java - API Key API
src/main/java/dev/urlshortener/web/ApiKeyController.java - Key Authentication
src/main/java/dev/urlshortener/auth/ApiKeyAuthFilter.java - Rate Limit Filter
src/main/java/dev/urlshortener/ratelimit/RateLimitFilter.java
Link Management
- Link Service
src/main/java/dev/urlshortener/service/LinkService.java - Key Service
src/main/java/dev/urlshortener/service/ApiKeyService.java - Code Generation
src/main/java/dev/urlshortener/codec/FeistelCodec.java - ID Leasing
src/main/java/dev/urlshortener/lease/IdBlockAllocator.java - Link Records
src/main/java/dev/urlshortener/domain/LinkRecord.java
Redirect Resolution
- Redirect Endpoint
src/main/java/dev/urlshortener/web/RedirectController.java - Redirect Service
src/main/java/dev/urlshortener/service/RedirectService.java - Layered Cache
src/main/java/dev/urlshortener/cache/RedirectCache.java
Click Analytics
- Click Publisher
src/main/java/dev/urlshortener/analytics/ClickPublisher.java - Redpanda
- Click Consumer
src/main/java/dev/urlshortener/analytics/ClickConsumer.java - ClickHouse Store
src/main/java/dev/urlshortener/analytics/ClickHouseStore.java - ClickHouse
- Analytics Queries
src/main/java/dev/urlshortener/service/AnalyticsService.java
State and Infrastructure
- Caffeine Cache
src/main/java/dev/urlshortener/cache/CaffeineLayerCache.java - Redis Cache
src/main/java/dev/urlshortener/cache/RedisLayerCache.java - Link Store
src/main/java/dev/urlshortener/store/JdbcLinkStore.java - API Key Store
src/main/java/dev/urlshortener/store/JdbcApiKeyStore.java - Postgres
- Application Metrics
src/main/java/dev/urlshortener/metrics/AppMetrics.java
Other components
- API Client
Connections 29
- API Client → URL API: manages links
src/main/java/dev/urlshortener/web/UrlController.java - API Client → Redirect Endpoint: requests short URL
README.md - API Client → API Key API: creates key
README.md - URL API → Link Service: delegates
src/main/java/dev/urlshortener/web/UrlController.java - URL API → Analytics Queries: queries analytics
src/main/java/dev/urlshortener/web/UrlController.java - API Key API → Key Service: delegates
src/main/java/dev/urlshortener/web/ApiKeyController.java - Key Authentication → API Key Store: validates key
src/main/java/dev/urlshortener/auth/ApiKeyAuthFilter.java - Key Authentication → Rate Limit Filter: rate limits API
- API Client → Rate Limit Filter: rate limited
README.md - Link Service → Code Generation: encodes ID
src/main/java/dev/urlshortener/service/LinkService.java - Link Service → ID Leasing: allocates IDs
src/main/java/dev/urlshortener/service/LinkService.java - Link Service → Link Store: persists links
src/main/java/dev/urlshortener/service/LinkService.java - Link Service → Layered Cache: invalidates entries
src/main/java/dev/urlshortener/service/LinkService.java - Link Service → Link Records: creates records
src/main/java/dev/urlshortener/service/LinkService.java - Code Generation → ID Leasing: transforms IDs
- Redirect Endpoint → Redirect Service: delegates
src/main/java/dev/urlshortener/web/RedirectController.java - Redirect Service → Layered Cache: resolves code
src/main/java/dev/urlshortener/service/RedirectService.java - Layered Cache → Caffeine Cache: checks first
README.md - Layered Cache → Redis Cache: checks next
README.md - Layered Cache → Link Store: loads on miss
README.md - Link Store → Postgres: reads and writes
README.md - Redirect Service → Click Publisher: offers click
src/main/java/dev/urlshortener/service/RedirectService.java - Click Publisher → Redpanda: publishes events
README.md - Redpanda → Click Consumer: delivers events
README.md - Click Consumer → ClickHouse Store: writes batches
src/main/java/dev/urlshortener/analytics/ClickConsumer.java - ClickHouse Store → ClickHouse: stores events
README.md - Analytics Queries → ClickHouse Store: queries counts
src/main/java/dev/urlshortener/service/AnalyticsService.java - Click Consumer → Application Metrics: records lag
src/main/java/dev/urlshortener/analytics/ClickConsumer.java - Redirect Service → Application Metrics: records redirects
src/main/java/dev/urlshortener/service/RedirectService.java