# rpkaur1408/fragments architecture

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

- Interactive diagram: https://gitdiagram.com/rpkaur1408/fragments
- Repository: https://github.com/rpkaur1408/fragments

## Overview

##### Project type and purpose
- This is a standalone backend microservice written in Node.js/Express (no frontend).
- It exposes a REST-style API to create, read, and manage “fragments.”
- It includes pluggable authentication (Basic Auth and AWS Cognito), in-memory data storage, logging, and a health-check endpoint.

##### File structure
- Top-level tooling/config: .github, .gitignore, Prettier, ESLint, Jest config.
- src/server.js boots the HTTP listener on port 8080.
- src/app.js configures the Express app: loads middleware, routes, error handlers.
- src/auth holds authentication middleware and strategies (basic-auth.js, cognito.js).
- src/routes defines API endpoints under /api (GET, POST) and the root health check.
- src/model contains data access logic: an abstract data layer at src/model/data, with a memory implementation in memory-db.js.
- Cross-cutting modules: src/logger.js for structured logging; src/hash.js for hashing fragments; src/response.js encapsulates HTTP response structure.
- tests/ covers unit tests for each module.

##### README for additional insights
- The README confirms it’s a Week-1 assignment exposing endpoints via “npm start,” health-check at GET /, and has dev/debug modes.

##### Elements
- Clear labels: “Client,” “Express Server,” “Auth Middleware,” “Router,” “Fragment Controller,” “Memory-DB.”
- Green for auth strategies
- Orange for data store
- Annotations: note ports (8080), endpoints (/api, /), and config files (.env, jest.config.js).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients
    Client["Client<br/>(curl/Postman/Services)"]:::external

    %% Entry Point
    ServerBootstrap["Express Server Bootstrap<br/>(src/server.js)"]:::runtime
    click ServerBootstrap "https://github.com/rpkaur1408/fragments/blob/main/src/server.js"

    EntryPoint["Entry Point<br/>(src/index.js)"]:::runtime
    click EntryPoint "https://github.com/rpkaur1408/fragments/blob/main/src/index.js"

    AppConfig["Express App Configuration<br/>(src/app.js)"]:::runtime
    click AppConfig "https://github.com/rpkaur1408/fragments/blob/main/src/app.js"

    %% Cross-Cutting Middleware
    Logger["Logging Module"]:::util
    click Logger "https://github.com/rpkaur1408/fragments/blob/main/src/logger.js"

    AuthLoader["Auth Middleware Loader"]:::auth
    click AuthLoader "https://github.com/rpkaur1408/fragments/blob/main/src/auth/index.js"

    AuthMiddleware["Authentication Middleware"]:::auth
    click AuthMiddleware "https://github.com/rpkaur1408/fragments/blob/main/src/auth/auth-middleware.js"

    BasicAuth["Basic Auth Strategy"]:::auth
    click BasicAuth "https://github.com/rpkaur1408/fragments/blob/main/src/auth/basic-auth.js"

    CognitoAuth["AWS Cognito Strategy"]:::auth
    click CognitoAuth "https://github.com/rpkaur1408/fragments/blob/main/src/auth/cognito.js"

    %% Routing Layer
    Router["Routing Layer"]:::runtime

    HealthRoute["Health-Check Endpoint<br/>(GET /)"]:::runtime
    click HealthRoute "https://github.com/rpkaur1408/fragments/blob/main/src/routes/index.js"

    APIRoot["API Root Router"]:::runtime
    click APIRoot "https://github.com/rpkaur1408/fragments/blob/main/src/routes/api/index.js"

    GetRoute["GET /api/fragments"]:::runtime
    click GetRoute "https://github.com/rpkaur1408/fragments/blob/main/src/routes/api/get.js"

    PostRoute["POST /api/fragments"]:::runtime
    click PostRoute "https://github.com/rpkaur1408/fragments/blob/main/src/routes/api/post.js"

    %% Business Logic
    FragmentController["Fragment Business Logic"]:::runtime
    click FragmentController "https://github.com/rpkaur1408/fragments/blob/main/src/model/fragment.js"

    HashUtil["Hash Utility"]:::util
    click HashUtil "https://github.com/rpkaur1408/fragments/blob/main/src/hash.js"

    ResponseBuilder["HTTP Response Builder"]:::util
    click ResponseBuilder "https://github.com/rpkaur1408/fragments/blob/main/src/response.js"

    %% Data Layer
    DataInterface["Data Layer Interface"]:::data
    click DataInterface "https://github.com/rpkaur1408/fragments/blob/main/src/model/data/index.js"

    MemoryIndex["Memory-DB Index"]:::data
    click MemoryIndex "https://github.com/rpkaur1408/fragments/blob/main/src/model/data/memory/index.js"

    MemoryDB["In-Memory DB Implementation"]:::data
    click MemoryDB "https://github.com/rpkaur1408/fragments/blob/main/src/model/data/memory/memory-db.js"

    %% Flow
    Client -->|HTTP Request| ServerBootstrap
    ServerBootstrap --> EntryPoint
    EntryPoint --> AppConfig
    AppConfig --> Logger
    AppConfig --> AuthLoader
    AuthLoader --> AuthMiddleware
    AuthMiddleware --> BasicAuth
    AuthMiddleware --> CognitoAuth
    AppConfig --> Router

    Router --> HealthRoute
    Router --> APIRoot
    APIRoot --> GetRoute
    APIRoot --> PostRoute

    GetRoute --> FragmentController
    PostRoute --> FragmentController

    FragmentController --> HashUtil
    FragmentController --> DataInterface
    FragmentController --> ResponseBuilder

    DataInterface --> MemoryIndex
    MemoryIndex --> MemoryDB

    ResponseBuilder -->|HTTP Response| Client

    %% Tests
    subgraph "Unit Tests (Jest)" 
        direction TB
        HealthTest["Health-Check Tests"]:::test
        FragmentTest["Fragment Model Tests"]:::test
        MemoryDBTest["Memory-DB Tests"]:::test
        HashTest["Hash Utility Tests"]:::test
        ResponseTest["Response Builder Tests"]:::test
        GetTest["GET Endpoint Tests"]:::test
        PostTest["POST Endpoint Tests"]:::test
        AppTest["App Integration Tests"]:::test
        TestSuite["Unit Tests Suite"]:::test
        click HealthTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/health.test.js"
        click FragmentTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/fragment.test.js"
        click MemoryDBTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/memory-db.test.js"
        click HashTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/hash.test.js"
        click ResponseTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/response.test.js"
        click GetTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/get.test.js"
        click PostTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/post.test.js"
        click AppTest "https://github.com/rpkaur1408/fragments/blob/main/tests/unit/app.test.js"
        click TestSuite "https://github.com/rpkaur1408/fragments/tree/main/tests/unit"
    end

    %% Test Interactions
    HealthTest -.-> HealthRoute
    FragmentTest -.-> FragmentController
    MemoryDBTest -.-> MemoryDB
    HashTest -.-> HashUtil
    ResponseTest -.-> ResponseBuilder
    GetTest -.-> GetRoute
    PostTest -.-> PostRoute
    AppTest -.-> AppConfig

    %% Classes
    classDef runtime fill:#add8e6,stroke:#333,stroke-width:1px;
    classDef auth fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef data fill:#FFA500,stroke:#333,stroke-width:1px;
    classDef util fill:#F0E68C,stroke:#333,stroke-width:1px;
    classDef test fill:#D3D3D3,stroke-dasharray: 5 5,stroke:#333,stroke-width:1px;
    classDef external fill:#ffffff,stroke:#333,stroke-width:1px;
```
