# truelayer/reqwest-middleware architecture

> Architecture diagram of the GitHub repository truelayer/reqwest-middleware, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/truelayer/reqwest-middleware
- Repository: https://github.com/truelayer/reqwest-middleware

## Overview

##### Main Components

a) Core Components:
- reqwest-middleware (Core Library)
- reqwest-retry (Retry Middleware)
- reqwest-tracing (Tracing Middleware)
- External reqwest Client

b) Integration Points:
- Third-party Middleware Support
- Client Builder Interface
- Middleware Chain

**┌─ Application Layer ─────────────────────────┐**
- Client Application Code                   │
- ┬───────────────────────┘
- ↓
**┌─ Middleware Chain Layer ────────────────────┐**
- ┌─────────────┐  ┌─────────────┐  ┌──────┐ │
- Tracing   │→ │    Retry    │→ │ More │ │
- Middleware  │  │  Middleware │  │ ...  │ │
- ┘  └─────────────┘  └──────┘ │
- ┬───────────────────────┘
- ↓
**┌─ Core Layer ──────────────────────────────┐**
- ┌─────────────────────────────────────┐   │
- ClientWithMiddleware           │   │
- ┌─────────────┐  ┌──────────────┐  │   │
- Middleware │  │    Request   │  │   │
- Manager    │  │   Pipeline   │  │   │
- ┘  └──────────────┘  │   │
- ┘   │
- ┬───────────────────────┘
- ↓
**┌─ Base Layer ──────────────────────────────┐**
- Reqwest HTTP Client                │
- ┘

##### Important Elements to Highlight

a) Core Functionality:
- ClientBuilder pattern
- Middleware Chain execution flow
- Request/Response pipeline

b) Extension Points:
- Custom middleware integration
- Third-party middleware support
- Configuration options

##### Additional Details

**┌─ Middleware Component ──────────────────┐**
- ┌──────────────┐      ┌──────────────┐ │
- Request    │ →    │  Middleware  │ │
- Interceptor │      │    Logic     │ │
- ┘      └──────────────┘ │
- ↓                     ↓        │
- ┌──────────────┐      ┌──────────────┐ │
- Response   │ ←    │   Error      │ │
- Handler     │      │   Handler    │ │
- ┘      └──────────────┘ │
- ┘

##### Key Relationships

- How the ClientBuilder constructs the middleware chain
- How requests flow through the middleware pipeline
- How each middleware component interacts with the core client
- Integration points for third-party middleware
- Error handling and retry flows

##### Notes for Implementation Details
- How the retry policy is configured
- Tracing integration points
- Extension points for custom middleware
- Error handling paths

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Application["Application Layer"]
        AppCode[Client Application Code]
    end

    subgraph MiddlewareChain["Middleware Chain Layer"]
        TracingMW[Tracing Middleware]:::middleware
        RetryMW[Retry Middleware]:::middleware
        CustomMW[Custom Middleware]:::middleware
        TracingMW --> RetryMW --> CustomMW
    end

    subgraph CoreLayer["Core Layer"]
        Client[ClientWithMiddleware]:::core
        MWManager[Middleware Manager]:::core
        ReqPipeline[Request Pipeline]:::core
        ErrorHandler[Error Handler]:::core

        MWManager --> ReqPipeline
        ReqPipeline --> ErrorHandler
        Client --> MWManager
    end

    subgraph BaseLayer["Base Layer"]
        ReqwestClient[Reqwest HTTP Client]:::external
    end

    subgraph TracingComponent["Tracing Component"]
        OTel[OpenTelemetry Integration]:::tracing
        SpanBuilder[Span Builder]:::tracing
        SpanMacros[Span Macros]:::tracing
        
        OTel --> SpanBuilder
        SpanBuilder --> SpanMacros
    end

    subgraph RetryComponent["Retry Component"]
        RetryStrategy[Retry Strategy]:::retry
        RetryHandler[Retryable Handler]:::retry
        
        RetryStrategy --> RetryHandler
    end

    Application --> MiddlewareChain
    MiddlewareChain --> CoreLayer
    CoreLayer --> BaseLayer
    TracingMW --> TracingComponent
    RetryMW --> RetryComponent

    %% Click events for component mapping
    click Client "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-middleware/src/client.rs"
    click MWManager "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-middleware/src/middleware.rs"
    click ErrorHandler "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-middleware/src/error.rs"
    click ReqPipeline "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-middleware/src/req_init.rs"
    click TracingMW "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-tracing/src/middleware.rs"
    click RetryMW "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-retry/src/middleware.rs"
    click RetryStrategy "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-retry/src/retryable_strategy.rs"
    click RetryHandler "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-retry/src/retryable.rs"
    click OTel "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-tracing/src/otel.rs"
    click SpanBuilder "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-tracing/src/reqwest_otel_span_builder.rs"
    click SpanMacros "https://github.com/truelayer/reqwest-middleware/blob/main/reqwest-tracing/src/reqwest_otel_span_macro.rs"

    %% Styling
    classDef core fill:#2374ab
    classDef middleware fill:#57a773
    classDef external fill:#ffd166
    classDef tracing fill:#89c2d9
    classDef retry fill:#a682ff

    %% Legend
    subgraph Legend
        CoreComp[Core Component]:::core
        MWComp[Middleware Component]:::middleware
        ExtComp[External Component]:::external
        TracingComp[Tracing Component]:::tracing
        RetryComp[Retry Component]:::retry
    end
```
