# x4b1/messenger architecture

> Architecture diagram of the GitHub repository x4b1/messenger, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/x4b1/messenger
- Repository: https://github.com/x4b1/messenger

## Overview

##### Main Components

a. Message Storage Layer
- Two implementations: PGX and StdSQL (shown as sub-components)
- This to the core messenger component

b. Message Brokers Layer
- AWS SNS
- AWS SQS (with both publisher and subscriber capabilities)

c. Core Components
- Messenger (central component)
- Message Handler
- Subscription Manager
- Store Transformer
- Broker Multiplexer

##### Component Relationships

- Application → Messenger → PostgreSQL Store (Message Storage)
- Inspector → PostgreSQL Store (Message Retrieval)
- Messenger → Broker Multiplexer → Individual Brokers (SNS/SQS)

##### Specific Implementation Details

Architectural elements:
- Separation between storage interfaces and implementations
- Broker abstraction layer
- Outbox pattern implementation
- Metadata handling components

##### Important Notes

a. Key aspects:
- The separation between message storage and publication
- The pluggable nature of different storage and broker implementations
- The transaction boundary around message storage

- Component types
- Implementation variants

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core
        Messenger["Messenger"]:::core
        MessageHandler["Message Handler"]:::core
        SubManager["Subscription Manager"]:::core
        MetadataHandler["Metadata Handler"]:::core
    end

    subgraph Storage
        StoreInterface["Storage Interface"]:::interface
        StoreTransformer["Store Transformer"]:::transformer
        subgraph PostgreSQL
            PGX["PGX Implementation"]:::storage
            StdSQL["StdSQL Implementation"]:::storage
        end
    end

    subgraph Brokers
        BrokerInterface["Broker Interface"]:::interface
        BrokerMux["Broker Multiplexer"]:::transformer
        subgraph "AWS Services"
            SNS["SNS Publisher"]:::broker
            SQSPub["SQS Publisher"]:::broker
            SQSSub["SQS Subscriber"]:::broker
        end
    end

    Inspector["Message Inspector"]:::support
    Publisher["Generic Publisher"]:::interface

    %% Relationships
    Messenger --> MessageHandler
    Messenger --> StoreInterface
    MessageHandler --> MetadataHandler
    StoreInterface --> StoreTransformer
    StoreTransformer --> PostgreSQL
    MessageHandler --> BrokerInterface
    BrokerInterface --> BrokerMux
    BrokerMux --> SNS
    BrokerMux --> SQSPub
    BrokerMux --> SQSSub
    Inspector --> StoreInterface
    SubManager --> MessageHandler
    Publisher --> BrokerInterface

    %% Click Events
    click Messenger "https://github.com/x4b1/messenger/blob/main/messenger.go"
    click MessageHandler "https://github.com/x4b1/messenger/blob/main/message.go"
    click SubManager "https://github.com/x4b1/messenger/blob/main/subscription.go"
    click MetadataHandler "https://github.com/x4b1/messenger/blob/main/metadata.go"
    click StoreInterface "https://github.com/x4b1/messenger/blob/main/store/postgres/interface.go"
    click StoreTransformer "https://github.com/x4b1/messenger/blob/main/store/transformer.go"
    click PGX "https://github.com/x4b1/messenger/blob/main/store/postgres/pgx/store.go"
    click StdSQL "https://github.com/x4b1/messenger/blob/main/store/postgres/stdsql/store.go"
    click BrokerInterface "https://github.com/x4b1/messenger/blob/main/broker/broker.go"
    click BrokerMux "https://github.com/x4b1/messenger/blob/main/broker/mux.go"
    click SNS "https://github.com/x4b1/messenger/blob/main/broker/sns/publisher.go"
    click SQSPub "https://github.com/x4b1/messenger/blob/main/broker/sqs/publisher.go"
    click SQSSub "https://github.com/x4b1/messenger/blob/main/broker/sqs/subscriber.go"
    click Inspector "https://github.com/x4b1/messenger/blob/main/inspect/inspector.go"
    click Publisher "https://github.com/x4b1/messenger/blob/main/broker/pubsub/publisher.go"

    %% Styling
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef interface fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef storage fill:#27ae60,stroke:#219a52,color:white
    classDef broker fill:#e67e22,stroke:#d35400,color:white
    classDef transformer fill:#f1c40f,stroke:#f39c12,color:black
    classDef support fill:#bdc3c7,stroke:#95a5a6,color:black

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Interfaces"]:::interface
        L3["Storage"]:::storage
        L4["Message Brokers"]:::broker
        L5["Transformers"]:::transformer
        L6["Support Components"]:::support
    end
```
