# hiroki0525/idle-task architecture

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

- Interactive diagram: https://gitdiagram.com/hiroki0525/idle-task
- Repository: https://github.com/hiroki0525/idle-task

## Overview

##### Main Components

a. Core Task Management System:
- Task Queue Manager (FIFO implementation)
- Priority Handler (high/low priority tasks)
- Task Execution Controller
- Cache Management System
- Task Status Tracker

b. API Layer:
- Task Management APIs
- Configuration APIs
- Status/Result Retrieval APIs

c. Integration Points:
- Browser's requestIdleCallback interface
- Promise-based result handling
- External task execution environment

**[Task Input Layer]**
- ↓
**[Task Management Core]**
- ↓
**[Browser Integration Layer]**

##### Component Details

a. Task Input Layer (Blue Components):
- setIdleTask Entry Point
- Task Configuration Handler
- Task Priority Sorter

b. Task Management Core (Green Components):
- FIFO Queue Manager
- Task Status Registry
- Cache Storage
- Result Manager
- Revalidation Controller

c. Browser Integration Layer (Orange Components):
- requestIdleCallback Wrapper
- Execution Timer
- Debug Logger
- Browser Idle State Monitor

##### Data Flow Indicators

- Task registration flow
- Execution paths
- Result retrieval routes
- Cache access patterns
- Revalidation loops

##### Implementation Details

Annotations for:
- Promise-based interfaces
- Timeout configurations
- Priority management
- Cache invalidation rules

##### Technical Notes

Notes about:
- Default timeout values
- Performance thresholds (50ms recommendation)
- Debug mode capabilities
- Browser compatibility

##### The promise-based result retrieval

- Rectangles for core components
- Rounded rectangles for APIs
- Diamonds for decision points

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph TaskInputLayer
        TIE["Task Input Entry Point"]:::input
        TCH["Task Configuration Handler"]:::input
        TPS["Task Priority Sorter"]:::input
    end

    subgraph TaskManagementCore
        FQM["FIFO Queue Manager"]:::core
        TSR["Task Status Registry"]:::core
        CS["Cache Storage"]:::core
        RM["Result Manager"]:::core
        RC["Revalidation Controller"]:::core
    end

    subgraph BrowserIntegrationLayer
        RIC["requestIdleCallback Wrapper"]:::browser
        ET["Execution Timer"]:::browser
        DL["Debug Logger"]:::browser
        BISM["Browser Idle State Monitor"]:::browser
    end

    subgraph SpecialSystems
        TH["Timeout Handler"]:::special
        FE["Force Execution"]:::special
        TC["Task Cancellation"]:::special
        SM["Status Monitor"]:::special
    end

    %% Task Input Layer Connections
    TIE --> TCH
    TCH --> TPS
    TPS --> FQM

    %% Core Management Connections
    FQM --> TSR
    TSR --> CS
    TSR --> RM
    CS --> RC
    RC --> FQM

    %% Browser Integration Connections
    FQM --> RIC
    RIC --> ET
    ET --> DL
    RIC --> BISM

    %% Special Systems Connections
    TH --> RIC
    FE --> FQM
    TC --> TSR
    SM --> TSR

    %% Component Mappings
    click TIE "https://github.com/hiroki0525/idle-task/blob/main/src/api/setIdleTask.ts"
    click TCH "https://github.com/hiroki0525/idle-task/blob/main/src/api/configureIdleTask.ts"
    click TSR "https://github.com/hiroki0525/idle-task/blob/main/src/api/getIdleTaskStatus.ts"
    click RM "https://github.com/hiroki0525/idle-task/blob/main/src/api/getResultFromIdleTask.ts"
    click TC "https://github.com/hiroki0525/idle-task/blob/main/src/api/cancelIdleTask.ts"
    click FE "https://github.com/hiroki0525/idle-task/blob/main/src/api/forceRunIdleTask.ts"
    click FQM "https://github.com/hiroki0525/idle-task/blob/main/src/internals.ts"
    click TIE "https://github.com/hiroki0525/idle-task/blob/main/src/index.ts"

    %% Styles
    classDef input fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef core fill:#90EE90,stroke:#333,stroke-width:2px
    classDef browser fill:#FFB347,stroke:#333,stroke-width:2px
    classDef special fill:#DDA0DD,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1["Task Input Components"]:::input
        L2["Core Components"]:::core
        L3["Browser Integration"]:::browser
        L4["Special Systems"]:::special
    end
```
