Use polling for socket receive message instead of timeouts. (#120)

* Use polling for socket receive message instead of timeouts.
In design mode client, wait for communication channel to be connected before sending version check. Fix #110.

* Add test.

Author: codito

src/Microsoft.TestPlatform.Client/DesignMode/DesignModeClient.cs

@@ -7,13 +7,11 @@ namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode
     using System.Threading;
     using System.Threading.Tasks;
 
+    using Microsoft.VisualStudio.TestPlatform.Client.RequestHelper;
+    using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;
     using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.Interfaces;
     using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.ObjectModel;
-    using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;
-    using Microsoft.VisualStudio.TestPlatform.Client.RequestHelper;
-    using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client.Interfaces;
     using Microsoft.VisualStudio.TestPlatform.ObjectModel;
-    using System.Diagnostics;
 
     /// <summary>
     /// The design mode client.
@@ -47,6 +45,9 @@ public DesignModeClient()
         /// <param name="communicationManager">
         /// The communication manager.
         /// </param>
+        /// <param name="dataSerializer">
+        /// The data Serializer.
+        /// </param>
         internal DesignModeClient(ICommunicationManager communicationManager, IDataSerializer dataSerializer)
         {
             this.communicationManager = communicationManager;
@@ -69,16 +70,21 @@ public static void Initialize()
         /// <summary>
         /// Creates a client and waits for server to accept connection asynchronously
         /// </summary>
-        /// <param name="port">port number to connect</param>
+        /// <param name="port">
+        /// Port number to connect
+        /// </param>
+        /// <param name="testRequestManager">
+        /// The test Request Manager.
+        /// </param>
         public void ConnectToClientAndProcessRequests(int port, ITestRequestManager testRequestManager)
         {
             EqtTrace.Info("Trying to connect to server on port : {0}", port);
             this.communicationManager.SetupClientAsync(port);
-            this.communicationManager.SendMessage(MessageType.SessionConnected);
 
             // Wait for the connection to the server and listen for requests.
             if (this.communicationManager.WaitForServerConnection(ClientListenTimeOut))
             {
+                this.communicationManager.SendMessage(MessageType.SessionConnected);
                 this.ProcessRequests(testRequestManager);
             }
             else
@@ -99,7 +105,9 @@ public void HandleParentProcessExit()
         /// <summary>
         /// Process Requests from the IDE
         /// </summary>
-        /// <param name="handler"></param>
+        /// <param name="testRequestManager">
+        /// The test Request Manager.
+        /// </param>
         private void ProcessRequests(ITestRequestManager testRequestManager)
         {
             var isSessionEnd = false;
@@ -202,7 +210,9 @@ private void ProcessRequests(ITestRequestManager testRequestManager)
         /// <summary>
         /// Send a custom host launch message to IDE
         /// </summary>
-        /// <param name="customTestHostLaunchPayload">Payload required to launch a custom host</param>
+        /// <param name="testProcessStartInfo">
+        /// The test Process Start Info.
+        /// </param>
         public int LaunchCustomHost(TestProcessStartInfo testProcessStartInfo)
         {
             lock (ackLockObject)

src/Microsoft.TestPlatform.CommunicationUtilities/Messages/MessageType.cs

@@ -160,6 +160,5 @@ public static class MessageType
         public const string AfterTestRunEndResult = "DataCollection.AfterTestRunEndResult";
 
         #endregion
-
     }
 }

src/Microsoft.TestPlatform.CommunicationUtilities/SocketCommunicationManager.cs

@@ -64,12 +64,17 @@ public class SocketCommunicationManager : ICommunicationManager
         /// </summary>
         private NetworkStream stream;
 
+        private Socket socket;
+
         /// <summary>
-        /// The server stream read timeout constant.
+        /// The server stream read timeout constant (in microseconds).
         /// </summary>
-        private const int StreamReadTimeout = 1000;
+        private const int StreamReadTimeout = 1000 * 1000;
 
-        public SocketCommunicationManager(): this(JsonDataSerializer.Instance)
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SocketCommunicationManager"/> class.
+        /// </summary>
+        public SocketCommunicationManager() : this(JsonDataSerializer.Instance)
         {
         }
 
@@ -107,6 +112,7 @@ public async Task AcceptClientAsync()
                 this.clientConnectedEvent.Reset();
 
                 var client = await this.tcpListener.AcceptTcpClientAsync();
+                this.socket = client.Client;
                 this.stream = client.GetStream();
                 this.binaryReader = new BinaryReader(this.stream);
                 this.binaryWriter = new BinaryWriter(this.stream);
@@ -150,6 +156,7 @@ public async Task SetupClientAsync(int portNumber)
             this.clientConnectionAcceptedEvent.Reset();
             EqtTrace.Info("Trying to connect to server on port : {0}", portNumber);
             this.tcpClient = new TcpClient();
+            this.socket = this.tcpClient.Client;
             await this.tcpClient.ConnectAsync(IPAddress.Loopback, portNumber);
             this.stream = this.tcpClient.GetStream();
             this.binaryReader = new BinaryReader(this.stream);
@@ -292,13 +299,15 @@ private string TryReceiveRawMessage(CancellationToken cancellationToken)
             bool success = false;
 
             // Set read timeout to avoid blocking receive raw message
-            this.stream.ReadTimeout = StreamReadTimeout;
             while (!cancellationToken.IsCancellationRequested && !success)
             {
                 try
                 {
-                    str = this.ReceiveRawMessage();
-                    success = true;
+                    if (this.socket.Poll(StreamReadTimeout, SelectMode.SelectRead))
+                    {
+                        str = this.ReceiveRawMessage();
+                        success = true;
+                    }
                 }
                 catch (IOException ioException)
                 {
@@ -327,7 +336,6 @@ private string TryReceiveRawMessage(CancellationToken cancellationToken)
                 }
             }
 
-            this.stream.ReadTimeout = -1;
             return str;
         }
 

src/Microsoft.TestPlatform.VsTestConsole.TranslationLayer/VsTestConsoleRequestSender.cs

@@ -198,7 +198,7 @@ public void StartTestRunWithCustomHost(
         /// </summary>
         public void CancelTestRun()
         {
-                this.communicationManager.SendMessage(MessageType.CancelTestRun);
+            this.communicationManager.SendMessage(MessageType.CancelTestRun);
         }
 
         /// <summary>
@@ -365,7 +365,7 @@ private void SendMessageAndListenAndReportTestResults(string messageType, object
                 eventHandler.HandleLogMessage(TestMessageLevel.Error, Resources.AbortedTestsRun);
                 var completeArgs = new TestRunCompleteEventArgs(null, false, true, exception, null, TimeSpan.Zero);
                 eventHandler.HandleTestRunComplete(completeArgs, null, null, null);
-                CleanupCommunicationIfProcessExit();
+                this.CleanupCommunicationIfProcessExit();
             }
         }
 
@@ -377,6 +377,7 @@ private void CleanupCommunicationIfProcessExit()
                 this.communicationManager.StopServer();
             }
         }
+
         private Message TryReceiveMessage()
         {
             Message message = null;