Read to end when ExecuteServerCommand without receiver

Rename ExecuteServerCommand which return IEnumerable to ExecuteServerEnumerable

Author: wherewhere

.gitignore

@@ -1,7 +1,7 @@
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##
-## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
 # User-specific files
 *.rsuser
@@ -29,14 +29,11 @@ x86/
 bld/
 [Bb]in/
 [Oo]bj/
-[Oo]ut/
 [Ll]og/
 #[Ll]ogs/
 
 # Visual Studio 2015/2017 cache/options directory
 .vs/
-# JetBrains Rider options directory
-.idea/
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
 
@@ -85,6 +82,8 @@ StyleCopReport.xml
 *.pgc
 *.pgd
 *.rsp
+# but not Directory.Build.rsp, as it configures directory-level build defaults
+!Directory.Build.rsp
 *.sbr
 *.tlb
 *.tli
@@ -93,6 +92,7 @@ StyleCopReport.xml
 *.tmp_proj
 *_wpftmp.csproj
 *.log
+*.tlog
 *.vspscc
 *.vssscc
 .builds
@@ -296,6 +296,17 @@ node_modules/
 # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
 *.vbw
 
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+*.ncb
+*.aps
+
 # Visual Studio LightSwitch build output
 **/*.HTMLClient/GeneratedArtifacts
 **/*.DesktopClient/GeneratedArtifacts
@@ -352,6 +363,9 @@ ASALocalRun/
 # Local History for Visual Studio
 .localhistory/
 
+# Visual Studio History (VSHistory) files
+.vshistory/
+
 # BeatPulse healthcheck temp database
 healthchecksdb
 
@@ -363,3 +377,24 @@ MigrationBackup/
 
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
+
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml

AdvancedSharpAdbClient.Tests/AdvancedSharpAdbClient.Tests.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <AllowUnsafeBlocks>True</AllowUnsafeBlocks>
     <LangVersion>latest</LangVersion>
     <NoWarn>$(NoWarn);CS1591</NoWarn>
   </PropertyGroup>
@@ -19,13 +20,13 @@
   </Choose>
 
   <ItemGroup>
-    <PackageReference Include="coverlet.msbuild" Version="6.0.2" PrivateAssets="all">
+    <PackageReference Include="coverlet.msbuild" Version="6.0.3" PrivateAssets="all">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="NSubstitute" Version="5.3.0" />
     <PackageReference Include="xunit" Version="2.9.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" PrivateAssets="all">
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0" PrivateAssets="all">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
   </ItemGroup>

AdvancedSharpAdbClient.Tests/Dummys/DummyAdbClient.cs

@@ -26,17 +26,17 @@ public void ExecuteRemoteCommand(string command, DeviceData device) =>
         public void ExecuteRemoteCommand(string command, DeviceData device, IShellOutputReceiver receiver, Encoding encoding) =>
             ExecuteServerCommand("shell", command, receiver, encoding);
 
-        public IEnumerable<string> ExecuteRemoteCommand(string command, DeviceData device, Encoding encoding) =>
-            ExecuteServerCommand("shell", command, encoding);
+        public IEnumerable<string> ExecuteRemoteEnumerable(string command, DeviceData device, Encoding encoding) =>
+            ExecuteServerEnumerable("shell", command, encoding);
 
         public Task ExecuteRemoteCommandAsync(string command, DeviceData device, CancellationToken cancellationToken = default) =>
             ExecuteServerCommandAsync("shell", command, cancellationToken);
 
         public Task ExecuteRemoteCommandAsync(string command, DeviceData device, IShellOutputReceiver receiver, Encoding encoding, CancellationToken cancellationToken = default) =>
             ExecuteServerCommandAsync("shell", command, receiver, encoding, cancellationToken);
 
-        public IAsyncEnumerable<string> ExecuteRemoteCommandAsync(string command, DeviceData device, Encoding encoding, CancellationToken cancellationToken) =>
-            ExecuteServerCommandAsync("shell", command, encoding, cancellationToken);
+        public IAsyncEnumerable<string> ExecuteRemoteEnumerableAsync(string command, DeviceData device, Encoding encoding, CancellationToken cancellationToken) =>
+            ExecuteServerEnumerableAsync("shell", command, encoding, cancellationToken);
 
         public void ExecuteServerCommand(string target, string command)
         {
@@ -89,7 +89,7 @@ public void ExecuteServerCommand(string target, string command, IShellOutputRece
         public void ExecuteServerCommand(string target, string command, IAdbSocket socket, IShellOutputReceiver receiver, Encoding encoding) =>
             ExecuteServerCommand(target, command, receiver, encoding);
 
-        public IEnumerable<string> ExecuteServerCommand(string target, string command, Encoding encoding)
+        public IEnumerable<string> ExecuteServerEnumerable(string target, string command, Encoding encoding)
         {
             StringBuilder requestBuilder = new();
             if (!StringExtensions.IsNullOrWhiteSpace(target))
@@ -115,8 +115,8 @@ public IEnumerable<string> ExecuteServerCommand(string target, string command, E
             }
         }
 
-        public IEnumerable<string> ExecuteServerCommand(string target, string command, IAdbSocket socket, Encoding encoding) =>
-            ExecuteServerCommand(target, command, encoding);
+        public IEnumerable<string> ExecuteServerEnumerable(string target, string command, IAdbSocket socket, Encoding encoding) =>
+            ExecuteServerEnumerable(target, command, encoding);
 
         public async Task ExecuteServerCommandAsync(string target, string command, CancellationToken cancellationToken = default)
         {
@@ -171,7 +171,7 @@ public async Task ExecuteServerCommandAsync(string target, string command, IShel
         public Task ExecuteServerCommandAsync(string target, string command, IAdbSocket socket, IShellOutputReceiver receiver, Encoding encoding, CancellationToken cancellationToken) =>
             ExecuteServerCommandAsync(target, command, receiver, encoding, cancellationToken);
 
-        public async IAsyncEnumerable<string> ExecuteServerCommandAsync(string target, string command, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken)
+        public async IAsyncEnumerable<string> ExecuteServerEnumerableAsync(string target, string command, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken)
         {
             StringBuilder requestBuilder = new();
             if (!StringExtensions.IsNullOrWhiteSpace(target))
@@ -197,8 +197,8 @@ public async IAsyncEnumerable<string> ExecuteServerCommandAsync(string target, s
             }
         }
 
-        public IAsyncEnumerable<string> ExecuteServerCommandAsync(string target, string command, IAdbSocket socket, Encoding encoding, CancellationToken cancellationToken = default) =>
-            ExecuteServerCommandAsync(target, command, socket, encoding, cancellationToken);
+        public IAsyncEnumerable<string> ExecuteServerEnumerableAsync(string target, string command, IAdbSocket socket, Encoding encoding, CancellationToken cancellationToken = default) =>
+            ExecuteServerEnumerableAsync(target, command, socket, encoding, cancellationToken);
 
         #region Not Implemented
 

AdvancedSharpAdbClient.Tests/Extensions/AdbClientExtensionsTests.Async.cs

@@ -44,7 +44,7 @@ public async Task ExecuteServerCommandAsyncTest()
                     Assert.Equal(default, x.ArgAt<CancellationToken>(5));
                     return Task.CompletedTask;
                 });
-            _ = client.ExecuteServerCommandAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<Encoding>(), Arg.Any<CancellationToken>())
+            _ = client.ExecuteServerEnumerableAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<Encoding>(), Arg.Any<CancellationToken>())
                 .Returns(x =>
                 {
                     Assert.Equal(target, x.ArgAt<string>(0));
@@ -53,7 +53,7 @@ public async Task ExecuteServerCommandAsyncTest()
                     Assert.Equal(default, x.ArgAt<CancellationToken>(3));
                     return result.AsEnumerableAsync(x.ArgAt<CancellationToken>(3));
                 });
-            _ = client.ExecuteServerCommandAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<IAdbSocket>(), Arg.Any<Encoding>(), Arg.Any<CancellationToken>())
+            _ = client.ExecuteServerEnumerableAsync(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<IAdbSocket>(), Arg.Any<Encoding>(), Arg.Any<CancellationToken>())
                 .Returns(x =>
                 {
                     Assert.Equal(target, x.ArgAt<string>(0));
@@ -70,8 +70,8 @@ public async Task ExecuteServerCommandAsyncTest()
             await client.ExecuteServerCommandAsync(target, command, socket, predicate);
             await client.ExecuteServerCommandAsync(target, command, predicate, encoding);
             await client.ExecuteServerCommandAsync(target, command, socket, predicate, encoding);
-            Assert.Equal(result, await AdbClientExtensions.ExecuteServerCommandAsync(client, target, command).ToListAsync());
-            Assert.Equal(result, await AdbClientExtensions.ExecuteServerCommandAsync(client, target, command, socket).ToListAsync());
+            Assert.Equal(result, await client.ExecuteServerEnumerableAsync(target, command).ToListAsync());
+            Assert.Equal(result, await client.ExecuteServerEnumerableAsync(target, command, socket).ToListAsync());
         }
 
         [Fact]
@@ -95,7 +95,7 @@ public async Task ExecuteRemoteCommandAsyncTest()
                     Assert.Equal(default, x.ArgAt<CancellationToken>(4));
                     return Task.CompletedTask;
                 });
-            _ = client.ExecuteRemoteCommandAsync(Arg.Any<string>(), device, Arg.Any<Encoding>(), Arg.Any<CancellationToken>())
+            _ = client.ExecuteRemoteEnumerableAsync(Arg.Any<string>(), device, Arg.Any<Encoding>(), Arg.Any<CancellationToken>())
                 .Returns(x =>
                 {
                     Assert.Equal(command, x.ArgAt<string>(0));
@@ -108,7 +108,7 @@ public async Task ExecuteRemoteCommandAsyncTest()
             await client.ExecuteRemoteCommandAsync(command, device, receiver);
             await client.ExecuteRemoteCommandAsync(command, device, predicate);
             await client.ExecuteRemoteCommandAsync(command, device, predicate, encoding);
-            Assert.Equal(result, await AdbClientExtensions.ExecuteRemoteCommandAsync(client, command, device).ToListAsync());
+            Assert.Equal(result, await client.ExecuteRemoteEnumerableAsync(command, device).ToListAsync());
         }
 
         [Fact]

AdvancedSharpAdbClient.Tests/Extensions/AdbClientExtensionsTests.cs

@@ -41,15 +41,15 @@ public void ExecuteServerCommandTest()
                     Assert.Equal(receiver, x.ArgAt<IShellOutputReceiver>(3));
                     Assert.Equal(encoding, x.ArgAt<Encoding>(4));
                 });
-            _ = client.ExecuteServerCommand(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<Encoding>())
+            _ = client.ExecuteServerEnumerable(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<Encoding>())
                 .Returns(x =>
                 {
                     Assert.Equal(target, x.ArgAt<string>(0));
                     Assert.Equal(command, x.ArgAt<string>(1));
                     Assert.Equal(encoding, x.ArgAt<Encoding>(2));
                     return result;
                 });
-            _ = client.ExecuteServerCommand(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<IAdbSocket>(), Arg.Any<Encoding>())
+            _ = client.ExecuteServerEnumerable(Arg.Any<string>(), Arg.Any<string>(), Arg.Any<IAdbSocket>(), Arg.Any<Encoding>())
                 .Returns(x =>
                 {
                     Assert.Equal(target, x.ArgAt<string>(0));
@@ -65,8 +65,8 @@ public void ExecuteServerCommandTest()
             client.ExecuteServerCommand(target, command, socket, predicate);
             client.ExecuteServerCommand(target, command, predicate, encoding);
             client.ExecuteServerCommand(target, command, socket, predicate, encoding);
-            Assert.Equal(result, AdbClientExtensions.ExecuteServerCommand(client, target, command));
-            Assert.Equal(result, AdbClientExtensions.ExecuteServerCommand(client, target, command, socket));
+            Assert.Equal(result, client.ExecuteServerEnumerable(target, command));
+            Assert.Equal(result, client.ExecuteServerEnumerable(target, command, socket));
         }
 
         [Fact]
@@ -88,7 +88,7 @@ public void ExecuteRemoteCommandTest()
                     Assert.Equal(receiver, x.ArgAt<IShellOutputReceiver>(2));
                     Assert.Equal(encoding, x.ArgAt<Encoding>(3));
                 });
-            _ = client.ExecuteRemoteCommand(Arg.Any<string>(), device, Arg.Any<Encoding>())
+            _ = client.ExecuteRemoteEnumerable(Arg.Any<string>(), device, Arg.Any<Encoding>())
                 .Returns(x =>
                 {
                     Assert.Equal(command, x.ArgAt<string>(0));
@@ -100,7 +100,7 @@ public void ExecuteRemoteCommandTest()
             client.ExecuteRemoteCommand(command, device, receiver);
             client.ExecuteRemoteCommand(command, device, predicate);
             client.ExecuteRemoteCommand(command, device, predicate, encoding);
-            Assert.Equal(result, AdbClientExtensions.ExecuteRemoteCommand(client, command, device));
+            Assert.Equal(result, client.ExecuteRemoteEnumerable(command, device));
         }
 
         [Fact]

AdvancedSharpAdbClient/AdbClient.Async.cs

@@ -178,6 +178,29 @@ public virtual async Task ExecuteServerCommandAsync(string target, string comman
 
             await socket.SendAdbRequestAsync(request.ToString(), cancellationToken);
             await socket.ReadAdbResponseAsync(cancellationToken).ConfigureAwait(false);
+
+            try
+            {
+                using StreamReader reader = new(socket.GetShellStream());
+                // Previously, we would loop while reader.Peek() >= 0. Turns out that this would
+                // break too soon in certain cases (about every 10 loops, so it appears to be a timing
+                // issue). Checking for reader.ReadLine() to return null appears to be much more robust
+                // -- one of the integration test fetches output 1000 times and found no truncations.
+                while (!cancellationToken.IsCancellationRequested)
+                {
+                    if (await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false) == null) { break; }
+                }
+            }
+            catch (Exception e)
+            {
+                // If a cancellation was requested, this main loop is interrupted with an exception
+                // because the socket is closed. In that case, we don't need to throw a ShellCommandUnresponsiveException.
+                // In all other cases, something went wrong, and we want to report it to the user.
+                if (!cancellationToken.IsCancellationRequested)
+                {
+                    throw new ShellCommandUnresponsiveException(e);
+                }
+            }
         }
 
         /// <inheritdoc/>
@@ -258,18 +281,18 @@ public async Task ExecuteRemoteCommandAsync(string command, DeviceData device, I
 
 #if COMP_NETSTANDARD2_1
         /// <inheritdoc/>
-        public async IAsyncEnumerable<string> ExecuteServerCommandAsync(string target, string command, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+        public async IAsyncEnumerable<string> ExecuteServerEnumerableAsync(string target, string command, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             ExceptionExtensions.ThrowIfNull(encoding);
             using IAdbSocket socket = CreateAdbSocket();
-            await foreach (string? line in ExecuteServerCommandAsync(target, command, socket, encoding, cancellationToken).ConfigureAwait(false))
+            await foreach (string? line in ExecuteServerEnumerableAsync(target, command, socket, encoding, cancellationToken).ConfigureAwait(false))
             {
                 yield return line;
             }
         }
 
         /// <inheritdoc/>
-        public virtual async IAsyncEnumerable<string> ExecuteServerCommandAsync(string target, string command, IAdbSocket socket, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+        public virtual async IAsyncEnumerable<string> ExecuteServerEnumerableAsync(string target, string command, IAdbSocket socket, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             ExceptionExtensions.ThrowIfNull(encoding);
 
@@ -311,15 +334,15 @@ public virtual async IAsyncEnumerable<string> ExecuteServerCommandAsync(string t
         }
 
         /// <inheritdoc/>
-        public async IAsyncEnumerable<string> ExecuteRemoteCommandAsync(string command, DeviceData device, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+        public async IAsyncEnumerable<string> ExecuteRemoteEnumerableAsync(string command, DeviceData device, Encoding encoding, [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             EnsureDevice(device);
             ExceptionExtensions.ThrowIfNull(encoding);
 
             using IAdbSocket socket = CreateAdbSocket();
             await socket.SetDeviceAsync(device, cancellationToken);
 
-            await foreach (string? line in ExecuteServerCommandAsync("shell", command, socket, encoding, cancellationToken).ConfigureAwait(false))
+            await foreach (string? line in ExecuteServerEnumerableAsync("shell", command, socket, encoding, cancellationToken).ConfigureAwait(false))
             {
                 yield return line;
             }