Feature Roadmap

Track the progress of Armature Framework's development. The framework is feature-complete for enterprise production use.

Overall Progress 122/126

97% complete — Only i18n and Grafana dashboards remaining!

✅ Completed 🔴 Critical 🟠 High Priority 🟡 Medium Priority 🟢 Low Priority

Implementation Phases

Q1 ✅

Phase 1: Production Essentials

100% complete

✅ Health Check Module
✅ Request Timeout & Size Limits
✅ Global Exception Filters
✅ Pagination Helpers
✅ Circuit Breaker
✅ Graceful Shutdown
✅ Multipart Upload
✅ SMTP Integration

Q2 ✅

Phase 2: Enterprise Features

83% complete

✅ Prometheus Metrics
✅ API Versioning
✅ Audit Logging
✅ Multi-tenancy
✅ Feature Flags
🟠 i18n Support

Q3 ✅

Phase 3: Advanced Capabilities

100% complete

✅ RabbitMQ/Kafka Integration
✅ Event Bus
✅ HTTP Client with Retry
✅ Distributed Locks
✅ Request Correlation
✅ Cloud Provider SDKs

Q4 ✅

Phase 4: Developer Experience

100% complete

✅ Test Containers
✅ Push Notifications
✅ Advanced Caching
✅ Serverless Deployment
✅ CLI Enhancements
✅ Grafana Dashboards

Q1 2025

Phase 5: Performance

33% complete

✅ CPU Profiling
✅ matchit Router
🔴 TechEmpower Benchmarks
🔴 Zero-Cost Abstractions
🔴 Buffer Pooling
🔴 io_uring Support

🔥

Performance Roadmap

Based on CPU profiling analysis. Goal: Achieve Axum and Actix-web competitive performance on TechEmpower benchmarks.

Profiling & Setup

5/13

Axum-Competitive

1/29

Actix-web Competitive

0/21

📊 CPU Profiling Results

Recently Completed

5/5

✅

CPU Profiling

Flamegraph generation with pprof

✅

Profiling Script

Automated profiling workflow

✅

Profiling Docs

Documentation website guide

✅

Grafana Dashboards

Pre-built dashboard templates

✅

matchit Router

Replace trie with matchit crate (PR #66)

Routing & Request Handling (~28% CPU)

0/3

🟠

Route Matching Cache

Cache compiled routes to avoid repeated traversal

🟠

Static Route Fast Path

Bypass tree for exact-match static routes using HashMap

🟡

Header Map Optimization

Use smallvec or pre-allocated headers for common cases

HTTP Parsing (~7% CPU)

0/2

🟡

SIMD HTTP Parser

Integrate httparse SIMD features or picohttpparser

🟡

Header Interning

Intern common header names to avoid allocations

Serialization

0/3

🟠

SIMD JSON

Add optional simd-json or sonic-rs for faster JSON

🟡

Zero-Copy Responses

Use Bytes for zero-copy response bodies

🟡

Pre-allocated Buffers

Buffer pool for response serialization

⚡ Axum-Competitive Optimizations

Goal: Match Axum's zero-cost abstractions and TechEmpower performance.

Router Optimization (Critical)

🔴 1 🟠 2

✅

Replace Trie with matchit

Use matchit crate (same as Axum) for route matching

armature-core/routing.rs

🔴

Compile-time Route Validation

Validate routes at compile time, not runtime

armature-macro

🟠

Route Parameter Extraction

Zero-allocation parameter extraction like Axum

armature-core/routing.rs

🟠

Wildcard/Catch-all Optimization

Optimize *path and /*rest patterns

armature-core/routing.rs

Zero-Cost Abstractions (Critical)

🔴 2 🟠 2

🔴

Inline Handler Dispatch

Ensure handlers are inlined via monomorphization

armature-core

🔴

Remove Runtime Type Checks

Eliminate Any downcasting in hot paths

armature-core/di.rs

🟠

Const Generic Extractors

Use const generics for zero-cost extractor chains

armature-core/extractors.rs

🟠

Static Dispatch Middleware

Replace Box<dyn> with static dispatch where possible

armature-core/middleware.rs

Memory & Allocation

🔴 1 🟠 3

🔴

Arena Allocator for Requests

Per-request arena to batch deallocations

armature-core

🟠

SmallVec for Headers

Use SmallVec<[_; 16]> for typical header counts

armature-core

🟠

CompactString for Paths

Use compact_str for short route paths

armature-core/routing.rs

🟠

Pre-sized Response Buffers

Avoid reallocations during response building

armature-core/response.rs

🟡

Object Pool for Requests

Reuse request/response objects across connections

armature-core

Hyper Integration

🔴 1 🟠 2

🔴

Direct Hyper Body Passthrough

Avoid wrapping/unwrapping hyper::Body

armature-core

🟠

Native http Crate Types

Use http::Request/Response directly

armature-core

🟠

Tower Service Compatibility

Implement tower::Service for composability

armature-core

🟡

Hyper 1.0 Full Support

Ensure all Hyper 1.0 features are utilized

armature-core

Async Runtime Optimization

🟠 2

🟠

Reduce Task Spawning

Inline simple handlers instead of spawning tasks

armature-core

🟠

tokio::task::LocalSet Option

Single-threaded mode for maximum cache locality

armature-core

🟡

Custom Executor Tuning

Expose tokio runtime configuration

armature-core

🟡

Work-Stealing Optimization

Tune work-stealing for HTTP workloads

armature-core

Benchmark Infrastructure

🔴 1 🟠 2

🔴

TechEmpower Benchmark Suite

Implement all TechEmpower tests (JSON, DB, Fortune)

benches/techempower/

🟠

Automated Regression Tests

CI pipeline to catch performance regressions

.github/workflows/

🟠

Axum Comparison Benchmark

Side-by-side benchmark vs Axum with same routes

benches/comparison/

🟡

Flame Graph CI Integration

Auto-generate flamegraphs on benchmark runs

.github/workflows/

Compiler Optimizations

🟠 2

🟠

Profile-Guided Optimization

Add PGO build profile

Cargo.toml

🟠

LTO Thin/Fat Modes

Benchmark LTO impact on binary size vs speed

Cargo.toml

🟡

Target-specific Tuning

Enable -C target-cpu=native for benchmarks

Cargo.toml

🟡

Codegen Units = 1

Single codegen unit for maximum optimization

Cargo.toml

🚀 Actix-web Competitive Optimizations

Goal: Match Actix-web's TechEmpower-leading performance through low-level optimizations.

HTTP/1.1 Optimizations (Critical)

🔴 2 🟠 2

🔴

HTTP/1.1 Pipelining

Process multiple requests per connection without waiting

armature-core/http.rs

🔴

Request Batching

Batch-read multiple requests from socket buffer

armature-core/http.rs

🟠

Response Pipelining

Queue responses for batch-write to socket

armature-core/http.rs

🟠

Vectored I/O (writev)

Use writev() to send headers+body in single syscall

armature-core/http.rs

Buffer Management (Critical)

🔴 2 🟠 2

🔴

BytesMut Buffer Pool

Thread-local pool of pre-allocated BytesMut buffers

armature-core/buffer.rs

🔴

Zero-Copy Request Body

Parse directly into pooled buffers without copying

armature-core/request.rs

🟠

Read Buffer Sizing

Tune read buffer sizes based on typical payload

armature-core/config.rs

🟠

Write Buffer Coalescing

Combine small writes into single buffer flush

armature-core/response.rs

🟡

Buffer Size Auto-Tuning

Dynamically adjust buffer sizes based on traffic

armature-core/buffer.rs

Worker Architecture

🟠 3

🟠

Per-Worker State

Thread-local state to avoid Arc contention

armature-core/worker.rs

🟠

CPU Core Affinity

Pin worker threads to CPU cores for cache locality

armature-core/runtime.rs

🟠

NUMA-Aware Allocation

Allocate memory on same NUMA node as worker

armature-core/runtime.rs

🟡

Worker Load Balancing

Round-robin or least-connections distribution

armature-core/worker.rs

Syscall Optimization

🔴 1 🟠 2

🔴

io_uring Support

Use io_uring for async I/O on Linux 5.1+

armature-core/io.rs

🟠

epoll Tuning

Optimize epoll flags and batch sizes

armature-core/io.rs

🟠

Reduce recv/send Calls

Batch socket operations where possible

armature-core/io.rs

🟡

TCP_CORK Usage

Cork TCP for header+body combining

armature-core/io.rs

Actix Benchmark Comparison

🔴 1 🟠 2

🔴

Actix Comparison Benchmark

Direct A/B benchmark against Actix-web

benches/comparison/actix/

🟠

JSON Serialization Benchmark

Compare JSON endpoint performance

benches/json/

🟠

Plaintext Benchmark

Raw "Hello World" throughput test

benches/plaintext/

🟡

Database Query Benchmark

Single/multiple query performance

benches/database/

✅

Already Completed

The following features are already implemented and production-ready:

✓ Core: DI, Controllers, Modules, Routing, Middleware, Guards, Interceptors

✓ Request Handling: Timeouts, Size Limits, Extractors, Streaming

✓ API: Versioning, Content Negotiation, ETags, Pagination, Filtering

✓ Error Handling: Global Filters, RFC 7807, Error Correlation

✓ Auth: JWT, OAuth2 (10+ providers), SAML 2.0, 2FA, Passwordless

✓ Security: Rate Limiting, CSP, HSTS, Request Signing, CORS

✓ Caching: Redis, Memcached, Multi-tier, Tag Invalidation

✓ Messaging: RabbitMQ, Kafka, NATS, AWS SQS/SNS

✓ Event-Driven: Event Bus, Event Sourcing, CQRS

✓ Storage: Local, S3, GCS, Azure Blob, Multipart Upload

✓ Email: SMTP, SendGrid, SES, Mailgun, Email Queue

✓ Push: Web Push, FCM, APNS, Unified Push Service

✓ Observability: OpenTelemetry, Prometheus, Health Checks, Audit Logging

✓ Resilience: Circuit Breaker, Retry, Bulkhead, Timeout, Fallback

✓ Multi-tenancy: Tenant Isolation, DB/Schema per Tenant, Feature Flags

✓ Distributed: Locks, Leader Election, Service Discovery

✓ Testing: Unit, Integration, Test Containers, Load, Contract

✓ Cloud: AWS, GCP, Azure SDKs, Lambda, Cloud Run, Azure Functions

✓ DevOps: Docker, Kubernetes, Helm, GitHub Actions, Jenkins

✓ CLI: Code Gen, Templates, Dev Server, REPL, Route Listing

Feature Categories

Request & Response Handling

7/7 completed

Status	Feature	Description	Module
✅ Completed	Request Timeout	Configurable request timeouts with graceful handling	`armature-core`
✅ Completed	Request Size Limits	Max body size, max header size configuration	`armature-core`
✅ Completed	Content Negotiation	Accept header parsing, response format selection	`armature-core`
✅ Completed	ETags & Conditional Requests	If-Match, If-None-Match, If-Modified-Since support	`armature-core`
✅ Completed	Response Caching Headers	Cache-Control, Expires, Vary header helpers	`armature-core`
✅ Completed	Streaming Responses	Chunked transfer encoding, streaming large files	`armature-core`
✅ Completed	Request Extractors	Body, Query, Path, Header extractors	`armature-core`

Routing & Controllers

7/7 completed

Status	Feature	Description	Module
✅ Completed	API Versioning	URL-based, header-based, and query-based versioning	`armature-core`
✅ Completed	Route Groups	Group routes with shared middleware/guards	`armature-core`
✅ Completed	Route Constraints	Parameter validation at route level	`armature-core`
✅ Completed	Middleware Decorator	Apply middleware via #[use_middleware] syntax	`armature-macro`
✅ Completed	Guard Decorator	Apply guards via #[use_guard] syntax	`armature-macro`
✅ Completed	Path Parameters	:id style path parameters	`armature-core`
✅ Completed	Query Parameters	Query string parsing	`armature-core`

Error Handling

4/4 completed

Status	Feature	Description	Module
✅ Completed	Global Exception Filters	Centralized error transformation	`armature-core`
✅ Completed	Problem Details (RFC 7807)	Standardized error response format	`armature-core`
✅ Completed	Error Correlation	Tie errors to request IDs for debugging	`armature-core`
✅ Completed	HTTP Status Errors	Type-safe error responses	`armature-core`

Observability & Monitoring

9/9 completed

Status	Feature	Description	Module
✅ Completed	Health Check Module	/health, /ready, /live endpoints	`armature-core`
✅ Completed	Custom Health Indicators	Register custom health checks	`armature-core`
✅ Completed	Kubernetes Probes	K8s-compatible probe endpoints	`armature-core`
✅ Completed	OpenTelemetry	Distributed tracing and metrics	`armature-opentelemetry`
✅ Completed	Structured Logging	JSON logging with tracing integration	`armature-core`
✅ Completed	Prometheus Metrics	/metrics endpoint with custom metrics	`armature-metrics`
✅ Completed	Request Metrics	Request count, latency, error rates	`armature-metrics`
✅ Completed	Business Metrics	Custom metric registration	`armature-metrics`
✅ Completed	Grafana Dashboards	Pre-built dashboard templates	`templates/grafana/`

Audit & Compliance

4/4 completed

Status	Feature	Description	Module
✅ Completed	Audit Logging	Track who did what, when	`armature-audit`
✅ Completed	Request/Response Logging	Configurable payload logging	`armature-audit`
✅ Completed	Data Masking	Mask sensitive data in logs (PII, passwords, credit cards)	`armature-audit`
✅ Completed	Retention Policies	Auto-cleanup old audit logs	`armature-audit`

Resilience & Reliability

8/8 completed

Status	Feature	Description	Module
✅ Completed	Circuit Breaker	Open/Closed/Half-Open states, sliding window	`armature-core`
✅ Completed	Retry with Backoff	Constant, linear, exponential, jitter strategies	`armature-core`
✅ Completed	Bulkhead Pattern	Semaphore-based resource isolation	`armature-core`
✅ Completed	Timeout Policies	Timeout configuration per endpoint	`armature-core`
✅ Completed	Fallback Handlers	Graceful degradation with chains	`armature-core`
✅ Completed	Connection Draining	Wait for in-flight requests on shutdown	`armature-core`
✅ Completed	Shutdown Hooks	Custom cleanup on shutdown	`armature-core`
✅ Completed	Lifecycle Hooks	OnApplicationShutdown, OnModuleInit	`armature-core`

API Features

5/5 completed

Status	Feature	Description	Module
✅ Completed	Pagination Helpers	Offset, cursor-based pagination	`armature-core`
✅ Completed	Sorting Helpers	Multi-field sorting	`armature-core`
✅ Completed	Filtering Helpers	Query parameter filtering	`armature-core`
✅ Completed	Search Helpers	Full-text search integration	`armature-core`
✅ Completed	Field Selection	Sparse fieldsets (GraphQL-like)	`armature-core`

File Storage

6/6 completed

Status	Feature	Description	Module
✅ Completed	Multipart Upload	Streaming file upload with constraints	`armature-storage`
✅ Completed	File Validation	Type, size, extension validation	`armature-storage`
✅ Completed	Local Storage	Filesystem storage with paths	`armature-storage`
✅ Completed	AWS S3	Presigned URLs, server-side encryption	`armature-storage`
✅ Completed	Google Cloud Storage	Signed URLs, resumable uploads	`armature-storage`
✅ Completed	Azure Blob Storage	Azurite support, SAS tokens	`armature-storage`

Email

6/6 completed

Status	Feature	Description	Module
✅ Completed	SMTP Transport	TLS, STARTTLS, connection pooling	`armature-mail`
✅ Completed	Email Templates	Handlebars-based HTML templates	`armature-mail`
✅ Completed	SendGrid Integration	SendGrid API support	`armature-mail`
✅ Completed	AWS SES	AWS Simple Email Service	`armature-mail`
✅ Completed	Mailgun	Mailgun API support	`armature-mail`
✅ Completed	Email Queue	Async sending, retries, dead letter queue	`armature-mail`

Messaging & Events

8/8 completed

Status	Feature	Description	Module
✅ Completed	RabbitMQ	Message broker integration	`armature-messaging`
✅ Completed	Apache Kafka	Event streaming platform	`armature-messaging`
✅ Completed	NATS	Cloud-native messaging	`armature-messaging`
✅ Completed	AWS SQS/SNS	AWS messaging services	`armature-messaging`
✅ Completed	Job Queue	Redis-based background jobs	`armature-queue`
✅ Completed	Event Bus	In-process event publishing	`armature-events`
✅ Completed	Event Sourcing	Event-sourced aggregates	`armature-eventsourcing`
✅ Completed	CQRS	Command/Query separation	`armature-cqrs`

External APIs & Networking

5/5 completed

Status	Feature	Description	Module
✅ Completed	HTTP Client	Built-in client with retry and circuit breaker	`armature-http-client`
✅ Completed	gRPC	Server and client support	`armature-grpc`
✅ Completed	GraphQL Client	Client for federation and subscriptions	`armature-graphql-client`
✅ Completed	WebSocket & SSE	Real-time bidirectional communication	`armature-core`
✅ Completed	Webhooks	Webhook sending and receiving	`armature-core`

Authentication & Security

9/9 completed

Status	Feature	Description	Module
✅ Completed	JWT Authentication	Token signing, verification, refresh	`armature-jwt`
✅ Completed	OAuth2/OIDC	Google, Microsoft, GitHub, Discord, and more	`armature-auth`
✅ Completed	SAML 2.0	Enterprise SSO integration	`armature-auth`
✅ Completed	API Key Management	Generation, rotation, scopes	`armature-auth`
✅ Completed	Two-Factor Auth	TOTP/HOTP support	`armature-auth`
✅ Completed	Passwordless Auth	Magic links, WebAuthn	`armature-auth`
✅ Completed	Rate Limiting	Token bucket, sliding window	`armature-ratelimit`
✅ Completed	Security Headers	CSP, HSTS, X-Frame-Options, etc.	`armature-security`
✅ Completed	Request Signing	HMAC-SHA256 verification	`armature-security`

Multi-tenancy & Enterprise

5/5 completed

Status	Feature	Description	Module
✅ Completed	Tenant Isolation	Request-scoped tenant context	`armature-tenancy`
✅ Completed	Database per Tenant	Separate database connections	`armature-tenancy`
✅ Completed	Schema per Tenant	PostgreSQL schema isolation	`armature-tenancy`
✅ Completed	Tenant Middleware	Auto tenant resolution	`armature-tenancy`
✅ Completed	Feature Flags	Runtime toggling, A/B testing, gradual rollout	`armature-features`

Internationalization

0/4 completed

Status	Feature	Description	Module
🟠 High	i18n Support	Message translation system	`armature-i18n`
🟠 High	Locale Detection	Accept-Language header parsing	`armature-i18n`
🟡 Medium	Pluralization	Plural rules support	`armature-i18n`
🟡 Medium	Date/Number Formatting	Locale-aware formatting	`armature-i18n`

Developer Experience

8/8 completed

Status	Feature	Description	Module
✅ Completed	Code Generation	Controllers, services, modules	`armature-cli`
✅ Completed	Project Templates	Starter templates	`armature-cli`
✅ Completed	Dev Server	Hot reloading development	`armature-cli`
✅ Completed	Interactive REPL	Interactive Rust shell	`armature-cli`
✅ Completed	Route Listing	armature routes command	`armature-cli`
✅ Completed	Config Validation	armature config:check	`armature-cli`
✅ Completed	OpenAPI Generation	Swagger/OpenAPI documentation	`armature-openapi`
✅ Completed	API Playground	Interactive API testing UI	`armature-openapi`

Testing

5/5 completed

Status	Feature	Description	Module
✅ Completed	Unit Test Helpers	Mocks, spies, assertions	`armature-testing`
✅ Completed	Integration Test Helpers	Database setup/teardown	`armature-testing`
✅ Completed	Test Containers	Docker-based testing (Postgres, Redis, MongoDB)	`armature-testing`
✅ Completed	Load Testing	Performance test utilities	`armature-testing`
✅ Completed	Contract Testing	Pact-compatible consumer-driven contracts	`armature-testing`

Distributed Systems

4/4 completed

Status	Feature	Description	Module
✅ Completed	Distributed Locks	Redis-based locks with TTL and RAII	`armature-distributed`
✅ Completed	Leader Election	Automatic failover with callbacks	`armature-distributed`
✅ Completed	Service Discovery	Consul, etcd integration	`armature-discovery`
✅ Completed	Request Correlation	Correlation ID propagation	`armature-core`

Caching

5/5 completed

Status	Feature	Description	Module
✅ Completed	Redis Cache	Distributed caching	`armature-cache`
✅ Completed	Memcached	High-performance caching	`armature-cache`
✅ Completed	Cache Decorators	#[cache] method decorator	`armature-cache`
✅ Completed	Tag-Based Invalidation	Bulk cache busting by tags	`armature-cache`
✅ Completed	Multi-Tier Caching	L1/L2 cache layers with auto-promotion	`armature-cache`

Push Notifications

4/4 completed

Status	Feature	Description	Module
✅ Completed	Web Push	VAPID-based browser notifications	`armature-push`
✅ Completed	Firebase Cloud Messaging	FCM for Android and web	`armature-push`
✅ Completed	Apple Push Notifications	APNS for iOS	`armature-push`
✅ Completed	Unified Push Service	Single API for all platforms	`armature-push`

Cloud Providers

4/4 completed

Status	Feature	Description	Module
✅ Completed	AWS SDK	S3, DynamoDB, SQS, SNS, Lambda, KMS, and more	`armature-aws`
✅ Completed	Google Cloud SDK	Storage, Pub/Sub, Firestore, BigQuery	`armature-gcp`
✅ Completed	Azure SDK	Blob, Queue, Cosmos, Service Bus, Key Vault	`armature-azure`
✅ Completed	Centralized Redis	Shared Redis client for all crates	`armature-redis`

Serverless Deployment

3/3 completed

Status	Feature	Description	Module
✅ Completed	AWS Lambda	API Gateway, ALB, Function URLs	`armature-lambda`
✅ Completed	Google Cloud Run	Container-based serverless	`armature-cloudrun`
✅ Completed	Azure Functions	HTTP triggers, custom handlers	`armature-azure-functions`

Containerization & CI/CD

6/6 completed

Status	Feature	Description	Module
✅ Completed	Dockerfile Templates	Optimized Alpine-based, multi-stage builds	`templates/`
✅ Completed	Docker Compose	Development environment with all services	`templates/`
✅ Completed	Kubernetes Manifests	Deployment, Service, Ingress, HPA, PDB	`templates/k8s/`
✅ Completed	Helm Charts	Production-ready Helm chart	`templates/helm/`
✅ Completed	GitHub Actions	CI, Release, Docs workflows	`.github/`
✅ Completed	Jenkins Pipelines	Basic, Docker agent, multibranch	`templates/jenkins/`

Want to Contribute?

We welcome contributions! Each feature should have comprehensive documentation, working examples, full test coverage, and follow existing code patterns.

Contributing Guide View Issues