more object service cleanup

LeftofZen · LeftofZen · commit 42ece58a69ba · 2025-06-30T11:07:17.000+10:00
diff --git a/Definitions/ObjectAvailability.cs b/Definitions/ObjectAvailability.cs
@@ -2,7 +2,7 @@ namespace Definitions
 {
 	public enum ObjectAvailability
 	{
-		Available,
-		Unavailable
+		Unavailable,
+		Available
 	}
 }
diff --git a/Definitions/Web/ApiVersionRoutePrefix.cs b/Definitions/Web/ApiVersionRoutePrefix.cs
diff --git a/Definitions/Web/Client.cs b/Definitions/Web/Client.cs
@@ -7,7 +7,7 @@ namespace OpenLoco.Definitions.Web
 {
 	public static class Client
 	{
-		public const string ApiVersion = ApiVersionRoutePrefix.V2;
+		public const string ApiVersion = RoutesV2.Prefix;
 
 		public static async Task<IEnumerable<DtoObjectEntry>> GetObjectListAsync(HttpClient client, ILogger? logger = null)
 			=> await ClientHelpers.GetAsync<IEnumerable<DtoObjectEntry>>(
diff --git a/Definitions/Web/ClientHelpers.cs b/Definitions/Web/ClientHelpers.cs
@@ -63,7 +63,7 @@ static string FormRoute(string apiRoute, string baseRoute, UniqueObjectId? resou
 				? apiRoute + baseRoute
 				: apiRoute + baseRoute + $"/{resourceId}";
 
-		internal static async Task<T?> SendRequestAsync<T>(HttpClient client, string route, Func<Task<HttpResponseMessage>> httpFunc, Func<HttpContent, Task<T?>>? contentReaderFunc = null, ILogger? logger = null)
+		public static async Task<T?> SendRequestAsync<T>(HttpClient client, string route, Func<Task<HttpResponseMessage>> httpFunc, Func<HttpContent, Task<T?>>? contentReaderFunc = null, ILogger? logger = null)
 		{
 			try
 			{
diff --git a/Definitions/Web/RoutesV1.cs b/Definitions/Web/RoutesV1.cs
@@ -2,6 +2,8 @@ namespace OpenLoco.Definitions.Web
 {
 	public static class RoutesV1
 	{
+		public const string Prefix = "/v1";
+
 		// GET
 		public const string ListObjects = "/objects/list";
 
diff --git a/Definitions/Web/RoutesV2.cs b/Definitions/Web/RoutesV2.cs
@@ -2,6 +2,8 @@ namespace OpenLoco.Definitions.Web
 {
 	public static class RoutesV2
 	{
+		public const string Prefix = "/v2";
+
 		public const string Objects = "/objects";
 		public const string ObjectPacks = "/objectpacks";
 		public const string Scenarios = "/scenarios";
diff --git a/ObjectService/ObjectService.csproj b/ObjectService/ObjectService.csproj
@@ -20,7 +20,7 @@
 		<PackageReference Include="Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore" Version="9.0.6" />
 		<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.6" />
 		<PackageReference Include="Microsoft.EntityFrameworkCore" Version="9.0.6" />
-		<PackageReference Include="Scalar.AspNetCore" Version="2.4.8" />
+		<PackageReference Include="Scalar.AspNetCore" Version="2.5.3" />
 	</ItemGroup>
 
 	<ItemGroup>
diff --git a/ObjectService/Program.cs b/ObjectService/Program.cs
@@ -18,6 +18,7 @@
 builder.Services.AddOpenApi(); // (options => _ = options.AddDocumentTransformer<BearerSecuritySchemeTransformer>());
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddHealthChecks();
+builder.Services.AddProblemDetails();
 builder.Services.AddDbContext<LocoDbContext>(options =>
 {
 	_ = options.UseSqlite(connectionString);
@@ -125,28 +126,26 @@
 	.MapHealthChecks("/health")
 	.RequireRateLimiting(tokenPolicy);
 
-_ = app.MapLegacyRoutes("/v1")
+_ = app.MapV2Routes()
 	.RequireRateLimiting(tokenPolicy);
 
-_ = app.MapServerRoutes("/v2")
-	.RequireRateLimiting(tokenPolicy);
-
-_ = app.MapAdminRoutes("/v2")
-	.RequireAuthorization()
+_ = app.MapV1Routes()
 	.RequireRateLimiting(tokenPolicy);
 
 var showScalar = builder.Configuration.GetValue<bool?>("ObjectService:ShowScalar");
 ArgumentNullException.ThrowIfNull(showScalar);
 
 _ = app.MapOpenApi();
+
 if (showScalar == true)
 {
-	_ = app.MapScalarApiReference(options =>
+	_ = app.MapScalarApiReference("/api", options =>
 	{
 		_ = options
 			.WithTitle("OpenLoco Object Service")
 			.WithTheme(ScalarTheme.Solarized)
 			.WithDefaultHttpClient(ScalarTarget.CSharp, ScalarClient.HttpClient);
+
 		//.AddPreferredSecuritySchemes("Bearer");
 	});
 }
diff --git a/ObjectService/Properties/launchSettings.json b/ObjectService/Properties/launchSettings.json
@@ -13,7 +13,7 @@
             "commandName": "Project",
             "dotnetRunMessages": true,
             "launchBrowser": true,
-            "launchUrl": "scalar/v1",
+            "launchUrl": "api",
             "applicationUrl": "http://0.0.0.0:7229",
             "environmentVariables": {
                 "ASPNETCORE_ENVIRONMENT": "Development"
@@ -23,7 +23,7 @@
             "commandName": "Project",
             "dotnetRunMessages": true,
             "launchBrowser": true,
-            "launchUrl": "scalar/v1",
+            "launchUrl": "api",
             "applicationUrl": "https://0.0.0.0:7230",
             "environmentVariables": {
                 "ASPNETCORE_ENVIRONMENT": "Development"
diff --git a/ObjectService/RouteHandlers/ServerRouteBuilderExtensions.cs b/ObjectService/RouteHandlers/ServerRouteBuilderExtensions.cs
diff --git a/ObjectService/RouteHandlers/V1RouteBuilderExtensions.cs b/ObjectService/RouteHandlers/V1RouteBuilderExtensions.cs
@@ -0,0 +1,60 @@
+using ObjectService.RouteHandlers.TableHandlers;
+using OpenLoco.Definitions.Web;
+
+namespace ObjectService.RouteHandlers
+{
+	public static class V1RouteBuilderExtensions
+	{
+		public static IEndpointConventionBuilder MapV1Routes(this IEndpointRouteBuilder endpoints)
+		{
+			var routeGroup = endpoints.MapGroup(RoutesV1.Prefix);
+			ArgumentNullException.ThrowIfNull(routeGroup);
+
+			LegacyRouteHandler.MapRoutes(routeGroup);
+			return routeGroup;
+		}
+	}
+
+	public static class V2RouteBuilderExtensions
+	{
+		public static IEndpointConventionBuilder MapV2Routes(this IEndpointRouteBuilder endpoints)
+		{
+			var v2 = endpoints.MapGroup(RoutesV2.Prefix);
+			_ = v2.MapServerRoutes();
+
+#if DEBUG
+			// not ready for prime time yet
+			_ = v2.MapAdminRoutes().RequireAuthorization();
+#endif
+
+			return v2;
+		}
+
+		static IEndpointConventionBuilder MapServerRoutes(this IEndpointRouteBuilder endpoints)
+		{
+			var routeGroup = endpoints.MapGroup(string.Empty);
+			ArgumentNullException.ThrowIfNull(routeGroup);
+
+			AuthorRouteHandler.MapRoutes(routeGroup);
+			TagRouteHandler.MapRoutes(routeGroup);
+			LicenceRouteHandler.MapRoutes(routeGroup);
+			ObjectRouteHandler.MapRoutes(routeGroup);
+			ScenarioRouteHandler.MapRoutes(routeGroup);
+			SC5FilePackRouteHandler.MapRoutes(routeGroup);
+			ObjectPackRouteHandler.MapRoutes(routeGroup);
+
+			return routeGroup;
+		}
+
+		static IEndpointConventionBuilder MapAdminRoutes(this IEndpointRouteBuilder endpoints)
+		{
+			var routeGroup = endpoints.MapGroup(string.Empty);
+			ArgumentNullException.ThrowIfNull(routeGroup);
+
+			UserRouteHandler.MapRoutes(routeGroup);
+			RoleRouteHandler.MapRoutes(routeGroup);
+
+			return routeGroup;
+		}
+	}
+}
diff --git a/Tests/ObjectServiceIntegrationTests/BaseReferenceDataTableTestFixture.cs b/Tests/ObjectServiceIntegrationTests/BaseReferenceDataTableTestFixture.cs
@@ -27,6 +27,14 @@ public async Task SetUp()
 			_factory = new TestWebApplicationFactory<Program>();
 			HttpClient = _factory.CreateClient();
 			await SeedDataCore();
+			var healthResponse = await HttpClient.GetAsync("/health");
+			var health = await healthResponse.Content.ReadAsStringAsync();
+
+			Assert.Multiple(() =>
+			{
+				Assert.That(healthResponse.IsSuccessStatusCode, Is.True);
+				Assert.That(health, Is.EqualTo("Healthy"));
+			});
 		}
 
 		[TearDown]
@@ -56,7 +64,7 @@ protected async Task SeedDataCore()
 		public virtual async Task ListAsync()
 		{
 			// act
-			var results = await ClientHelpers.GetAsync<IEnumerable<TDto>>(HttpClient!, ApiVersionRoutePrefix.V2, BaseRoute);
+			var results = await ClientHelpers.GetAsync<IEnumerable<TDto>>(HttpClient!, RoutesV2.Prefix, BaseRoute);
 
 			// assert
 			Assert.Multiple(() =>
@@ -71,7 +79,7 @@ public async Task GetAsync()
 		{
 			// act
 			const int id = 2;
-			var results = await ClientHelpers.GetAsync<TDto>(HttpClient!, ApiVersionRoutePrefix.V2, BaseRoute, id);
+			var results = await ClientHelpers.GetAsync<TDto>(HttpClient!, RoutesV2.Prefix, BaseRoute, id);
 
 			// assert
 			Assert.That(results, Is.EqualTo(SeedData.ToList()[id - 1]));
@@ -82,12 +90,12 @@ public async Task DeleteAsync()
 		{
 			// act
 			const int id = 1;
-			var results = await ClientHelpers.DeleteAsync(HttpClient!, ApiVersionRoutePrefix.V2, BaseRoute, id);
+			var results = await ClientHelpers.DeleteAsync(HttpClient!, RoutesV2.Prefix, BaseRoute, id);
 
 			// assert
 			Assert.Multiple(async () =>
 			{
-				var results = await ClientHelpers.GetAsync<IEnumerable<TDto>>(HttpClient!, ApiVersionRoutePrefix.V2, BaseRoute);
+				var results = await ClientHelpers.GetAsync<IEnumerable<TDto>>(HttpClient!, RoutesV2.Prefix, BaseRoute);
 				Assert.That(results.First(), Is.EqualTo(SeedData.ToList()[id]));
 			});
 		}
@@ -96,7 +104,7 @@ public async Task DeleteAsync()
 		public async Task PostAsync()
 		{
 			// act
-			var results = await ClientHelpers.PostAsync(HttpClient!, ApiVersionRoutePrefix.V2, BaseRoute, ExtraSeedDatum);
+			var results = await ClientHelpers.PostAsync(HttpClient!, RoutesV2.Prefix, BaseRoute, ExtraSeedDatum);
 
 			// assert
 			Assert.That(results, Is.EqualTo(ExtraSeedDatum));
@@ -107,7 +115,7 @@ public async Task PutAsync()
 		{
 			// act
 			const int id = 1;
-			var results = await ClientHelpers.PutAsync(HttpClient!, ApiVersionRoutePrefix.V2, BaseRoute, id, ExtraSeedDatum);
+			var results = await ClientHelpers.PutAsync(HttpClient!, RoutesV2.Prefix, BaseRoute, id, ExtraSeedDatum);
 
 			// assert
 			Assert.That(results.Id, Is.EqualTo(id));

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ namespace Definitions`
`2`	`2`	`{`
`3`	`3`	`public enum ObjectAvailability`
`4`	`4`	`{`
`5`		`- Available,`
`6`		`- Unavailable`
	`5`	`+ Unavailable,`
	`6`	`+ Available`
`7`	`7`	`}`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace OpenLoco.Definitions.Web`
`7`	`7`	`{`
`8`	`8`	`public static class Client`
`9`	`9`	`{`
`10`		`- public const string ApiVersion = ApiVersionRoutePrefix.V2;`
	`10`	`+ public const string ApiVersion = RoutesV2.Prefix;`
`11`	`11`
`12`	`12`	`public static async Task<IEnumerable<DtoObjectEntry>> GetObjectListAsync(HttpClient client, ILogger? logger = null)`
`13`	`13`	`=> await ClientHelpers.GetAsync<IEnumerable<DtoObjectEntry>>(`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ static string FormRoute(string apiRoute, string baseRoute, UniqueObjectId? resou`
`63`	`63`	`? apiRoute + baseRoute`
`64`	`64`	`: apiRoute + baseRoute + $"/{resourceId}";`
`65`	`65`
`66`		`- internal static async Task<T?> SendRequestAsync<T>(HttpClient client, string route, Func<Task<HttpResponseMessage>> httpFunc, Func<HttpContent, Task<T?>>? contentReaderFunc = null, ILogger? logger = null)`
	`66`	`+ public static async Task<T?> SendRequestAsync<T>(HttpClient client, string route, Func<Task<HttpResponseMessage>> httpFunc, Func<HttpContent, Task<T?>>? contentReaderFunc = null, ILogger? logger = null)`
`67`	`67`	`{`
`68`	`68`	`try`
`69`	`69`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@ namespace OpenLoco.Definitions.Web`
`2`	`2`	`{`
`3`	`3`	`public static class RoutesV1`
`4`	`4`	`{`
	`5`	`+ public const string Prefix = "/v1";`
	`6`	`+`
`5`	`7`	`// GET`
`6`	`8`	`public const string ListObjects = "/objects/list";`
`7`	`9`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@ namespace OpenLoco.Definitions.Web`
`2`	`2`	`{`
`3`	`3`	`public static class RoutesV2`
`4`	`4`	`{`
	`5`	`+ public const string Prefix = "/v2";`
	`6`	`+`
`5`	`7`	`public const string Objects = "/objects";`
`6`	`8`	`public const string ObjectPacks = "/objectpacks";`
`7`	`9`	`public const string Scenarios = "/scenarios";`