Fix Validation SG for non-Web SDK projects (#63687)

Author: oroztocil

src/Shared/RoslynUtils/WellKnownTypes.cs

@@ -58,7 +58,28 @@ public INamedTypeSymbol Get(SpecialType type)
         return _compilation.GetSpecialType(type);
     }
 
+    /// <summary>
+    /// Returns the type symbol for the specified well-known type, or throws if the type cannot be found.
+    /// </summary>
     public INamedTypeSymbol Get(WellKnownTypeData.WellKnownType type)
+    {
+        return Get(type, throwOnNotFound: true);
+    }
+
+    /// <summary>
+    /// Returns the type symbol for the specified well-known type, or a special marker type symbol if the type cannot be found.
+    /// </summary>
+    /// <remarks>
+    /// We use a special marker type for cases where some types can be legitimately missing.
+    /// E.g. The Microsoft.Extensions.Validation source generator checks against some types
+    /// from the shared framework which are missing in Blazor WebAssembly SDK projects.
+    /// </remarks>
+    public INamedTypeSymbol GetOptional(WellKnownTypeData.WellKnownType type)
+    {
+        return Get(type, throwOnNotFound: false);
+    }
+
+    private INamedTypeSymbol Get(WellKnownTypeData.WellKnownType type, bool throwOnNotFound)
     {
         var index = (int)type;
         var symbol = _lazyWellKnownTypes[index];
@@ -69,16 +90,22 @@ public INamedTypeSymbol Get(WellKnownTypeData.WellKnownType type)
 
         // Symbol hasn't been added to the cache yet.
         // Resolve symbol from name, cache, and return.
-        return GetAndCache(index);
+        return GetAndCache(index, throwOnNotFound);
     }
 
-    private INamedTypeSymbol GetAndCache(int index)
+    private INamedTypeSymbol GetAndCache(int index, bool throwOnNotFound)
     {
         var result = GetTypeByMetadataNameInTargetAssembly(WellKnownTypeData.WellKnownTypeNames[index]);
-        if (result == null)
+
+        if (result == null && throwOnNotFound)
         {
             throw new InvalidOperationException($"Failed to resolve well-known type '{WellKnownTypeData.WellKnownTypeNames[index]}'.");
         }
+        else
+        {
+            result ??= _compilation.GetTypeByMetadataName(typeof(MissingType).FullName!)!;
+        }
+
         Interlocked.CompareExchange(ref _lazyWellKnownTypes[index], result, null);
 
         // GetTypeByMetadataName should always return the same instance for a name.
@@ -159,4 +186,6 @@ public static bool Implements(ITypeSymbol? type, ITypeSymbol interfaceType)
         }
         return false;
     }
+
+    internal class MissingType { }
 }

src/Validation/gen/Extensions/ITypeSymbolExtensions.cs

@@ -95,13 +95,13 @@ internal static bool ImplementsInterface(this ITypeSymbol type, ITypeSymbol inte
     // types themselves so we short-circuit on them.
     internal static bool IsExemptType(this ITypeSymbol type, WellKnownTypes wellKnownTypes)
     {
-        return SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_HttpContext))
-               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_HttpRequest))
-               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_HttpResponse))
+        return SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.GetOptional(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_HttpContext))
+               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.GetOptional(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_HttpRequest))
+               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.GetOptional(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_HttpResponse))
                || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.System_Threading_CancellationToken))
-               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_IFormCollection))
-               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_IFormFileCollection))
-               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_IFormFile))
+               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.GetOptional(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_IFormCollection))
+               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.GetOptional(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_IFormFileCollection))
+               || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.GetOptional(WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_IFormFile))
                || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.System_IO_Stream))
                || SymbolEqualityComparer.Default.Equals(type, wellKnownTypes.Get(WellKnownTypeData.WellKnownType.System_IO_Pipelines_PipeReader));
     }

src/Validation/gen/Parsers/ValidationsGenerator.TypesParser.cs

@@ -27,9 +27,9 @@ internal ImmutableArray<ValidatableType> ExtractValidatableTypes(IInvocationOper
             ? method.Parameters
             : [];
 
-        var fromServiceMetadataSymbol = wellKnownTypes.Get(
+        var fromServiceMetadataSymbol = wellKnownTypes.GetOptional(
             WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_Metadata_IFromServiceMetadata);
-        var fromKeyedServiceAttributeSymbol = wellKnownTypes.Get(
+        var fromKeyedServiceAttributeSymbol = wellKnownTypes.GetOptional(
             WellKnownTypeData.WellKnownType.Microsoft_Extensions_DependencyInjection_FromKeyedServicesAttribute);
         var skipValidationAttributeSymbol = wellKnownTypes.Get(
             WellKnownTypeData.WellKnownType.Microsoft_Extensions_Validation_SkipValidationAttribute);
@@ -127,9 +127,9 @@ internal ImmutableArray<ValidatableProperty> ExtractValidatableMembers(ITypeSymb
         var members = new List<ValidatableProperty>();
         var resolvedRecordProperty = new List<IPropertySymbol>();
 
-        var fromServiceMetadataSymbol = wellKnownTypes.Get(
+        var fromServiceMetadataSymbol = wellKnownTypes.GetOptional(
             WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_Metadata_IFromServiceMetadata);
-        var fromKeyedServiceAttributeSymbol = wellKnownTypes.Get(
+        var fromKeyedServiceAttributeSymbol = wellKnownTypes.GetOptional(
             WellKnownTypeData.WellKnownType.Microsoft_Extensions_DependencyInjection_FromKeyedServicesAttribute);
         var jsonIgnoreAttributeSymbol = wellKnownTypes.Get(
             WellKnownTypeData.WellKnownType.System_Text_Json_Serialization_JsonIgnoreAttribute);

src/Validation/src/Microsoft.Extensions.Validation.csproj

@@ -11,6 +11,19 @@
     <EnableDefaultItems>true</EnableDefaultItems>
   </PropertyGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="$(RepoRoot)src\Validation\gen\Microsoft.Extensions.Validation.ValidationsGenerator.csproj" Pack="false">
+      <ReferenceOutputAssembly>false</ReferenceOutputAssembly>
+      <OutputItemType>Content</OutputItemType>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </ProjectReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <!-- Package the generator in the analyzer directory of the nuget package -->
+    <None Include="$(OutputPath)\$(AssemblyName).ValidationsGenerator.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
+  </ItemGroup>
+
   <ItemGroup>
     <Reference Include="Microsoft.Extensions.DependencyInjection.Abstractions" />
     <Reference Include="Microsoft.Extensions.Options" />