feat: Replace output consumer with IContainer.GetLogsAsync(DateTime, DateTime, bool, CancellationToken)
#793
Conversation
✅ Deploy Preview for testcontainers-dotnet ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
HofmeisterAn
deleted the
feature/remove-wait-strategy-log-message-stream
branch
… DateTime, bool, CancellationToken)` (#793)
| @@ -385,13 +397,10 @@ protected virtual async Task UnsafeStartAsync(CancellationToken ct = default) | |||
| await this.UnsafeCreateAsync(ct) | |||
| .ConfigureAwait(false); | |||
|
|
|||
| await this.client.AttachAsync(this.container.ID, this.configuration.OutputConsumer, ct) | |||
There was a problem hiding this comment.
This was such a useful feature. Don't understand why it got removed. In my case I use it to write to xunit's ITestOutputHelper and can see logs in IDE at runtime. Now the only option is to run a background task that will periodically call GetLogsAsync. For now, as a workaround to preserve the previous behavior, I override UnsafeStartAsync and call AttachAsync via reflection.
There was a problem hiding this comment.
The intention is explained in the pull request. We have noticed that developers frequently use the consumer wrong. Using the GetLogsAsync(DateTime, DateTime, bool, CancellationToken) method is much easier. However, please create an issue and include your use case in it, and we will consider adding the attach call again. Having both is probably not a big deal. Thanks for bringing this up.
|
I second that this deprecation seems strange. I am looking to redirect output from the container on an "as-written" basis; I do not simply want to grab logs on an ad-hoc basis via a point-in-time method call. As far as I can tell, this log streaming use case is not supported without the Output Consumer API. |
What does this PR do?
This pull request sets the
WithOutputConsumer(IOutputConsumer)member obsolete, as it is no longer necessary to attach a stream to consume the output of a container. Instead, gettingstdoutorstderris much easier now, as developers can simply callIContainer.GetLogsAsync(DateTime, DateTime, bool, CancellationToken).Why is it important?
This PR is an important step in continuing the clean up of the API, as it further reduces the amount of configuration necessary to get log messages.
Related issues
-