netstandard 2.1 support for Orleans.Serialization (#8222)

* netstandard2.1 compatible serialization

* use build property for package version

* fix merge errors and handle additional upstream changes

* Update src/Orleans.Serialization/Codecs/GuidCodec.cs

Co-authored-by: Reuben Bond <[email protected]>

* add netstandard2.1 (via netcoreapp3.1) test coverage for serialization

* install other .net versions in ci

* don't pin segment array to prevent possible leaking in a simple manner

* Fix issues causing test failures (#2)

xref: #8222

* Create pre net7 version of NumericsWideningAndNarrowingTests

Co-authored-by: Reuben Bond <[email protected]>

Author: jsteinich

.github/workflows/ci.yml

@@ -21,6 +21,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Build
       run: dotnet build
     - uses: actions/upload-artifact@v3
@@ -49,6 +53,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v2
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -85,6 +93,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v2
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -117,6 +129,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -153,6 +169,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -187,6 +207,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&Category=${{ matrix.suite }}" --framework ${{ matrix.framework }} --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -220,6 +244,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -253,6 +281,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:
@@ -287,6 +319,10 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: |
+          3.1.x
+          7.0.x
     - name: Test
       run: dotnet test --filter "Category=${{ matrix.provider }}&(Category=BVT|Category=SlowBVT|Category=Functional)" --blame-hang-timeout 10m --logger "trx" -- -parallel none -noshadow
       env:

Directory.Packages.props

@@ -18,6 +18,7 @@
     <PackageVersion Include="System.IO.Pipelines" Version="7.0.0" />
     <PackageVersion Include="System.Memory.Data" Version="7.0.0" />
     <PackageVersion Include="System.Net.NameResolution" Version="4.3.0" />
+    <PackageVersion Include="System.Collections.Immutable" Version="7.0.0" />
     <!-- Microsoft packages -->
     <PackageVersion Include="Microsoft.Build" Version="17.3.2" />
     <PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
@@ -27,6 +28,7 @@
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="$(MicrosoftCodeAnalysisVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="$(MicrosoftCodeAnalysisVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.3" />
+    <PackageVersion Include="Microsoft.DotNet.PlatformAbstractions" Version="3.1.6" />
     <PackageVersion Include="Microsoft.AspNetCore.Connections.Abstractions" Version="7.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration" Version="$(MicrosoftExtensionsConfigurationVersion)" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="$(MicrosoftExtensionsConfigurationVersion)" />

src/Orleans.CodeGenerator/LibraryTypes.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Concurrent;
+using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
 using Microsoft.CodeAnalysis;
@@ -66,17 +67,17 @@ public static LibraryTypes FromCompilation(Compilation compilation, CodeGenerato
                 Task_1 = Type("System.Threading.Tasks.Task`1"),
                 Type = Type("System.Type"),
                 Uri = Type("System.Uri"),
-                Int128 = Type("System.Int128"),
-                UInt128 = Type("System.UInt128"),
-                Half = Type("System.Half"),
-                DateOnly = Type("System.DateOnly"),
+                Int128 = TypeOrDefault("System.Int128"),
+                UInt128 = TypeOrDefault("System.UInt128"),
+                Half = TypeOrDefault("System.Half"),
+                DateOnly = TypeOrDefault("System.DateOnly"),
                 DateTimeOffset = Type("System.DateTimeOffset"),
                 BitVector32 = Type("System.Collections.Specialized.BitVector32"),
                 Guid = Type("System.Guid"),
                 CompareInfo = Type("System.Globalization.CompareInfo"),
                 CultureInfo = Type("System.Globalization.CultureInfo"),
                 Version = Type("System.Version"),
-                TimeOnly = Type("System.TimeOnly"),
+                TimeOnly = TypeOrDefault("System.TimeOnly"),
                 ICodecProvider = Type("Orleans.Serialization.Serializers.ICodecProvider"),
                 ValueSerializer = Type("Orleans.Serialization.Serializers.IValueSerializer`1"),
                 ValueTask = Type("System.Threading.Tasks.ValueTask"),
@@ -86,7 +87,7 @@ public static LibraryTypes FromCompilation(Compilation compilation, CodeGenerato
                 Writer = Type("Orleans.Serialization.Buffers.Writer`1"),
                 FSharpSourceConstructFlagsOrDefault = TypeOrDefault("Microsoft.FSharp.Core.SourceConstructFlags"),
                 FSharpCompilationMappingAttributeOrDefault = TypeOrDefault("Microsoft.FSharp.Core.CompilationMappingAttribute"),
-                StaticCodecs = new WellKnownCodecDescription[]
+                StaticCodecs = new List<WellKnownCodecDescription>
                 {
                     new(compilation.GetSpecialType(SpecialType.System_Object), Type("Orleans.Serialization.Codecs.ObjectCodec")),
                     new(compilation.GetSpecialType(SpecialType.System_Boolean), Type("Orleans.Serialization.Codecs.BoolCodec")),
@@ -107,19 +108,19 @@ public static LibraryTypes FromCompilation(Compilation compilation, CodeGenerato
                     new(compilation.GetSpecialType(SpecialType.System_DateTime), Type("Orleans.Serialization.Codecs.DateTimeCodec")),
                     new(Type("System.TimeSpan"), Type("Orleans.Serialization.Codecs.TimeSpanCodec")),
                     new(Type("System.DateTimeOffset"), Type("Orleans.Serialization.Codecs.DateTimeOffsetCodec")),
-                    new(Type("System.DateOnly"), Type("Orleans.Serialization.Codecs.DateOnlyCodec")),
-                    new(Type("System.TimeOnly"), Type("Orleans.Serialization.Codecs.TimeOnlyCodec")),
+                    new(TypeOrDefault("System.DateOnly"), TypeOrDefault("Orleans.Serialization.Codecs.DateOnlyCodec")),
+                    new(TypeOrDefault("System.TimeOnly"), TypeOrDefault("Orleans.Serialization.Codecs.TimeOnlyCodec")),
                     new(Type("System.Guid"), Type("Orleans.Serialization.Codecs.GuidCodec")),
                     new(Type("System.Type"), Type("Orleans.Serialization.Codecs.TypeSerializerCodec")),
                     new(Type("System.ReadOnlyMemory`1").Construct(compilation.GetSpecialType(SpecialType.System_Byte)), Type("Orleans.Serialization.Codecs.ReadOnlyMemoryOfByteCodec")),
                     new(Type("System.Memory`1").Construct(compilation.GetSpecialType(SpecialType.System_Byte)), Type("Orleans.Serialization.Codecs.MemoryOfByteCodec")),
                     new(Type("System.Net.IPAddress"), Type("Orleans.Serialization.Codecs.IPAddressCodec")),
                     new(Type("System.Net.IPEndPoint"), Type("Orleans.Serialization.Codecs.IPEndPointCodec")),
-                    new(Type("System.UInt128"), Type("Orleans.Serialization.Codecs.UInt128Codec")),
-                    new(Type("System.Int128"), Type("Orleans.Serialization.Codecs.Int128Codec")),
-                    new(Type("System.Half"), Type("Orleans.Serialization.Codecs.HalfCodec")),
+                    new(TypeOrDefault("System.UInt128"), TypeOrDefault("Orleans.Serialization.Codecs.UInt128Codec")),
+                    new(TypeOrDefault("System.Int128"), TypeOrDefault("Orleans.Serialization.Codecs.Int128Codec")),
+                    new(TypeOrDefault("System.Half"), TypeOrDefault("Orleans.Serialization.Codecs.HalfCodec")),
                     new(Type("System.Uri"), Type("Orleans.Serialization.Codecs.UriCodec")),
-                },
+                }.Where(desc => desc.UnderlyingType is {} && desc.CodecType is {}).ToArray(),
                 WellKnownCodecs = new WellKnownCodecDescription[]
                 {
                     new(Type("System.Exception"), Type("Orleans.Serialization.ExceptionCodec")),
@@ -266,7 +267,7 @@ INamedTypeSymbol TypeOrDefault(string metadataName)
         private INamedTypeSymbol UInt128;
         private INamedTypeSymbol Half;
         private INamedTypeSymbol[] _regularShallowCopyableTypes;
-        private INamedTypeSymbol[] RegularShallowCopyableType => _regularShallowCopyableTypes ??= new[]
+        private INamedTypeSymbol[] RegularShallowCopyableType => _regularShallowCopyableTypes ??= new List<INamedTypeSymbol>
         {
             TimeSpan,
             DateOnly,
@@ -285,7 +286,7 @@ INamedTypeSymbol TypeOrDefault(string metadataName)
             UInt128,
             Int128,
             Half
-        };
+        }.Where(t => t is {}).ToArray();
 
         public INamedTypeSymbol[] ImmutableAttributes { get; private set; }
         public INamedTypeSymbol Exception { get; private set; }

src/Orleans.Serialization.FSharp/Orleans.Serialization.FSharp.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageId>Microsoft.Orleans.Serialization.FSharp</PackageId>
-    <TargetFrameworks>$(DefaultTargetFrameworks)</TargetFrameworks>
+    <TargetFrameworks>$(DefaultTargetFrameworks);netstandard2.1</TargetFrameworks>
     <PackageDescription>F# core type support for Orleans.Serialization</PackageDescription>
     <OrleansBuildTimeCodeGen>true</OrleansBuildTimeCodeGen>
     <IsOrleansFrameworkPart>false</IsOrleansFrameworkPart>

src/Orleans.Serialization.NewtonsoftJson/Orleans.Serialization.NewtonsoftJson.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageId>Microsoft.Orleans.Serialization.NewtonsoftJson</PackageId>
-    <TargetFrameworks>$(DefaultTargetFrameworks)</TargetFrameworks>
+    <TargetFrameworks>$(DefaultTargetFrameworks);netstandard2.1</TargetFrameworks>
     <PackageDescription>Newtonsoft.Json integration for Orleans.Serialization</PackageDescription>
     <OrleansBuildTimeCodeGen>true</OrleansBuildTimeCodeGen>
     <IsOrleansFrameworkPart>false</IsOrleansFrameworkPart>

src/Orleans.Serialization.SystemTextJson/Orleans.Serialization.SystemTextJson.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageId>Microsoft.Orleans.Serialization.SystemTextJson</PackageId>
-    <TargetFrameworks>$(DefaultTargetFrameworks)</TargetFrameworks>
+    <TargetFrameworks>$(DefaultTargetFrameworks);netstandard2.1</TargetFrameworks>
     <PackageDescription>System.Text.Json integration for Orleans.Serialization</PackageDescription>
     <OrleansBuildTimeCodeGen>true</OrleansBuildTimeCodeGen>
     <IsOrleansFrameworkPart>false</IsOrleansFrameworkPart>

src/Orleans.Serialization.TestKit/CopierTester.cs

@@ -18,7 +18,11 @@ public abstract class CopierTester<TValue, TCopier> where TCopier : class, IDeep
 
         protected CopierTester(ITestOutputHelper output)
         {
+#if NET6_0_OR_GREATER
             var seed = Random.Shared.Next();
+#else
+            var seed = new Random().Next();
+#endif
             output.WriteLine($"Random seed: {seed}");
             Random = new(seed);
             var services = new ServiceCollection();
@@ -51,7 +55,7 @@ protected virtual void Configure(ISerializerBuilder builder)
         protected virtual bool Equals(TValue left, TValue right) => EqualityComparer<TValue>.Default.Equals(left, right);
 
         protected virtual Action<Action<TValue>> ValueProvider { get; }
-        
+
         [Fact]
         public void CopiedValuesAreEqual()
         {

src/Orleans.Serialization.TestKit/FieldCodecTester.cs

@@ -26,7 +26,11 @@ public abstract class FieldCodecTester<TValue, TCodec> : IDisposable where TCode
 
         protected FieldCodecTester(ITestOutputHelper output)
         {
+#if NET6_0_OR_GREATER
             var seed = Random.Shared.Next();
+#else
+            var seed = new Random().Next();
+#endif
             output.WriteLine($"Random seed: {seed}");
             Random = new(seed);
             var services = new ServiceCollection();
@@ -121,7 +125,7 @@ public void CorrectlyAdvancesReferenceCounterStream()
         public void CorrectlyAdvancesReferenceCounter()
         {
             var pipe = new Pipe();
-            using var writerSession = _sessionPool.GetSession(); 
+            using var writerSession = _sessionPool.GetSession();
             var writer = Writer.Create(pipe.Writer, writerSession);
             var writerCodec = CreateCodec();
             var beforeReference = writer.Session.ReferencedObjects.CurrentReferenceId;
@@ -139,7 +143,7 @@ public void CorrectlyAdvancesReferenceCounter()
             pipe.Writer.Complete();
 
             _ = pipe.Reader.TryRead(out var readResult);
-            using var readerSession = _sessionPool.GetSession(); 
+            using var readerSession = _sessionPool.GetSession();
             var reader = Reader.Create(readResult.Buffer, readerSession);
 
             var previousPos = reader.Position;

src/Orleans.Serialization.TestKit/Orleans.Serialization.TestKit.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageId>Microsoft.Orleans.Serialization.TestKit</PackageId>
-    <TargetFrameworks>$(DefaultTargetFrameworks)</TargetFrameworks>
+    <TargetFrameworks>$(DefaultTargetFrameworks);netstandard2.1</TargetFrameworks>
     <PackageDescription>Test kit for projects using Orleans.Serialization</PackageDescription>
     <IsOrleansFrameworkPart>false</IsOrleansFrameworkPart>
   </PropertyGroup>

src/Orleans.Serialization/Activators/DefaultActivator.cs

@@ -21,7 +21,7 @@ private static Func<T> Init()
             var il = method.GetILGenerator();
             il.Emit(OpCodes.Newobj, ctor);
             il.Emit(OpCodes.Ret);
-            return method.CreateDelegate<Func<T>>();
+            return (Func<T>)method.CreateDelegate(typeof(Func<T>));
         }
 
         public T Create() => _constructor is { } ctor ? ctor() : Unsafe.As<T>(FormatterServices.GetUninitializedObject(_type));