Prevent external codecs from serializing types which are abstract, ge…

…nerated, or from the framework itself (#8765)
dotnet · Dec 13, 2023 · d6894ae · d6894ae
1 parent eca20f5
commit d6894ae
Show file tree

Hide file tree

Showing 11 changed files with 312 additions and 119 deletions.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -28,4 +28,9 @@
     <SourceLinkCreate>true</SourceLinkCreate>
     <SourceLinkOriginUrl>https://github.com/dotnet/orleans</SourceLinkOriginUrl>
   </PropertyGroup>
+
+  <ItemGroup>
+    <AssemblyAttribute Include="Orleans.Metadata.FrameworkPartAttribute" />
+  </ItemGroup>
+
 </Project>
diff --git a/src/Orleans.Analyzers/Orleans.Analyzers.csproj b/src/Orleans.Analyzers/Orleans.Analyzers.csproj
@@ -37,4 +37,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <ItemGroup>
+    <AssemblyAttribute Remove="Orleans.Metadata.FrameworkPartAttribute"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Orleans.CodeGenerator/Orleans.CodeGenerator.csproj b/src/Orleans.CodeGenerator/Orleans.CodeGenerator.csproj
@@ -62,4 +62,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <ItemGroup>
+    <AssemblyAttribute Remove="Orleans.Metadata.FrameworkPartAttribute"/>
+  </ItemGroup>
+
 </Project>
diff --git a/src/Orleans.Serialization.Abstractions/FrameworkPartAttribute.cs b/src/Orleans.Serialization.Abstractions/FrameworkPartAttribute.cs
@@ -0,0 +1,13 @@
+using System;
+using System.ComponentModel;
+
+namespace Orleans.Metadata;
+
+/// <summary>
+/// Specifies that an assembly does not contain application code.
+/// </summary>
+[AttributeUsage(AttributeTargets.Assembly)]
+[EditorBrowsable(EditorBrowsableState.Never)]
+public sealed class FrameworkPartAttribute : Attribute
+{
+}
diff --git a/src/Orleans.Serialization.NewtonsoftJson/NewtonsoftJsonCodec.cs b/src/Orleans.Serialization.NewtonsoftJson/NewtonsoftJsonCodec.cs
@@ -1,9 +1,12 @@
 using System;
+using System.CodeDom.Compiler;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Reflection;
 using Microsoft.Extensions.Options;
 using Newtonsoft.Json;
+using Orleans.Metadata;
 using Orleans.Serialization.Buffers;
 using Orleans.Serialization.Buffers.Adaptors;
 using Orleans.Serialization.Cloning;
@@ -124,6 +127,11 @@ bool IGeneralizedCodec.IsSupportedType(Type type)
             return true;
         }
 
+        if (CommonCodecTypeFilter.IsAbstractOrFrameworkType(type))
+        {
+            return false;
+        }
+
         foreach (var selector in _serializableTypeSelectors)
         {
             if (selector.IsSupportedType(type))
@@ -173,6 +181,11 @@ object IDeepCopier.DeepCopy(object input, CopyContext context)
     /// <inheritdoc/>
     bool IGeneralizedCopier.IsSupportedType(Type type)
     {
+        if (CommonCodecTypeFilter.IsAbstractOrFrameworkType(type))
+        {
+            return false;
+        }
+
         foreach (var selector in _copyableTypeSelectors)
         {
             if (selector.IsSupportedType(type))

diff --git a/src/Orleans.Serialization.SystemTextJson/JsonCodec.cs b/src/Orleans.Serialization.SystemTextJson/JsonCodec.cs
@@ -2,8 +2,10 @@
 using System.Buffers;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 using System.Text.Json;
 using Microsoft.Extensions.Options;
+using Orleans.Metadata;
 using Orleans.Serialization.Buffers;
 using Orleans.Serialization.Buffers.Adaptors;
 using Orleans.Serialization.Cloning;
@@ -158,6 +160,11 @@ bool IGeneralizedCodec.IsSupportedType(Type type)
             return true;
         }
 
+        if (CommonCodecTypeFilter.IsAbstractOrFrameworkType(type))
+        {
+            return false;
+        }
+
         foreach (var selector in _serializableTypeSelectors)
         {
             if (selector.IsSupportedType(type))
@@ -204,6 +211,11 @@ object IDeepCopier.DeepCopy(object input, CopyContext context)
     /// <inheritdoc/>
     bool IGeneralizedCopier.IsSupportedType(Type type)
     {
+        if (CommonCodecTypeFilter.IsAbstractOrFrameworkType(type))
+        {
+            return false;
+        }
+
         foreach (var selector in _copyableTypeSelectors)
         {
             if (selector.IsSupportedType(type))

diff --git a/src/Orleans.Serialization/Codecs/CommonCodecTypeFilter.cs b/src/Orleans.Serialization/Codecs/CommonCodecTypeFilter.cs
@@ -0,0 +1,31 @@
+using System;
+using System.CodeDom.Compiler;
+using System.Linq;
+using System.Reflection;
+
+using Orleans.Metadata;
+
+namespace Orleans.Serialization.Codecs;
+
+/// <summary>
+/// Defines common type filtering operations.
+/// </summary>
+public class CommonCodecTypeFilter
+{
+    /// <summary>
+    /// Returns true if the provided type is a framework or abstract type.
+    /// </summary>
+    /// <param name="type">The type to check.</param>
+    /// <returns><see langword="true"/> if the type is a framework or abstract type, otherwise <see langword="false"/>.</returns>
+    public static bool IsAbstractOrFrameworkType(Type type)
+    {
+        if (type.IsAbstract
+            || type.GetCustomAttributes<GeneratedCodeAttribute>().Any(a => a.Tool.Equals("OrleansCodeGen"))
+            || type.Assembly.GetCustomAttribute<FrameworkPartAttribute>() is not null)
+        {
+            return true;
+        }
+
+        return false;
+    }
+}
diff --git a/src/Serializers/Orleans.Serialization.Protobuf/ProtobufCodec.cs b/src/Serializers/Orleans.Serialization.Protobuf/ProtobufCodec.cs
@@ -1,4 +1,5 @@
 using Google.Protobuf;
+using Orleans.Metadata;
 using Orleans.Serialization.Buffers;
 using Orleans.Serialization.Cloning;
 using Orleans.Serialization.Codecs;
@@ -8,6 +9,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 
 namespace Orleans.Serialization;
 
@@ -68,6 +70,11 @@ bool IGeneralizedCodec.IsSupportedType(Type type)
             return true;
         }
 
+        if (CommonCodecTypeFilter.IsAbstractOrFrameworkType(type))
+        {
+            return false;
+        }
+
         foreach (var selector in _serializableTypeSelectors)
         {
             if (selector.IsSupportedType(type))
@@ -82,6 +89,11 @@ bool IGeneralizedCodec.IsSupportedType(Type type)
     /// <inheritdoc/>
     bool IGeneralizedCopier.IsSupportedType(Type type)
     {
+        if (CommonCodecTypeFilter.IsAbstractOrFrameworkType(type))
+        {
+            return false;
+        }
+
         foreach (var selector in _copyableTypeSelectors)
         {
             if (selector.IsSupportedType(type))

diff --git a/test/NonSilo.Tests/NonSilo.Tests.csproj b/test/NonSilo.Tests/NonSilo.Tests.csproj
@@ -9,6 +9,8 @@
     <ProjectReference Include="$(SourceRoot)test\Tester\Tester.csproj" />
     <ProjectReference Include="$(SourceRoot)src\Orleans.Serialization.NewtonsoftJson\Orleans.Serialization.NewtonsoftJson.csproj" />
     <ProjectReference Include="$(SourceRoot)test\Misc\TestInternalDtosRefOrleans\TestInternalDtosRefOrleans.csproj" />
+    <ProjectReference Include="..\..\src\Orleans.Serialization.SystemTextJson\Orleans.Serialization.SystemTextJson.csproj" />
+    <ProjectReference Include="..\..\src\Serializers\Orleans.Serialization.Protobuf\Orleans.Serialization.Protobuf.csproj" />
   </ItemGroup>
 
   <ItemGroup>