Feat: implement get locker logs paginated + get locker log by id

src/Api/Controllers/LockersController.cs

@@ -1,6 +1,8 @@
-using Api.Controllers.Payload.Requests.Lockers;
+using Api.Controllers.Payload.Requests;
+using Api.Controllers.Payload.Requests.Lockers;
 using Application.Common.Interfaces;
 using Application.Common.Models;
+using Application.Common.Models.Dtos.Logging;
 using Application.Common.Models.Dtos.Physical;
 using Application.Identity;
 using Application.Lockers.Commands;
@@ -178,4 +180,49 @@ public async Task<ActionResult<Result<LockerDto>>> Update([FromRoute] Guid locke
  var result = await Mediator.Send(command);
  return Ok(Result<LockerDto>.Succeed(result));
  }
+
+ /// <summary>
+ /// Get all logs related to locker.
+ /// </summary>
+ /// <param name="queryParameters">Query parameters</param>
+ /// <returns>A list of LockerLogsDtos.</returns>
+ [RequiresRole(IdentityData.Roles.Admin)]
+ [HttpGet("logs")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status403Forbidden)]
+ public async Task<ActionResult<Result<PaginatedList<LockerLogDto>>>> GetAllLockerLogs(
+ [FromQuery] GetAllLogsPaginatedQueryParameters queryParameters)
+ {
+ var query = new GetAllLockerLogsPaginated.Query()
+ {
+ SearchTerm = queryParameters.SearchTerm,
+ Page = queryParameters.Page,
+ Size = queryParameters.Size,
+ SortBy = queryParameters.SortBy,
+ SortOrder = queryParameters.SortOrder,
+ };
+ var result = await Mediator.Send(query);
+ return Ok(Result<PaginatedList<LockerLogDto>>.Succeed(result)); 
+ }
+
+ /// <summary>
+ /// Get a log related to locker by Id.
+ /// </summary>
+ /// <param name="logId">Id of the requested log</param>
+ /// <returns>A LockerLogDto of the requested log.</returns>
+ [RequiresRole(IdentityData.Roles.Admin)]
+ [HttpGet("log/{logId:guid}")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status403Forbidden)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task<ActionResult<Result<LockerLogDto>>> GetLockerLogById([FromRoute] Guid logId)
+ {
+ var query = new GetLockerLogById.Query()
+ {
+ LogId = logId
+ };
+
+ var result = await Mediator.Send(query);
+ return Ok(Result<LockerLogDto>.Succeed(result));
+ }
 }

src/Application/Common/Models/Dtos/Logging/LockerLogDto.cs

@@ -0,0 +1,25 @@
+using Application.Common.Mappings;
+using Application.Common.Models.Dtos.Physical;
+using Application.Users.Queries;
+using AutoMapper;
+using Domain.Entities.Logging;
+
+namespace Application.Common.Models.Dtos.Logging;
+
+public class LockerLogDto : IMapFrom<LockerLog>
+{
+ public Guid Id { get; set; }
+ public string Action { get; set; } = null!;
+ public LockerDto? Object { get; set; }
+ public DateTime Time { get; set; }
+ public UserDto User { get; set; } = null!;
+
+ public void Mapping(Profile profile)
+ {
+ profile.CreateMap<LockerLog, LockerLogDto>()
+ .ForMember( dest => dest.Time, 
+ opt => opt.MapFrom( src => src.Time.ToDateTimeUnspecified()))
+ .ForMember(dest => dest.Object, 
+ opt => opt.MapFrom( src => src.Object));
+ }
+}

src/Application/Lockers/Queries/GetAllLockerLogsPaginated.cs

@@ -0,0 +1,66 @@
+using Application.Common.Extensions;
+using Application.Common.Interfaces;
+using Application.Common.Models;
+using Application.Common.Models.Dtos.Logging;
+using AutoMapper;
+using MediatR;
+using Microsoft.EntityFrameworkCore;
+
+namespace Application.Lockers.Queries;
+
+public class GetAllLockerLogsPaginated
+{
+ public record Query : IRequest<PaginatedList<LockerLogDto>>
+ {
+ public string? SearchTerm { get; init; }
+ public int? Page { get; init; }
+ public int? Size { get; init; }
+ public string? SortBy { get; init; }
+ public string? SortOrder { get; init; }
+ }
+
+ public class QueryHandler : IRequestHandler<Query, PaginatedList<LockerLogDto>>
+ {
+ private readonly IApplicationDbContext _context;
+ private readonly IMapper _mapper;
+
+ public QueryHandler(IApplicationDbContext context, IMapper mapper)
+ {
+ _context = context;
+ _mapper = mapper;
+ }
+
+ public async Task<PaginatedList<LockerLogDto>> Handle(Query request, CancellationToken cancellationToken)
+ {
+ var logs = _context.LockerLogs
+ .Include(x => x.Object)
+ .AsQueryable();
+
+ if (!(request.SearchTerm is null || request.SearchTerm.Trim().Equals(string.Empty)))
+ {
+ logs = logs.Where(x => 
+ x.Action.Trim().ToLower().Contains(request.SearchTerm.Trim().ToLower()));
+ }
+
+ var sortBy = request.SortBy;
+ if (sortBy is null || !sortBy.MatchesPropertyName<LockerLogDto>())
+ {
+ sortBy = nameof(LockerLogDto.Time);
+ }
+
+ var sortOrder = request.SortOrder ?? "dsc";
+ var pageNumber = request.Page is null or <= 0 ? 1 : request.Page;
+ var sizeNumber = request.Size is null or <= 0 ? 5 : request.Size;
+
+ var count = await logs.CountAsync(cancellationToken);
+ var list = await logs
+ .Paginate(pageNumber.Value, sizeNumber.Value)
+ .OrderByCustom(sortBy, sortOrder)
+ .ToListAsync(cancellationToken);
+
+ var result = _mapper.Map<List<LockerLogDto>>(list);
+
+ return new PaginatedList<LockerLogDto>(result, count, pageNumber.Value, sizeNumber.Value);
+ }
+ }
+}

src/Application/Lockers/Queries/GetLockerLogById.cs

@@ -0,0 +1,44 @@
+using Application.Common.Interfaces;
+using Application.Common.Models.Dtos.Logging;
+using AutoMapper;
+using MediatR;
+using Microsoft.EntityFrameworkCore;
+
+namespace Application.Lockers.Queries;
+
+public class GetLockerLogById
+{
+ public record Query : IRequest<LockerLogDto>
+ {
+ public Guid LogId { get; init; }
+ }
+
+ public class QueryHandler : IRequestHandler<Query, LockerLogDto>
+ {
+ private readonly IApplicationDbContext _context;
+ private readonly IMapper _mapper;
+
+ public QueryHandler(IApplicationDbContext context, IMapper mapper)
+ {
+ _context = context;
+ _mapper = mapper;
+ }
+
+ public async Task<LockerLogDto> Handle(Query request, CancellationToken cancellationToken)
+ {
+ var log = await _context.LockerLogs
+ .Include(x => x.Object)
+ .ThenInclude(x => x!.Room)
+ .Include(x => x.User)
+ .ThenInclude(x => x.Department)
+ .FirstOrDefaultAsync(x => x.Id.Equals(request.LogId), cancellationToken);
+
+ if (log is null)
+ {
+ throw new KeyNotFoundException("Log does not exist.");
+ }
+
+ return _mapper.Map<LockerLogDto>(log);
+ }
+ }
+}