Connection opening cancellation (DNET-1034).

cincuranet · cincuranet · commit c97c4046b4a4 · 2021-03-25T11:02:14.000+01:00
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient.Tests/FbConnectionTests.cs b/Provider/src/FirebirdSql.Data.FirebirdClient.Tests/FbConnectionTests.cs
@@ -550,7 +550,6 @@ public async Task InvalidCredentialsGiveProperError()
 				catch (FbException ex) when (ex.ErrorCode == 335544472)
 				{
 					Assert.Pass();
-					return;
 				}
 			}
 		}
@@ -575,6 +574,54 @@ public async Task InfoMessageTest()
 			Assert.IsTrue(messageReceived);
 		}
 
+		[Test]
+		public async Task ConnectionTimeoutUsingTimeout()
+		{
+			if (!EnsureServerType(FbServerType.Default))
+				return;
+
+			var csb = BuildConnectionStringBuilder(ServerType, Compression, WireCrypt);
+			csb.ConnectionTimeout = 1;
+			csb.DataSource = "10.0.0.0"; // intentionally wrong address
+			await using (var conn = new FbConnection(csb.ToString()))
+			{
+				try
+				{
+					await conn.OpenAsync();
+					Assert.Fail();
+				}
+				catch (TimeoutException)
+				{
+					Assert.Pass();
+				}
+			}
+		}
+
+		[Test]
+		public async Task ConnectionTimeoutUsingCancellationToken()
+		{
+			if (!EnsureServerType(FbServerType.Default))
+				return;
+
+			var csb = BuildConnectionStringBuilder(ServerType, Compression, WireCrypt);
+			csb.DataSource = "10.0.0.0"; // intentionally wrong address
+			await using (var conn = new FbConnection(csb.ToString()))
+			{
+				try
+				{
+					using (var cts = new CancellationTokenSource(100))
+					{
+						await conn.OpenAsync(cts.Token);
+					}
+					Assert.Fail();
+				}
+				catch (OperationCanceledException)
+				{
+					Assert.Pass();
+				}
+			}
+		}
+
 		private async Task BeginTransactionILTestsHelper(IsolationLevel level)
 		{
 			await using (var conn = new FbConnection(BuildConnectionString(ServerType, Compression, WireCrypt)))
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient/Client/ClientFactory.cs b/Provider/src/FirebirdSql.Data.FirebirdClient/Client/ClientFactory.cs
@@ -48,7 +48,7 @@ public static async Task<ServiceManagerBase> CreateServiceManager(ConnectionStri
 
 		private static async Task<DatabaseBase> CreateManagedDatabase(ConnectionString options, AsyncWrappingCommonArgs async)
 		{
-			var connection = new GdsConnection(options.UserID, options.Password, options.DataSource, options.Port, options.PacketSize, Charset.GetCharset(options.Charset), options.Compression, FbWireCryptToWireCryptOption(options.WireCrypt));
+			var connection = new GdsConnection(options.UserID, options.Password, options.DataSource, options.Port, options.ConnectionTimeout, options.PacketSize, Charset.GetCharset(options.Charset), options.Compression, FbWireCryptToWireCryptOption(options.WireCrypt));
 			await connection.Connect(async).ConfigureAwait(false);
 			await connection.Identify(options.Database, async).ConfigureAwait(false);
 			return connection.ProtocolVersion switch
@@ -63,7 +63,7 @@ private static async Task<DatabaseBase> CreateManagedDatabase(ConnectionString o
 
 		private static async Task<ServiceManagerBase> CreateManagedServiceManager(ConnectionString options, AsyncWrappingCommonArgs async)
 		{
-			var connection = new GdsConnection(options.UserID, options.Password, options.DataSource, options.Port, options.PacketSize, Charset.GetCharset(options.Charset), options.Compression, FbWireCryptToWireCryptOption(options.WireCrypt));
+			var connection = new GdsConnection(options.UserID, options.Password, options.DataSource, options.Port, options.ConnectionTimeout, options.PacketSize, Charset.GetCharset(options.Charset), options.Compression, FbWireCryptToWireCryptOption(options.WireCrypt));
 			await connection.Connect(async).ConfigureAwait(false);
 			await connection.Identify(!string.IsNullOrEmpty(options.Database) ? options.Database : string.Empty, async).ConfigureAwait(false);
 			return connection.ProtocolVersion switch
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/GdsConnection.cs b/Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/GdsConnection.cs
@@ -38,6 +38,7 @@ internal sealed class GdsConnection
 		private string _userID;
 		private string _dataSource;
 		private int _portNumber;
+		private int _timeout;
 		private int _packetSize;
 		private Charset _charset;
 		private bool _compression;
@@ -55,22 +56,24 @@ internal sealed class GdsConnection
 		public bool ConnectionBroken => _firebirdNetworkHandlingWrapper?.IOFailed ?? false;
 
 		internal IPAddress IPAddress { get; private set; }
+		internal int Timeout => _timeout;
 		internal XdrReaderWriter Xdr { get; private set; }
 
 		#endregion
 
 		#region Constructors
 
-		public GdsConnection(string dataSource, int port)
-			: this(null, null, dataSource, port, 8192, Charset.DefaultCharset, false, WireCryptOption.Enabled)
+		public GdsConnection(string dataSource, int port, int timeout)
+			: this(null, null, dataSource, port, timeout, 8192, Charset.DefaultCharset, false, WireCryptOption.Enabled)
 		{ }
 
-		public GdsConnection(string userID, string password, string dataSource, int portNumber, int packetSize, Charset charset, bool compression, WireCryptOption wireCrypt)
+		public GdsConnection(string userID, string password, string dataSource, int portNumber, int timeout, int packetSize, Charset charset, bool compression, WireCryptOption wireCrypt)
 		{
 			_userID = userID;
 			Password = password;
 			_dataSource = dataSource;
 			_portNumber = portNumber;
+			_timeout = timeout;
 			_packetSize = packetSize;
 			_charset = charset;
 			_compression = compression;
@@ -93,12 +96,26 @@ public async Task Connect(AsyncWrappingCommonArgs async)
 				socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendBuffer, _packetSize);
 				socket.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.NoDelay, 1);
 				socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.KeepAlive, 1);
+
+				if (async.IsAsync)
+				{
+					using (var timeoutCts = new CancellationTokenSource(TimeSpan.FromSeconds(_timeout)))
+					{
+						using (var combinedCts = CancellationTokenSource.CreateLinkedTokenSource(timeoutCts.Token, async.CancellationToken))
+						{
+							await ConnectAsyncHelper(socket)(endPoint, combinedCts.Token).ConfigureAwait(false);
+						}
+					}
 #if NET48 || NETSTANDARD2_0 || NETSTANDARD2_1
-				static Func<IPEndPoint, CancellationToken, Task> ConnectHelper(Socket socket) => (e, ct) => Task.Factory.FromAsync(socket.BeginConnect, socket.EndConnect, e, null);
+					static Func<IPEndPoint, CancellationToken, Task> ConnectAsyncHelper(Socket socket) => (e, ct) => Task.Factory.FromAsync(socket.BeginConnect, socket.EndConnect, e, null);
 #else
-				static Func<IPEndPoint, CancellationToken, Task> ConnectHelper(Socket socket) => (e, ct) => SocketTaskExtensions.ConnectAsync(socket, e, ct).AsTask();
+					static Func<IPEndPoint, CancellationToken, Task> ConnectAsyncHelper(Socket socket) => (e, ct) => SocketTaskExtensions.ConnectAsync(socket, e, ct).AsTask();
 #endif
-				await async.AsyncSyncCall(ConnectHelper(socket), socket.Connect, endPoint).ConfigureAwait(false);
+				}
+				else
+				{
+					socket.Connect(endPoint);
+				}
 
 				_networkStream = new NetworkStream(socket, true);
 				_firebirdNetworkHandlingWrapper = new FirebirdNetworkHandlingWrapper(new DataProviderStreamWrapper(_networkStream));
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/Version10/GdsDatabase.cs b/Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/Version10/GdsDatabase.cs
@@ -263,7 +263,7 @@ public override async Task DropDatabase(AsyncWrappingCommonArgs async)
 
 		#region Auxiliary Connection Methods
 
-		public virtual async Task<(int auxHandle, string ipAddress, int portNumber)> ConnectionRequest(AsyncWrappingCommonArgs async)
+		public virtual async Task<(int auxHandle, string ipAddress, int portNumber, int timeout)> ConnectionRequest(AsyncWrappingCommonArgs async)
 		{
 			try
 			{
@@ -306,7 +306,7 @@ public override async Task DropDatabase(AsyncWrappingCommonArgs async)
 
 				await Xdr.ReadStatusVector(async).ConfigureAwait(false);
 
-				return (auxHandle, ipAddress, portNumber);
+				return (auxHandle, ipAddress, portNumber, _connection.Timeout);
 			}
 			catch (IOException ex)
 			{
@@ -342,8 +342,8 @@ public override async Task QueueEvents(RemoteEvent remoteEvent, AsyncWrappingCom
 			{
 				if (_eventManager == null)
 				{
-					var (auxHandle, ipAddress, portNumber) = await ConnectionRequest(async).ConfigureAwait(false);
-					_eventManager = new GdsEventManager(auxHandle, ipAddress, portNumber);
+					var (auxHandle, ipAddress, portNumber, timeout) = await ConnectionRequest(async).ConfigureAwait(false);
+					_eventManager = new GdsEventManager(auxHandle, ipAddress, portNumber, timeout);
 					await _eventManager.Open(async).ConfigureAwait(false);
 					var dummy = _eventManager.WaitForEvents(remoteEvent, new AsyncWrappingCommonArgs(true));
 				}
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/Version10/GdsEventManager.cs b/Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/Version10/GdsEventManager.cs
@@ -30,19 +30,21 @@ internal class GdsEventManager
 		int _handle;
 		string _ipAddress;
 		int _portNumber;
+		int _timeout;
 		GdsDatabase _database;
 
-		public GdsEventManager(int handle, string ipAddress, int portNumber)
+		public GdsEventManager(int handle, string ipAddress, int portNumber, int timeout)
 		{
 			_closing = false;
 			_handle = handle;
 			_ipAddress = ipAddress;
 			_portNumber = portNumber;
+			_timeout = timeout;
 		}
 
 		public async Task Open(AsyncWrappingCommonArgs async)
 		{
-			var connection = new GdsConnection(_ipAddress, _portNumber);
+			var connection = new GdsConnection(_ipAddress, _portNumber, _timeout);
 			await connection.Connect(async).ConfigureAwait(false);
 			_database = new GdsDatabase(connection);
 		}
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient/Common/AsyncWrappingCommonArgs.cs b/Provider/src/FirebirdSql.Data.FirebirdClient/Common/AsyncWrappingCommonArgs.cs
@@ -29,7 +29,8 @@ internal struct AsyncWrappingCommonArgs
 		readonly bool _isAsync;
 		readonly CancellationToken _cancellationTokenRaw;
 		int _explicitCancel;
-		readonly CancellationToken CancellationToken => _explicitCancel > 0 ? CancellationToken.None : _cancellationTokenRaw;
+		public readonly bool IsAsync => _isAsync;
+		public readonly CancellationToken CancellationToken => _explicitCancel > 0 ? CancellationToken.None : _cancellationTokenRaw;
 
 		public AsyncWrappingCommonArgs(bool isAsync, CancellationToken cancellationToken = default)
 		{
diff --git a/Provider/src/FirebirdSql.Data.FirebirdClient/FirebirdClient/FbConnection.cs b/Provider/src/FirebirdSql.Data.FirebirdClient/FirebirdClient/FbConnection.cs
@@ -460,6 +460,11 @@ internal async Task OpenImpl(AsyncWrappingCommonArgs async)
 					{
 						await _innerConnection.Connect(async).ConfigureAwait(false);
 					}
+					catch (OperationCanceledException ex)
+					{
+						async.CancellationToken.ThrowIfCancellationRequested();
+						throw new TimeoutException("Timeout while connecting.", ex);
+					}
 					catch
 					{
 						if (_options.Pooling)

Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ public override async Task DropDatabase(AsyncWrappingCommonArgs async)`
`263`	`263`
`264`	`264`	`#region Auxiliary Connection Methods`
`265`	`265`
`266`		`- public virtual async Task<(int auxHandle, string ipAddress, int portNumber)> ConnectionRequest(AsyncWrappingCommonArgs async)`
	`266`	`+ public virtual async Task<(int auxHandle, string ipAddress, int portNumber, int timeout)> ConnectionRequest(AsyncWrappingCommonArgs async)`
`267`	`267`	`{`
`268`	`268`	`try`
`269`	`269`	`{`
`@@ -306,7 +306,7 @@ public override async Task DropDatabase(AsyncWrappingCommonArgs async)`
`306`	`306`
`307`	`307`	`await Xdr.ReadStatusVector(async).ConfigureAwait(false);`
`308`	`308`
`309`		`- return (auxHandle, ipAddress, portNumber);`
	`309`	`+ return (auxHandle, ipAddress, portNumber, _connection.Timeout);`
`310`	`310`	`}`
`311`	`311`	`catch (IOException ex)`
`312`	`312`	`{`
`@@ -342,8 +342,8 @@ public override async Task QueueEvents(RemoteEvent remoteEvent, AsyncWrappingCom`
`342`	`342`	`{`
`343`	`343`	`if (_eventManager == null)`
`344`	`344`	`{`
`345`		`- var (auxHandle, ipAddress, portNumber) = await ConnectionRequest(async).ConfigureAwait(false);`
`346`		`- _eventManager = new GdsEventManager(auxHandle, ipAddress, portNumber);`
	`345`	`+ var (auxHandle, ipAddress, portNumber, timeout) = await ConnectionRequest(async).ConfigureAwait(false);`
	`346`	`+ _eventManager = new GdsEventManager(auxHandle, ipAddress, portNumber, timeout);`
`347`	`347`	`await _eventManager.Open(async).ConfigureAwait(false);`
`348`	`348`	`var dummy = _eventManager.WaitForEvents(remoteEvent, new AsyncWrappingCommonArgs(true));`
`349`	`349`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,19 +30,21 @@ internal class GdsEventManager`
`30`	`30`	`int _handle;`
`31`	`31`	`string _ipAddress;`
`32`	`32`	`int _portNumber;`
	`33`	`+ int _timeout;`
`33`	`34`	`GdsDatabase _database;`
`34`	`35`
`35`		`- public GdsEventManager(int handle, string ipAddress, int portNumber)`
	`36`	`+ public GdsEventManager(int handle, string ipAddress, int portNumber, int timeout)`
`36`	`37`	`{`
`37`	`38`	`_closing = false;`
`38`	`39`	`_handle = handle;`
`39`	`40`	`_ipAddress = ipAddress;`
`40`	`41`	`_portNumber = portNumber;`
	`42`	`+ _timeout = timeout;`
`41`	`43`	`}`
`42`	`44`
`43`	`45`	`public async Task Open(AsyncWrappingCommonArgs async)`
`44`	`46`	`{`
`45`		`- var connection = new GdsConnection(_ipAddress, _portNumber);`
	`47`	`+ var connection = new GdsConnection(_ipAddress, _portNumber, _timeout);`
`46`	`48`	`await connection.Connect(async).ConfigureAwait(false);`
`47`	`49`	`_database = new GdsDatabase(connection);`
`48`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,8 @@ internal struct AsyncWrappingCommonArgs`
`29`	`29`	`readonly bool _isAsync;`
`30`	`30`	`readonly CancellationToken _cancellationTokenRaw;`
`31`	`31`	`int _explicitCancel;`
`32`		`- readonly CancellationToken CancellationToken => _explicitCancel > 0 ? CancellationToken.None : _cancellationTokenRaw;`
	`32`	`+ public readonly bool IsAsync => _isAsync;`
	`33`	`+ public readonly CancellationToken CancellationToken => _explicitCancel > 0 ? CancellationToken.None : _cancellationTokenRaw;`
`33`	`34`
`34`	`35`	`public AsyncWrappingCommonArgs(bool isAsync, CancellationToken cancellationToken = default)`
`35`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -460,6 +460,11 @@ internal async Task OpenImpl(AsyncWrappingCommonArgs async)`
`460`	`460`	`{`
`461`	`461`	`await _innerConnection.Connect(async).ConfigureAwait(false);`
`462`	`462`	`}`
	`463`	`+ catch (OperationCanceledException ex)`
	`464`	`+ {`
	`465`	`+ async.CancellationToken.ThrowIfCancellationRequested();`
	`466`	`+ throw new TimeoutException("Timeout while connecting.", ex);`
	`467`	`+ }`
`463`	`468`	`catch`
`464`	`469`	`{`
`465`	`470`	`if (_options.Pooling)`