Add InteractiveSession option. Fixes #510

Author: bgrainger

docs/content/connection-options.md

@@ -232,6 +232,11 @@ These are the other options that MySqlConnector supports. They are set to sensib
     <td>If <code>true</code>, the value of <code>MySqlCommand.Transaction</code> is ignored when commands are executed.
     This matches the Connector/NET behaviour and can make porting code easier. For more information, see <a href="https://github.com/mysql-net/MySqlConnector/issues/474">Issue 474</a>.</td>
   </tr>
+  <tr>
+    <td>Interactive, Interactive Session, InteractiveSession</td>
+    <td>false</td>
+    <td>If <code>true</code>, the session <code>wait_timeout</code> variable is initialized from the global <code>interactive_timeout<code> value instead of the global <code>wait_timeout</code> value.</td>
+  </tr>
   <tr>
     <td>Keep Alive, Keepalive</td>
     <td>0</td>

src/MySqlConnector/Core/ConnectionSettings.cs

@@ -59,6 +59,7 @@ public ConnectionSettings(MySqlConnectionStringBuilder csb)
 			DefaultCommandTimeout = (int) csb.DefaultCommandTimeout;
 			ForceSynchronous = csb.ForceSynchronous;
 			IgnoreCommandTransaction = csb.IgnoreCommandTransaction;
+			InteractiveSession = csb.InteractiveSession;
 			GuidFormat = GetEffectiveGuidFormat(csb.GuidFormat, csb.OldGuids);
 			Keepalive = csb.Keepalive;
 			PersistSecurityInfo = csb.PersistSecurityInfo;
@@ -131,6 +132,7 @@ private static MySqlGuidFormat GetEffectiveGuidFormat(MySqlGuidFormat guidFormat
 		public bool ForceSynchronous { get; }
 		public MySqlGuidFormat GuidFormat { get; }
 		public bool IgnoreCommandTransaction { get; }
+		public bool InteractiveSession { get; }
 		public uint Keepalive { get; }
 		public bool PersistSecurityInfo { get; }
 		public string ServerRsaPublicKeyFile { get; }

src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnectionStringBuilder.cs

@@ -189,6 +189,12 @@ public bool IgnoreCommandTransaction
 			set => MySqlConnectionStringOption.IgnoreCommandTransaction.SetValue(this, value);
 		}
 
+		public bool InteractiveSession
+		{
+			get => MySqlConnectionStringOption.InteractiveSession.GetValue(this);
+			set => MySqlConnectionStringOption.InteractiveSession.SetValue(this, value);
+		}
+
 		public uint Keepalive
 		{
 			get => MySqlConnectionStringOption.Keepalive.GetValue(this);
@@ -311,6 +317,7 @@ internal abstract class MySqlConnectionStringOption
 		public static readonly MySqlConnectionStringOption<bool> ForceSynchronous;
 		public static readonly MySqlConnectionStringOption<MySqlGuidFormat> GuidFormat;
 		public static readonly MySqlConnectionStringOption<bool> IgnoreCommandTransaction;
+		public static readonly MySqlConnectionStringOption<bool> InteractiveSession;
 		public static readonly MySqlConnectionStringOption<uint> Keepalive;
 		public static readonly MySqlConnectionStringOption<bool> OldGuids;
 		public static readonly MySqlConnectionStringOption<bool> PersistSecurityInfo;
@@ -461,6 +468,10 @@ static MySqlConnectionStringOption()
 				keys: new[] { "IgnoreCommandTransaction", "Ignore Command Transaction" },
 				defaultValue: false));
 
+			AddOption(InteractiveSession = new MySqlConnectionStringOption<bool>(
+				keys: new[] { "InteractiveSession", "Interactive", "Interactive Session" },
+				defaultValue: false));
+
 			AddOption(Keepalive = new MySqlConnectionStringOption<uint>(
 				keys: new[] { "Keep Alive", "Keepalive" },
 				defaultValue: 0u));

src/MySqlConnector/Protocol/Payloads/HandshakeResponse41Payload.cs

@@ -11,6 +11,7 @@ private static ByteBufferWriter CreateCapabilitiesPayload(ProtocolCapabilities s
 
 			writer.Write((int) (
 				ProtocolCapabilities.Protocol41 |
+				(cs.InteractiveSession ? (serverCapabilities & ProtocolCapabilities.Interactive) : 0) |
 				ProtocolCapabilities.LongPassword |
 				ProtocolCapabilities.SecureConnection |
 				(serverCapabilities & ProtocolCapabilities.PluginAuth) |

src/MySqlConnector/Protocol/ProtocolCapabilities.cs

@@ -2,6 +2,9 @@
 
 namespace MySqlConnector.Protocol
 {
+	/// <summary>
+	/// The <a href="https://dev.mysql.com/doc/internals/en/capability-flags.html">MySQL Capability flags</a>.
+	/// </summary>
 	[Flags]
 	internal enum ProtocolCapabilities
 	{
@@ -61,7 +64,7 @@ internal enum ProtocolCapabilities
 		Protocol41 = 0x200,
 
 		/// <summary>
-		/// Supports interactive and noninteractive clients.
+		/// Server: Supports interactive and noninteractive clients. Client: The session <code>wait_timeout</code> variable is set to the value of the session <code>interactive_timeout</code> variable.
 		/// </summary>
 		Interactive = 0x400,
 

tests/MySqlConnector.Tests/MySqlConnectionStringBuilderTests.cs

@@ -40,6 +40,7 @@ public void Defaults()
 			Assert.Null(csb.CACertificateFile);
 			Assert.Equal(MySqlLoadBalance.RoundRobin, csb.LoadBalance);
 #endif
+			Assert.False(csb.InteractiveSession);
 			Assert.Equal(0u, csb.Keepalive);
 			Assert.Equal(100u, csb.MaximumPoolSize);
 			Assert.Equal(0u, csb.MinimumPoolSize);
@@ -99,6 +100,7 @@ public void ParseConnectionString()
 					"load balance=random;" +
 					"guidformat=timeswapbinary16;" +
 #endif
+					"interactive=true;" +
 					"Keep Alive=90;" +
 					"minpoolsize=5;" +
 					"maxpoolsize=15;" +
@@ -137,6 +139,7 @@ public void ParseConnectionString()
 			Assert.Equal(MySqlLoadBalance.Random, csb.LoadBalance);
 			Assert.Equal(MySqlGuidFormat.TimeSwapBinary16, csb.GuidFormat);
 #endif
+			Assert.True(csb.InteractiveSession);
 			Assert.Equal(90u, csb.Keepalive);
 			Assert.Equal(15u, csb.MaximumPoolSize);
 			Assert.Equal(5u, csb.MinimumPoolSize);