# bewuethr/slack-analyzer architecture

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

- Interactive diagram: https://gitdiagram.com/bewuethr/slack-analyzer
- Repository: https://github.com/bewuethr/slack-analyzer

## Overview

##### Main Components Identification

a. Input Sources:
- Slack Workspace (external system)
- GitHub Repository (hosting environment)
- Optional Telegram Channel (external system)

b. Core Processing Components:
- User Data Collector
- Message Analysis Engine
- Data Correction Handler
- Statistics Generator
- Visualization Engine
- Telegram Notification Service

**External Services Layer**
- ↕
**Input Processing Layer**
- ↕
**Core Processing Layer**
- ↕
**Output Generation Layer**
- ↕
**Distribution Layer**

##### Component Relationships

a. Data Flow:
- Slack API → User Data Collector (users.list endpoint)
- Slack API → Message Analysis Engine (search.messages endpoint)
- Data Correction Handler ← corrections.csv
- Statistics Generator → Visualization Engine
- Visualization Engine → Output Files
- Telegram Notification Service → Telegram Channel

##### Specific Implementation Details

Key elements:
- Input Configuration: GitHub Action inputs (tokens, workspace name)
- Data Processing Flow: Show how the data moves from raw Slack API responses to processed tenure information
- File Generation Pipeline: Illustrate the creation of various output files (README.md, TSV files, graphs)
- Correction Mechanism: Show how corrections.csv integrates with the main data flow

##### Important Notes

Annotations for:
- Rate limiting handling
- Retry mechanisms for API calls
- Optional components (Telegram integration)
- Data correction workflow
- File organization structure

##### Technical Details

Specific technical implementations:
- API Endpoints used (users.list, search.messages)
- Data formats (TSV, CSV, Markdown)
- Generated visualizations (turnover graph, boxplot)
- Directory structure for diffs (YYYY/MM/*.diff)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External
        Slack[("Slack Workspace")]
        GitHub[("GitHub Repository")]
        Telegram[("Telegram Channel")]
    end

    subgraph Input
        Config["Action Configuration"]
        SlackAPI["Slack API Endpoints"]
        CSVInput["corrections.csv"]
    end

    subgraph Processing
        Collector["User Data Collector"]
        Analysis["Message Analysis Engine"]
        Correction["Data Correction Handler"]
        Stats["Statistics Generator"]
    end

    subgraph Visualization
        VizEngine["Visualization Engine"]
        TurnoverViz["Turnover Graph"]
        DurationViz["Duration Boxplot"]
    end

    subgraph Output
        README["README.md"]
        TSV["TSV Files"]
        Diffs["YYYY/MM/*.diff"]
        TGNotify["Telegram Notifications"]
    end

    %% Relationships
    Slack --> SlackAPI
    GitHub --> Config
    SlackAPI --> Collector
    SlackAPI --> Analysis
    CSVInput --> Correction
    
    Collector --> Stats
    Analysis --> Stats
    Correction --> Stats
    
    Stats --> VizEngine
    VizEngine --> TurnoverViz
    VizEngine --> DurationViz
    
    TurnoverViz --> README
    DurationViz --> README
    Stats --> TSV
    Stats --> Diffs
    Stats --> TGNotify
    TGNotify --> Telegram

    %% Click Events
    click Config "https://github.com/bewuethr/slack-analyzer/blob/main/action.yml"
    click Correction "https://github.com/bewuethr/slack-analyzer/tree/main/scripts/corrtool"
    click Collector "https://github.com/bewuethr/slack-analyzer/tree/main/scripts/slacktenure"
    click Analysis "https://github.com/bewuethr/slack-analyzer/tree/main/scripts/slacktenure"
    click Stats "https://github.com/bewuethr/slack-analyzer/tree/main/scripts/stats"
    click TurnoverViz "https://github.com/bewuethr/slack-analyzer/blob/main/scripts/turnover.gpi"
    click DurationViz "https://github.com/bewuethr/slack-analyzer/blob/main/scripts/durationboxplot.gpi"
    click TGNotify "https://github.com/bewuethr/slack-analyzer/blob/main/docs/telegram.md"
    click Correction "https://github.com/bewuethr/slack-analyzer/blob/main/docs/corrections.md"

    %% Styling
    classDef external fill:#C0C0C0,stroke:#333
    classDef input fill:#A0D8EF,stroke:#333
    classDef processing fill:#90EE90,stroke:#333
    classDef visualization fill:#FFB347,stroke:#333
    classDef output fill:#FFA07A,stroke:#333

    class Slack,GitHub,Telegram external
    class Config,SlackAPI,CSVInput input
    class Collector,Analysis,Correction,Stats processing
    class VizEngine,TurnoverViz,DurationViz visualization
    class README,TSV,Diffs,TGNotify output
```
