Skip to content

[EPIC] Production Hardening #8

@copyleftdev

Description

@copyleftdev

Depends On: #3, #6

POLYMCP-009

Goals

  • Robust error handling with retries
  • Configurable rate limiting
  • Optional response caching
  • Comprehensive documentation
  • Release binaries for major platforms

Production-ready hardening including comprehensive error handling, rate limit management, optional caching, structured logging, documentation, and release packaging.

Acceptance Criteria

AC-1

  • Given Polygon API returns a transient error
  • When The client retries
  • Then It uses exponential backoff with jitter and respects max retries config

AC-2

  • Given A user makes many requests quickly
  • When Approaching rate limits
  • Then The client proactively throttles to avoid 429s

AC-3

  • Given Caching is enabled
  • When The same request is made within TTL
  • Then The cached response is returned without API call

AC-4

  • Given The project
  • When cargo doc is run
  • Then All public items have documentation with examples

AC-5

  • Given A release is tagged
  • When CI runs
  • Then Binaries are published for Linux, macOS, and Windows

Technical Context

Crates: tracing, tracing-subscriber, moka, config

Files:

  • src/config.rs
  • src/cache.rs
  • src/retry.rs
  • .github/workflows/release.yml
  • README.md
  • CHANGELOG.md

Out of Scope

  • Metrics/Prometheus endpoint
  • Admin API

Source: epics/08-production.json
Content Hash: c1dc7b53bf3568ff

Metadata

Metadata

Assignees

No one assigned

    Labels

    epicLarge feature containing multiple storiespriority:mediumNormal priority

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions