persistence/DD.Persistence.API/Controllers/ChangeLogController.cs

using DD.Persistence.API;
using DD.Persistence.Models.ChangeLog;
using DD.Persistence.Models.Common;
using DD.Persistence.Models.Requests;
using DD.Persistence.Services;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using System.Net;

/// <summary>
/// Контроллер по работе с журналом изменений 
/// </summary>
[ApiController]
[Authorize]
[Route("api/[controller]")]
public class ChangeLogController : ControllerBase, IChangeLogApi
{
    private readonly ChangeLogService service;

    /// <summary>
    /// ctor
    /// </summary>
    /// <param name="service"></param>
    public ChangeLogController(ChangeLogService service)
    {
        this.service = service;
    }

    /// <summary>
    /// Добавить записи в журнал изменений по дискриминатору
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dtos"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpPost("{idDiscriminator}")]
    [ProducesResponseType(typeof(int), (int)HttpStatusCode.Created)]
    public async Task<IActionResult> AddRange(
        [FromRoute] Guid idDiscriminator,
        [FromBody] IEnumerable<IDictionary<string, object>> dtos,
        string? comment,
        CancellationToken token)
    {
        var userId = User.GetUserId<Guid>();
        var changeLogCommitRequest = new ChangeLogCommitCreateRequest
        {
            IdAuthor = userId,
            Comment = comment,
            DiscriminatorId = idDiscriminator,
        };
        var result = await service.AddRange(changeLogCommitRequest, dtos, token);

        return CreatedAtAction(nameof(AddRange), result);
    }

    /// <summary>
    /// Удалить записи в журнале изменений
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="ids"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpDelete]
    [ProducesResponseType(typeof(int), (int)HttpStatusCode.OK)]
    public async Task<IActionResult> DeleteRange(Guid idDiscriminator, IEnumerable<Guid> ids, string comment, CancellationToken token)
    {
        var userId = User.GetUserId<Guid>();
        var changeLogCommitRequest = new ChangeLogCommitCreateRequest(idDiscriminator, userId, comment);
        var result = await service.MarkAsDeleted(ids, changeLogCommitRequest, token);

        return Ok(result);
    }


    /// <summary>
    /// Очистить все записи в журнале изменений (по дискриминатору) и добавить новые
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dtos"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpPost("replace/{idDiscriminator}")]
    [ProducesResponseType(typeof(int), (int)HttpStatusCode.OK)]
    public async Task<IActionResult> ClearAndAddRange(
        [FromRoute] Guid idDiscriminator,
        [FromBody] IEnumerable<IDictionary<string, object>> dtos,
        string comment,
        CancellationToken token)
    {
        var userId = User.GetUserId<Guid>();
        var changeLogCommitRequest = new ChangeLogCommitCreateRequest(idDiscriminator, userId, comment);
        var result = await service.ClearAndAddRange(changeLogCommitRequest, dtos, token);
        return Ok(result);
    }

    /// <summary>
    /// сохранить изменения в записях журнала изменений
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dtos"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpPut]
    [ProducesResponseType(typeof(int), (int)HttpStatusCode.OK)]
    [ProducesResponseType(StatusCodes.Status400BadRequest)]
    public async Task<IActionResult> UpdateRange(
        Guid idDiscriminator,
        IEnumerable<ChangeLogBaseDto> dtos,
        string comment,
        CancellationToken token)
    {
        var userId = User.GetUserId<Guid>();
        var changeLogCommitRequest = new ChangeLogCommitCreateRequest(idDiscriminator, userId, comment);
        var result = await service.UpdateRange(changeLogCommitRequest, dtos, token);

        return Ok(result);
    }

    /// <summary>
    /// Получение актуальных записей (с пагинацией)
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="paginationRequest"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("{idDiscriminator}")]
    [ProducesResponseType(typeof(PaginationContainer<ChangeLogBaseDto>), (int)HttpStatusCode.OK)]
    public async Task<IActionResult> GetCurrent(
        [FromRoute] Guid idDiscriminator,
        [FromQuery] PaginationRequest paginationRequest,
        CancellationToken token)
    {
        var moment = new DateTimeOffset(3000, 1, 1, 0, 0, 0, TimeSpan.Zero);
        var result = await service.GetByDate(idDiscriminator, moment, paginationRequest, token);

        return Ok(result);
    }

    /// <summary>
    /// Получение записей на определенный момент времени (с пагинацией)
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="moment"></param>
    /// <param name="paginationRequest"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("moment/{idDiscriminator}")]
    [ProducesResponseType(typeof(PaginationContainer<ChangeLogBaseDto>), (int)HttpStatusCode.OK)]
    public async Task<IActionResult> GetByDate(
        [FromRoute] Guid idDiscriminator,
        DateTimeOffset moment,
        [FromQuery] PaginationRequest paginationRequest,
        CancellationToken token)
    {
        var result = await service.GetByDate(idDiscriminator, moment, paginationRequest, token);

        return Ok(result);
    }

    /// <summary>
    /// Получение измененных записей за период времени
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dateBegin"></param>
    /// <param name="dateEnd"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("history/{idDiscriminator}")]
    [ProducesResponseType(typeof(IEnumerable<ChangeLogDto>), (int)HttpStatusCode.OK)]
    [ProducesResponseType((int)HttpStatusCode.NoContent)]
    public async Task<IActionResult> GetChangeLogForDate(
        [FromRoute] Guid idDiscriminator,
        DateTimeOffset dateBegin,
        DateTimeOffset dateEnd,
        CancellationToken token)
    {
        var result = await service.GetChangeLogForInterval(idDiscriminator, dateBegin, dateEnd, token);

        return Ok(result);
    }

    /// <summary>
    /// Получение списка дат, в которые происходили изменения (день, месяц, год, без времени)
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("datesChange/{idDiscriminator}")]
    [ProducesResponseType(typeof(IEnumerable<DateOnly>), (int)HttpStatusCode.OK)]
    [ProducesResponseType((int)HttpStatusCode.NoContent)]
    public async Task<IActionResult> GetDatesChange([FromRoute] Guid idDiscriminator, CancellationToken token)
    {
        var result = await service.GetDatesChange(idDiscriminator, token);

        return Ok(result);
    }

    /// <summary>
    /// Получение данных, начиная с определенной даты
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dateBegin"></param>
    /// <param name="take"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("part/{idDiscriminator}")]
    [ProducesResponseType(typeof(IEnumerable<ChangeLogBaseDto>), (int)HttpStatusCode.OK)]
    [ProducesResponseType((int)HttpStatusCode.NoContent)]
    public async Task<ActionResult<IEnumerable<ChangeLogBaseDto>>> GetPart([FromRoute] Guid idDiscriminator, DateTimeOffset dateBegin, int take = 86400, CancellationToken token = default)
    {
        var result = await service.GetGtDate(idDiscriminator, dateBegin, token);

        return Ok(result);
    }

    /// <summary>
    /// Получить диапазон дат, для которых есть данные в репозитории
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("datesRange/{idDiscriminator}")]
    [ProducesResponseType(typeof(DatesRangeDto), (int)HttpStatusCode.OK)]
    [ProducesResponseType((int)HttpStatusCode.NoContent)]
    public async Task<ActionResult<DatesRangeDto>> GetDatesRangeAsync([FromRoute] Guid idDiscriminator, CancellationToken token)
    {
        var result = await service.GetDatesRange(idDiscriminator, token);

        if (result is null)
            return NoContent();

        return Ok(result);
    }

    /// <summary>
    /// Метод, который возвращает статистику пользователя по количеству изменений в разрезе дней
    /// </summary>
    /// <param name="request"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("statistics")]
    [ProducesResponseType(typeof(IEnumerable<ChangeLogStatisticsDto>), (int)HttpStatusCode.OK)]
    public async Task<IActionResult> GetStatistics([FromQuery] ChangeLogQuery request, CancellationToken token)
    {
        var result = await service.GetStatistics(request, token);

        return Ok(result);
    }

    /// <summary>
    /// Метод, который возвращает историю изменений в разрезе дней
    /// </summary>
    /// <param name="request"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    [HttpGet("history")]
    [ProducesResponseType(typeof(IEnumerable<ChangeLogCommitDto>), (int)HttpStatusCode.OK)]
    public async Task<IActionResult> GetHistory([FromQuery] ChangeLogQuery request, CancellationToken token)
    {
        var result = await service.GetHistory(request, token);

        return Ok(result);
    }
}