Merge pull request #40 from SuessLabs/feature/AsyncConnections

Reduce VS Freezing

Author: DamianSuess

sandbox/GuiApp.PrismAvalonia/ViewModels/DashboardViewModel.cs

@@ -1,10 +1,20 @@
-namespace GuiApp.PrismAvalonia.ViewModels
+using Microsoft.CodeAnalysis;
+using Prism.Commands;
+
+namespace GuiApp.PrismAvalonia.ViewModels
 {
   public class DashboardViewModel : ViewModelBase
   {
     public DashboardViewModel()
     {
       Title = "Dashboard View!";
     }
+
+    public DelegateCommand CmdBreakPoint => new(() =>
+    {
+      // Force a breakpoint
+      System.Diagnostics.Debug.WriteLine("Breakpoint triggering");
+      System.Diagnostics.Debugger.Break();
+    });
   }
 }

sandbox/GuiApp.PrismAvalonia/Views/DashboardView.axaml

@@ -10,6 +10,7 @@
     <StackPanel VerticalAlignment="Center" HorizontalAlignment="Center">
       <TextBlock Text="Welcome to Prism.Avalonia!" />
       <TextBlock Text="{Binding Title}" />
+      <Button Content="Trigger Breakpoint" Command="{Binding CmdBreakPoint}" />
     </StackPanel>
   </DockPanel>
 </UserControl>

src/VsLinuxDebugger/Core/RemoteDebugger.cs

@@ -63,15 +63,16 @@ public async Task<bool> BeginAsync(BuildOptions buildOptions)
 
         using (var ssh = new SshTool(_options, _launchBuilder))
         {
-          if (!ssh.Connect())
+          var success = await ssh.ConnectAsync();
+          if (!success)
           {
             Logger.Output("Could not connect to remote device.");
             return false;
           }
 
-          ssh.TryInstallVsDbg();
-          ssh.MakeDeploymentFolder();
-          ssh.CleanDeploymentFolder();
+          await ssh.TryInstallVsDbgAsync();
+          await ssh.MakeDeploymentFolderAsync();
+          await ssh.CleanDeploymentFolderAsync();
 
           if (buildOptions.HasFlag(BuildOptions.Deploy))
           {

src/VsLinuxDebugger/Core/SshTool.cs

@@ -31,29 +31,35 @@ public SshTool(UserOptions opts, LaunchBuilder launch)
 
     public SshClient Ssh => _ssh;
 
-    public string Bash(string command, bool createCommand = false)
+    public async Task<string> BashAsync(string command, bool createCommand = false)
     {
       try
       {
         if (!_isConnected)
         {
           // attempt to reconnect
-          if (!Connect())
+          if (!await ConnectAsync())
             return "Cannot connect to remote host to execute Bash command.";
         }
 
         Logger.Output($"BASH> {command}");
 
         SshCommand cmd;
-        if (!createCommand)
-        {
-          cmd = _ssh.RunCommand(command);
-        }
-        else
+
+        cmd = await Task.Run(() =>
         {
-          cmd = _ssh.CreateCommand(command);
-          cmd.Execute();
-        }
+          if (!createCommand)
+          {
+            cmd = _ssh.RunCommand(command);
+          }
+          else
+          {
+            cmd = _ssh.CreateCommand(command);
+            cmd.Execute();
+          }
+
+          return cmd;
+        });
 
         return cmd.Result;
       }
@@ -79,6 +85,7 @@ public string BashStream(string command, bool isSudo = false)
       var modes = new Dictionary<TerminalModes, uint>();
       // modes.Add(Renci.SshNet.Common.TerminalModes.ECHO, 53);
 
+      // TODO: Make async
       using (var stream = _ssh.CreateShellStream("xterm", 255, 50, 800, 600, 1024, modes))
       {
         stream.Write(command + "\n");
@@ -89,13 +96,13 @@ public string BashStream(string command, bool isSudo = false)
         }
         else
         {
-          Logger.Output($"BASH-SUDO: TRUE");
+          Logger.Debug($"BASH-SUDO: TRUE");
           result = stream.Expect("password");
-          Logger.Output($"BASH-SUDO: {result}");
+          Logger.Debug($"BASH-SUDO: {result}");
 
           stream.Write(_opts.UserPass + "\n");
           result = stream.Expect(prompt);
-          Logger.Output($"BASH-SUDO: {result}");
+          Logger.Debug($"BASH-SUDO: {result}");
         }
       }
 
@@ -124,34 +131,30 @@ public string BashStream(string command, string searchText)
 
         result = stream.ReadLine();
 
-        Logger.Output($"BashEx: Waiting for search text, '{searchText}'");
+        Logger.Debug($"BashEx: Waiting for search text, '{searchText}'");
         result = stream.Expect(searchText);
-        Logger.Output($"BashEx: {result}");
+        Logger.Debug($"BashEx: {result}");
       }
 
       return result;
     }
 
     /// <summary>Cleans the contents of the deployment path.</summary>
     /// <param name="fullScrub">Clear entire base deployment folder (TRUE) or just our project.</param>
-    public void CleanDeploymentFolder(bool fullScrub = false)
+    public async Task CleanDeploymentFolderAsync(bool fullScrub = false)
     {
       // Whole deployment folder and hidden files
       // rm -rf xxx/*      == Contents of the folder but not the folder itself
       // rm -rf xxx/{*,.*} == All hidden files and folders
       var filesAndFolders = "{*,.*}";
 
       if (fullScrub)
-      {
-        Bash($"rm -rf \"{_opts.RemoteDeployBasePath}/{filesAndFolders}\"");
-      }
+        await BashAsync($"rm -rf \"{_opts.RemoteDeployBasePath}/{filesAndFolders}\"");
       else
-      {
-        Bash($"rm -rf {_launch.RemoteDeployProjectFolder}/{filesAndFolders}");
-      }
+        await BashAsync($"rm -rf {_launch.RemoteDeployProjectFolder}/{filesAndFolders}");
     }
 
-    public bool Connect()
+    public async Task<bool> ConnectAsync()
     {
       PrivateKeyFile keyFile = null;
 
@@ -178,7 +181,7 @@ public bool Connect()
           ? new SshClient(_opts.HostIp, _opts.HostPort, _opts.UserName, keyFile)
           : new SshClient(_opts.HostIp, _opts.HostPort, _opts.UserName, _opts.UserPass);
 
-        _ssh.Connect();
+        await Task.Run(() => _ssh.Connect());
       }
       catch (Exception ex)
       {
@@ -222,10 +225,10 @@ public void Dispose()
       _scp?.Dispose();
     }
 
-    public void MakeDeploymentFolder()
+    public async Task MakeDeploymentFolderAsync()
     {
       // do we need SUDO?
-      Bash($"mkdir -p {_opts.RemoteDeployBasePath}");
+      await BashAsync($"mkdir -p {_opts.RemoteDeployBasePath}");
       //// Bash($"mkdir -p {_opts.RemoteDeployDebugPath}");
       //// Bash($"mkdir -p {_opts.RemoteDeployReleasePath}");
 
@@ -234,17 +237,17 @@ public void MakeDeploymentFolder()
         : $":{_opts.UserGroupName}";
 
       // Update ownership so it's not "root"
-      Bash($"sudo chown -R {_opts.UserName}{group} {_opts.RemoteDeployBasePath}");
+      await BashAsync($"sudo chown -R {_opts.UserName}{group} {_opts.RemoteDeployBasePath}");
     }
 
     /// <summary>
-    /// Instals VS Debugger if it doesn't exist already
+    /// Install cURL and VS Debugger if it doesn't exist already.
     /// </summary>
-    public void TryInstallVsDbg()
+    public async Task TryInstallVsDbgAsync()
     {
-      string arch = Bash("uname -m").Trim('\n');
+      string arch = (await BashAsync("uname -m")).Trim('\n');
 
-      var curlExists = Bash("which curl ; echo $?");
+      var curlExists = await BashAsync("which curl ; echo $?");
       if (curlExists.Equals("1\n"))
       {
         // TODO: Need to pass in password.
@@ -253,7 +256,7 @@ public void TryInstallVsDbg()
       }
 
       //// OLD: var ret = Bash("[ -d ~/.vsdbg ] || curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l ~/.vsdbg");
-      var ret = Bash($"[ -d {_opts.RemoteVsDbgBasePath} ] || curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l {_opts.RemoteVsDbgBasePath}");
+      var ret = await BashAsync($"[ -d {_opts.RemoteVsDbgBasePath} ] || curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l {_opts.RemoteVsDbgBasePath}");
       Logger.Output($"Returned: {ret}");
     }
 
@@ -282,7 +285,7 @@ public async Task<string> UploadFilesAsync()
         // TODO: Rev3 - Allow for both SFTP and SCP as a backup. This separating connection to a new disposable class.
         //// Logger.Output($"Connected to {_connectionInfo.Username}@{_connectionInfo.Host}:{_connectionInfo.Port} via SSH and {(_sftpClient != null ? "SFTP" : "SCP")}");
 
-        Bash($@"mkdir -p {_launch.RemoteDeployProjectFolder}");
+        BashAsync($@"mkdir -p {_launch.RemoteDeployProjectFolder}");
 
         var srcDirInfo = new DirectoryInfo(_launch.OutputDirFullPath);
         if (!srcDirInfo.Exists)
@@ -497,9 +500,10 @@ await Task.Run(() =>
     /// <returns>Returns true on success.</returns>
     private async Task<bool> PayloadDecompressAsync(string pathBuildTarGz, bool removeTarGz = true)
     {
+      var decompressOutput = string.Empty;
+
       try
       {
-        var decompressOutput = string.Empty;
 
         var cmd = "set -e";
         cmd += $";cd \"{_launch.RemoteDeployProjectFolder}\"";
@@ -509,19 +513,16 @@ private async Task<bool> PayloadDecompressAsync(string pathBuildTarGz, bool remo
         if (removeTarGz)
           cmd += $";rm \"{pathBuildTarGz}\"";
 
-        await Task.Run(() =>
-        {
-          decompressOutput = Bash(cmd);
-        });
+        decompressOutput = await BashAsync(cmd);
 
         Logger.Output($"Payload Decompress results: '{decompressOutput}' (blank=OK)");
-
-        return true;
       }
       catch (Exception)
       {
         return false;
       }
+
+      return true;
     }
   }
 }

src/VsLinuxDebugger/Logger.cs

@@ -42,6 +42,13 @@ public static void Init(
       _name = name;
     }
 
+    public static void Debug(string message)
+    {
+#if DEBUG
+      Output($"DEBUG: {message}");
+#endif
+    }
+
     public static void Output(string message)
     {
       var msg = $"{FormattedTime}: {message}{Environment.NewLine}";