2024.3 Maintenance Release 2

.gitignore

@@ -287,3 +287,6 @@ __pycache__/
 *.xsd.cs
 
 .DS_Store
+
+# ci.global.json is used in CI; local builds are unconstrained
+global.json

Build.ps1

@@ -78,16 +78,32 @@ function Publish-Docs($version)
     if($LASTEXITCODE -ne 0) { throw "Build failed" }
 }
 
+function Remove-GlobalJson
+{
+    if(Test-Path ./global.json) { rm ./global.json }    
+}
+
+function Create-GlobalJson
+{
+    # It's very important that SeqCli use the same .NET SDK version as its matching Seq version, to avoid
+    # container and installer bloat. But, highly-restrictive global.json files are annoying during development. So,
+    # we create a temporary global.json from ci.global.json to use during CI builds.
+    Remove-GlobalJson
+    cp ./ci.global.json global.json
+}
+
 Write-Output "Building version $version"
 
 $env:Path = "$pwd/.dotnetcli;$env:Path"
 
 Clean-Output
 Create-ArtifactDir
+Create-GlobalJson
 Restore-Packages
 Publish-Archives($version)
 Publish-DotNetTool($version)
 Execute-Tests($version)
 Publish-Docs($version)
+Remove-GlobalJson
 
 Pop-Location

Setup.ps1

@@ -1,6 +1,6 @@
 $ErrorActionPreference = "Stop"
 
-$RequiredDotnetVersion =  $(cat ./global.json | convertfrom-json).sdk.version
+$RequiredDotnetVersion =  $(cat ./ci.global.json | convertfrom-json).sdk.version
 
 New-Item -ItemType Directory -Force "./build/" | Out-Null
 

ci.global.json

@@ -0,0 +1,5 @@
+{
+  "sdk": {
+    "version": "8.0.303"
+  }
+}

seqcli.sln

@@ -10,14 +10,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sln", "sln", "{2EA56595-519
 		.gitignore = .gitignore
 		appveyor.yml = appveyor.yml
 		Build.ps1 = Build.ps1
-		global.json = global.json
 		LICENSE = LICENSE
 		README.md = README.md
 		setup.sh = setup.sh
 		Build.Docker.ps1 = Build.Docker.ps1
 		docker-publish.ps1 = docker-publish.ps1
 		Setup.ps1 = Setup.ps1
 		CONTRIBUTING.md = CONTRIBUTING.md
+		ci.global.json = ci.global.json
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{3587B633-0C03-4235-8903-6226900328F1}"

setup.sh

@@ -7,7 +7,7 @@ set -o pipefail
 sudo apt-get update || true
 sudo apt-get install -y --no-install-recommends jq
 
-RequiredDotnetVersion=$(jq -r '.sdk.version' global.json)
+RequiredDotnetVersion=$(jq -r '.sdk.version' ci.global.json)
 
 curl https://dot.net/v1/dotnet-install.sh -sSfL --output dotnet-install.sh
 chmod +x dotnet-install.sh

src/Roastery/Roastery.csproj

@@ -6,8 +6,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Serilog" Version="3.1.1" />
-        <PackageReference Include="SerilogTracing" Version="1.0.0" />
+        <PackageReference Include="Serilog" Version="4.0.2" />
+        <PackageReference Include="SerilogTracing" Version="2.1.2" />
     </ItemGroup>
 
 </Project>

src/SeqCli/Cli/Commands/ApiKey/CreateCommand.cs

@@ -75,7 +75,7 @@ public CreateCommand(SeqConnectionFactory connectionFactory, SeqCliConfig config
 
         Options.Add(
             "permissions=",
-            "A comma-separated list of permissions to delegate to the API key; valid permissions are `Ingest` (default), `Read`, `Write`, `Project` and `System`",
+            "A comma-separated list of permissions to delegate to the API key; valid permissions are `Ingest` (default), `Read`, `Write`, `Project`, `Organization`, and `System`",
             v => _permissions = ArgumentString.NormalizeList(v));
 
         Options.Add(
@@ -133,7 +133,7 @@ protected override async Task<int> Run()
         {
             foreach (var permission in _permissions)
             {
-                if (!Enum.TryParse<Permission>(permission, out var p))
+                if (!Enum.TryParse<Permission>(permission, true, out var p))
                 {
                     Log.Error("Unrecognized permission {Permission}", permission);
                     return 1;

src/SeqCli/Cli/Commands/ConfigCommand.cs

@@ -44,24 +44,25 @@ protected override Task<int> Run()
 
         try
         {
-            var config = SeqCliConfig.Read();
-
+            var config = SeqCliConfig.ReadFromFile(RuntimeConfigurationLoader.DefaultConfigFilename);
+            
             if (_key != null)
             {
                 if (_clear)
                 {
                     verb = "clear";
-                    Clear(config, _key);
-                    SeqCliConfig.Write(config);
+                    KeyValueSettings.Clear(config, _key);
+                    SeqCliConfig.WriteToFile(config, RuntimeConfigurationLoader.DefaultConfigFilename);
                 }
                 else if (_value != null)
                 {
                     verb = "update";
-                    Set(config, _key, _value);
-                    SeqCliConfig.Write(config);
+                    KeyValueSettings.Set(config, _key, _value);
+                    SeqCliConfig.WriteToFile(config, RuntimeConfigurationLoader.DefaultConfigFilename);
                 }
                 else
                 {
+                    verb = "print";
                     Print(config, _key);
                 }
             }
@@ -78,114 +79,23 @@ protected override Task<int> Run()
             return Task.FromResult(1);
         }
     }
-
+    
     static void Print(SeqCliConfig config, string key)
     {
         if (config == null) throw new ArgumentNullException(nameof(config));
         if (key == null) throw new ArgumentNullException(nameof(key));
 
-        var pr = ReadPairs(config).SingleOrDefault(p => p.Key == key);
-        if (pr.Key == null)
-            throw new ArgumentException($"Option {key} not found.");
-
-        Console.WriteLine(Format(pr.Value));
-    }
-
-    static void Set(SeqCliConfig config, string key, string? value)
-    {
-        if (config == null) throw new ArgumentNullException(nameof(config));
-        if (key == null) throw new ArgumentNullException(nameof(key));
-
-        var steps = key.Split('.');
-        if (steps.Length != 2)
-            throw new ArgumentException("The format of the key is incorrect; run the command without any arguments to view all keys.");
-
-        var first = config.GetType().GetTypeInfo().DeclaredProperties
-            .Where(p => p.CanRead && p.GetMethod!.IsPublic && !p.GetMethod.IsStatic)
-            .SingleOrDefault(p => Camelize(p.Name) == steps[0]);
-
-        if (first == null)
-            throw new ArgumentException("The key could not be found; run the command without any arguments to view all keys.");
-
-        if (first.PropertyType == typeof(Dictionary<string, SeqCliConnectionConfig>))
-            throw new NotSupportedException("Use `seqcli profile create` to configure connection profiles.");
-
-        var second = first.PropertyType.GetTypeInfo().DeclaredProperties
-            .Where(p => p.CanRead && p.GetMethod!.IsPublic && !p.GetMethod.IsStatic)
-            .SingleOrDefault(p => Camelize(p.Name) == steps[1]);
-
-        if (second == null)
-            throw new ArgumentException("The key could not be found; run the command without any arguments to view all keys.");
+        if (!KeyValueSettings.TryGetValue(config, key, out var value, out _))
+            throw new ArgumentException($"Option {key} not found");
 
-        if (!second.CanWrite || !second.SetMethod!.IsPublic)
-            throw new ArgumentException("The value is not writeable.");
-
-        var targetValue = Convert.ChangeType(value, second.PropertyType, CultureInfo.InvariantCulture);
-        var configItem = first.GetValue(config);
-        second.SetValue(configItem, targetValue);
-    }
-
-    static void Clear(SeqCliConfig config, string key)
-    {
-        Set(config, key, null);
+        Console.WriteLine(value);
     }
 
     static void List(SeqCliConfig config)
     {
-        foreach (var (key, value) in ReadPairs(config))
-        {
-            Console.WriteLine($"{key}:");
-            Console.WriteLine($"  {Format(value)}");
-        }
-    }
-
-    static IEnumerable<KeyValuePair<string, object?>> ReadPairs(object config)
-    {
-        foreach (var property in config.GetType().GetTypeInfo().DeclaredProperties
-                     .Where(p => p.CanRead && p.GetMethod!.IsPublic && !p.GetMethod.IsStatic && !p.Name.StartsWith("Encoded"))
-                     .OrderBy(p => p.Name))
+        foreach (var (key, value, _) in KeyValueSettings.Inspect(config))
         {
-            var propertyName = Camelize(property.Name);
-            var propertyValue = property.GetValue(config);
-
-            if (propertyValue is IDictionary dict)
-            {
-                foreach (var elementKey in dict.Keys)
-                {
-                    foreach (var elementPair in ReadPairs(dict[elementKey]!))
-                    {
-                        yield return new KeyValuePair<string, object?>(
-                            $"{propertyName}[{elementKey}].{elementPair.Key}",
-                            elementPair.Value);
-                    }
-                }
-            }
-            else if (propertyValue?.GetType().Namespace?.StartsWith("SeqCli.Config") ?? false)
-            {
-                foreach (var childPair in ReadPairs(propertyValue))
-                {
-                    var name = propertyName + "." + childPair.Key;
-                    yield return new KeyValuePair<string, object?>(name, childPair.Value);
-                }
-            }
-            else
-            {
-                yield return new KeyValuePair<string, object?>(propertyName, propertyValue);
-            }
+            Console.WriteLine($"{key}={value}");
         }
     }
-
-    static string Camelize(string s)
-    {
-        if (s.Length < 2)
-            throw new NotSupportedException("No camel-case support for short names");
-        return char.ToLowerInvariant(s[0]) + s.Substring(1);
-    }
-
-    static string Format(object? value)
-    {
-        return value is IFormattable formattable
-            ? formattable.ToString(null, CultureInfo.InvariantCulture)
-            : value?.ToString() ?? "";
-    }
 }

src/SeqCli/Cli/Commands/IngestCommand.cs

@@ -47,7 +47,7 @@ class IngestCommand : Command
     public IngestCommand(SeqConnectionFactory connectionFactory)
     {
         _connectionFactory = connectionFactory;
-        _fileInputFeature = Enable(new FileInputFeature("File(s) to ingest", supportsWildcard: true));
+        _fileInputFeature = Enable(new FileInputFeature("File(s) to ingest", allowMultiple: true));
         _invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();
         _properties = Enable<PropertiesFeature>();
 

src/SeqCli/Cli/Commands/Node/HealthCommand.cs

@@ -54,13 +54,16 @@ protected override async Task<int> Run()
         try
         {
             var response = await connection.Client.HttpClient.GetAsync("health");
-            Console.WriteLine($"HTTP {response.Version} {((int)response.StatusCode).ToString(CultureInfo.InvariantCulture)} {response.ReasonPhrase}");
+            Log.Information("HTTP {HttpVersion} {StatusCode} {ReasonPhrase}", response.Version, (int)response.StatusCode, response.ReasonPhrase);
+
             foreach (var (key, values) in response.Headers.Concat(response.Content.Headers))
             foreach (var value in values)
             {
-                Console.WriteLine($"{key}: {value}");
+                Log.Information("{HeaderName}: {HeaderValue}", key, value);
             }
+
             Console.WriteLine(await response.Content.ReadAsStringAsync());
+
             return response.IsSuccessStatusCode ? 0 : 1;
         }
         catch (Exception ex)

src/SeqCli/Cli/Commands/PrintCommand.cs

@@ -44,7 +44,7 @@ public PrintCommand(SeqCliOutputConfig outputConfig)
         _noColor = outputConfig.DisableColor;
         _forceColor = outputConfig.ForceColor;
 
-        _fileInputFeature = Enable(new FileInputFeature("CLEF file to read", supportsWildcard: true));
+        _fileInputFeature = Enable(new FileInputFeature("CLEF file to read", allowMultiple: true));
 
         Options.Add("f=|filter=",
             "Filter expression to select a subset of events",

src/SeqCli/Cli/Commands/Profile/CreateCommand.cs

@@ -48,9 +48,9 @@ int RunSync()
 
         try
         {
-            var config = SeqCliConfig.Read();
+            var config = SeqCliConfig.ReadFromFile(RuntimeConfigurationLoader.DefaultConfigFilename);
             config.Profiles[_name] = new SeqCliConnectionConfig { ServerUrl = _url, ApiKey = _apiKey };
-            SeqCliConfig.Write(config);
+            SeqCliConfig.WriteToFile(config, RuntimeConfigurationLoader.DefaultConfigFilename);
             return 0;
         }
         catch (Exception ex)

src/SeqCli/Cli/Commands/Profile/ListCommand.cs

@@ -11,7 +11,7 @@ class ListCommand : Command
 {
     protected override Task<int> Run()
     {
-        var config = SeqCliConfig.Read();
+        var config = RuntimeConfigurationLoader.Load();
 
         foreach (var profile in config.Profiles.OrderBy(p => p.Key))
         {

src/SeqCli/Cli/Commands/Profile/RemoveCommand.cs

@@ -34,14 +34,14 @@ int RunSync()
 
         try
         {
-            var config = SeqCliConfig.Read();
+            var config = SeqCliConfig.ReadFromFile(RuntimeConfigurationLoader.DefaultConfigFilename);
             if (!config.Profiles.Remove(_name))
             {
                 Log.Error("No profile with name {ProfileName} was found", _name);
                 return 1;
             }
 
-            SeqCliConfig.Write(config);
+            SeqCliConfig.WriteToFile(config, RuntimeConfigurationLoader.DefaultConfigFilename);
 
             return 0;
         }

src/SeqCli/Cli/Commands/Signal/ImportCommand.cs

@@ -59,7 +59,7 @@ protected override async Task<int> Run()
     {
         var connection = _connectionFactory.Connect(_connection);
 
-        using var input = _fileInputFeature.OpenInput();
+        using var input = _fileInputFeature.OpenSingleInput();
         var line = await input.ReadLineAsync();
         while (line != null)
         {