Вторая итерация исправлений после ревью

This commit is contained in:
parent 34009b9737
commit f7eb894195
6 changed files with 52 additions and 88 deletions

View File

@ -3,27 +3,22 @@ using System;
namespace AsbCloudApp.Requests;
/// <summary>
/// Параметры запроса для получения загруженных данных ГТИ по скважине
/// Параметры запроса для получения загруженных данных ГТИ по скважине
/// </summary>
public class GtrWithGetDataRequest
{
/// <summary>
/// Id скважины
/// </summary>
public int IdWell { get; set; }
/// <summary>
/// Дата начала выборки.По умолчанию: текущее время - IntervalSec
/// Дата начала выборки.По умолчанию: текущее время - IntervalSec
/// </summary>
public DateTime? Begin { get; set; }
/// <summary>
/// Интервал времени даты начала выборки, секунды
/// Интервал времени даты начала выборки, секунды
/// </summary>
public int IntervalSec { get; set; } = 600;
/// <summary>
/// Желаемое количество точек. Если в выборке точек будет больше, то выборка будет прорежена.
/// Желаемое количество точек. Если в выборке точек будет больше, то выборка будет прорежена.
/// </summary>
public int ApproxPointsCount { get; set; } = 1024;
}

View File

@ -1,34 +0,0 @@
using System;
namespace AsbCloudApp.Requests;
/// <summary>
/// Ïàðàìåòðû çàïðîñà äëÿ ñîçäàíèÿ îò÷¸òà
/// </summary>
public class ReportCreateRequest
{
/// <summary>
/// Id ñêâàæèíû
/// </summary>
public int IdWell { get; set; }
/// <summary>
/// Øàã èíòåðâàëà
/// </summary>
public int StepSeconds { get; set; }
/// <summary>
/// ôîðìàò îò÷åòà (0-PDF, 1-LAS)
/// </summary>
public int Format { get; set; }
/// <summary>
/// Äàòà íà÷àëà èíòåðâàëà
/// </summary>
public DateTime Begin { get; set; } = default;
/// <summary>
/// Äàòà îêîí÷àíèÿ èíòåðâàëà
/// </summary>
public DateTime End { get; set; } = default;
}

View File

@ -1,34 +0,0 @@
using System;
namespace AsbCloudApp.Requests;
/// <summary>
/// Ïàðàìåòðû çàïðîñà äëÿ ïîëó÷åíèÿ ïðîãíîçèðóåìîãî êîëè÷åñòâî ñòðàíèö áóäóùåãî îò÷åòà
/// </summary>
public class ReportGetSizeRequest
{
/// <summary>
/// Id ñêâàæèíû
/// </summary>
public int IdWell { get; set; }
/// <summary>
/// Øàã èíòåðâàëà
/// </summary>
public int StepSeconds { get; set; }
/// <summary>
/// Ôîðìàò îò÷åòà (0-PDF, 1-LAS)
/// </summary>
public int Format { get; set; }
/// <summary>
/// Äàòà íà÷àëà èíòåðâàëà
/// </summary>
public DateTime Begin { get; set; } = default;
/// <summary>
/// Äàòà îêîí÷àíèÿ èíòåðâàëà
/// </summary>
public DateTime End { get; set; } = default;
}

View File

@ -0,0 +1,29 @@
using System;
namespace AsbCloudApp.Requests;
/// <summary>
/// Параметры для создания отчёта и получения прогнозируемого количества страниц будущего отчета
/// </summary>
public class ReportParametersRequest
{
/// <summary>
/// Шаг интервала
/// </summary>
public int StepSeconds { get; set; }
/// <summary>
/// формат отчета (0-PDF, 1-LAS)
/// </summary>
public int Format { get; set; }
/// <summary>
/// Дата начала интервала
/// </summary>
public DateTime Begin { get; set; } = default;
/// <summary>
/// Дата окончания интервала
/// </summary>
public DateTime End { get; set; } = default;
}

View File

@ -4,6 +4,7 @@ using AsbCloudWebApi.SignalR;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.SignalR;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Threading;
using System.Threading.Tasks;
using AsbCloudApp.Requests;
@ -34,13 +35,15 @@ namespace AsbCloudWebApi.Controllers
/// <summary>
/// Создает отчет по скважине с указанными параметрами
/// </summary>
/// <param name="idWell">Id скважины</param>
/// <param name="request">Параметры запроса</param>
/// <param name="token">Токен для отмены задачи</param>
/// <returns>id фоновой задачи формирования отчета</returns>
[HttpPost]
[Permission]
[ProducesResponseType(typeof(int), (int)System.Net.HttpStatusCode.OK)]
public async Task<IActionResult> CreateReportAsync(ReportCreateRequest request,
public async Task<IActionResult> CreateReportAsync([Required] int idWell,
[FromQuery] ReportParametersRequest request,
CancellationToken token)
{
var idCompany = User.GetCompanyId();
@ -50,7 +53,7 @@ namespace AsbCloudWebApi.Controllers
return Forbid();
if (!await wellService.IsCompanyInvolvedInWellAsync((int)idCompany,
request.IdWell, token).ConfigureAwait(false))
idWell, token).ConfigureAwait(false))
return Forbid();
void HandleReportProgressAsync(object progress, string id) =>
@ -63,7 +66,7 @@ namespace AsbCloudWebApi.Controllers
).ConfigureAwait(false);
}, token);
var id = reportService.EnqueueCreateReportWork(request.IdWell, (int)idUser,
var id = reportService.EnqueueCreateReportWork(idWell, (int)idUser,
request.StepSeconds, request.Format, request.Begin, request.End, HandleReportProgressAsync);
return Ok(id);
@ -97,6 +100,7 @@ namespace AsbCloudWebApi.Controllers
/// <summary>
/// Возвращает прогнозируемое количество страниц будущего отчета
/// </summary>
/// <param name="idWell">Id скважины</param>
/// <param name="request">Параметры запроса</param>
/// <param name="token">Токен для отмены задачи</param>
/// <returns>прогнозируемое кол-во страниц отчета</returns>
@ -104,7 +108,8 @@ namespace AsbCloudWebApi.Controllers
[Route("reportSize")]
[Permission]
[ProducesResponseType(typeof(string), (int)System.Net.HttpStatusCode.OK)]
public async Task<IActionResult> GetReportSizeAsync(ReportGetSizeRequest request,
public async Task<IActionResult> GetReportSizeAsync([Required] int idWell,
[FromQuery] ReportParametersRequest request,
CancellationToken token)
{
int? idCompany = User.GetCompanyId();
@ -113,10 +118,10 @@ namespace AsbCloudWebApi.Controllers
return Forbid();
if (!await wellService.IsCompanyInvolvedInWellAsync((int)idCompany,
request.IdWell, token).ConfigureAwait(false))
idWell, token).ConfigureAwait(false))
return Forbid();
int reportSize = reportService.GetReportPagesCount(request.IdWell,
int reportSize = reportService.GetReportPagesCount(idWell,
request.Begin, request.End, request.StepSeconds, request.Format);
return Ok(reportSize);

View File

@ -5,6 +5,7 @@ using AsbCloudWebApi.SignalR;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.SignalR;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Threading;
using System.Threading.Tasks;
using AsbCloudApp.Requests;
@ -39,12 +40,14 @@ namespace AsbCloudWebApi.Controllers.SAUB
/// <summary>
/// Получить загруженные данные ГТИ по скважине
/// </summary>
/// <param name="idWell">Id скважины</param>
/// <param name="request">Параметры запроса</param>
/// <param name = "token" >Токен завершения задачи</param>
/// <returns></returns>
[HttpGet("{idWell}")]
[Permission]
public async Task<ActionResult<IEnumerable<WitsRecordDto>>> GetDataAsync(GtrWithGetDataRequest request,
public async Task<ActionResult<IEnumerable<WitsRecordDto>>> GetDataAsync([Required] int idWell,
[FromQuery] GtrWithGetDataRequest request,
CancellationToken token)
{
int? idCompany = User.GetCompanyId();
@ -53,12 +56,12 @@ namespace AsbCloudWebApi.Controllers.SAUB
return Forbid();
bool isCompanyOwnsWell = await wellService.IsCompanyInvolvedInWellAsync((int)idCompany,
request.IdWell, token).ConfigureAwait(false);
idWell, token).ConfigureAwait(false);
if (!isCompanyOwnsWell)
return Forbid();
var content = await gtrRepository.GetAsync(request.IdWell, request.Begin,
var content = await gtrRepository.GetAsync(idWell, request.Begin,
request.IntervalSec, request.ApproxPointsCount, token).ConfigureAwait(false);
return Ok(content);