Другой алгоритм согласования для старых версий

Author: EvilBeaver

src/1Script.sln

@@ -67,6 +67,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OneScript.Web.Server", "One
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocumenterTests", "Tests\DocumenterTests\DocumenterTests.csproj", "{BD385142-E9B4-43C1-8F88-067F24E5AF6D}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VSCode.DebugAdapter.Tests", "Tests\VSCode.DebugAdapter.Tests\VSCode.DebugAdapter.Tests.csproj", "{861F70F4-B10D-4E4E-865C-B8E900391424}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -339,6 +341,18 @@ Global
 		{BD385142-E9B4-43C1-8F88-067F24E5AF6D}.Release|Any CPU.Build.0 = Release|Any CPU
 		{BD385142-E9B4-43C1-8F88-067F24E5AF6D}.Release|x86.ActiveCfg = Release|Any CPU
 		{BD385142-E9B4-43C1-8F88-067F24E5AF6D}.Release|x86.Build.0 = Release|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Debug|x86.Build.0 = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.LinuxDebug|Any CPU.ActiveCfg = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.LinuxDebug|Any CPU.Build.0 = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.LinuxDebug|x86.ActiveCfg = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.LinuxDebug|x86.Build.0 = Debug|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Release|Any CPU.Build.0 = Release|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Release|x86.ActiveCfg = Release|Any CPU
+		{861F70F4-B10D-4E4E-865C-B8E900391424}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -351,6 +365,7 @@ Global
 		{0F5E6099-39BA-41CF-B55F-357F7DF4DE00} = {91059C5B-526C-4B81-B106-99DEFF542D1F}
 		{2F264379-B3B4-44B3-9CBA-A4B0AF3D8785} = {91059C5B-526C-4B81-B106-99DEFF542D1F}
 		{BD385142-E9B4-43C1-8F88-067F24E5AF6D} = {91059C5B-526C-4B81-B106-99DEFF542D1F}
+		{861F70F4-B10D-4E4E-865C-B8E900391424} = {91059C5B-526C-4B81-B106-99DEFF542D1F}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {A4A871EF-C5A7-478F-907E-31C69A869973}

src/OneScript.DebugProtocol/OneScript.DebugProtocol.csproj

@@ -7,7 +7,7 @@
     <Configurations>Debug;Release;LinuxDebug</Configurations>
     <AssemblyTitle>1Script Debug Protocol common objects and DTO's</AssemblyTitle>
     <Platforms>AnyCPU</Platforms>
-    <!--Нацеливание на net461 нужно для сборки дебаг-адаптера под net461 без лишних DLL-->
+    <!--Нацеливание на net4 нужно для сборки дебаг-адаптера под net4 без лишних DLL-->
     <TargetFrameworks>net48;$(TargetFrameworkVersion)</TargetFrameworks>
   </PropertyGroup>
 

src/OneScript.DebugProtocol/TcpServer/BinaryFormatWriter.cs

@@ -0,0 +1,60 @@
+/*----------------------------------------------------------
+This Source Code Form is subject to the terms of the
+Mozilla Public License, v.2.0. If a copy of the MPL
+was not distributed with this file, You can obtain one
+at http://mozilla.org/MPL/2.0/.
+----------------------------------------------------------*/
+
+using System;
+using System.IO;
+using System.Text;
+
+namespace OneScript.DebugProtocol.TcpServer
+{
+    internal class BinaryFormatWriter : IDisposable
+    {
+        private readonly BinaryWriter _writer;
+        
+        public BinaryFormatWriter(Stream target)
+        {
+            _writer = new BinaryWriter(target, Encoding.UTF8, leaveOpen: true);
+        }
+
+        public void WriteHeader(int rootId, int headerId)
+        {
+            _writer.Write((byte)0);
+            _writer.Write(rootId);
+            _writer.Write(headerId);
+            _writer.Write(1);
+            _writer.Write(0);
+        }
+
+        public void WriteStringRecord(int objectId, string data)
+        {
+            var bytes = Encoding.UTF8.GetBytes(data);
+            if (bytes.Length > 127)
+                throw new ArgumentOutOfRangeException(nameof(data), "Length encoding not supported for strings more than 127 bytes");
+            
+            _writer.Write((byte)6);
+            _writer.Write(objectId);
+            _writer.Write((byte)bytes.Length);
+            _writer.Write(bytes, 0, bytes.Length);
+        }
+
+        public void WriteEnd()
+        {
+            _writer.Write((byte)11);
+        }
+
+        public void Close()
+        {
+            Dispose();
+        }
+
+        public void Dispose()
+        {
+            _writer.Flush();
+            _writer.Dispose();
+        }
+    }
+}

src/OneScript.DebugProtocol/TcpServer/FormatReconcileUtils.cs

@@ -5,24 +5,32 @@ This Source Code Form is subject to the terms of the
 at http://mozilla.org/MPL/2.0/.
 ----------------------------------------------------------*/
 using System;
+using System.IO;
+using System.Text;
 
 namespace OneScript.DebugProtocol.TcpServer
 {
     public static class FormatReconcileUtils
     {
         /// <summary>
-        /// Массив байт, который вызовет SerializationException при чтении его через BinaryFormatter
-        /// И при этом оставит поток пустым, для следующего валидного сообщения
-        /// <see>[MS-NRBF] .NET Remoting: Binary Format Data Structure</see>
+        /// Специальный пакет, который будет принят двоичным десериализатором старого движка, но который потом
+        /// упадет на приведении типов.
+        /// В новом движке он будет принят, как команда для обмена версией формата.
         /// </summary>
-        public static readonly byte[] FORMAT_RECONCILE_MAGIC = 
+        public static byte[] GetReconcileMagic()
         {
-            0x11, // RecordTypeEnum
-            0,0,0,0, // RootId
-            0,0,0,0, // HeaderId
-            0x00, 0x0A, 0x00, 0x0A, // Version Major
-            0xAA, 0xAA, 0xAA, 0xAA  // Version Minor,
-        };
+            using (var memoryStream = new MemoryStream(128))
+            {
+                using (var writer = new BinaryFormatWriter(memoryStream))
+                {
+                    writer.WriteHeader(1, 1);
+                    writer.WriteStringRecord(1, "1C1C1C");
+                    writer.WriteEnd();
+                }
+
+                return memoryStream.ToArray();
+            }
+        }
 
         /// <summary>
         /// Ответ на запрос формата
@@ -48,17 +56,29 @@ public static bool CheckReconcilePrefix(byte[] data)
             return true;
         }
 
-        public static bool CheckReconcileRequest(byte[] data)
+        public static bool CheckReconcileRequest(Stream stream)
         {
-            for (int i = 0; i < FORMAT_RECONCILE_MAGIC.Length; i++)
+            var magic = GetReconcileMagic();
+            var buffer = new byte[magic.Length];
+            ReadStream(stream, buffer, buffer.Length);
+            for (int i = 0; i < magic.Length; i++)
             {
-                if (data[i] != FORMAT_RECONCILE_MAGIC[i]) 
+                if (buffer[i] != magic[i]) 
                     return false;
             }
 
             return true;
         }
 
+        public static void WriteReconcileResponse(Stream target, short transport, short version)
+        {
+            var formatInfo = EncodeFormatMarker(transport, version);
+                
+            using var binaryWriter = new BinaryWriter(target, Encoding.UTF8, true);
+            binaryWriter.Write(FORMAT_RECONCILE_RESPONSE_PREFIX);
+            binaryWriter.Write(formatInfo);
+        }
+
         public static int EncodeFormatMarker(short transport, short dataVersion)
         {
             var marker = transport << 16;
@@ -72,5 +92,20 @@ public static (int, int) DecodeFormatMarker(int marker)
 
             return (transport, dataVersion);
         }
+        
+        private static void ReadStream(Stream stream, byte[] buffer, int length)
+        {
+            int readPosition = 0;
+            int bytesReceived = 0;
+
+            while (bytesReceived < length)
+            {
+                bytesReceived = stream.Read(buffer, readPosition, length - bytesReceived);
+                if (bytesReceived == 0)
+                    throw new IOException("Unexpected end of stream");
+                
+                readPosition += bytesReceived;
+            }
+        }
     }
 }

src/OneScript.DebugServices/Internal/DelayedConnectionChannel.cs

@@ -69,37 +69,15 @@ private void ReconcileFormat()
             _listener = null;
 
             var tcpStream = tcpClient.GetStream();
-            
-            var buffer = new byte[FormatReconcileUtils.FORMAT_RECONCILE_MAGIC.Length];
-            ReadStream(tcpStream, buffer, buffer.Length);
 
-            if (FormatReconcileUtils.CheckReconcileRequest(buffer))
+            if (FormatReconcileUtils.CheckReconcileRequest(tcpStream))
             {
                 // Да, это наш фейковый заголовок
-                var formatInfo = FormatReconcileUtils.EncodeFormatMarker(JSON_FORMAT_MARKER, SUPPORTED_FORMAT_VERSION);
-                
-                using var binaryWriter = new BinaryWriter(tcpStream, Encoding.UTF8, true);
-                binaryWriter.Write(FormatReconcileUtils.FORMAT_RECONCILE_RESPONSE_PREFIX);
-                binaryWriter.Write(formatInfo);
+                FormatReconcileUtils.WriteReconcileResponse(tcpStream, JSON_FORMAT_MARKER, SUPPORTED_FORMAT_VERSION);
             }
             _reconciled = true;
             _connectedChannel = new JsonDtoChannel(tcpClient);
         }
-        
-        private void ReadStream(Stream stream, byte[] buffer, int length)
-        {
-            int readPosition = 0;
-            int bytesReceived = 0;
-
-            while (bytesReceived < length)
-            {
-                bytesReceived = stream.Read(buffer, readPosition, length - bytesReceived);
-                if (bytesReceived == 0)
-                    throw new IOException("Unexpected end of stream");
-                
-                readPosition += bytesReceived;
-            }
-        }
 
         public bool Connected => _connectedChannel?.Connected ?? false;
     }

src/Tests/OneScript.DebugProtocol.Test/OneScript.DebugProtocol.Test.csproj

@@ -32,4 +32,8 @@
       <ProjectReference Include="..\..\ScriptEngine\ScriptEngine.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+      <Compile Remove="FormatReconcileTest.cs" />
+    </ItemGroup>
+
 </Project>

src/Tests/VSCode.DebugAdapter.Tests/ReconcileForOlderVersionTests.cs

@@ -0,0 +1,48 @@
+
+using System;
+using System.IO;
+using System.Runtime.Serialization.Formatters.Binary;
+using FluentAssertions;
+using OneScript.DebugProtocol.TcpServer;
+using Xunit;
+
+namespace VSCode.DebugAdapter.Tests
+{
+    public class ReconcileForOlderVersionTests
+    {
+        [Fact]
+        public void CanReadReconcileViaBinaryFormatter()
+        {
+            using (var stream = new MemoryStream(FormatReconcileUtils.GetReconcileMagic()))
+            {
+                var reader = new BinaryFormatter();
+                var value = reader.Deserialize(stream);
+                value.Should().Be("1C1C1C");
+            }
+        }
+
+        [Fact]
+        public void ExchangeReconcileVersions()
+        {
+            using (var stream = new MemoryStream(FormatReconcileUtils.GetReconcileMagic()))
+            {
+                using(var response = new MemoryStream())
+                {
+                    if (FormatReconcileUtils.CheckReconcileRequest(stream))
+                    {
+                        FormatReconcileUtils.WriteReconcileResponse(response, 1, 1);
+                    }
+
+                    var data = response.ToArray();
+                    Assert.True(FormatReconcileUtils.CheckReconcilePrefix(data));
+                    Assert.Equal(FormatReconcileUtils.FORMAT_RECONCILE_RESPONSE_PREFIX.Length + sizeof(int), data.Length);
+                    
+                    var frmt = BitConverter.ToInt32(data, FormatReconcileUtils.FORMAT_RECONCILE_RESPONSE_PREFIX.Length);
+                    var (transport, version) = FormatReconcileUtils.DecodeFormatMarker(frmt);
+                    Assert.Equal(1, transport);
+                    Assert.Equal(1, version);
+                }
+            }
+        }
+    }
+}

src/Tests/VSCode.DebugAdapter.Tests/VSCode.DebugAdapter.Tests.csproj

@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net48</TargetFramework>
+        <Configurations>Debug;Release;LinuxDebug</Configurations>
+        <Platforms>AnyCPU</Platforms>
+        <LangVersion>7.3</LangVersion>
+        <GenerateRuntimeConfigDevFile>true</GenerateRuntimeConfigDevFile>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="coverlet.collector" Version="6.0.0"/>
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
+        <PackageReference Include="xunit" Version="2.5.3"/>
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3"/>
+        <PackageReference Include="FluentAssertions" Version="5.10.3" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\..\OneScript.DebugProtocol\OneScript.DebugProtocol.csproj" />
+    </ItemGroup>
+
+</Project>

src/VSCode.DebugAdapter/Transport/ConnectionFactory.cs

@@ -24,6 +24,10 @@ public static TcpClient Connect(int port)
 
             var client = new TcpClient();
             TryConnect(client, debuggerUri);
+            var waitSec = 15;
+            Log.Information("Waiting {waitSec} seconds", waitSec);
+            Thread.Sleep(waitSec * 1000);
+            Log.Information("Waiting completed");
 
             return client;
         }

src/VSCode.DebugAdapter/Transport/DebugClientFactory.cs

@@ -61,7 +61,8 @@ private void ReconcileDataFormat(TcpClient client)
         {
             Log.Verbose("Sending reconcile message");
             var stream = client.GetStream();
-            stream.Write(FormatReconcileUtils.FORMAT_RECONCILE_MAGIC, 0, FormatReconcileUtils.FORMAT_RECONCILE_MAGIC.Length);
+            var magic = FormatReconcileUtils.GetReconcileMagic();
+            stream.Write(magic, 0, magic.Length);
 
             var pollResult = client.Client
                 .Poll(FormatReconcileUtils.FORMAT_RECONCILE_TIMEOUT.Milliseconds * 1000, SelectMode.SelectRead);
@@ -93,6 +94,7 @@ private void ReconcileDataFormat(TcpClient client)
                         {
                             Log.Verbose("Received data is not reconcile message");
                             SelectSafestFormat();
+                            EmptyIncomingBuffer(client);
                             return;
                         }
 
@@ -116,15 +118,34 @@ private void ReconcileDataFormat(TcpClient client)
                 }
                 else
                 {
+                    Log.Verbose("We waited for full reconcile data, but it hadn't arrived");
                     SelectSafestFormat();
+                    EmptyIncomingBuffer(client);
                 }
             }
             else
             {
+                Log.Verbose("No reconciliation response");
                 SelectSafestFormat();
             }
         }
 
+        private void EmptyIncomingBuffer(TcpClient client)
+        {
+            if (client.Available == 0)
+                return;
+
+            var buf = new byte[1024];
+            do
+            {
+                var hasBytes = client.Available;
+                var bytesRead = client.GetStream().Read(buf, 0, Math.Min(hasBytes, buf.Length));
+                if (bytesRead == 0)
+                    return;
+                
+            } while (client.Available > 0);
+        }
+
         private void ReadStream(BinaryReader reader, byte[] buffer, int length)
         {
             int readPosition = 0;
@@ -142,7 +163,6 @@ private void ReadStream(BinaryReader reader, byte[] buffer, int length)
 
         private void SelectSafestFormat()
         {
-            Log.Verbose("Reconcilation failed, selecting safest format");
             _protocolVersion = ProtocolVersions.SafestVersion;
             _transport = TransportProtocols.Binary;
         }