mtfarkas/ConnectionsAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Refactor Get connections

Browse Source
This commit is contained in:
Máté Farkas
2024-12-26 14:23:50 +01:00
parent feb47b1f8e
commit e33c270fde
11 changed files with 431 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
Database/Migrations/20241226131510_RenameCategoriesPuzzles2.Designer.cs generated Normal file
View File

@@ -0,0 +1,135 @@
// <auto-generated />
using System;
using ConnectionsAPI.Database;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
#nullable disable
namespace ConnectionsAPI.Database.Migrations
{
[DbContext(typeof(ConnectionsContext))]
[Migration("20241226131510_RenameCategoriesPuzzles2")]
partial class RenameCategoriesPuzzles2
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder.HasAnnotation("ProductVersion", "8.0.4");
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsCard", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("INTEGER");
b.Property<int>("ConnectionsCategoryId")
.HasColumnType("INTEGER");
b.Property<string>("Content")
.IsRequired()
.HasColumnType("TEXT");
b.Property<int>("Position")
.HasColumnType("INTEGER");
b.HasKey("Id");
b.HasIndex("ConnectionsCategoryId");
b.ToTable("ConnectionsCard");
});
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsCategory", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("INTEGER");
b.Property<int>("Color")
.HasColumnType("INTEGER");
b.Property<int>("ConnectionsPuzzleId")
.HasColumnType("INTEGER");
b.Property<string>("Name")
.IsRequired()
.HasColumnType("TEXT");
b.HasKey("Id");
b.HasIndex("ConnectionsPuzzleId");
b.ToTable("ConnectionsCategory");
});
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsPuzzle", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("INTEGER");
b.Property<string>("ContentMD5")
.IsRequired()
.HasColumnType("TEXT");
b.Property<DateTime>("CreatedDate")
.HasColumnType("TEXT");
b.Property<string>("EditorName")
.IsRequired()
.HasColumnType("TEXT");
b.Property<int>("Index")
.HasColumnType("INTEGER");
b.Property<string>("PrintDate")
.IsRequired()
.HasColumnType("TEXT");
b.HasKey("Id");
b.HasIndex("PrintDate")
.IsUnique();
b.ToTable("ConnectionsPuzzles");
});
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsCard", b =>
{
b.HasOne("ConnectionsAPI.Database.Entities.ConnectionsCategory", "Category")
.WithMany("Cards")
.HasForeignKey("ConnectionsCategoryId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("Category");
});
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsCategory", b =>
{
b.HasOne("ConnectionsAPI.Database.Entities.ConnectionsPuzzle", "ConnectionsPuzzle")
.WithMany("Categories")
.HasForeignKey("ConnectionsPuzzleId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("ConnectionsPuzzle");
});
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsCategory", b =>
{
b.Navigation("Cards");
});
modelBuilder.Entity("ConnectionsAPI.Database.Entities.ConnectionsPuzzle", b =>
{
b.Navigation("Categories");
});
#pragma warning restore 612, 618
}
}
}

79
Database/Migrations/20241226131510_RenameCategoriesPuzzles2.cs Normal file
View File

@@ -0,0 +1,79 @@
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace ConnectionsAPI.Database.Migrations
{
/// <inheritdoc />
public partial class RenameCategoriesPuzzles2 : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropForeignKey(
name: "FK_ConnectionsCard_ConnectionsCategory_CategoryId",
table: "ConnectionsCard");
migrationBuilder.DropIndex(
name: "IX_ConnectionsCard_CategoryId",
table: "ConnectionsCard");
migrationBuilder.DropColumn(
name: "CategoryId",
table: "ConnectionsCard");
migrationBuilder.RenameColumn(
name: "CategoriesCategoryId",
table: "ConnectionsCard",
newName: "ConnectionsCategoryId");
migrationBuilder.CreateIndex(
name: "IX_ConnectionsCard_ConnectionsCategoryId",
table: "ConnectionsCard",
column: "ConnectionsCategoryId");
migrationBuilder.AddForeignKey(
name: "FK_ConnectionsCard_ConnectionsCategory_ConnectionsCategoryId",
table: "ConnectionsCard",
column: "ConnectionsCategoryId",
principalTable: "ConnectionsCategory",
principalColumn: "Id",
onDelete: ReferentialAction.Cascade);
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropForeignKey(
name: "FK_ConnectionsCard_ConnectionsCategory_ConnectionsCategoryId",
table: "ConnectionsCard");
migrationBuilder.DropIndex(
name: "IX_ConnectionsCard_ConnectionsCategoryId",
table: "ConnectionsCard");
migrationBuilder.RenameColumn(
name: "ConnectionsCategoryId",
table: "ConnectionsCard",
newName: "CategoriesCategoryId");
migrationBuilder.AddColumn<int>(
name: "CategoryId",
table: "ConnectionsCard",
type: "INTEGER",
nullable: true);
migrationBuilder.CreateIndex(
name: "IX_ConnectionsCard_CategoryId",
table: "ConnectionsCard",
column: "CategoryId");
migrationBuilder.AddForeignKey(
name: "FK_ConnectionsCard_ConnectionsCategory_CategoryId",
table: "ConnectionsCard",
column: "CategoryId",
principalTable: "ConnectionsCategory",
principalColumn: "Id");
}
}
}

11
Database/Migrations/ConnectionsContextModelSnapshot.cs
View File

@@ -23,10 +23,7 @@ namespace ConnectionsAPI.Database.Migrations
.ValueGeneratedOnAdd() .ValueGeneratedOnAdd()
.HasColumnType("INTEGER"); .HasColumnType("INTEGER");
b.Property<int>("CategoriesCategoryId") b.Property<int>("ConnectionsCategoryId")
.HasColumnType("INTEGER");
b.Property<int?>("CategoryId")
.HasColumnType("INTEGER"); .HasColumnType("INTEGER");
b.Property<string>("Content") b.Property<string>("Content")
@@ -38,7 +35,7 @@ namespace ConnectionsAPI.Database.Migrations
b.HasKey("Id"); b.HasKey("Id");
b.HasIndex("CategoryId"); b.HasIndex("ConnectionsCategoryId");
b.ToTable("ConnectionsCard"); b.ToTable("ConnectionsCard");
}); });
@@ -102,7 +99,9 @@ namespace ConnectionsAPI.Database.Migrations
{ {
b.HasOne("ConnectionsAPI.Database.Entities.ConnectionsCategory", "Category") b.HasOne("ConnectionsAPI.Database.Entities.ConnectionsCategory", "Category")
.WithMany("Cards") .WithMany("Cards")
.HasForeignKey("CategoryId"); .HasForeignKey("ConnectionsCategoryId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired();
b.Navigation("Category"); b.Navigation("Category");
}); });

14
Features/Connections/ConnectionsGroup.cs Normal file
View File

@@ -0,0 +1,14 @@
using System;
namespace ConnectionsAPI.Features.Connections;
public class ConnectionsGroup : Group
{
public ConnectionsGroup()
{
Configure("connections", ep =>
{
ep.AllowAnonymous();
});
}
}

35
Features/Connections/Get/Endpoint.cs Normal file
View File

@@ -0,0 +1,35 @@
using ConnectionsAPI.Database.Repository;
using ConnectionsAPI.Models.Request;
using ConnectionsAPI.Models.Response;
namespace ConnectionsAPI.Features.Connections.Get;
public class GetConnectionsEndpoint(PuzzleRepository _puzzleRepo) : Endpoint<GetPuzzleRequest, ConnectionsPuzzleDTO>
{
public override void Configure()
{
Get("{PrintDate}");
Group<ConnectionsGroup>();
}
public override async Task HandleAsync(GetPuzzleRequest req, CancellationToken ct)
{
bool hideSolutions = Query<bool>("hideSolutions", isRequired: false);
// query for the puzzle
var puzzle = await _puzzleRepo.GetPuzzleByDateAsync(req.PrintDate, includeSolutions: !hideSolutions);
// if not found, done here
if (puzzle == null)
{
await SendNotFoundAsync(ct);
return;
}
// get response from cache
var response = ConnectionsPuzzleDTO.FromEntity(puzzle);
// done
await SendAsync(response, cancellation: ct);
}
}

112
Features/Puzzle/Get/GetPuzzleEndpoint.cs
View File

@@ -1,67 +1,67 @@
using ConnectionsAPI.Database.Repository; // using ConnectionsAPI.Database.Repository;
using ConnectionsAPI.Models; // using ConnectionsAPI.Models;
using FluentValidation; // using FluentValidation;
using LazyCache; // using LazyCache;
using System.Text.RegularExpressions; // using System.Text.RegularExpressions;
namespace ConnectionsAPI.Features.Puzzle.Get // namespace ConnectionsAPI.Features.Puzzle.Get
{ // {
public record GetPuzzleEndpointRequest(string PuzzleDate); // public record GetPuzzleEndpointRequest(string PuzzleDate);
public partial class GetPuzzleEndpointRequestValidator : Validator<GetPuzzleEndpointRequest> // public partial class GetPuzzleEndpointRequestValidator : Validator<GetPuzzleEndpointRequest>
{ // {
[GeneratedRegex("^\\d{4}-\\d{2}-\\d{2}$", RegexOptions.IgnoreCase)] // [GeneratedRegex("^\\d{4}-\\d{2}-\\d{2}$", RegexOptions.IgnoreCase)]
private static partial Regex PrintDateGeneratedRegex(); // private static partial Regex PrintDateGeneratedRegex();
public GetPuzzleEndpointRequestValidator() // public GetPuzzleEndpointRequestValidator()
{ // {
RuleFor(x => x.PuzzleDate) // RuleFor(x => x.PuzzleDate)
.NotEmpty().WithMessage("Puzzle date is required") // .NotEmpty().WithMessage("Puzzle date is required")
.Must(x => PrintDateGeneratedRegex().IsMatch(x)).WithMessage("Puzzle date must be in the format yyyy-MM-dd"); // .Must(x => PrintDateGeneratedRegex().IsMatch(x)).WithMessage("Puzzle date must be in the format yyyy-MM-dd");
} // }
} // }
public class GetPuzzleEndpoint(PuzzleRepository puzzleRepo, ILogger<GetPuzzleEndpoint> logger, IAppCache cache) : Endpoint<GetPuzzleEndpointRequest, ConnectionsPuzzleDTO> // public class GetPuzzleEndpoint(PuzzleRepository puzzleRepo, ILogger<GetPuzzleEndpoint> logger, IAppCache cache) : Endpoint<GetPuzzleEndpointRequest, ConnectionsPuzzleDTO>
{ // {
private readonly PuzzleRepository _puzzleRepo = puzzleRepo; // private readonly PuzzleRepository _puzzleRepo = puzzleRepo;
private readonly ILogger<GetPuzzleEndpoint> _logger = logger; // private readonly ILogger<GetPuzzleEndpoint> _logger = logger;
private readonly IAppCache _cache = cache; // private readonly IAppCache _cache = cache;
public override void Configure() // public override void Configure()
{ // {
Get("/{PuzzleDate}.json", // Get("/{PuzzleDate}.json",
"/puzzle/{PuzzleDate}"); // "/puzzle/{PuzzleDate}");
AllowAnonymous(); // AllowAnonymous();
DontThrowIfValidationFails(); // DontThrowIfValidationFails();
} // }
public override async Task HandleAsync(GetPuzzleEndpointRequest req, CancellationToken ct) // public override async Task HandleAsync(GetPuzzleEndpointRequest req, CancellationToken ct)
{ // {
// default to 404 if validation fails // // default to 404 if validation fails
if (ValidationFailed) // if (ValidationFailed)
{ // {
_logger.LogError("Validation error. {path} {pathBase}", HttpContext.Request.Path, HttpContext.Request.PathBase); // _logger.LogError("Validation error. {path} {pathBase}", HttpContext.Request.Path, HttpContext.Request.PathBase);
await SendNotFoundAsync(ct); // await SendNotFoundAsync(ct);
return; // return;
} // }
bool hideSolutions = Query<bool>("hideSolutions", isRequired: false); // bool hideSolutions = Query<bool>("hideSolutions", isRequired: false);
// query for the puzzle // // query for the puzzle
var puzzle = await _puzzleRepo.GetPuzzleByDateAsync(req.PuzzleDate, includeSolutions: !hideSolutions); // var puzzle = await _puzzleRepo.GetPuzzleByDateAsync(req.PuzzleDate, includeSolutions: !hideSolutions);
// if not found, done here // // if not found, done here
if (puzzle == null) // if (puzzle == null)
{ // {
await SendNotFoundAsync(ct); // await SendNotFoundAsync(ct);
return; // return;
} // }
// get response from cache // // get response from cache
var response = ConnectionsPuzzleDTO.FromEntity(puzzle); // var response = ConnectionsPuzzleDTO.FromEntity(puzzle);
// done // // done
await SendAsync(response, cancellation: ct); // await SendAsync(response, cancellation: ct);
} // }
} // }
} // }

56
Features/Puzzle/List/ListPuzzlesEndpoint.cs
View File

@@ -1,34 +1,34 @@
using ConnectionsAPI.Database.Repository; // using ConnectionsAPI.Database.Repository;
using ConnectionsAPI.Models; // using ConnectionsAPI.Models;
using LazyCache; // using LazyCache;
using Microsoft.EntityFrameworkCore; // using Microsoft.EntityFrameworkCore;
namespace ConnectionsAPI.Features.Puzzle.List // namespace ConnectionsAPI.Features.Puzzle.List
{ // {
public class ListPuzzlesEndpoint(PuzzleRepository puzzleRepo, IAppCache cache) : EndpointWithoutRequest<ICollection<ConnectionsPuzzleDTO>> // public class ListPuzzlesEndpoint(PuzzleRepository puzzleRepo, IAppCache cache) : EndpointWithoutRequest<ICollection<ConnectionsPuzzleDTO>>
{ // {
private readonly PuzzleRepository _puzzleRepo = puzzleRepo; // private readonly PuzzleRepository _puzzleRepo = puzzleRepo;
private readonly IAppCache _cache = cache; // private readonly IAppCache _cache = cache;
public override void Configure() // public override void Configure()
{ // {
Get("/all.json", // Get("/all.json",
"/puzzle/all"); // "/puzzle/all");
AllowAnonymous(); // AllowAnonymous();
} // }
public override async Task HandleAsync(CancellationToken ct) // public override async Task HandleAsync(CancellationToken ct)
{ // {
bool hideSolutions = Query<bool>("hideSolutions", isRequired: false); // bool hideSolutions = Query<bool>("hideSolutions", isRequired: false);
// query all, ordered by print date // // query all, ordered by print date
var puzzles = await _puzzleRepo.GetAllPuzzlesAsync(includeSolutions: !hideSolutions); // var puzzles = await _puzzleRepo.GetAllPuzzlesAsync(includeSolutions: !hideSolutions);
// map to response object // // map to response object
var response = puzzles.Select(ConnectionsPuzzleDTO.FromEntity).ToList(); // var response = puzzles.Select(ConnectionsPuzzleDTO.FromEntity).ToList();
// done // // done
await SendAsync(response, cancellation: ct); // await SendAsync(response, cancellation: ct);
} // }
} // }
} // }

55
Models/PuzzleDTO.cs
View File

@@ -1,55 +0,0 @@
namespace ConnectionsAPI.Models
{
public class ConnectionsPuzzleDTO
{
public static ConnectionsPuzzleDTO FromEntity(Database.Entities.ConnectionsPuzzle dbPuzzle) =>
new()
{
PuzzleNumber = dbPuzzle.Index,
PrintDate = dbPuzzle.PrintDate,
Editor = dbPuzzle.EditorName,
NextPuzzle = dbPuzzle.NextPrintDate ?? string.Empty,
PreviousPuzzle = dbPuzzle.PrevPrintDate ?? string.Empty,
Categories = dbPuzzle.Categories.OrderBy(x => (int)x.Color).Select(PuzzleCategoryDTO.FromEntity).ToList(),
};
public int PuzzleNumber { get; set; }
public string PrintDate { get; set; } = string.Empty;
public string PreviousPuzzle { get; set; } = string.Empty;
public string NextPuzzle { get; set; } = string.Empty;
public string Editor { get; set; } = string.Empty;
public ICollection<PuzzleCategoryDTO> Categories { get; set; } = [];
}
public class PuzzleCategoryDTO
{
public static PuzzleCategoryDTO FromEntity(Database.Entities.ConnectionsCategory dbCategory) =>
new()
{
Title = dbCategory.Name,
Cards = dbCategory.Cards.OrderBy(x => x.Content).Select(PuzzleCardDTO.FromEntity).ToList(),
Color = dbCategory.Color.ToString().ToLower(),
OrderingKey = (int)dbCategory.Color
};
public string Title { get; set; } = string.Empty;
public string Color { get; set; } = string.Empty;
public int OrderingKey { get; set; }
public ICollection<PuzzleCardDTO> Cards { get; set; } = [];
}
public class PuzzleCardDTO
{
public static PuzzleCardDTO FromEntity(Database.Entities.ConnectionsCard dbCard) =>
new()
{
Content = dbCard.Content,
Position = dbCard.Position,
};
public string Content { get; set; } = string.Empty;
public int Position { get; set; }
}
}

3
Models/Request/GetPuzzleRequest.cs Normal file
View File

@@ -0,0 +1,3 @@
namespace ConnectionsAPI.Models.Request;
public record GetPuzzleRequest(string PrintDate);

53
Models/Response/ConnectionsPuzzleDTO.cs Normal file
View File

@@ -0,0 +1,53 @@
namespace ConnectionsAPI.Models.Response;
public class ConnectionsPuzzleDTO
{
public static ConnectionsPuzzleDTO FromEntity(Database.Entities.ConnectionsPuzzle dbPuzzle) =>
new()
{
PuzzleNumber = dbPuzzle.Index,
PrintDate = dbPuzzle.PrintDate,
Editor = dbPuzzle.EditorName,
NextPuzzle = dbPuzzle.NextPrintDate ?? string.Empty,
PreviousPuzzle = dbPuzzle.PrevPrintDate ?? string.Empty,
Categories = dbPuzzle.Categories.OrderBy(x => (int)x.Color).Select(PuzzleCategoryDTO.FromEntity).ToList(),
};
public int PuzzleNumber { get; set; }
public string PrintDate { get; set; } = string.Empty;
public string PreviousPuzzle { get; set; } = string.Empty;
public string NextPuzzle { get; set; } = string.Empty;
public string Editor { get; set; } = string.Empty;
public ICollection<PuzzleCategoryDTO> Categories { get; set; } = [];
}
public class PuzzleCategoryDTO
{
public static PuzzleCategoryDTO FromEntity(Database.Entities.ConnectionsCategory dbCategory) =>
new()
{
Title = dbCategory.Name,
Cards = dbCategory.Cards.OrderBy(x => x.Content).Select(PuzzleCardDTO.FromEntity).ToList(),
Color = dbCategory.Color.ToString().ToLower(),
OrderingKey = (int)dbCategory.Color
};
public string Title { get; set; } = string.Empty;
public string Color { get; set; } = string.Empty;
public int OrderingKey { get; set; }
public ICollection<PuzzleCardDTO> Cards { get; set; } = [];
}
public class PuzzleCardDTO
{
public static PuzzleCardDTO FromEntity(Database.Entities.ConnectionsCard dbCard) =>
new()
{
Content = dbCard.Content,
Position = dbCard.Position,
};
public string Content { get; set; } = string.Empty;
public int Position { get; set; }
}

23
Validators/GetPuzzleRequestValidator.cs Normal file
View File

@@ -0,0 +1,23 @@
using System.Globalization;
using System.Text.RegularExpressions;
using ConnectionsAPI.Models.Request;
using FluentValidation;
namespace ConnectionsAPI.Validators;
public partial class GetPuzzleRequestValidator : Validator<GetPuzzleRequest>
{
[GeneratedRegex("^\\d{4}-\\d{2}-\\d{2}$", RegexOptions.IgnoreCase)]
private static partial Regex PrintDateGeneratedRegex();
public GetPuzzleRequestValidator()
{
RuleFor(x => x.PrintDate)
.NotEmpty().WithMessage("Puzzle date is required")
.Must(x => PrintDateGeneratedRegex().IsMatch(x))
.WithMessage("Print date must be in the format yyyy-MM-dd")
.Must(x => DateTime.TryParseExact(x, "yyyy-MM-dd", CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal, out _))
.WithMessage("Print date must be a valid datetime");
}
}