Backend

The backend is responsible for offering two APIs: the public REST API that the frontend uses to fetch metadata, such as which crates and versions exist and which artifacts have been built. The second API is for the builder instances to connect and fetch build jobs, consisting of a WebSocket and a REST API for uploading artifacts. This component tracks the number of downloads for each crate and periodically writes this data to the database.

Interactions

graph BT
    database[Database]
    backend[Backend]
    storage[Storage]
    frontend[Frontend]
    builder[Builder]
    backend --> storage
    backend --> database
    builder --> backend
    frontend --> backend

    click frontend "./frontend.html"
    click database "./database.html"
    click storage "./storage.html"
    click builder "./builder.html"

The backend uses the storage service to store crate artifacts, and the database to store metadata (crates, versions, artifacts, builders, build logs, jobs).

It offers a REST API that exposes all of the metadata and artifacts. This API is consumed by the frontend, and external tools. It also offers a WebSocket, which is used by the builders to connect to the backend, receive jobs and stream logs.

Dependencies

graph BT
    common[buildsrs_common]
    backend[buildsrs_backend]
    storage[buildsrs_storage]
    database[buildsrs_database]
    protocol[buildsrs_protocol]

    backend --> common
    backend --> storage
    backend --> database
    backend --> protocol

    click storage "/rustdoc/buildsrs_storage"
    click protocol "/rustdoc/buildsrs_protocol"
    click database "/rustdoc/buildsrs_database"
    click common "/rustdoc/buildsrs_common"
    click backend "/rustdoc/buildsrs_backend"

The backend is implemented in the buildsrs_backend crate. It uses the buildsrs_common crate for common type definitions. It uses the buildsrs_database and buildsrs_storage crates to connect to those respective services. It uses the buildsrs_protocol crate to implement the builder websocket protocol.

Features