Skip to content

Update content-type for mappings to v3 #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimHess merged 3 commits into from
Feb 25, 2025
Merged

Update content-type for mappings to v3 #1478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3f88bb
Update content-type for mappings to v3, throw if SBA url wasn't set
TimHess Feb 24, 2025
d901457
fix duplicate exception logging
TimHess Feb 25, 2025
9325dac
fix another duplicated exception in logs
TimHess Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions src/Management/src/Endpoint/Actuators/RouteMappings/RouteMappingsEndpointMiddleware.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ internal sealed class RouteMappingsEndpointMiddleware(
IRouteMappingsEndpointHandler endpointHandler, IOptionsMonitor<ManagementOptions> managementOptionsMonitor, ILoggerFactory loggerFactory)
: EndpointMiddleware<object?, RouteMappingsResponse>(endpointHandler, managementOptionsMonitor, loggerFactory)
{
// There is no difference between v2 and v3 responses. This override is a workaround for Spring Boot Admin: https://github.com/codecentric/spring-boot-admin/issues/4001.
private protected override string ContentType => "application/vnd.spring-boot.actuator.v2+json";

protected override async Task<RouteMappingsResponse> InvokeEndpointHandlerAsync(object? request, CancellationToken cancellationToken)
{
return await EndpointHandler.InvokeAsync(request, cancellationToken);
Expand Down
9 changes: 7 additions & 2 deletions src/Management/src/Endpoint/SpringBootAdminClient/SpringBootAdminClientHostedService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ public async Task StartAsync(CancellationToken cancellationToken)
{
SpringBootAdminClientOptions clientOptions = _clientOptionsMonitor.CurrentValue;

if (clientOptions.Url == null)
{
throw new InvalidOperationException("Spring Boot Admin Server Url must be provided in options.");
}

_logger.LogInformation("Registering with Spring Boot Admin Server at {Url}", clientOptions.Url);

if (clientOptions.ApplicationName == null || !Uri.TryCreate(clientOptions.BasePath, UriKind.Absolute, out Uri? baseUri))
Expand All @@ -69,7 +74,7 @@ public async Task StartAsync(CancellationToken cancellationToken)
}
catch (Exception exception) when (!exception.IsCancellation())
{
_logger.LogError(exception, "Error connecting to Spring Boot Admin Server: {Message}", exception.Message);
_logger.LogError(exception, "Error connecting to Spring Boot Admin Server.");
return;
}

Expand Down Expand Up @@ -132,7 +137,7 @@ public async Task StopAsync(CancellationToken cancellationToken)
}
catch (Exception exception) when (!exception.IsCancellation())
{
_logger.LogError(exception, "Error connecting to Spring Boot Admin Server: {Message}", exception.Message);
_logger.LogError(exception, "Error connecting to Spring Boot Admin Server.");
return;
}

Expand Down
2 changes: 1 addition & 1 deletion src/Management/test/Endpoint.Test/ActuatorContentNegotiationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public sealed class ActuatorContentNegotiationTests
[InlineData("httpexchanges", SpringBootStandardAccept, ActuatorV3)]
[InlineData("info", $"{ActuatorV3},{SpringBootStandardAccept}", ActuatorV3)]
[InlineData("loggers", SpringBootStandardAccept, ActuatorV3)]
[InlineData("mappings", SpringBootStandardAccept, ActuatorV2)]
[InlineData("mappings", SpringBootStandardAccept, ActuatorV3)]
[InlineData("threaddump", SpringBootStandardAccept, ActuatorV3)]
[Theory]
public async Task Responses_for_SpringBootAdmin_match_expectations(string endpoint, string acceptHeader, string responseContentType)
Expand Down
4 changes: 2 additions & 2 deletions src/Management/test/Endpoint.Test/Actuators/RouteMappings/ActuatorRouteMappingsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ public async Task Returns_endpoints_for_RouteMappings_actuator(HostBuilderType h
"dispatcherServlet": [
{
"handler": "/actuator/mappings",
"predicate": "{GET [/actuator/mappings], produces [application/vnd.spring-boot.actuator.v2+json]}",
"predicate": "{GET [/actuator/mappings], produces [application/vnd.spring-boot.actuator.v3+json]}",
"details": {
"handlerMethod": {
"className": "Steeltoe.Management.Endpoint.Middleware.EndpointMiddleware`2",
Expand All @@ -668,7 +668,7 @@ public async Task Returns_endpoints_for_RouteMappings_actuator(HostBuilderType h
"consumes": [],
"produces": [
{
"mediaType": "application/vnd.spring-boot.actuator.v2+json",
"mediaType": "application/vnd.spring-boot.actuator.v3+json",
"negated": false
}
],
Expand Down
Loading