Merge pull request #134 from serilog/dev

4.0.0 Release

Author: nblumhardt

README.md

@@ -1,9 +1,9 @@
-# Serilog.Sinks.Email
-
-[![Build status](https://ci.appveyor.com/api/projects/status/sfvp7dw8u6aiodj1/branch/main?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-email/branch/main)
+# Serilog.Sinks.Email [![Build status](https://ci.appveyor.com/api/projects/status/sfvp7dw8u6aiodj1/branch/main?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-email/branch/main)
 
 Sends log events by SMTP email.
 
+> ℹ️ Version 3.x of this package changes the name and structure of many configuration parameters from their 2.x names; see below for detailed information.
+
 **Package** - [Serilog.Sinks.Email](http://nuget.org/packages/serilog.sinks.email)
 
 ```csharp

appveyor.yml

@@ -1,15 +1,15 @@
 version: '{build}'
 skip_tags: true
 image: Visual Studio 2022
-test: off
 build_script:
   - pwsh: ./Build.ps1
+test: off
 artifacts:
   - path: artifacts/Serilog.*.nupkg
 deploy:
   - provider: NuGet
     api_key:
-      secure: sDnchSg4TZIOK7oIUI6BJwFPNENTOZrGNsroGO1hehLJSvlHpFmpTwiX8+bgPD+Q
+      secure: ZpUO4ECx4c/V0Ecj04cfV1UGd+ZABeEG9DDW2fjG8vITjNYhmbiiJH0qNOnRy2G3
     skip_symbols: true
     on:
       branch: /^(main|dev)$/
@@ -20,4 +20,3 @@ deploy:
     tag: v$(appveyor_build_version)
     on:
       branch: main
-

src/Serilog.Sinks.Email/LoggerConfigurationEmailExtensions.cs

@@ -21,7 +21,6 @@
 using Serilog.Events;
 using Serilog.Formatting.Display;
 using Serilog.Sinks.Email;
-using Serilog.Sinks.PeriodicBatching;
 // ReSharper disable MemberCanBePrivate.Global
 
 namespace Serilog;
@@ -31,7 +30,7 @@ namespace Serilog;
 /// </summary>
 public static class LoggerConfigurationEmailExtensions
 {
-    static readonly TimeSpan DefaultPeriod = TimeSpan.FromSeconds(30);
+    static readonly TimeSpan DefaultBufferingTimeLimit = TimeSpan.FromSeconds(30);
     const int DefaultQueueLimit = 10000;
 
     /// <summary>
@@ -108,7 +107,7 @@ public static LoggerConfiguration Email(
     /// </summary>
     /// <param name="loggerConfiguration">The logger configuration.</param>
     /// <param name="options">The connection info used for</param>
-    /// <param name="batchingOptions">Optionally, a <see cref="PeriodicBatchingSinkOptions"/> to control background batching.</param>
+    /// <param name="batchingOptions">Optionally, a <see cref="BatchingOptions"/> to control background batching.</param>
     /// <param name="restrictedToMinimumLevel">The minimum level for
     /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
     /// <param name="levelSwitch">A switch allowing the pass-through minimum level
@@ -120,27 +119,25 @@ public static LoggerConfiguration Email(
     public static LoggerConfiguration Email(
         this LoggerSinkConfiguration loggerConfiguration,
         EmailSinkOptions options,
-        PeriodicBatchingSinkOptions? batchingOptions = null,
+        BatchingOptions? batchingOptions = null,
         LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
         LoggingLevelSwitch? levelSwitch = null)
     {
         if (options == null) throw new ArgumentNullException(nameof(options));
 
-        batchingOptions ??= new PeriodicBatchingSinkOptions
+        batchingOptions ??= new BatchingOptions
         {
             // Batching not used by default: fire off an email immediately upon receiving each event.
             BatchSizeLimit = 1,
-            Period = DefaultPeriod,
+            BufferingTimeLimit = DefaultBufferingTimeLimit,
             EagerlyEmitFirstEvent = true,
             QueueLimit = DefaultQueueLimit,
         };
 
         var transport = new MailKitEmailTransport(options);
         var sink = new EmailSink(options, transport);
 
-        var batchingSink = new PeriodicBatchingSink(sink, batchingOptions);
-
-        return loggerConfiguration.Sink(batchingSink, restrictedToMinimumLevel, levelSwitch);
+        return loggerConfiguration.Sink(sink, batchingOptions, restrictedToMinimumLevel, levelSwitch);
     }
 
 

src/Serilog.Sinks.Email/Serilog.Sinks.Email.csproj

@@ -1,10 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <Description>Send Serilog events as SMTP email using MailKit.</Description>
-    <VersionPrefix>3.0.0</VersionPrefix>
+    <VersionPrefix>4.0.0</VersionPrefix>
     <Authors>Serilog Contributors</Authors>
-    <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net462</TargetFrameworks>
-    <TargetFrameworks>$(TargetFrameworks);netstandard2.0;net6.0</TargetFrameworks>
+    <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net462;net471</TargetFrameworks>
+    <TargetFrameworks>$(TargetFrameworks);netstandard2.0;net6.0;net8.0</TargetFrameworks>
     <AssemblyOriginatorKeyFile>../../assets/Serilog.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
@@ -30,9 +30,8 @@
     <None Include="../../README.md" Pack="true" Visible="false" PackagePath="/" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
     <PackageReference Include="PolySharp" Version="1.14.1" PrivateAssets="All" />
-    <PackageReference Include="Serilog" Version="3.1.1" />
-    <PackageReference Include="Serilog.Sinks.PeriodicBatching" Version="4.0.0-*" />
-    <PackageReference Include="MailKit" Version="4.3.0" />
+    <PackageReference Include="Serilog" Version="4.0.0" />
+    <PackageReference Include="MailKit" Version="4.6.0" />
   </ItemGroup>
 
 </Project>

src/Serilog.Sinks.Email/Sinks/Email/EmailSink.cs

@@ -16,15 +16,17 @@
 using System.IO;
 using System.Threading.Tasks;
 using Serilog.Events;
-using Serilog.Sinks.PeriodicBatching;
 using System.Linq;
+using Serilog.Core;
+using Serilog.Formatting;
 
 namespace Serilog.Sinks.Email;
 
 class EmailSink : IBatchedLogEventSink, IDisposable
 {
     readonly EmailSinkOptions _sinkOptions;
     readonly IEmailTransport _emailTransport;
+
     /// <summary>
     /// Construct a sink emailing with the specified details.
     /// </summary>
@@ -41,40 +43,45 @@ public EmailSink(EmailSinkOptions options, IEmailTransport emailTransport)
     /// Emit a batch of log events, running asynchronously.
     /// </summary>
     /// <param name="events">The events to emit.</param>
-    public Task EmitBatchAsync(IEnumerable<LogEvent> events)
+    public Task EmitBatchAsync(IReadOnlyCollection<LogEvent> events)
     {
-        // ReSharper disable PossibleMultipleEnumeration
-
         if (events == null)
             throw new ArgumentNullException(nameof(events));
 
-        var payload = new StringWriter();
+        var body = new StringWriter();
 
         if (_sinkOptions.Body is IBatchTextFormatter batchTextFormatter)
         {
-            batchTextFormatter.FormatBatch(events, payload);
+            batchTextFormatter.FormatBatch(events, body);
         }
         else
         {
             foreach (var logEvent in events)
             {
-                _sinkOptions.Body.Format(logEvent, payload);
+                _sinkOptions.Body.Format(logEvent, body);
             }
         }
 
-        var subject = new StringWriter();
-        _sinkOptions.Subject.Format(events.OrderByDescending(e => e.Level).First(), subject);
+        var subject = ComputeMailSubject(_sinkOptions.Subject, events);
 
         var email = new EmailMessage(
             _sinkOptions.From,
             _sinkOptions.To,
-            subject.ToString(),
-            payload.ToString(),
+            subject,
+            body.ToString(),
             _sinkOptions.IsBodyHtml);
 
         return _emailTransport.SendMailAsync(email);
+    }
 
-        // ReSharper restore PossibleMultipleEnumeration
+    internal static string ComputeMailSubject(ITextFormatter subjectLineFormatter, IEnumerable<LogEvent> events)
+    {
+        var subject = new StringWriter();
+        subjectLineFormatter.Format(events.OrderByDescending(e => e.Level).First(), subject);
+        var subjectAsText = subject.ToString();
+        var firstLineOfSubject = subjectAsText.Split(new[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries)
+                                     .FirstOrDefault() ?? string.Empty;
+        return firstLineOfSubject;
     }
 
     public Task OnEmptyBatchAsync()

test/Serilog.Sinks.Email.Tests/EmailSinkTests.cs

@@ -6,8 +6,8 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using Serilog.Configuration;
 using Serilog.Sinks.Email.Tests.Support;
-using Serilog.Sinks.PeriodicBatching;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -84,7 +84,7 @@ public async Task SendEmailIsCorrectlyCalledWhenEventAreLogged()
             To = ["[email protected]"],
             From = "[email protected]",
             Body = new MessageTemplateTextFormatter("[{Level}] {Message}{NewLine}{Exception}"),
-            Subject = new MessageTemplateTextFormatter("[{Level}] {Message}{NewLine}{Exception}")
+            Subject = new MessageTemplateTextFormatter("[{Level}] A message")
         };
 
         var transport = new TestEmailTransport();
@@ -101,8 +101,7 @@ await emailSink.EmitBatchAsync(new[]
                 new MessageTemplate("Subject",
                     new MessageTemplateToken[]
                     {
-                        new PropertyToken("Message", "A multiline" + Environment.NewLine
-                                                                   + "Message")
+                        new PropertyToken("Message", "A multiline" + Environment.NewLine + "Message")
                     })
                 , Enumerable.Empty<LogEventProperty>())
         });
@@ -115,16 +114,29 @@ await emailSink.EmitBatchAsync(new[]
                                            + "System.ArgumentOutOfRangeException: Message of the exception"
                                            + " (Parameter 'parameter1')"
                                            + Environment.NewLine + "", actual.Body);
-        Assert.Equal("[Error] A multiline" + Environment.NewLine
-                                            + "Message" + Environment.NewLine
-                                            + "System.ArgumentOutOfRangeException: Message of the exception"
-                                            + " (Parameter 'parameter1')"
-                                            + Environment.NewLine + "", actual.Subject);
+        Assert.Equal("[Error] A message", actual.Subject);
         Assert.Equal("[email protected]", actual.From);
         Assert.Equal(new[] { "[email protected]" }, actual.To);
         Assert.False(actual.IsBodyHtml);
     }
 
+    [Fact]
+    public void MultilineMessageCreatesSubjectWithTheFirstLineOnly()
+    {
+        var subjectLineFormatter = new MessageTemplateTextFormatter("{Message}", null);
+
+        var logEvents = new[]
+        {
+            new LogEvent(DateTimeOffset.Now, LogEventLevel.Error, new Exception("An exception occured"),
+                new MessageTemplate(@"Subject",
+                    new MessageTemplateToken[]{new PropertyToken("Message", "A multiline" + Environment.NewLine + "Message")})
+                , Enumerable.Empty<LogEventProperty>())
+        };
+        var mailSubject = EmailSink.ComputeMailSubject(subjectLineFormatter, logEvents);
+
+        Assert.Equal("A multiline", mailSubject);
+    }
+
     [Fact]
     public void WorksWithIBatchTextFormatter()
     {
@@ -140,7 +152,7 @@ public void WorksWithIBatchTextFormatter()
         var sink = new EmailSink(emailConnectionInfo, emailTransport);
 
         using (var emailLogger = new LoggerConfiguration()
-                   .WriteTo.Sink(new PeriodicBatchingSink(sink, new PeriodicBatchingSinkOptions()))
+                   .WriteTo.Sink(sink, new BatchingOptions())
                    .CreateLogger())
         {
             emailLogger.Information("Information");

test/Serilog.Sinks.Email.Tests/Serilog.Sinks.Email.Tests.csproj

@@ -14,9 +14,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-    <PackageReference Include="xunit" Version="2.6.4" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+    <PackageReference Include="xunit" Version="2.8.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>