Move auth to general availability (#744)

* Remove all preview markers from the APIs surrounding auth managers * Fix styling
neo4j · Oct 25, 2023 · 7691480 · 7691480
1 parent 9d48d59
commit 7691480
Show file tree

Hide file tree

Showing 37 changed files with 78 additions and 121 deletions.
diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Direct/CertificateTrustIT.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Direct/CertificateTrustIT.cs
@@ -19,7 +19,7 @@
 using System.Net;
 using System.Threading.Tasks;
 using FluentAssertions;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.IntegrationTests.Internals;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Auth;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Direct/DirectDriverTestBase.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Direct/DirectDriverTestBase.cs
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 using System;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.IntegrationTests.Internals;
 using Xunit;
 using Xunit.Abstractions;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Examples.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Examples.cs
@@ -22,7 +22,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using FluentAssertions;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.IntegrationTests.Internals;
 using Xunit;
 using Xunit.Abstractions;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/CausalCluster.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/CausalCluster.cs
@@ -20,7 +20,7 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Threading;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/ExistingCluster.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/ExistingCluster.cs
@@ -17,7 +17,7 @@
 
 using System;
 using Castle.Core.Internal;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/ICausalCluster.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/ICausalCluster.cs
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 using System;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/SingleInstance.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/Cluster/SingleInstance.cs
@@ -17,7 +17,7 @@
 
 using System;
 using System.IO;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/ISingleInstance.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/ISingleInstance.cs
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 using System;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/StandAlone/DefaultInstallation.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/StandAlone/DefaultInstallation.cs
@@ -17,7 +17,7 @@
 
 using System;
 using System.Diagnostics;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.TestUtil;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/StandAlone/StandAlone.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Internals/StandAlone/StandAlone.cs
@@ -17,7 +17,7 @@
 
 using System;
 using System.Linq;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Org.BouncyCastle.Pkcs;
 
 namespace Neo4j.Driver.IntegrationTests.Internals;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Routing/RoutingDriverTestBase.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Routing/RoutingDriverTestBase.cs
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 using System;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.IntegrationTests.Internals;
 using Neo4j.Driver.TestUtil;
 using Xunit;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Stress/StressTest.cs b/Neo4j.Driver/Neo4j.Driver.Tests.Integration/Stress/StressTest.cs
@@ -24,7 +24,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using FluentAssertions;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.IntegrationTests.Extensions;
 using Neo4j.Driver.IntegrationTests.Internals;
 using Neo4j.Driver.Internal;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.TestBackend/Protocol/Auth/NewBasicAuthTokenManager.cs b/Neo4j.Driver/Neo4j.Driver.Tests.TestBackend/Protocol/Auth/NewBasicAuthTokenManager.cs
@@ -19,7 +19,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Auth;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.TestBackend/Protocol/Auth/NewBearerAuthTokenManager.cs b/Neo4j.Driver/Neo4j.Driver.Tests.TestBackend/Protocol/Auth/NewBearerAuthTokenManager.cs
@@ -17,7 +17,7 @@
 
 using System;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Auth;
 

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests.TestBackend/Protocol/Driver/NewDriver.cs b/Neo4j.Driver/Neo4j.Driver.Tests.TestBackend/Protocol/Driver/NewDriver.cs
@@ -19,7 +19,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Newtonsoft.Json;
 
 namespace Neo4j.Driver.Tests.TestBackend;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/AsyncSessionTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/AsyncSessionTests.cs
@@ -23,7 +23,7 @@
 using System.Threading.Tasks;
 using FluentAssertions;
 using Moq;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Connector;
 using Neo4j.Driver.Internal.Logging;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Auth/Neo4jAuthTokenManagerTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Auth/Neo4jAuthTokenManagerTests.cs
@@ -20,7 +20,7 @@
 using FluentAssertions;
 using Moq;
 using Moq.AutoMock;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal.Auth;
 using Neo4j.Driver.Internal.Services;
 using Xunit;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/ConnectionPoolTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/ConnectionPoolTests.cs
@@ -27,7 +27,7 @@
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Connector;
 using Neo4j.Driver.Internal.Util;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Tests.TestUtil;
 using Xunit;
 using Xunit.Abstractions;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Connector/MockedMessagingClient.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Connector/MockedMessagingClient.cs
@@ -21,7 +21,7 @@
 using System.Threading.Tasks;
 using FluentAssertions;
 using Moq;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Auth;
 using Neo4j.Driver.Internal.Connector;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Connector/SocketClientTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Connector/SocketClientTests.cs
@@ -27,7 +27,7 @@
 using Neo4j.Driver.Internal.IO;
 using Neo4j.Driver.Internal.MessageHandling;
 using Neo4j.Driver.Internal.Messaging;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Xunit;
 
 namespace Neo4j.Driver.Tests

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Connector/SocketConnectionTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Connector/SocketConnectionTests.cs
@@ -22,7 +22,7 @@
 using System.Threading.Tasks;
 using FluentAssertions;
 using Moq;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Connector;
 using Neo4j.Driver.Internal.MessageHandling;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Connector/TcpSocketClientTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Connector/TcpSocketClientTests.cs
@@ -24,7 +24,7 @@
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Auth;
 using Neo4j.Driver.Internal.Connector;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Xunit;
 
 namespace Neo4j.Driver.Tests.Connector

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Internal/IO/ChunkWriterTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Internal/IO/ChunkWriterTests.cs
@@ -22,7 +22,7 @@
 using FluentAssertions;
 using Moq;
 using Neo4j.Driver.Internal.Auth;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Tests;
 using Neo4j.Driver.Tests.TestUtil;
 using Xunit;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/Routing/ClusterConnectionPoolTests.cs b/Neo4j.Driver/Neo4j.Driver.Tests/Routing/ClusterConnectionPoolTests.cs
@@ -23,7 +23,7 @@
 using System.Threading.Tasks;
 using FluentAssertions;
 using Moq;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Auth;
 using Neo4j.Driver.Internal.Connector;

diff --git a/Neo4j.Driver/Neo4j.Driver.Tests/TestDriverContext.cs b/Neo4j.Driver/Neo4j.Driver.Tests/TestDriverContext.cs
@@ -17,7 +17,7 @@
 
 using System;
 using Neo4j.Driver.Internal;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.Tests
 {

diff --git a/...er/Preview/Auth/AuthTokenAndExpiration.cs → ...o4j.Driver/Auth/AuthTokenAndExpiration.cs b/...er/Preview/Auth/AuthTokenAndExpiration.cs → ...o4j.Driver/Auth/AuthTokenAndExpiration.cs
@@ -18,7 +18,7 @@
 using System;
 using Neo4j.Driver.Internal.Services;
 
-namespace Neo4j.Driver.Preview.Auth;
+namespace Neo4j.Driver.Auth;
 
 /// <summary>
 /// Represents an auth token and its expiration.

diff --git a/....Driver/Preview/Auth/AuthTokenManagers.cs → ...er/Neo4j.Driver/Auth/AuthTokenManagers.cs b/....Driver/Preview/Auth/AuthTokenManagers.cs → ...er/Neo4j.Driver/Auth/AuthTokenManagers.cs
@@ -20,7 +20,7 @@
 using Neo4j.Driver.Internal.Auth;
 using Neo4j.Driver.Internal.Services;
 
-namespace Neo4j.Driver.Preview.Auth;
+namespace Neo4j.Driver.Auth;
 
 /// <summary>
 /// This class provides common implementations of <see cref="IAuthTokenManager"/> without needing to create a new

diff --git a/...r/Neo4j.Driver/Preview/Auth/IAuthToken.cs → Neo4j.Driver/Neo4j.Driver/Auth/IAuthToken.cs b/...r/Neo4j.Driver/Preview/Auth/IAuthToken.cs → Neo4j.Driver/Neo4j.Driver/Auth/IAuthToken.cs
diff --git a/....Driver/Preview/Auth/IAuthTokenManager.cs → ...er/Neo4j.Driver/Auth/IAuthTokenManager.cs b/....Driver/Preview/Auth/IAuthTokenManager.cs → ...er/Neo4j.Driver/Auth/IAuthTokenManager.cs
@@ -18,7 +18,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-namespace Neo4j.Driver.Preview.Auth;
+namespace Neo4j.Driver.Auth;
 
 /// <summary>Common interface for components that can provide auth tokens.</summary>
 public interface IAuthTokenManager

diff --git a/Neo4j.Driver/Neo4j.Driver/GraphDatabase.cs b/Neo4j.Driver/Neo4j.Driver/GraphDatabase.cs
@@ -16,7 +16,7 @@
 // limitations under the License.
 
 using System;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal;
 using Neo4j.Driver.Internal.Routing;
 
@@ -146,7 +146,17 @@ public static IDriver Driver(Uri uri, IAuthToken authToken)
         return Driver(uri, authToken, null);
     }
 
-    internal static IDriver Driver(Uri uri, IAuthTokenManager authTokenManager)
+    /// <summary>Returns a driver for a Neo4j instance with default configuration settings.</summary>
+    /// <param name="uri">
+    /// The URI to the Neo4j instance. Should be in the form
+    /// <c>protocol://&lt;server location&gt;:&lt;port&gt;</c>. If <c>port</c> is not supplied the default of <c>7687</c> will
+    /// be used. The supported protocols in URI could either be <c>bolt</c> or <c>neo4j</c>. The protocol <c>bolt</c> should be
+    /// used when creating a driver connecting to the Neo4j instance directly. The protocol <c>neo4j</c> should be used when
+    /// creating a driver with built-in routing.
+    /// </param>
+    /// <param name="authTokenManager">The <see cref="IAuthTokenManager"/> to use for authentication.</param>
+    /// <returns>A new <see cref="IDriver"/> instance.</returns>
+    public static IDriver Driver(Uri uri, IAuthTokenManager authTokenManager)
     {
         return Driver(uri, authTokenManager, null);
     }
@@ -171,7 +181,22 @@ public static IDriver Driver(string uri, IAuthToken authToken, Action<ConfigBuil
         return Driver(new Uri(uri), authToken, action);
     }
 
-    internal static IDriver Driver(string uri, IAuthTokenManager authTokenManager, Action<ConfigBuilder> action)
+    /// <summary>Returns a driver for a Neo4j instance with custom configuration.</summary>
+    /// <param name="uri">
+    /// The URI to the Neo4j instance. Should be in the form
+    /// <c>protocol://&lt;server location&gt;:&lt;port&gt;</c>. If <c>port</c> is not supplied the default of <c>7687</c> will
+    /// be used. The supported protocols in URI could either be <c>bolt</c> or <c>neo4j</c>. The protocol <c>bolt</c> should be
+    /// used when creating a driver connecting to the Neo4j instance directly. The protocol <c>neo4j</c> should be used when
+    /// creating a driver with built-in routing.
+    /// </param>
+    /// <param name="authTokenManager">The <see cref="IAuthTokenManager"/> to use for authentication.</param>
+    /// <param name="action">
+    /// Specifies how to build a driver configuration <see cref="Config"/>, using
+    /// <see cref="ConfigBuilder"/>. If set to <c>null</c>, then no modification will be carried out and the default driver
+    /// configurations <see cref="Config"/> will be used when creating the driver.
+    /// </param>
+    /// <returns>A new <see cref="IDriver"/> instance.</returns>
+    public static IDriver Driver(string uri, IAuthTokenManager authTokenManager, Action<ConfigBuilder> action)
     {
         return Driver(new Uri(uri), authTokenManager, action);
     }
@@ -194,7 +219,22 @@ public static IDriver Driver(Uri uri, IAuthToken authToken, Action<ConfigBuilder
         return Driver(uri, AuthTokenManagers.Static(authToken), action);
     }
 
-    internal static IDriver Driver(Uri uri, IAuthTokenManager authTokenManager, Action<ConfigBuilder> action)
+    /// <summary>Returns a driver for a Neo4j instance with custom configuration.</summary>
+    /// <param name="uri">
+    /// The URI to the Neo4j instance. Should be in the form
+    /// <c>protocol://&lt;server location&gt;:&lt;port&gt;</c>. If <c>port</c> is not supplied the default of <c>7687</c> will
+    /// be used. The supported protocols in URI could either be <c>bolt</c> or <c>neo4j</c>. The protocol <c>bolt</c> should be
+    /// used when creating a driver connecting to the Neo4j instance directly. The protocol <c>neo4j</c> should be used when
+    /// creating a driver with built-in routing.
+    /// </param>
+    /// <param name="authTokenManager">The <see cref="IAuthTokenManager"/> to use for authentication.</param>
+    /// <param name="action">
+    /// Specifies how to build a driver configuration <see cref="Config"/>, using
+    /// <see cref="ConfigBuilder"/>. If set to <c>null</c>, then no modification will be carried out and the default driver
+    /// configurations <see cref="Config"/> will be used when creating the driver.
+    /// </param>
+    /// <returns>A new <see cref="IDriver"/> instance.</returns>
+    public static IDriver Driver(Uri uri, IAuthTokenManager authTokenManager, Action<ConfigBuilder> action)
     {
         uri = uri ?? throw new ArgumentNullException(nameof(uri));
         authTokenManager = authTokenManager ?? throw new ArgumentNullException(nameof(authTokenManager));

diff --git a/Neo4j.Driver/Neo4j.Driver/Internal/Auth/Neo4jAuthTokenManager.cs b/Neo4j.Driver/Neo4j.Driver/Internal/Auth/Neo4jAuthTokenManager.cs
@@ -20,7 +20,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Neo4j.Driver.Internal.Services;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.Internal.Auth;
 

diff --git a/Neo4j.Driver/Neo4j.Driver/Internal/Auth/StaticAuthTokenManager.cs b/Neo4j.Driver/Neo4j.Driver/Internal/Auth/StaticAuthTokenManager.cs
@@ -17,7 +17,7 @@
 
 using System.Threading;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.Internal.Auth;
 

diff --git a/Neo4j.Driver/Neo4j.Driver/Internal/Connector/DelegatedConnection.cs b/Neo4j.Driver/Neo4j.Driver/Internal/Connector/DelegatedConnection.cs
@@ -19,7 +19,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal.MessageHandling;
 using Neo4j.Driver.Internal.Messaging;
 using Neo4j.Driver.Internal.Util;

diff --git a/Neo4j.Driver/Neo4j.Driver/Internal/Connector/IConnection.cs b/Neo4j.Driver/Neo4j.Driver/Internal/Connector/IConnection.cs
@@ -18,7 +18,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal.MessageHandling;
 using Neo4j.Driver.Internal.Messaging;
 using Neo4j.Driver.Internal.Util;

diff --git a/Neo4j.Driver/Neo4j.Driver/Internal/Connector/SocketConnection.cs b/Neo4j.Driver/Neo4j.Driver/Internal/Connector/SocketConnection.cs
@@ -20,7 +20,7 @@
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 using Neo4j.Driver.Internal.Logging;
 using Neo4j.Driver.Internal.MessageHandling;
 using Neo4j.Driver.Internal.Messaging;

diff --git a/Neo4j.Driver/Neo4j.Driver/Internal/DriverContext.cs b/Neo4j.Driver/Neo4j.Driver/Internal/DriverContext.cs
@@ -19,7 +19,7 @@
 using System.Collections.Generic;
 using Neo4j.Driver.Internal.Connector;
 using Neo4j.Driver.Internal.Metrics;
-using Neo4j.Driver.Preview.Auth;
+using Neo4j.Driver.Auth;
 
 namespace Neo4j.Driver.Internal;