Sources/XCMetricsBackendLib/Statistics/Repositories/StatisticsRepository.swift

// Copyright (c) 2021 Spotify AB.
//
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

import Foundation
import Fluent

/// Repository to insert and query statistics
public protocol StatisticsRepository {

    /// Fetches build statuses, sorted by date descending
    /// - Parameters:
    ///   - page: Page to fetch.
    ///   - per: Numer of rows per page
    ///   - eventLoop: Eventloop to use
    func getBuildStatuses(page: Int, per: Int, using eventLoop: EventLoop) -> EventLoopFuture<Page<BuildStatusResult>>

    /// Fetches counts for a date range, sorted by date
    /// - Parameters:
    ///   - from: Start of date range, inclusive.
    ///   - to: End of date range, inclusive.
    ///   - eventLoop: Eventloop to use
    func getDayCounts(from: Date, to: Date, using eventLoop: EventLoop) -> EventLoopFuture<[DayCount]>

    /// Calculates and returns number of builds and errors for a given day
    /// - Parameters:
    ///   - day: Date to calculate
    ///   - eventLoop: Eventloop to use
    func getCount(day: Date, using eventLoop: EventLoop) -> EventLoopFuture<DayCount>

    /// Calculates and stores number of builds and errors for a given day
    /// - Parameters:
    ///   - day: Date to calculate
    ///   - eventLoop: Eventloop to use
    func createDayCount(day: Date, using eventLoop: EventLoop) -> EventLoopFuture<Void>

    /// Fetches build times for a date range, sorted by date
    /// - Parameters:
    ///   - from: Start of date range, inclusive.
    ///   - to: End of date range, inclusive.
    ///   - eventLoop: Eventloop to use
    func getDayBuildTimes(from: Date, to: Date, using eventLoop: EventLoop) -> EventLoopFuture<[DayBuildTime]>

    /// Calculates and returns build time information for a given day
    /// - Parameters:
    ///   - day: Date to calculate
    ///   - eventLoop: Eventloop to use
    func getBuildTime(day: Date, using eventLoop: EventLoop) -> EventLoopFuture<DayBuildTime>

    /// Calculates and stores build time information for a given day
    /// - Parameters:
    ///   - day: Date to calculate
    ///   - eventLoop: Eventloop to use
    func createDayBuildTime(day: Date, using eventLoop: EventLoop) -> EventLoopFuture<Void>

}