fix: Preserve builder options when selecting transport (#87)

Author: HofmeisterAn

src/Docker.DotNet/DockerClient.cs

@@ -20,8 +20,7 @@ internal DockerClient(
         HttpMessageHandler handler,
         ClientOptions clientOptions,
         Uri effectiveEndpoint,
-        IStreamHijacker hijack,
-        ILogger logger)
+        IStreamHijacker hijack)
     {
         _client = new HttpClient(handler, true);
         _client.Timeout = Timeout.InfiniteTimeSpan;

src/Docker.DotNet/DockerClientBuilder.cs

@@ -22,6 +22,19 @@ public DockerClientBuilder()
         _ = WithEndpoint(LocalDockerEndpoint);
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DockerClientBuilder"/> class.
+    /// </summary>
+    /// <param name="clientOptions">The client options to preserve.</param>
+    /// <param name="logger">The logger to preserve.</param>
+    protected DockerClientBuilder(
+        ClientOptions clientOptions,
+        ILogger logger)
+    {
+        ClientOptions = clientOptions;
+        Logger = logger;
+    }
+
     /// <summary>
     /// Gets the client options.
     /// </summary>
@@ -140,7 +153,7 @@ public DockerClientBuilder WithLogger(ILogger logger)
     /// <returns>A typed builder that uses the legacy HTTP transport.</returns>
     public DockerClientBuilder<LegacyHttpTransportOptions> WithTransportOptions(LegacyHttpTransportOptions transportOptions)
     {
-        return new DockerClientBuilder<LegacyHttpTransportOptions>(LegacyHttp.DockerHandlerFactory.Instance, transportOptions);
+        return new DockerClientBuilder<LegacyHttpTransportOptions>(LegacyHttp.DockerHandlerFactory.Instance, transportOptions, ClientOptions, Logger);
     }
 
     /// <summary>
@@ -150,7 +163,7 @@ public DockerClientBuilder<LegacyHttpTransportOptions> WithTransportOptions(Lega
     /// <returns>A typed builder that uses the native HTTP transport.</returns>
     public DockerClientBuilder<NativeHttpTransportOptions> WithTransportOptions(NativeHttpTransportOptions transportOptions)
     {
-        return new DockerClientBuilder<NativeHttpTransportOptions>(NativeHttp.DockerHandlerFactory.Instance, transportOptions);
+        return new DockerClientBuilder<NativeHttpTransportOptions>(NativeHttp.DockerHandlerFactory.Instance, transportOptions, ClientOptions, Logger);
     }
 
     /// <summary>
@@ -160,7 +173,7 @@ public DockerClientBuilder<NativeHttpTransportOptions> WithTransportOptions(Nati
     /// <returns>A typed builder that uses the named pipe transport.</returns>
     public DockerClientBuilder<NPipeTransportOptions> WithTransportOptions(NPipeTransportOptions transportOptions)
     {
-        return new DockerClientBuilder<NPipeTransportOptions>(NPipe.DockerHandlerFactory.Instance, transportOptions);
+        return new DockerClientBuilder<NPipeTransportOptions>(NPipe.DockerHandlerFactory.Instance, transportOptions, ClientOptions, Logger);
     }
 
     /// <summary>
@@ -170,7 +183,7 @@ public DockerClientBuilder<NPipeTransportOptions> WithTransportOptions(NPipeTran
     /// <returns>A typed builder that uses the Unix socket transport.</returns>
     public DockerClientBuilder<UnixSocketTransportOptions> WithTransportOptions(UnixSocketTransportOptions transportOptions)
     {
-        return new DockerClientBuilder<UnixSocketTransportOptions>(Unix.DockerHandlerFactory.Instance, transportOptions);
+        return new DockerClientBuilder<UnixSocketTransportOptions>(Unix.DockerHandlerFactory.Instance, transportOptions, ClientOptions, Logger);
     }
 
     /// <summary>
@@ -182,7 +195,7 @@ public DockerClientBuilder<UnixSocketTransportOptions> WithTransportOptions(Unix
     /// <returns>A typed builder that uses the provided custom transport.</returns>
     public DockerClientBuilder<TTransportOptions> WithTransportOptions<TTransportOptions>(IDockerHandlerFactory<TTransportOptions> transportFactory, TTransportOptions transportOptions)
     {
-        return new DockerClientBuilder<TTransportOptions>(transportFactory, transportOptions);
+        return new DockerClientBuilder<TTransportOptions>(transportFactory, transportOptions, ClientOptions, Logger);
     }
 
     /// <summary>
@@ -200,7 +213,7 @@ public virtual DockerClient Build()
 
         var authenticatedHandler = ClientOptions.AuthProvider.ConfigureHandler(resolvedTransport.Handler);
 
-        return new DockerClient(authenticatedHandler, ClientOptions, resolvedTransport.EffectiveEndpoint, transportFactory, Logger);
+        return new DockerClient(authenticatedHandler, ClientOptions, resolvedTransport.EffectiveEndpoint, transportFactory);
     }
 
     /// <summary>

src/Docker.DotNet/DockerClientBuilder`1.cs

@@ -23,6 +23,24 @@ public DockerClientBuilder(
         _transportOptions = transportOptions;
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DockerClientBuilder{TTransportOptions}"/> class.
+    /// </summary>
+    /// <param name="transportFactory">The transport handler factory.</param>
+    /// <param name="transportOptions">The transport options.</param>
+    /// <param name="clientOptions">The client options to preserve.</param>
+    /// <param name="logger">The logger to preserve.</param>
+    public DockerClientBuilder(
+        IDockerHandlerFactory<TTransportOptions> transportFactory,
+        TTransportOptions transportOptions,
+        ClientOptions clientOptions,
+        ILogger logger)
+        : base(clientOptions, logger)
+    {
+        _transportFactory = transportFactory;
+        _transportOptions = transportOptions;
+    }
+
     /// <summary>
     /// Builds a <see cref="DockerClient"/> using the explicitly selected transport handler.
     /// </summary>
@@ -33,6 +51,6 @@ public override DockerClient Build()
 
         var authenticatedHandler = ClientOptions.AuthProvider.ConfigureHandler(resolvedTransport.Handler);
 
-        return new DockerClient(authenticatedHandler, ClientOptions, resolvedTransport.EffectiveEndpoint, _transportFactory, Logger);
+        return new DockerClient(authenticatedHandler, ClientOptions, resolvedTransport.EffectiveEndpoint, _transportFactory);
     }
 }

test/Docker.DotNet.TestsV2/DockerClientBuilderTests.cs

@@ -119,7 +119,7 @@ public void Build_WithUnsupportedScheme_ThrowsNotSupportedException()
     [Theory]
     [InlineData("npipe://./pipe/docker_engine", typeof(NPipe.DockerHandlerFactory))]
     [InlineData("unix:/var/run/docker.sock", typeof(Unix.DockerHandlerFactory))]
-    public void ResolveTransportFactory_UsesExpectedFactory_ForSocketSchemes(string endpoint, Type expectedFactoryType)
+    public void ResolveTransportFactory_UsesExpectedFactory_WhenSocketSchemeIsProvided(string endpoint, Type expectedFactoryType)
     {
         var builder = new TestDockerClientBuilder();
 
@@ -129,7 +129,7 @@ public void ResolveTransportFactory_UsesExpectedFactory_ForSocketSchemes(string
     }
 
     [Fact]
-    public void ResolveTransportFactory_WithHttpScheme_UsesConfiguredDefaultHttpFactory()
+    public void ResolveTransportFactory_UsesExpectedFactory_WhenHttpSchemeIsProvided()
     {
         var builder = new TestDockerClientBuilder();
 
@@ -143,30 +143,79 @@ public void ResolveTransportFactory_WithHttpScheme_UsesConfiguredDefaultHttpFact
     }
 
     [Fact]
-    public void Build_WithExplicitTransport_UsesProvidedFactoryAndOptions()
+    public void Build_PreservesClientOptionsAndLogger_WhenSetBeforeTransportSelection()
     {
         var transportFactory = new FakeTransportFactory();
 
         var transportOptions = new FakeTransportOptions();
 
+        const string headerName = "x-test";
+        const string headerValue = "value";
+
+        var apiVersion = new Version(1, 52);
+        var endpoint = new Uri("http://localhost:2375");
+        var authProvider = new PassThroughAuthProvider(true);
+        var timeout = TimeSpan.FromSeconds(1);
+        var logger = NullLogger.Instance;
+
+        _ = new DockerClientBuilder()
+            .WithApiVersion(apiVersion)
+            .WithEndpoint(endpoint)
+            .WithAuthProvider(authProvider)
+            .WithHeader(headerName, headerValue)
+            .WithTimeout(timeout)
+            .WithLogger(logger)
+            .WithTransportOptions(transportFactory, transportOptions)
+            .Build();
+
+        Assert.Equal(apiVersion, transportFactory.LastClientOptions.ApiVersion);
+        Assert.Equal(endpoint, transportFactory.LastClientOptions.Endpoint);
+        Assert.Same(authProvider, transportFactory.LastClientOptions.AuthProvider);
+        Assert.Equal(headerValue, transportFactory.LastClientOptions.Headers[headerName]);
+        Assert.Equal(timeout, transportFactory.LastClientOptions.Timeout);
+        Assert.Same(logger, transportFactory.LastLogger);
+        Assert.Equal(1, transportFactory.TypedCreateHandlerCallCount);
+        Assert.Same(transportOptions, transportFactory.LastTransportOptions);
+    }
+
+    [Fact]
+    public void Build_PreservesClientOptionsAndLogger_WhenSetAfterTransportSelection()
+    {
+        var transportFactory = new FakeTransportFactory();
+
+        var transportOptions = new FakeTransportOptions();
+
+        const string headerName = "x-test";
+        const string headerValue = "value";
+
+        var apiVersion = new Version(1, 52);
+        var endpoint = new Uri("http://localhost:2375");
+        var authProvider = new PassThroughAuthProvider(true);
+        var timeout = TimeSpan.FromSeconds(5);
+        var logger = NullLogger.Instance;
+
         _ = new DockerClientBuilder()
             .WithTransportOptions(transportFactory, transportOptions)
-            .WithEndpoint(new Uri("http://localhost:2375"))
-            .WithApiVersion(new Version(1, 52))
-            .WithHeader("x-test", "value")
-            .WithTimeout(TimeSpan.FromSeconds(1))
+            .WithApiVersion(apiVersion)
+            .WithEndpoint(endpoint)
+            .WithAuthProvider(authProvider)
+            .WithHeader(headerName, headerValue)
+            .WithTimeout(timeout)
+            .WithLogger(logger)
             .Build();
 
+        Assert.Equal(apiVersion, transportFactory.LastClientOptions.ApiVersion);
+        Assert.Equal(endpoint, transportFactory.LastClientOptions.Endpoint);
+        Assert.Same(authProvider, transportFactory.LastClientOptions.AuthProvider);
+        Assert.Equal(headerValue, transportFactory.LastClientOptions.Headers[headerName]);
+        Assert.Equal(timeout, transportFactory.LastClientOptions.Timeout);
+        Assert.Same(logger, transportFactory.LastLogger);
         Assert.Equal(1, transportFactory.TypedCreateHandlerCallCount);
         Assert.Same(transportOptions, transportFactory.LastTransportOptions);
-        Assert.Equal("http", transportFactory.LastClientOptions.Endpoint.Scheme);
-        Assert.Equal("value", transportFactory.LastClientOptions.Headers["x-test"]);
-        Assert.Equal(new Version(1, 52), transportFactory.LastClientOptions.ApiVersion);
-        Assert.Equal(TimeSpan.FromSeconds(1), transportFactory.LastClientOptions.Timeout);
     }
 
     [Fact]
-    public void Build_PreservesOriginalEndpointInClientOptions_WhenTransportNormalizesEndpoint()
+    public void Build_PreservesEndpointInClientOptions_WhenTransportNormalizesEndpoint()
     {
         var transportFactory = new FakeTransportFactory();
 
@@ -183,7 +232,7 @@ public void Build_PreservesOriginalEndpointInClientOptions_WhenTransportNormaliz
     }
 
     [Fact]
-    public void WithTransportOptions_ReturnsTypedBuilder_ForBuiltInTransports()
+    public void WithTransportOptions_ReturnsTypedBuilder_WhenBuiltInTransportIsSelected()
     {
         var builder = new DockerClientBuilder();
 
@@ -229,11 +278,14 @@ private sealed class FakeTransportFactory : IDockerHandlerFactory<FakeTransportO
 
         public ClientOptions LastClientOptions { get; private set; } = null!;
 
+        public ILogger LastLogger { get; private set; } = null!;
+
         public ResolvedTransport CreateHandler(FakeTransportOptions transportOptions, ClientOptions clientOptions, ILogger logger)
         {
             TypedCreateHandlerCallCount++;
             LastTransportOptions = transportOptions;
             LastClientOptions = clientOptions;
+            LastLogger = logger;
 
             return new ResolvedTransport(new HttpClientHandler(), clientOptions.Endpoint);
         }

version.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "nugetPackageVersion": {
     "semVer": 2
   },