Merge pull request #1304 from ably/fix/delta-compression

[ECO-4285] Fix delta compression

Author: sacOO7

cake-build/helpers/test-execution.cake

@@ -106,7 +106,7 @@ public class TestExecutionHelper
     public FilePathCollection FindTestAssemblies(string projectRelativePath, string pattern = "IO.Ably.Tests.*.dll")
     {
         var projectPath = _paths.Src.Combine(projectRelativePath);
-        var searchPath = projectPath.Combine("bin/Release").FullPath + "/" + pattern;
+        var searchPath = projectPath.Combine("bin/Release").Combine(pattern).FullPath;
         var testAssemblies = _context.GetFiles(searchPath);
 
         if (!testAssemblies.Any())

cake-build/helpers/tools.cake

@@ -30,15 +30,15 @@ public class ILRepackHelper
         var exitCode = _context.StartProcess(ilRepackPath.FullPath, new ProcessSettings
         {
             Arguments = new ProcessArgumentBuilder()
-                .Append($"/lib:{sourcePath.FullPath}")
+                .Append($"/lib:\"{sourcePath.FullPath}\"")
                 .Append("/targetplatform:v4")
                 .Append("/internalize")
-                .Append($"/attr:{targetDll.FullPath}")
-                .Append($"/keyfile:{rootDir.CombineWithFilePath("IO.Ably.snk").FullPath}")
+                .Append($"/attr:\"{targetDll.FullPath}\"")
+                .Append($"/keyfile:\"{rootDir.CombineWithFilePath("IO.Ably.snk").FullPath}\"")
                 .Append("/parallel")
-                .Append($"/out:{outputDll.FullPath}")
-                .Append(targetDll.FullPath)
-                .Append(jsonNetDll.FullPath)
+                .Append($"/out:\"{outputDll.FullPath}\"")
+                .Append($"\"{targetDll.FullPath}\"")
+                .Append($"\"{jsonNetDll.FullPath}\"")
         });
 
         if (exitCode != 0)
@@ -54,6 +54,101 @@ public class ILRepackHelper
 
         _context.Information($"✓ Merged assembly created at {outputDll}");
     }
+    
+    public void MergeDeltaCodec(DirectoryPath sourcePath, DirectoryPath outputPath)
+    {
+        var targetDll = outputPath.CombineWithFilePath("IO.Ably.dll");
+        var docsFile = outputPath.CombineWithFilePath("IO.Ably.xml");
+        var deltaCodecDll = sourcePath.CombineWithFilePath("IO.Ably.DeltaCodec.dll");
+        var tempInputDll = outputPath.CombineWithFilePath("IO.Ably.temp.dll");
+        
+        if (!_context.FileExists(deltaCodecDll))
+        {
+            _context.Warning($"DeltaCodec DLL not found at {deltaCodecDll}, skipping merge...");
+            return;
+        }
+        
+        if (!_context.FileExists(targetDll))
+        {
+            _context.Warning($"Target DLL not found at {targetDll}, skipping merge...");
+            return;
+        }
+        
+        _context.Information($"Merging {deltaCodecDll.GetFilename()} into {targetDll.GetFilename()}...");
+        
+        // Get the root directory (parent of cake-build)
+        var rootDir = _context.MakeAbsolute(_context.Directory("../"));
+        var ilRepackPath = rootDir.CombineWithFilePath("tools/ilrepack.exe");
+        
+        // Copy target DLL to temp location to avoid input/output conflict
+        _context.CopyFile(targetDll, tempInputDll);
+        
+        // Backup PDB and config files
+        var targetPdb = outputPath.CombineWithFilePath("IO.Ably.pdb");
+        var tempInputPdb = outputPath.CombineWithFilePath("IO.Ably.temp.pdb");
+        if (_context.FileExists(targetPdb))
+        {
+            _context.CopyFile(targetPdb, tempInputPdb);
+        }
+        
+        var targetConfig = outputPath.CombineWithFilePath("IO.Ably.dll.config");
+        var tempInputConfig = outputPath.CombineWithFilePath("IO.Ably.temp.dll.config");
+        if (_context.FileExists(targetConfig))
+        {
+            _context.CopyFile(targetConfig, tempInputConfig);
+        }
+        
+        try
+        {
+            // Merge DeltaCodec into IO.Ably.dll (output directly with correct name)
+            var exitCode = _context.StartProcess(ilRepackPath.FullPath, new ProcessSettings
+            {
+                Arguments = new ProcessArgumentBuilder()
+                    .Append($"/lib:\"{sourcePath.FullPath}\"")
+                    .Append($"/lib:\"{outputPath.FullPath}\"")
+                    .Append("/targetplatform:v4")
+                    .Append("/internalize")
+                    .Append($"/attr:\"{tempInputDll.FullPath}\"")
+                    .Append($"/keyfile:\"{rootDir.CombineWithFilePath("IO.Ably.snk").FullPath}\"")
+                    .Append("/parallel")
+                    .Append($"/out:\"{targetDll.FullPath}\"")
+                    .Append($"\"{tempInputDll.FullPath}\"")
+                    .Append($"\"{deltaCodecDll.FullPath}\"")
+            });
+            
+            if (exitCode != 0)
+            {
+                throw new Exception($"ILRepack failed with exit code {exitCode}");
+            }
+        }
+        finally
+        {
+            // Clean up temp files
+            if (_context.FileExists(tempInputDll))
+            {
+                _context.DeleteFile(tempInputDll);
+            }
+            if (_context.FileExists(tempInputPdb))
+            {
+                _context.DeleteFile(tempInputPdb);
+            }
+            if (_context.FileExists(tempInputConfig))
+            {
+                _context.DeleteFile(tempInputConfig);
+            }
+        }
+        
+        // Clean up DeltaCodec files from output path since they're now merged
+        var deltaCodecFiles = _context.GetFiles(outputPath.Combine("IO.Ably.DeltaCodec.*").FullPath);
+
+        foreach (var file in deltaCodecFiles)
+        {
+            _context.DeleteFile(file);
+            _context.Information($"Cleaned up: {file.GetFilename()}");
+        }
+        
+        _context.Information($"✓ DeltaCodec merged into {targetDll}");
+    }
 }
 
 var ilRepackHelper = new ILRepackHelper(Context);

cake-build/helpers/utils.cake

@@ -36,7 +36,7 @@ public void RestoreSolution(FilePath solutionPath)
             // On macOS/Linux, use nuget command (installed via mono)
             StartProcess("nuget", new ProcessSettings
             {
-                Arguments = $"restore {solutionPath.FullPath} -Verbosity quiet"
+                Arguments = $"restore \"{solutionPath.FullPath}\" -Verbosity quiet"
             });
         }
     }

cake-build/tasks/package.cake

@@ -51,7 +51,7 @@ Task("_Package_Merge_JsonNet")
         }
 
         var binPath = projectPath.Combine("bin/Release");
-        var packagedPath = binPath.Combine("packaged");
+        var packagedPath = binPath.Combine("Packaged");
 
         if (!DirectoryExists(binPath))
         {
@@ -61,8 +61,8 @@ Task("_Package_Merge_JsonNet")
 
         Information($"Processing {project}...");
 
-        // Copy all IO.Ably* files to packaged folder
-        var ablyFiles = GetFiles(binPath.FullPath + "/IO.Ably*");
+        // Copy all IO.Ably* files to Packaged folder
+        var ablyFiles = GetFiles(binPath.Combine("IO.Ably*").FullPath);
         EnsureDirectoryExists(packagedPath);
         CopyFiles(ablyFiles, packagedPath);
 
@@ -71,8 +71,46 @@ Task("_Package_Merge_JsonNet")
     }
 });
 
-Task("_Package_Create_NuGet")
+Task("_Package_Merge_DeltaCodec")
     .IsDependentOn("_Package_Merge_JsonNet")
+    .Does(() =>
+{
+    Information("Merging DeltaCodec into Ably assemblies for all platforms...");
+    
+    // Legacy platforms (already in packaged folder after JsonNet merge)
+    var legacyProjects = new[]
+    {
+        "IO.Ably.Android",
+        "IO.Ably.iOS",
+        "IO.Ably.NETFramework"
+    };
+    
+    foreach (var project in legacyProjects)
+    {
+        var projectPath = paths.Src.Combine(project);
+        
+        if (!DirectoryExists(projectPath))
+        {
+            Warning($"Project directory not found: {project}, skipping...");
+            continue;
+        }
+        
+        var binPath = projectPath.Combine("bin/Release");
+        var packagedPath = binPath.Combine("Packaged");
+        
+        if (!DirectoryExists(packagedPath))
+        {
+            Warning($"Packaged directory not found for {project}, skipping...");
+            continue;
+        }
+        
+        Information($"Merging DeltaCodec for {project}...");
+        ilRepackHelper.MergeDeltaCodec(binPath, packagedPath);
+    }
+});
+
+Task("_Package_Create_NuGet")
+    .IsDependentOn("_Package_Merge_DeltaCodec")
     .WithCriteria(() => !string.IsNullOrEmpty(version))
     .Does(() =>
 {
@@ -196,7 +234,7 @@ Task("_Package_Unity")
         Information("Cloning unity-packager repository...");
         StartProcess("git", new ProcessSettings
         {
-            Arguments = "clone https://github.com/ably-forks/unity-packager.git -b v1.0.0 unity-packager",
+            Arguments = $"clone https://github.com/ably-forks/unity-packager.git -b v1.0.0 \"{unityPackagerPath.FullPath}\"",
             WorkingDirectory = paths.Root
         });
     }
@@ -212,8 +250,8 @@ Task("_Package_Unity")
     Information("Building Unity package...");
     StartProcess("dotnet", new ProcessSettings
     {
-        Arguments = $"run --project {unityPackagerProject.FullPath} " +
-                   $"-project unity -output {outputPath.FullPath} -dir Assets/Ably",
+        Arguments = $"run --project \"{unityPackagerProject.FullPath}\" " +
+                   $"-project \"{paths.Root.Combine("unity").FullPath}\" -output \"{outputPath.FullPath}\" -dir Assets/Ably",
         WorkingDirectory = paths.Root
     });
 

lib/delta-codec

@@ -14,10 +14,28 @@
         <copyright>©2022 Ably</copyright>
         <language />
         <dependencies>
-          <group>
+          <group targetFramework="net46">
+            <dependency id="System.Threading.Channels" version="4.6.0" />
+          </group>
+          <group targetFramework="monoandroid">
+            <dependency id="System.Threading.Channels" version="4.6.0" />
+          </group>
+          <group targetFramework="Xamarin.iOS">
+            <dependency id="System.Threading.Channels" version="4.6.0" />
+          </group>
+          <group targetFramework="monotouch">
             <dependency id="System.Threading.Channels" version="4.6.0" />
           </group>
           <group targetFramework="netstandard2.0">
+            <dependency id="System.Threading.Channels" version="4.6.0" />
+            <dependency id="Newtonsoft.Json" version="9.0.1" />
+          </group>
+          <group targetFramework="net6.0">
+            <dependency id="System.Threading.Channels" version="4.6.0" />
+            <dependency id="Newtonsoft.Json" version="9.0.1" />
+          </group>
+          <group targetFramework="net7.0">
+            <dependency id="System.Threading.Channels" version="4.6.0" />
             <dependency id="Newtonsoft.Json" version="9.0.1" />
           </group>
         </dependencies>

nuget/io.ably.nuspec

@@ -95,10 +95,10 @@ public Task<bool> MessageReceived(ProtocolMessage protocolMessage, RealtimeState
                     break;
                 case ProtocolMessage.MessageAction.Message:
 
-                    if (channel.State == ChannelState.Attaching)
+                    if (channel.State != ChannelState.Attached)
                     {
                         Logger.Warning(
-                            $"Channel #{channel.Name} is currently in Attaching state. Messages received in this state are ignored. Ignoring ${protocolMessage.Messages?.Length ?? 0} messages");
+                            $"Channel #{channel.Name} is currently in #{channel.State} state. Messages received in this state are ignored. Ignoring {protocolMessage.Messages?.Length ?? 0} messages");
                         return TaskConstants.BooleanTrue;
                     }
 

src/IO.Ably.Shared/Realtime/ChannelMessageProcessor.cs

@@ -227,8 +227,8 @@ public async Task WhenDeltaDecodeFail_ShouldSetStateToAttachingLogTheErrorAndDis
         {
             string channelName = "delta-channel".AddRandomSuffix();
             var testSink = new TestLoggerSink();
-            var taskAwaiter = new TaskCompletionAwaiter(5000);
-            var firstMessageReceived = new TaskCompletionAwaiter();
+            var taskAwaiter = new TaskCompletionAwaiter(20000);
+            var firstMessageReceived = new TaskCompletionAwaiter(20000);
             using (((IInternalLogger)Logger).CreateDisposableLoggingContext(testSink))
             {
                 var realtime = await GetRealtimeClient(protocol);