ALICE O2 Bookkeeping

• Docs Notes
  • Models and Entities
    • Entities are public representations of the data that can be used both front and backend
    • Models are for use only on the backend, and are JS mappings corresponding to the database.
  • Controller - Service - Model Architecture
    • Controller
      • Extracts domain entities from the request and provides it as api-agnostic parameters to services.
    • services
      • currently represented by usecases, and are responsible for
        • extracting domain-related information (?) from the HTTP requests
        • perform domain specific treatment
      • However, since the introduction of the gRPC API, the usecases need to be independent of the API.
      • Because of this, services are divided into high and low level services
      • Low level services are responsible for one action. They manipulate exclusively models. They can never depend on high level services or controllers
      • High level services group multiple actions to be used within controllers. They are based on entities but use adapters to manipulate them. The objective is to provide high level functionalities such as filtering runs.
    • model
      • Usually accessed through repositories.
  • Example notes (already processed)
    • Runs API Example
    • gPRC API Example
      • e.g. GPRCRunController.js uses RunService.js
      • RunService.js uses lower level (?) services such as getRun.js
      • getRun.js uses the RunRepository
    • HTTP API Example
      • runs.controller.js:90 getRunById
        • Takes a http request
        • Validates the data
        • uses the usecase GetRunUseCase to retrieve the data
        • and responds to the request
      • GetRunUseCase queries RunRepository
        • Which interfaces with the database, using the Run model
    • Environment API Example
      • ⇒ Both gPRC API and HTTP uses environmentService to update the environment
      • HTTP
        • environments.controller.js uses UpdateEnvironmentUseCase
        • UpdateEnvironmentUsecase uses environmentService
    • The HTTP controllers seem to use usecases, which use services.
    • gPRC controllers seem to only rely on services.
    • Services might be high level, such as EnvironmentService.js, which use lower level services such as getEnvironment.js
  • Usecases and services
    • Some API routes use a combination of usecases and services.
    • Services are in plain javascript, so they are API agnostic. This is because the project contains two different APIs: HTTP and gRPC
    • Originally, when the project only had a HTTP API, usecases were used which ‘knew’ about the session.
    • The project is slowly migrating away from usecases to services. At the moment usecases are a transparent layer between the controller and the service while they migrate.
• Worked tickets
  • O2B-927 Ticket log titles
  • O2B-937 About page enhancements
  • O2B-944 Log style improvements
  • O2B-861 Search & Filter for EOR reason
  • O2B-825 link logs to LHC fills
    • O2B-946 Add LHCFill Relation to log table
    • O2B-947 Add LHCFill to create log API
    • O2B-948 Update API route for filtering logs by lhcFills

The Bookkeeping system uses the O2 WebUI for the frontend.

Architecture

O2B Models and Views implementation O2B Controller Anatomy