Skip to content

CHANGELOG.md

Latest commit

 

History

History
195 lines (157 loc) · 7.27 KB

CHANGELOG.md

File metadata and controls

195 lines (157 loc) · 7.27 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

[0.1.11] - 2026-01-14

Fixed

  • WebSocket: Fixed ManualUpgrade error by properly draining request body before upgrade in rustapi-ws.
  • WebSocket: Enabled http1::Builder::with_upgrades() in rustapi-core server for Hyper 1.0 compatibility.
  • Examples: Fixed compilation issues in phase11-demo and graphql-api.
  • Examples: Updated websocket example with better debug logging.

[0.1.10] - 2026-01-14

Documentation

  • Updated READMEs for all crates with comprehensive examples and better structure.
  • Improved Cargo.toml descriptions and documentation links.

[0.1.9] - 2026-01-14

Added

Performance (big-performance branch)

  • simd-json feature: 2-4x faster JSON parsing when enabled
  • Stack-optimized PathParams: Using SmallVec<[_; 4]> for fewer allocations
  • Conditional tracing: Logging gated behind tracing feature for 10-20% less overhead
  • Streaming request body: Support for large/unbuffered bodies without full memory buffering

New Crates

  • rustapi-jobs: Background job processing
    • In-memory, Redis, and Postgres backends
    • Job queue with retry logic and exponential backoff
    • Dead letter queue for failed jobs
    • Scheduled and delayed execution
  • rustapi-testing: Test utilities
    • TestServer for spawning test instances
    • Matcher for response body/header matching
    • Expectation builder for fluent assertions

Security & Compliance

  • Audit Logging System in rustapi-extras
    • GDPR and SOC2 compliance support
    • In-memory and file-based audit stores
    • Event/query types with store trait

CLI Improvements (cargo-rustapi)

  • cargo rustapi watch — Auto-reload on file changes
  • cargo rustapi add — Add dependencies or features
  • cargo rustapi doctor — Check environment health

Testing

  • Property-based tests with proptest:
    • Streaming memory bounds validation
    • Audit event completeness
    • CSRF token lifecycle
    • OAuth2 token exchange round-trips
    • OpenTelemetry trace context propagation
    • Structured logging format compliance

New Examples

  • event-sourcing — CQRS/Event Sourcing demo
  • microservices-advanced — Multi-binary with Docker + service discovery
  • serverless-lambda — AWS Lambda integration

Fixed

  • Fixed async handling and error mapping in file writes
  • Fixed Redis zadd call in job backend
  • Enabled r2d2 feature for diesel, clarified error types
  • Removed unused imports across crates

[0.1.8] - 2026-01-10

Added

  • CORS middleware: CorsLayer with full MiddlewareLayer trait implementation
    • Support for CorsLayer::permissive() and custom configuration
    • Proper preflight request handling
    • Origin validation and credential support

Fixed

  • Fixed missing MiddlewareLayer implementation for CorsLayer
  • Fixed CI build issues with GitHub Actions runner disk space

0.1.4 - 2026-01-03

Added

  • #[rustapi_rs::schema] attribute macro for opt-in OpenAPI schema auto-registration

Changed

  • Internal workspace dependency pins aligned to the workspace version for consistent publishing
  • Proof-of-concept example includes a minimal GET / landing page

0.1.3 - 2026-01-01

Added

  • New rustapi-toon crate: TOON (Token-Oriented Object Notation) format support
    • LLM-optimized data serialization format
    • Content negotiation via Accept header (application/toon, application/json)
    • Toon<T> extractor and responder
    • ToonNegotiate<T> for automatic format selection
    • LlmResponse<T> for AI-friendly structured responses
    • OpenAPI integration with TOON schema support
  • toon feature flag in rustapi-rs for opt-in TOON support
  • toon-api example demonstrating TOON format usage
  • Improved cookie extraction test for duplicate cookie names

Changed

  • Updated rustapi-rs to re-export toon module when feature enabled

0.1.2 - 2024-12-31

Added

  • skip_paths method for JwtLayer to exclude paths from JWT validation
  • docs_with_auth method for Basic Auth protected Swagger UI
  • docs_with_auth_and_info method for customized protected docs

Changed

  • auth-api example now demonstrates protected docs with Basic Auth
  • JWT middleware can now skip validation for public endpoints

0.1.1 - 2024-12-31

Added

Phase 4: Ergonomics & v1.0 Preparation

  • Body size limit middleware with configurable limits
  • .body_limit(size) builder method on RustApi (default: 1MB)
  • 413 Payload Too Large response for oversized requests
  • Production error masking (RUSTAPI_ENV=production)
  • Development error details (RUSTAPI_ENV=development)
  • Unique error IDs (err_{uuid}) for log correlation
  • Enhanced tracing layer with request_id, status, and duration
  • Custom span field support via .with_field(key, value)
  • Prometheus metrics middleware (feature-gated)
  • http_requests_total counter with method, path, status labels
  • http_request_duration_seconds histogram
  • rustapi_info gauge with version information
  • /metrics endpoint handler
  • TestClient for integration testing without network binding
  • TestRequest builder with method, header, and body support
  • TestResponse with assertion helpers
  • RUSTAPI_DEBUG=1 macro expansion output support
  • Improved route path validation at compile time
  • Enhanced route conflict detection messages

Changed

  • Error responses now include error_id field
  • TracingLayer enhanced with additional span fields

0.1.0 - 2024-12-01

Added

Phase 1: MVP Core

  • Core HTTP server built on tokio and hyper 1.0
  • Radix-tree based routing with matchit
  • Request extractors: Json<T>, Query<T>, Path<T>
  • Response types with automatic serialization
  • Async handler support
  • Basic error handling with ApiError
  • #[rustapi::get], #[rustapi::post] route macros
  • #[rustapi::main] async main macro

Phase 2: Validation & OpenAPI

  • Automatic OpenAPI spec generation
  • Swagger UI at /docs endpoint
  • Request validation with validator crate
  • #[validate] attribute support
  • 422 Unprocessable Entity for validation errors
  • #[rustapi::tag] and #[rustapi::summary] macros
  • Schema derivation for request/response types

Phase 3: Batteries Included

  • JWT authentication middleware (jwt feature)
  • AuthUser<T> extractor for authenticated routes
  • CORS middleware with builder pattern (cors feature)
  • IP-based rate limiting (rate-limit feature)
  • Configuration management with .env support (config feature)
  • Cookie parsing extractor (cookies feature)
  • SQLx error conversion (sqlx feature)
  • Request ID middleware
  • Middleware layer trait for custom middleware
  • extras meta-feature for common optional features
  • full feature for all optional features