clovers-service

Frontend + Backend + Batch for clovers, the raytracing renderer.

Currently deployed at https://clovers.fly.dev/

clovers-front

Web frontend service, user-facing interface for the application. Written in Typescript using React with create-react-app.

clovers-back

Web backend service, handles API requests. Written in Rust using axum.

clovers-batch

Batch processing service, handles offline rendering of longer tasks with a high amount of resources available. Written in Rust using axum.

clovers-preview

Preview processing service, handles near-realtime rendering for web UI purposes. Written in Rust using axum.

postgres

Main database for the service. Persistent data.

redis

Queue service for the preview rendering tasks and results. Ephemeral data.

bucket

S3 compatible storage for images and thumbnails.

Usage

Note: first time build times will be slow.

• Development mode: just dev
• Production mode: just prod

In development mode, hot reload will be available for all services.

Sequence diagrams

Full render flow

sequenceDiagram
    participant front
    participant back
    participant postgres
    participant redis
    participant batch
    participant bucket
    loop
      batch->>redis: pop render_task queue
      redis-->>batch: nil
    end
    front->>back: POST /render
    back->>postgres: save render_task
    back->>redis: queue render_task id
    back->>front: render_task id
    batch->>redis: pop render_task queue
    redis->>batch: render_task id
    batch->>postgres: get render_task by id
    postgres->>batch: ;
    note over batch: rendering
    batch->>postgres: delete render_task
    batch->>bucket: save image and thumbnail
    batch->>postgres: save render_result id
    front-->batch: ;
    front->>back: GET /renders
    back->>postgres: get render_result ids
    postgres->>back: ;
    back->>front: ;
    front->>back: GET /renders/:id
    back->>bucket: get image
    bucket->>back: ;
    back->>front: .png;

Preview render flow

sequenceDiagram
    participant front
    participant back
    participant redis
    participant preview
    loop
      preview->>redis: pop preview_task queue
      redis-->>preview: nil
    end
    front->>back: WebSocket send <br> preview_task
    note over back: create preview_id
    back->>redis: queue preview_task
    preview->>redis: pop preview_task queue
    redis->>preview: preview_task
    note over preview: rendering
    note right of back: todo: smarter polling
    loop
      back->>redis: exists results/preview_id;
      redis-->>back: false
    end
    preview->>redis: save results/preview_id
    back->>redis: exists results/preview_id
    redis->>back: ;
    back->>front: WebSocket send <br> preview_id
    front->>back: GET /preview/:id
    back->>redis: get preview
    redis->>back: ;
    back->>front: .png
    note over redis: redis object TTL <br> for auto cleanup

Work log