Volver a casos de éxito

Iris

Iris helps labs send files to SoloDB safely and consistently. It takes uploads from lab systems, keeps them in a temporary holding area, and lets a workstation confirm what should be stored.

Overview

Iris middleware for uploads from a lab client to SoloDB with a solodb-workstation or other client as intermediary. The lab initiates uploads and sends file data. Iris stores the data temporarily, streams upload events over SSE to the workstation, and uploads approved files to SoloDB.

The flow, entity fields, and state transitions are illustrated below.

Iris flow diagram

API

[CENSORED]

Entities

FileUploadEvent

  • uid: string identifier for the event.
  • state: enum state for the event lifecycle.
  • content: map of filename to data (data points to a path).
  • start: timestamp when the upload started.
  • completedState: string for logging purposes.
  • TTL: uint seconds before the event is automatically rejected.
  • autoApprove: boolean to automatically approve uploads to SoloDB.

State (FSM)

FileUploadEvent follows this finite state machine:

  • started --START_UPLOAD--> uploading
  • started --REJECT--> rejected
  • started --FAIL--> error
  • uploading --FINISH_UPLOAD--> awaiting_approval
  • uploading --REJECT--> rejected
  • uploading --START_UPLOAD--> uploading
  • uploading --FAIL--> error
  • awaiting_approval --APPROVE--> syncing
  • awaiting_approval --REJECT--> rejected
  • awaiting_approval --FAIL--> error
  • syncing --SUCCESS--> completed
  • syncing --FAIL--> error

Flow

  1. 1The lab starts an upload and Iris returns a FileUploadEvent UID.
  2. 2The lab uploads file data and Iris stores it temporarily.
  3. 3Iris streams upload events and the workstation listens for updates.
  4. 4Iris indicates that data is being uploaded and the workstation checks the event status.
  5. 5The workstation approves the event.
  6. 6Iris uploads the file to SoloDB and storage completes.