Prefix lines in seed log with worker id.

Author: sharpjs

PSql.Deploy.Engine.Tests/Core/PrefixTextWriterSqlMessageLoggerTests.cs

@@ -0,0 +1,55 @@
+// Copyright Subatomix Research Inc.
+// SPDX-License-Identifier: MIT
+
+namespace PSql.Deploy;
+
+using static SqlMessageConstants;
+
+[TestFixture]
+public class PrefixTextWriterSqlMessageLoggerTests
+{
+    private readonly PrefixTextWriterSqlMessageLogger _logger;
+    private readonly StringWriter                     _writer;
+
+    public PrefixTextWriterSqlMessageLoggerTests()
+    {
+        _writer = new();
+        _logger = new(_writer, prefix: "Test>");
+    }
+
+    [Test]
+    public void Construct_NullWriter()
+    {
+        Should.Throw<ArgumentNullException>(() =>
+        {
+            _ = new PrefixTextWriterSqlMessageLogger(null!, "any");
+        });
+    }
+
+    [Test]
+    public void Construct_NullPrefix()
+    {
+        Should.Throw<ArgumentNullException>(() =>
+        {
+            _ = new PrefixTextWriterSqlMessageLogger(_writer, null!);
+        });
+    }
+
+    [Test]
+    public void Log_Information()
+    {
+        _logger.Log("foo", line: 42, number: 1337, MaxInformationalSeverity, message: "a");
+
+        _writer.ToString().ShouldBe("Test> a" + Environment.NewLine);
+    }
+
+    [Test]
+    public void Log_Error()
+    {
+        (11).ShouldBeGreaterThan(MaxInformationalSeverity);
+
+        _logger.Log("foo", line: 42, number: 1337, severity: 11, "a");
+
+        _writer.ToString().ShouldBe("Test> foo:42: E1337:11: a" + Environment.NewLine);
+    }
+}

PSql.Deploy.Engine/Core/PrefixTextWriterSqlMessageLogger.cs

@@ -0,0 +1,47 @@
+// Copyright Subatomix Research Inc.
+// SPDX-License-Identifier: MIT
+
+namespace PSql.Deploy;
+
+using static SqlMessageConstants;
+
+/// <summary>
+///   An <see cref="ISqlMessageLogger"/> implementation that writes messages to
+///   a <see cref="TextWriter"/> with a prefix.
+/// </summary>
+public sealed class PrefixTextWriterSqlMessageLogger : ISqlMessageLogger
+{
+    private readonly TextWriter _writer;
+    private readonly string     _prefix;
+
+    /// <summary>
+    ///   Initializes a new <see cref="PrefixTextWriterSqlMessageLogger"/>
+    ///   instance with the specified writer and prefix.
+    /// </summary>
+    /// <param name="writer">
+    ///   The writer to use to write messages.
+    /// </param>
+    /// <param name="prefix">
+    ///   The prefix to prepend to each message.
+    /// </param>
+    /// <exception cref="ArgumentNullException">
+    ///   <paramref name="writer"/> is <see langword="null"/>.
+    /// </exception>
+    public PrefixTextWriterSqlMessageLogger(TextWriter writer, string prefix)
+    {
+        ArgumentNullException.ThrowIfNull(writer);
+        ArgumentNullException.ThrowIfNull(prefix);
+
+        _writer = writer;
+        _prefix = prefix;
+    }
+
+    /// <inheritdoc/>
+    public void Log(string procedure, int line, int number, int severity, string? message)
+    {
+        if (severity <= MaxInformationalSeverity)
+            _writer.WriteLine($"{_prefix} {message}");
+        else
+            _writer.WriteLine($"{_prefix} {procedure}:{line}: E{number}:{severity}: {message}");
+    }
+}

PSql.Deploy.Engine/Seeds/SeedApplicator.cs

@@ -195,7 +195,7 @@ private void Validate(DependencyQueue<SeedModule> queue)
 
     private async Task SeedWorkerMainAsync(QueueContext context)
     {
-        await using var connection = Connect();
+        await using var connection = Connect(context);
 
         await PrepareAsync(connection, context);
 
@@ -207,11 +207,12 @@ bool CanTake(SeedModule module)
             await ExecuteAsync(module, connection, context);
     }
 
-    private ISeedTargetConnection Connect()
+    private ISeedTargetConnection Connect(QueueContext context)
     {
         Assume.NotNull(_logWriter);
 
-        var logger = new TextWriterSqlMessageLogger(_logWriter);
+        var prefix = $"{context.WorkerId}>";
+        var logger = new PrefixTextWriterSqlMessageLogger(_logWriter, prefix);
 
         return Session.Connect(Target, logger);
     }