Add WireMockHealthCheck in WireMock.Net.Aspire #1375
+87
−12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For use with Aspire, to make WaitFor(wiremock) more useful. Calls /__admin/health and checks the result, as well as checks if mappings using AdminApiMappingBuilder has been submitted to the server. This created a catch-22 problem where the mappings were not submitted until the health check was healthy, but the health check was not healthy until the mappings were submitted. To avoid this, the WireMockServerLifecycleHook class has been slightly re-arranged, and is now using the AfterEndpointsAllocatedAsync callback rather than the AfterResourcesCreatedAsync callback. Within which a separate Task is created that waits until the server is ready and submits the mappings.
StefH
requested changes
Nov 8, 2025
Collaborator
StefH
left a comment
StefH
left a comment
There was a problem hiding this comment.
some comments / questions
| public async ValueTask DisposeAsync() | ||
| { | ||
| await _shutdownCts.CancelAsync(); | ||
| if (_mappingTask is not null) |
Collaborator
There was a problem hiding this comment.
can you add { and { for if statements?
| internal WireMockServerArguments Arguments { get; } | ||
| internal Lazy<IWireMockAdminApi> AdminApi => new(CreateWireMockAdminApi); | ||
|
|
||
| internal enum MappingState |
Collaborator
There was a problem hiding this comment.
Can you move this enum to its own file?
|
|
||
| public async Task AfterEndpointsAllocatedAsync(DistributedApplicationModel appModel, CancellationToken cancellationToken = default) | ||
| { | ||
| var cts = CancellationTokenSource.CreateLinkedTokenSource(_shutdownCts.Token, cancellationToken); |
Collaborator
There was a problem hiding this comment.
Sonar complains on this.
Maybe dispose this cts in DisposeAsync method?
| .ToArray(); | ||
|
|
||
| foreach (var wireMockServerResource in wireMockServerResources) | ||
| _mappingTask = Task.Run(async () => |
Collaborator
There was a problem hiding this comment.
maybe use SafeFireAndForget (https://github.com/TheCodeTraveler/AsyncAwaitBestPractices) or something similar to indicate that this is a long running task and exceptions do not matter or are only logged?
| return HealthCheckResult.Unhealthy("WireMock.Net is not healthy"); | ||
| } | ||
|
|
||
| if (resource.ApiMappingState == WireMockServerResource.MappingState.NotSubmitted) |
Collaborator
There was a problem hiding this comment.
What if I post some mappings.
And then clean all mappings?
Will the HealthStatus be not-healthy?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I know the contributing guidelines says to make an issue first to have a discussion, but we can have the discussion here and I don't mind if the effort was wasted.
The point of this change is to make
WaitFor()in Aspire more useful with WireMock, since it currently doesn't wait for anything. This can be a problem and create a race condition if the main project starts doing HTTP calls to the wiremock server immediately on startup, and will on some runs get a 404 back.To fix that I've added a health check that calls
/__admin/healthand checks the result, as well as checks if mappings using AdminApiMappingBuilder has been submitted to the server.That last part created a catch-22 problem where the mappings were not submitted until the health check was healthy, but the health check was not healthy until the mappings were submitted.
To avoid this, the WireMockServerLifecycleHook class has been slightly re-arranged, and is now using the AfterEndpointsAllocatedAsync callback rather than the AfterResourcesCreatedAsync callback. Within which a separate Task is created that waits until the server is ready and submits the mappings.
Submitter checklist
#help-contributingor a project-specific channel like#wiremock-java