ScalarValue.Value can be null

src/Serilog/Events/ScalarValue.cs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#nullable enable
 using System;
 using System.Globalization;
 using System.IO;
@@ -28,15 +29,15 @@ public class ScalarValue : LogEventPropertyValue
         /// value.
         /// </summary>
         /// <param name="value">The value, which may be <code>null</code>.</param>
-        public ScalarValue(object value)
+        public ScalarValue(object? value)
         {
             Value = value;
         }
 
         /// <summary>
         /// The value, which may be <code>null</code>.
         /// </summary>
-        public object Value { get; }
+        public object? Value { get; }
 
         /// <summary>
         /// Render the value to the output.
@@ -46,13 +47,13 @@ public ScalarValue(object value)
         /// <param name="formatProvider">A format provider to apply to the value, or null to use the default.</param>
         /// <seealso cref="LogEventPropertyValue.ToString(string, IFormatProvider)"/>.
         /// <exception cref="ArgumentNullException">When <paramref name="output"/> is <code>null</code></exception>
-        public override void Render(TextWriter output, string format = null, IFormatProvider formatProvider = null)
+        public override void Render(TextWriter output, string? format = null, IFormatProvider? formatProvider = null)
         {
             Render(Value, output, format, formatProvider);
         }
 
         /// <exception cref="ArgumentNullException">When <paramref name="output"/> is <code>null</code></exception>
-        internal static void Render(object value, TextWriter output, string format = null, IFormatProvider formatProvider = null)
+        internal static void Render(object? value, TextWriter output, string? format = null, IFormatProvider? formatProvider = null)
         {
             if (output == null) throw new ArgumentNullException(nameof(output));
 
@@ -77,14 +78,11 @@ internal static void Render(object value, TextWriter output, string format = nul
                 return;
             }
 
-            if (formatProvider != null)
+            var custom = (ICustomFormatter?) formatProvider?.GetFormat(typeof(ICustomFormatter));
+            if (custom != null)
             {
-                var custom = (ICustomFormatter)formatProvider.GetFormat(typeof(ICustomFormatter));
-                if (custom != null)
-                {
-                    output.Write(custom.Format(format, value, formatProvider));
-                    return;
-                }
+                output.Write(custom.Format(format, value, formatProvider));
+                return;
             }
 
             if (value is IFormattable f)
@@ -102,7 +100,7 @@ internal static void Render(object value, TextWriter output, string format = nul
         /// </summary>
         /// <param name="obj">The instance to compare with.</param>
         /// <returns>True if the instances are equal; otherwise, false.</returns>
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             return obj is ScalarValue sv && Equals(Value, sv.Value);
         }

test/Serilog.PerformanceTests/Support/Some.cs

@@ -11,7 +11,7 @@ public static LogEvent InformationEvent(string messageTemplate = "Hello, world!"
 #pragma warning disable Serilog004 // Constant MessageTemplate verifier
             logger.BindMessageTemplate(messageTemplate, propertyValues, out var parsedTemplate, out var boundProperties);
 #pragma warning restore Serilog004 // Constant MessageTemplate verifier
-            return new LogEvent(DateTime.Now, LogEventLevel.Information, null, parsedTemplate, boundProperties);
+            return new LogEvent(DateTime.Now, LogEventLevel.Information, null, parsedTemplate!, boundProperties!);
         }
     }
 }

test/Serilog.Tests/Capturing/PropertyValueConverterTests.cs

@@ -187,7 +187,7 @@ public void ByteArraysAreConvertedToStrings()
         {
             var bytes = Enumerable.Range(0, 10).Select(b => (byte)b).ToArray();
             var pv = _converter.CreatePropertyValue(bytes);
-            var lv = (string)pv.LiteralValue();
+            var lv = (string?)pv.LiteralValue();
             Assert.Equal("00010203040506070809", lv);
         }
 
@@ -196,7 +196,7 @@ public void ByteArraysLargerThan1kAreLimitedAndConvertedToStrings()
         {
             var bytes = Enumerable.Range(0, 1025).Select(b => (byte)b).ToArray();
             var pv = _converter.CreatePropertyValue(bytes);
-            var lv = (string)pv.LiteralValue();
+            var lv = (string?)pv.LiteralValue();
             Assert.EndsWith("(1025 bytes)", lv);
         }
 
@@ -206,7 +206,7 @@ public void ByteSpansAreConvertedToStrings()
         {
             var bytes = Enumerable.Range(0, 10).Select(b => (byte)b).ToArray().AsMemory();
             var pv = _converter.CreatePropertyValue(bytes);
-            var lv = (string)pv.LiteralValue();
+            var lv = (string?)pv.LiteralValue();
             Assert.Equal("00010203040506070809", lv);
         }
 
@@ -215,7 +215,7 @@ public void ByteSpansLargerThan1kAreLimitedAndConvertedToStrings()
         {
             var bytes = Enumerable.Range(0, 1025).Select(b => (byte)b).ToArray().AsMemory();
             var pv = _converter.CreatePropertyValue(bytes);
-            var lv = (string)pv.LiteralValue();
+            var lv = (string?)pv.LiteralValue();
             Assert.EndsWith("(1025 bytes)", lv);
         }
 
@@ -247,7 +247,7 @@ public void FailsGracefullyWhenAccessingPropertiesViaReflectionThrows()
             var l = sv.Properties.Single(m => m.Name == "Length");
             Assert.Equal(3, l.Value.LiteralValue());
             var k = sv.Properties.Single(m => m.Name == "IsEmpty");
-            Assert.False((bool)k.Value.LiteralValue());
+            Assert.False((bool?)k.Value.LiteralValue());
             var s = sv.Properties.Single(m => m.Name == "Span");
         }
 #endif

test/Serilog.Tests/Support/Extensions.cs

@@ -4,7 +4,7 @@ namespace Serilog.Tests.Support
 {
     public static class Extensions
     {
-        public static object LiteralValue(this LogEventPropertyValue @this)
+        public static object? LiteralValue(this LogEventPropertyValue @this)
         {
             return ((ScalarValue)@this).Value;
         }

test/Serilog.Tests/Support/LogEventPropertyValueComparer.cs

@@ -18,6 +18,16 @@ public bool Equals(LogEventPropertyValue? x, LogEventPropertyValue? y)
         {
             if (x is ScalarValue scalarX && y is ScalarValue scalarY)
             {
+                if (scalarX.Value is null && scalarY.Value is null)
+                {
+                    return true;
+                }
+
+                if (scalarX.Value is null || scalarY.Value is null)
+                {
+                    return false;
+                }
+
                 return _objectEqualityComparer.Equals(scalarX.Value, scalarY.Value);
             }