LiveLink release v1.0

Author: luvoid

COM3D2.LiveLink.sln

@@ -18,6 +18,11 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CM3D2.Serialization", "..\C
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CM3D2.Serialization.Tests", "..\CM3D2.Serialization\CM3D2.Serialization.Tests\CM3D2.Serialization.Tests.csproj", "{3A4C2284-D50C-4F0F-A6E3-9303B423595D}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{B0235D70-D8D6-4AF7-8D1F-25DD22CC681C}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

LiveLink.CLI/Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("0.1.*")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyFileVersion("1.0")]

LiveLink.Plugin/LiveLinkPlugin.cs

@@ -23,7 +23,7 @@
 
 // This is the major & minor version with an asterisk (*) appended to auto increment numbers.
 [assembly: AssemblyVersion(COM3D2.LiveLink.Plugin.PluginInfo.PLUGIN_VERSION + ".*")]
-[assembly: AssemblyFileVersion(COM3D2.LiveLink.Plugin.PluginInfo.PLUGIN_VERSION + ".0.0")]
+[assembly: AssemblyFileVersion(COM3D2.LiveLink.Plugin.PluginInfo.PLUGIN_VERSION)]
 
 // These two lines tell the compiler not worry about accessing private variables/classes.
 [module: UnverifiableCode]
@@ -39,7 +39,7 @@ public static class PluginInfo
 		// The name of this plugin.
 		public const string PLUGIN_NAME = "LiveLink";
 		// The version of this plugin.
-		public const string PLUGIN_VERSION = "0.1";
+		public const string PLUGIN_VERSION = "1.0";
 	}
 }
 
@@ -124,7 +124,12 @@ private void Update()
 				}
 				else if (m_Core.IsConnected && m_DisconnectShortcut.IsDown())
 				{
-					DisconnectClient();
+					GameMain.Instance.SysDlg.Show(
+						"⚠️ WARNING ⚠️\n" +
+						"Disconnecting client may crash the server, the client, or both. " +
+						"This action is only safe if the server is already disconnected.\n\n" +
+						"Are you sure you want to try disconnecting?", 
+						SystemDialog.TYPE.YES_NO, DisconnectClient);
 				}
 			}
 		}

LiveLink.Tests/LiveLinkTestBase.cs

@@ -19,7 +19,7 @@ public static LiveLinkCore CreateServer()
 			string address = GetProcessUniqueAddress();
 			LiveLinkCore serverCore = new LiveLinkCore();
 			serverCore.StartServer(address);
-			Console.WriteLine($"address = {serverCore.Address}");
+			//Console.WriteLine($"address = {serverCore.Address}");
 			return serverCore;
 		}
 

LiveLink.Tests/TestCore.cs

@@ -3,6 +3,8 @@
 using System.Diagnostics;
 using System.IO;
 using System.Collections.Concurrent;
+using System.Threading;
+using System.Threading.Tasks;
 
 namespace COM3D2.LiveLink.Tests
 {
@@ -70,27 +72,29 @@ public int StopCLIProcess(Process cliProcess)
 			return cliProcess.ExitCode;
 		}
 
-		public void StartClientCoreAndServerCLI(out LiveLinkCore clientCore, out Process serverCLI)
+		public void StartClientCoreAndServerCLI(out LiveLinkCore clientCore, out Process serverCLI, out string address)
 		{
-			serverCLI = CreateServerProcess(out string address);
+			serverCLI = CreateServerProcess(out address);
 			Console.WriteLine($"address = {address}");
 
 			clientCore = new LiveLinkCore();
 			Assert.IsTrue(clientCore.StartClient(address), "Failed to connect client to server.");
-			clientCore.WaitForConnection();
 
 			serverCLI.StandardInput.WriteLine($"waitfor --connection --time 1");
 			Assert.IsTrue(clientCore.IsConnected);
 		}
 
+		public void StartClientCoreAndServerCLI(out LiveLinkCore clientCore, out Process serverCLI)
+		{
+			StartClientCoreAndServerCLI(out clientCore, out serverCLI, out string address);
+		}
+
 		public void StartServerCoreAndClientCLI(out LiveLinkCore serverCore, out Process clientCLI)
 		{
 			serverCore = CreateServer();
 			clientCLI = CreateClientProcess(serverCore.Address);
 
-			serverCore.WaitForConnection(1000);
-
-			Assert.IsTrue(serverCore.IsConnected);
+			Assert.IsTrue(serverCore.WaitForConnection(1000), "Client did not connect to server.");
 		}
 
 		[TestMethod]
@@ -104,7 +108,7 @@ public void TestClientCLI()
 			int exitCode = -1;
 			try
 			{
-				serverCore.WaitForConnection();
+				serverCore.WaitForConnection(1000);
 				serverCore.SendString(testString);
 				serverCore.Flush();
 
@@ -223,6 +227,34 @@ public void TestClientNoReadBlock()
 			AssertContains(output, testString);
 		}
 
+		[TestMethod]
+		public void TestServerWaitForConnectionTimeout()
+		{
+			LiveLinkCore serverCore = CreateServer();
+
+			var task = Task.Run(() => serverCore.WaitForConnection(10));
+			Assert.IsTrue(task.Wait(20));
+		}
+
+		[TestMethod]
+		public void TestServerListenForConnection()
+		{
+			LiveLinkCore serverCore = CreateServer();
+			Process clientCLI = CreateClientProcess(serverCore.Address);
+
+			Thread.Sleep(1000);
+
+			try
+			{
+				Assert.IsTrue(serverCore.IsConnected, "serverCore.IsConnected = false");
+			}
+			finally
+			{
+				StopCLIProcess(clientCLI);
+			}
+		}
+
+
 		[TestMethod]
 		public void TestSendFile()
 		{
@@ -275,14 +307,14 @@ public void TestFileCommand()
 			serverCLI.StandardInput.WriteLine($"send --file {filePath}");
 			serverCLI.StandardInput.WriteLine($"flush");
 
-			System.Threading.Thread.Sleep(100);
+			Thread.Sleep(100);
 
 			bool recieved = clientCore.TryReadMessage(out MemoryStream message);
 
 			clientCore.Dispose();
 			int exitCode = StopCLIProcess(serverCLI);
 			Console.WriteLine("Server Output - - - - - - - - -");
-			Console.Write(serverCLI.StandardOutput.ReadAllAvailable());
+			Console.WriteLine(serverCLI.StandardOutput.ReadAllAvailable());
 			Debug.Write(serverCLI.StandardError.ReadAllAvailable());
 			Console.WriteLine("- - - - - - - - - - - - - - - -");
 			Assert.That.ExitZero(serverCLI);
@@ -292,26 +324,29 @@ public void TestFileCommand()
 				Assert.That.StreamsAreEqual(fileStream, message);
 			}
 		}
-
-
+		
 		[TestMethod]
-		public void TestServerCLIDisconnect()
+		public void TestServerIsConnected()
 		{
-			StartClientCoreAndServerCLI(out LiveLinkCore clientCore, out Process serverCLI);
+			StartServerCoreAndClientCLI(out LiveLinkCore serverCore, out Process clientCLI);
 
-			Console.WriteLine($"clientCore.IsConnected = {clientCore.IsConnected}");
+			Console.WriteLine($"serverCore.IsConnected = {serverCore.IsConnected}");
 
-			serverCLI.StandardInput.WriteLine("disconnect");
+			clientCLI.StandardInput.WriteLine("disconnect");
 
-			System.Threading.Thread.Sleep(100);
+			Thread.Sleep(1000);
 
-			clientCore.ReadAll();
+			Console.WriteLine("Client Output - - - - - - - - -");
+			Console.WriteLine(clientCLI.StandardOutput.ReadAllAvailable());
+			Console.WriteLine("- - - - - - - - - - - - - - - -");
+
+			StopCLIProcess(clientCLI);
+			Assert.That.ExitZero(clientCLI);
+
+			Console.WriteLine($"serverCore.IsConnected = {serverCore.IsConnected}");
+			Assert.IsFalse(serverCore.IsConnected, "serverCore.IsConnected is still still true.");
 
-			Console.WriteLine($"clientCore.IsConnected = {clientCore.IsConnected}");
-			Assert.IsFalse(clientCore.IsConnected);
 
-			StopCLIProcess(serverCLI);
-			Assert.That.ExitZero(serverCLI);
 		}
 
 		[TestMethod]
@@ -326,7 +361,7 @@ public void TestServerCLIUnexpectedDisconnect()
 		}
 
 		[TestMethod]
-		public void TestServerCoreDisconnect()
+		public void TestClientIsConnectedCLI()
 		{
 			StartServerCoreAndClientCLI(out LiveLinkCore serverCore, out Process clientCLI);
 
@@ -348,6 +383,71 @@ public void TestServerCoreDisconnect()
 			Assert.That.ExitZero(clientCLI);
 		}
 
+		[TestMethod]
+		public void TestServerCrashing()
+		{
+			StartClientCoreAndServerCLI(out LiveLinkCore clientCore, out Process serverCLI, out string address);
+
+			for (int i = 0; i < 1; i++)
+			{
+				Console.WriteLine($"Attempt {i}");
+
+				// Crash area
+				serverCLI.StandardInput.WriteLine("disconnect");
+				while (clientCore.IsConnected)
+				{
+					Thread.Sleep(0);
+				}
+				if (serverCLI.HasExited) break;
+
+				// Reconnect for next attempt
+				clientCore.Disconnect();
+				serverCLI.StandardInput.WriteLine($"start --server {address}");
+				serverCLI.StandardInput.WriteLine($"waitfor --connection");
+				
+				bool connected = false;
+				for (int j = 0; j < 10; j++)
+				{
+					if (connected = clientCore.StartClient(address)) break;
+					Thread.Sleep(0);
+				}
+				if (serverCLI.HasExited) break;
+				Assert.IsTrue(connected, "Failed to connect client to server.");
+			}
+			StopCLIProcess(serverCLI);
+			Assert.That.ExitZero(serverCLI);
+		}
+
+		[TestMethod]
+		public void TestClientCrashingCLI()
+		{
+			StartServerCoreAndClientCLI(out LiveLinkCore serverCore, out Process clientCLI);
+
+			for (int i = 0; i < 100; i++)
+			{
+				Console.WriteLine($"Attempt {i}");
+
+				// Crash area
+				clientCLI.StandardInput.WriteLine("disconnect");
+				int j = 0;
+				while (serverCore.IsConnected && !clientCLI.HasExited)
+				{
+					if (j++ >= 300) break;
+					Thread.Sleep(1);
+				}
+				if (clientCLI.HasExited) break;
+				Assert.IsFalse(serverCore.IsConnected, "Client never disconnected");
+
+				// Reconnect for next attempt
+				serverCore.Disconnect();
+				serverCore.StartServer(serverCore.Address);
+				clientCLI.StandardInput.WriteLine($"start --client {serverCore.Address}");
+				Assert.IsTrue(serverCore.WaitForConnection(1000), "Client did not reconnect.");
+			}
+			StopCLIProcess(clientCLI);
+			Assert.That.ExitZero(clientCLI);
+		}
+
 
 
 		void AssertContains(string output, string mustContain)

LiveLink/ClientConnection.cs

@@ -35,8 +35,8 @@ public static bool TryConnect(string serverName, string pipeName, out ClientConn
 			m_ClientPipe = new NamedPipeClientStream(
 				serverName,
 				pipeName,
-				PipeAccessRights.ReadData | PipeAccessRights.WriteAttributes,
-				PipeOptions.Asynchronous,
+				PipeAccessRights.Read | PipeAccessRights.Write | PipeAccessRights.Delete,
+				PipeOptions.None,
 				System.Security.Principal.TokenImpersonationLevel.None,
 				HandleInheritability.None
 			);
@@ -57,11 +57,15 @@ bool TryConnect(int timeout = 1000)
 			{
 				Console.Error.WriteLine($"Failed to connect to LiveLink server. (OS Error)\n{ex.Message}");
 			}
+			catch (IOException ex)
+			{
+				Console.Error.WriteLine($"Failed to connect to LiveLink server. (IO Error)\n{ex.Message}");
+			}
 
 			if (m_ClientPipe.IsConnected)
 			{
 				Console.WriteLine("Connected to LiveLink server!");
-				Console.WriteLine($"m_ClientPipe.ReadMode = {m_ClientPipe.ReadMode}");
+				//Console.WriteLine($"m_ClientPipe.ReadMode = {m_ClientPipe.ReadMode}");
 				Initialize();
 				return true;
 			}
@@ -141,6 +145,7 @@ protected override void OnDispose(bool disposing)
 			if (disposing)
 			{
 				// Free managed resources
+				Console.WriteLine("Closing client connection...");
 				m_ClientPipe.Dispose();
 				m_ClientPipe = null;
 				m_InMessageQueue = null;

LiveLink/Concurrent/Concurrent.cs

@@ -0,0 +1,33 @@
+using System;
+using System.CodeDom;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace COM3D2.LiveLink.Concurrent
+{
+	internal class Concurrent<T>
+		where T : struct
+	{
+		public T Value
+		{
+			get { lock (m_ValueLock) return _value;  }
+			set { lock (m_ValueLock) _value = value; }
+		}
+
+		private object m_ValueLock;
+		private T _value;
+
+		public Concurrent(T value)
+		{
+			m_ValueLock = new object();
+			_value = value;
+		}
+
+		public static implicit operator T(Concurrent<T> x) => x.Value;
+
+		public override string ToString() => Value.ToString();
+		public override bool Equals(object obj) => Value.Equals(obj);
+		public override int GetHashCode() => Value.GetHashCode();
+	}
+}

LiveLink/Connection.cs

@@ -10,7 +10,7 @@ internal abstract class Connection : IDisposable
 	{
 		protected abstract PipeStream Pipe { get; }
 
-		public bool IsConnected => Pipe != null && Pipe.IsConnected;
+		public virtual bool IsConnected => Pipe != null && Pipe.IsConnected;
 
 		public abstract bool CanRead { get; }
 		public abstract bool CanWrite { get; }

LiveLink/LiveLink.csproj

@@ -33,6 +33,9 @@
     <WarningLevel>4</WarningLevel>
     <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
+  <PropertyGroup>
+    <SignAssembly>true</SignAssembly>
+  </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Core" />
@@ -47,6 +50,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ClientConnection.cs" />
+    <Compile Include="Concurrent\Concurrent.cs" />
     <Compile Include="Connection.cs" />
     <Compile Include="LiveLinkCore.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />