Refactor output providers (#80)

Author: FrankRay78

resources/nuget/README.md

@@ -32,7 +32,8 @@ public interface ISpeedTestService
 {
     public Task<IServer[]> GetServersAsync(CancellationToken cancellationToken = default);
 
-    public Task<ServerLatencyResult> GetServerLatencyAsync(IServer server, CancellationToken cancellationToken = default);
+    public Task<ServerLatencyResult> GetServerLatencyAsync(IServer server, CancellationToken cancellationToken = default);
+    public Task<ServerLatencyResult> GetServerLatencyAsync(string serverUrl, CancellationToken cancellationToken = default);
     public Task<ServerLatencyResult> GetFastestServerByLatencyAsync(IServer[] servers, CancellationToken cancellationToken = default);
 
     public Task<SpeedTestResult> GetDownloadSpeedAsync(IServer server, CancellationToken cancellationToken = default);

src/NetPace.Console/Commands/SpeedTestCommand.cs

@@ -1,9 +1,5 @@
-using System;
-using System.Text.Json;
-using System.Text.Json.Serialization;
-using ByteSizeLib;
-using Humanizer;
 using NetPace.Core;
+using NetPace.Console.ConsoleWriters;
 using Spectre.Console.Extensions;
 
 namespace NetPace.Console.Commands;
@@ -12,6 +8,14 @@ public sealed class SpeedTestCommand(IAnsiConsole console, ISpeedTestService spe
 {
     protected override async Task<int> ExecuteAsync(CommandContext context, SpeedTestCommandSettings settings, CancellationToken cancellationToken)
     {
+        IConsoleWriter writer = settings switch
+        {
+            { CSV: true } => new CSVConsoleWriter(),
+            { Json: true } or { JsonPretty: true } => new JsonConsoleWriter(),
+            { Verbosity: Verbosity.Minimal } => new MinimalConsoleWriter(),
+            _ => new DefaultConsoleWriter()
+        };
+
         if (settings.Loop)
         {
             // Run continuously.
@@ -21,7 +25,7 @@ protected override async Task<int> ExecuteAsync(CommandContext context, SpeedTes
                 try
                 {
                     // Run the speed test.
-                    await internalExecuteAsync(includeCSVHeader: firstLoop, settings, cancellationToken);
+                    await writer.PerformSpeedTestAsync(initialSpeedTest: firstLoop, console, clock, speedTestClient, settings, cancellationToken);
                 }
                 catch (TaskCanceledException)
                 {
@@ -58,7 +62,7 @@ protected override async Task<int> ExecuteAsync(CommandContext context, SpeedTes
                 try
                 {
                     // Run the speed test.
-                    await internalExecuteAsync(includeCSVHeader: (i == 0), settings, cancellationToken);
+                    await writer.PerformSpeedTestAsync(initialSpeedTest: (i == 0), console, clock, speedTestClient, settings, cancellationToken);
                 }
                 catch (TaskCanceledException)
                 {
@@ -91,7 +95,7 @@ protected override async Task<int> ExecuteAsync(CommandContext context, SpeedTes
             try
             {
                 // Run the speed test.
-                await internalExecuteAsync(includeCSVHeader: true, settings, cancellationToken);
+                await writer.PerformSpeedTestAsync(initialSpeedTest: true, console, clock, speedTestClient, settings, cancellationToken);
             }
             catch (TaskCanceledException)
             {
@@ -106,234 +110,4 @@ protected override async Task<int> ExecuteAsync(CommandContext context, SpeedTes
 
         return 0;
     }
-
-    private async Task internalExecuteAsync(bool includeCSVHeader, SpeedTestCommandSettings settings, CancellationToken cancellationToken)
-    {
-        ServerLatencyResult fastest;
-
-        if (string.IsNullOrEmpty(settings.ServerUrl))
-        {
-            // Get the fastest speed test server.
-            var servers = await speedTestClient.GetServersAsync(cancellationToken);
-            fastest = await speedTestClient.GetFastestServerByLatencyAsync(servers, cancellationToken);
-        }
-        else
-        {
-            // User specified speed test server.
-            var server = new Core.Clients.Ookla.Server() { Sponsor = "(Unknown)", Url = settings.ServerUrl };
-            fastest = await speedTestClient.GetServerLatencyAsync(server, cancellationToken);
-        }
-
-
-        if (!settings.CSV && !settings.Json && !settings.JsonPretty && ((settings.Verbosity & (Verbosity.Normal | Verbosity.Debug)) != 0))
-        {
-            console.WriteLine("");
-            console.WriteLine($"{fastest.Server.Sponsor}", new Style(foreground: Color.Yellow, decoration: Decoration.Bold));
-            console.WriteLine($"{fastest.Server.Url}");
-
-            if (!console.Profile.Capabilities.Interactive)
-            {
-                // Add an extra line given the live widget will not appear.
-                console.WriteLine("");
-            }
-        }
-
-
-        // Perform speed test
-        var (downloadResult, uploadResult) = await PerformSpeedTestAsync(fastest.Server, settings, cancellationToken);
-
-
-        // CSV output overrides the display options below
-        if (settings.CSV)
-        {
-            // Always including the timestamp in the CSV output seems reasonable
-            settings.IncludeTimestamp = true;
-
-            if (settings.CSVHeaderUnits)
-            {
-                var downloadFormattedParts = downloadResult.GetSpeedStringParts(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale);
-                var uploadFormattedParts = uploadResult.GetSpeedStringParts(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale);
-
-                // Header row.
-                if (includeCSVHeader)
-                {
-                    console.WriteLine(string.Join(settings.CSVDelimiter, new[]
-                    {
-                        settings.IncludeTimestamp ? "Timestamp" : null,
-                        "Latency (ms)",
-                        !settings.NoDownload ? $"Download ({downloadFormattedParts.unit})" : null,
-                        !settings.NoUpload ? $"Upload ({uploadFormattedParts.unit})" : null
-                    }.Where(s => !string.IsNullOrEmpty(s))));
-                }
-
-                // Data row.
-                console.WriteLine(string.Join(settings.CSVDelimiter, new[]
-                {
-                    settings.IncludeTimestamp ? clock.Now.ToString(settings.DateTimeFormat) : null,
-                    $"{fastest.Latency}",
-                    !settings.NoDownload ? downloadFormattedParts.speed : null,
-                    !settings.NoUpload ? uploadFormattedParts.speed : null
-                }.Where(s => !string.IsNullOrEmpty(s))));
-            }
-            else
-            {
-                // Header row.
-                if (includeCSVHeader)
-                {
-                    console.WriteLine(string.Join(settings.CSVDelimiter, new[]
-                    {
-                        settings.IncludeTimestamp ? "Timestamp" : null,
-                        "Latency",
-                        !settings.NoDownload ? "Download" : null,
-                        !settings.NoUpload ? "Upload" : null
-                    }.Where(s => !string.IsNullOrEmpty(s))));
-                }
-
-                // Data row.
-                console.WriteLine(string.Join(settings.CSVDelimiter, new[]
-                {
-                    settings.IncludeTimestamp ? clock.Now.ToString(settings.DateTimeFormat) : null,
-                    $"{fastest.Latency} ms",
-                    !settings.NoDownload ? downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null,
-                    !settings.NoUpload ? uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null
-                }.Where(s => !string.IsNullOrEmpty(s))));
-            }
-        }
-        // Json output overrides the display options below
-        else if (settings.Json || settings.JsonPretty)
-        {
-            var downloadFormatted = !settings.NoDownload ? downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null;
-            var uploadFormatted = !settings.NoUpload ? uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null;
-
-            var jsonResult = new JsonResult
-            {
-                ServerLocation = fastest.Server.Location,
-                ServerSponsor = fastest.Server.Sponsor,
-                ServerUrl = fastest.Server.Url,
-                Timestamp = clock.Now.ToString(settings.DateTimeFormat),
-                Latency = $"{fastest.Latency} ms",
-                DownloadSpeed = downloadFormatted!,
-                UploadSpeed = uploadFormatted!
-            };
-
-            var options = new JsonSerializerOptions { WriteIndented = settings.JsonPretty, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull };
-            string jsonString = JsonSerializer.Serialize(jsonResult, options);
-
-            console.WriteLine(jsonString);
-        }
-        else
-        {
-            if ((settings.Verbosity & Verbosity.Debug) != 0)
-            {
-                // Display detailed diagnostics
-                ByteSize size; TimeSpan elapsed;
-
-                if (!settings.NoDownload)
-                {
-                    size = ByteSize.FromBytes(downloadResult.BytesProcessed);
-                    elapsed = TimeSpan.FromMilliseconds(downloadResult.ElapsedMilliseconds);
-                    console.WriteLine($"{size} downloaded in {elapsed.Humanize()}");
-                }
-                if (!settings.NoUpload)
-                {
-                    size = ByteSize.FromBytes(uploadResult.BytesProcessed);
-                    elapsed = TimeSpan.FromMilliseconds(uploadResult.ElapsedMilliseconds);
-                    console.WriteLine($"{size} uploaded in {elapsed.Humanize()}");
-                }
-
-                if (!(settings.NoDownload && settings.NoUpload))
-                {
-                    console.WriteLine("");
-                }
-            }
-
-            if ((settings.NoDownload && settings.NoUpload) && ((settings.Verbosity & (Verbosity.Normal | Verbosity.Debug)) != 0) &&
-                console.Profile.Capabilities.Interactive)
-            {
-                // Latency only test: Add an extra blank line for formatting.
-                console.WriteLine("");
-            }
-
-
-            // Display speed test result
-            console.WriteLine(string.Join(", ", new[]
-            {
-                settings.IncludeTimestamp ? clock.Now.ToString(settings.DateTimeFormat) : null,
-                $"Latency: {fastest.Latency} ms",
-                !settings.NoDownload ? $"Download: {downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale)}" : null,
-                !settings.NoUpload ? $"Upload: {uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale)}" : null
-            }.Where(s => !string.IsNullOrEmpty(s))));
-
-
-            if ((settings.Verbosity & (Verbosity.Normal | Verbosity.Debug)) != 0)
-            {
-                console.WriteLine("\nTry 'NetPace --help' for more information.");
-            }
-        }
-    }
-
-    private async Task<(SpeedTestResult downloadResult, SpeedTestResult uploadResult)> PerformSpeedTestAsync(IServer server, SpeedTestCommandSettings settings, CancellationToken cancellationToken)
-    {
-        var downloadResult = new SpeedTestResult();
-        var uploadResult = new SpeedTestResult();
-
-
-        if (settings.NoDownload && settings.NoUpload)
-        {
-            // Latency only test - so just return
-            return (downloadResult, uploadResult);
-        }
-
-
-        if (settings.CSV || settings.Json || settings.JsonPretty || ((settings.Verbosity & Verbosity.Minimal) != 0))
-        {
-            // No progress is reported
-            if (!settings.NoDownload) downloadResult = await speedTestClient.GetDownloadSpeedAsync(server, settings.DownloadSizeMb, cancellationToken);
-            if (!settings.NoUpload) uploadResult = await speedTestClient.GetUploadSpeedAsync(server, settings.UploadSizeMb, cancellationToken);
-        }
-        else
-        {
-            // Graphical progress bar
-            await console.Progress()
-                .AutoClear(false)
-                .Columns(
-                [
-                    new TaskDescriptionColumn(),
-                    new ProgressBarColumn(),
-                    new PercentageColumn(),
-                ])
-                .StartAsync(async progress =>
-                {
-                    ProgressTask? downloadProgress = null; ProgressTask? uploadProgress = null;
-
-                    // Create the progress bars
-                    if (!settings.NoDownload)
-                    {
-                        downloadProgress = progress.AddTask("Downloading", autoStart: true, maxValue: 100);
-                    }
-                    if (!settings.NoUpload)
-                    {
-                        uploadProgress = progress.AddTask("Uploading", autoStart: true, maxValue: 100);
-                    }
-
-                    // Perform the speed tests and show progress
-                    if (!settings.NoDownload)
-                    {
-                        downloadResult = await speedTestClient.GetDownloadSpeedAsync(server, settings.DownloadSizeMb, (SpeedTestProgress progress) =>
-                        {
-                            downloadProgress!.Value = progress.PercentageComplete;
-                        }, cancellationToken);
-                    }
-                    if (!settings.NoUpload)
-                    {
-                        uploadResult = await speedTestClient.GetUploadSpeedAsync(server, settings.UploadSizeMb, (SpeedTestProgress progress) =>
-                        {
-                            uploadProgress!.Value = progress.PercentageComplete;
-                        }, cancellationToken);
-                    }
-                });
-        }
-
-        return (downloadResult, uploadResult);
-    }
 }

src/NetPace.Console/ConsoleWriters/CSVConsoleWriter.cs

@@ -0,0 +1,83 @@
+using NetPace.Core;
+
+namespace NetPace.Console.ConsoleWriters;
+
+public sealed class CSVConsoleWriter : IConsoleWriter
+{
+    public async Task PerformSpeedTestAsync(bool initialSpeedTest, IAnsiConsole console, IClock clock, ISpeedTestService speedTestClient, SpeedTestCommandSettings settings, CancellationToken cancellationToken)
+    {
+        ServerLatencyResult fastest;
+
+        if (string.IsNullOrEmpty(settings.ServerUrl))
+        {
+            // Get the fastest speed test server.
+            var servers = await speedTestClient.GetServersAsync(cancellationToken);
+            fastest = await speedTestClient.GetFastestServerByLatencyAsync(servers, cancellationToken);
+        }
+        else
+        {
+            // User specified speed test server.
+            fastest = await speedTestClient.GetServerLatencyAsync(settings.ServerUrl, cancellationToken);
+        }
+
+
+        var downloadResult = new SpeedTestResult();
+        var uploadResult = new SpeedTestResult();
+
+        // Perform speed test.
+        if (!settings.NoDownload) downloadResult = await speedTestClient.GetDownloadSpeedAsync(fastest.Server, settings.DownloadSizeMb, cancellationToken);
+        if (!settings.NoUpload) uploadResult = await speedTestClient.GetUploadSpeedAsync(fastest.Server, settings.UploadSizeMb, cancellationToken);
+
+
+        // Display speed test result.
+        if (settings.CSVHeaderUnits)
+        {
+            var downloadFormattedParts = downloadResult.GetSpeedStringParts(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale);
+            var uploadFormattedParts = uploadResult.GetSpeedStringParts(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale);
+
+            // Header row.
+            if (initialSpeedTest)
+            {
+                console.WriteLine(string.Join(settings.CSVDelimiter, new[]
+                {
+                    "Timestamp",
+                    "Latency (ms)",
+                    !settings.NoDownload ? $"Download ({downloadFormattedParts.unit})" : null,
+                    !settings.NoUpload ? $"Upload ({uploadFormattedParts.unit})" : null
+                }.Where(s => !string.IsNullOrEmpty(s))));
+            }
+
+            // Data row.
+            console.WriteLine(string.Join(settings.CSVDelimiter, new[]
+            {
+                clock.Now.ToString(settings.DateTimeFormat),
+                $"{fastest.Latency}",
+                !settings.NoDownload ? downloadFormattedParts.speed : null,
+                !settings.NoUpload ? uploadFormattedParts.speed : null
+            }.Where(s => !string.IsNullOrEmpty(s))));
+        }
+        else
+        {
+            // Header row.
+            if (initialSpeedTest)
+            {
+                console.WriteLine(string.Join(settings.CSVDelimiter, new[]
+                {
+                    "Timestamp",
+                    "Latency",
+                    !settings.NoDownload ? "Download" : null,
+                    !settings.NoUpload ? "Upload" : null
+                }.Where(s => !string.IsNullOrEmpty(s))));
+            }
+
+            // Data row.
+            console.WriteLine(string.Join(settings.CSVDelimiter, new[]
+            {
+                clock.Now.ToString(settings.DateTimeFormat),
+                $"{fastest.Latency} ms",
+                !settings.NoDownload ? downloadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null,
+                !settings.NoUpload ? uploadResult.GetSpeedString(settings.SpeedUnit, settings.SpeedUnitSystem, settings.SpeedScale) : null
+            }.Where(s => !string.IsNullOrEmpty(s))));
+        }
+    }
+}