Merge pull request #587 from SteveDunn/565-support-for-trimming-no-re…

…flection-in-systemtextjson

Support for trimmed/no-reflection/AOT with System.Text.Json

Consumers.sln

@@ -21,6 +21,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApplication", "samples\W
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApplicationConsumer", "samples\WebApplicationConsumer\WebApplicationConsumer.csproj", "{CCFC28B7-3E56-4364-AAE9-83EC01FBE820}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AotTrimmedSample", "samples\AotTrimmedSample\AotTrimmedSample.csproj", "{99CBD5AD-854A-4678-8667-2D1C4434D551}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -43,6 +45,10 @@ Global
 		{CCFC28B7-3E56-4364-AAE9-83EC01FBE820}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{CCFC28B7-3E56-4364-AAE9-83EC01FBE820}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{CCFC28B7-3E56-4364-AAE9-83EC01FBE820}.Release|Any CPU.Build.0 = Release|Any CPU
+		{99CBD5AD-854A-4678-8667-2D1C4434D551}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{99CBD5AD-854A-4678-8667-2D1C4434D551}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{99CBD5AD-854A-4678-8667-2D1C4434D551}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{99CBD5AD-854A-4678-8667-2D1C4434D551}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

samples/AotTrimmedSample/AotTrimmedSample.csproj

@@ -0,0 +1,26 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <UseLocallyBuiltPackage>true</UseLocallyBuiltPackage>
+        <RootNamespace>MyApp</RootNamespace>
+        <RuntimeIdentifier>win-x64</RuntimeIdentifier>
+
+        <PublishTrimmed>true</PublishTrimmed>
+        <PublishAot>true</PublishAot>
+        <TrimMode>partial</TrimMode>
+        <JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>        
+    </PropertyGroup>
+
+    <ItemGroup Condition=" '$(UseLocallyBuiltPackage)' != ''">
+        <PackageReference Include="Vogen" Version="999.9.*" />
+    </ItemGroup>
+
+    <ItemGroup Condition=" '$(UseLocallyBuiltPackage)' == ''">
+        <PackageReference Include="Vogen" Version="999.9.10219943" />
+    </ItemGroup>
+
+</Project>

samples/AotTrimmedSample/Program.cs

@@ -0,0 +1,52 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Vogen;
+
+// to *not* generate the factory, use:
+// [assembly: VogenDefaults(systemTextJsonConverterFactoryGeneration: SystemTextJsonConverterFactoryGeneration.Omit)]
+
+Person person = new()
+{
+    Name = Name.From("Fred Flintstone"),
+    Age = Age.From(44),
+    Address = Address.From("201 Cobblestone Lane"),
+};
+
+var options = new JsonSerializerOptions
+{
+    WriteIndented = true,
+    Converters =
+    {
+        new VogenTypesFactory()
+    }
+};
+
+var ctx = new JsonSourceGenerationContext(options);
+
+var json = JsonSerializer.Serialize(person, ctx.Person);
+Person person2 = JsonSerializer.Deserialize(json, ctx.Person)!;
+
+Console.WriteLine(json);
+Console.WriteLine($"{person2.Name} is {person2.Age}, and lives at {person2.Address}");
+
+public class Person
+{
+    public Age Age { get; set; }
+    public Name Name { get; set; }
+    public Address Address { get; set; }
+}
+
+[ValueObject<int>]
+public partial struct Age {}
+
+[ValueObject<string>]
+public partial struct Name {}
+
+[ValueObject<string>]
+public partial struct Address {}
+
+[JsonSourceGenerationOptions(WriteIndented = true)]
+[JsonSerializable(typeof(Person))]
+internal partial class JsonSourceGenerationContext : JsonSerializerContext
+{
+}

samples/AotTrimmedSample/README.md

@@ -0,0 +1,35 @@
+An example of using Vogen with System.Text.Json (STJ) source-generated serialization.
+
+Reflection cannot be used in trimmed, and/or AOT compiled .NET applications.
+
+Additionally, STJ converters, as produced by Vogen, aren't available
+when STJ does its source generation.
+
+The solution to this is for Vogen to source-generate a 'factory', which tells
+STJ the respective converters for each value object generated.
+
+A typical example is something like:
+
+```c#
+var options = new JsonSerializerOptions
+{
+    WriteIndented = true,
+    Converters =
+    {
+        new VogenTypesFactory()
+    }
+};
+
+var ctx = new JsonSourceGenerationContext(options);
+
+var json = JsonSerializer.Serialize(person, ctx.Person);
+Person person2 = JsonSerializer.Deserialize(json, ctx.Person)!;
+```
+
+This sample produces a self-contained AOT binary for `win-x64`.
+
+**Note**
+If you _don't_ want the factory built, then this is configurable in the global config with:
+
+`[assembly: VogenDefaults(
+    systemTextJsonConverterFactoryGeneration: SystemTextJsonConverterFactoryGeneration.Omit)]`

src/Vogen.SharedTypes/SystemTextJsonConverterFactoryGeneration.cs

@@ -0,0 +1,22 @@
+using System.Diagnostics;
+
+namespace Vogen;
+
+/// <summary>
+/// Defines if a JSON converter 'factory' is generated containing value objects with System.Text.Json converters.
+/// These factories can be used in various scenarios with System.Text.Json, including source-generation.
+/// </summary>
+public enum SystemTextJsonConverterFactoryGeneration
+{
+    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+    Unspecified = -1,
+    /// <summary>
+    /// Do not generate the factory.
+    /// </summary>
+    Omit = 0,
+
+    /// <summary>
+    /// Generate the factory.
+    /// </summary>
+    Generate = 1
+}

src/Vogen.SharedTypes/ValueObjectAttribute.cs

@@ -5,7 +5,7 @@ namespace Vogen
 {
     using System;
 
-    // Generic attributes were introduced in .NET 5 and C# 9
+    // Generic attributes were introduced in C# 11
     /// <summary>
     /// Marks a type as a Value Object. The type should be partial so that the
     /// source generator can augment the type with equality and validation.

src/Vogen.SharedTypes/VogenDefaultsAttribute.cs

@@ -48,7 +48,8 @@ public VogenDefaultsAttribute(
         ParsableForStrings parsableForStrings = ParsableForStrings.GenerateMethodsAndInterface,
         ParsableForPrimitives parsableForPrimitives = ParsableForPrimitives.HoistMethodsAndInterfaces,
         TryFromGeneration tryFromGeneration = TryFromGeneration.Unspecified,
-        IsInitializedMethodGeneration isInitializedMethodGeneration = IsInitializedMethodGeneration.Unspecified
+        IsInitializedMethodGeneration isInitializedMethodGeneration = IsInitializedMethodGeneration.Unspecified,
+        SystemTextJsonConverterFactoryGeneration systemTextJsonConverterFactoryGeneration = SystemTextJsonConverterFactoryGeneration.Unspecified
         )
     {
     }

src/Vogen/AnalyzerReleases.Shipped.md

@@ -18,4 +18,12 @@ VOG025 | Usage | Error | DoNotUseReflection
 
 Rule ID | Category | Severity | Notes
 --------|----------|----------|-------
-VOG026 | Usage | Warning  | DoNotDeriveFromVogenAttributes
+VOG026 | Usage | Warning  | DoNotDeriveFromVogenAttributes
+
+## Release 4.0.2
+
+### New Rules
+
+Rule ID | Category | Severity | Notes
+--------|----------|----------|-------
+VOG027 | Usage | Error | DoNotUseNewAnalyzer

src/Vogen/AnalyzerReleases.Unshipped.md

@@ -5,4 +5,3 @@
 
 Rule ID | Category | Severity | Notes
 --------|----------|----------|-------
-VOG027 | Usage | Error | DoNotUseNewAnalyzer

src/Vogen/BuildConfigurationFromAttributes.cs

@@ -30,7 +30,8 @@ internal class BuildConfigurationFromAttributes
     private ParsableForStrings _parsableForStrings; 
     private ParsableForPrimitives _parsableForPrimitives; 
     private TryFromGeneration _tryFromGeneration; 
-    private IsInitializedMethodGeneration _isInitializedMethodGeneration; 
+    private IsInitializedMethodGeneration _isInitializedMethodGeneration;
+    private SystemTextJsonConverterFactoryGeneration _systemTextJsonConverterFactoryGeneration;
 
     private BuildConfigurationFromAttributes(AttributeData att)
     {
@@ -51,6 +52,7 @@ private BuildConfigurationFromAttributes(AttributeData att)
         _hasErroredAttributes = false;
         _tryFromGeneration = TryFromGeneration.Unspecified;
         _isInitializedMethodGeneration = IsInitializedMethodGeneration.Unspecified;
+        _systemTextJsonConverterFactoryGeneration = SystemTextJsonConverterFactoryGeneration.Unspecified;
 
        _diagnostics = new List<Diagnostic>();
 
@@ -108,7 +110,8 @@ private VogenConfigurationBuildResult Build(bool argsAreFromVogenDefaultAttribut
                 _parsableForStrings,
                 _parsableForPrimitives,
                 _tryFromGeneration,
-                _isInitializedMethodGeneration),
+                _isInitializedMethodGeneration,
+                _systemTextJsonConverterFactoryGeneration),
             diagnostics: _diagnostics);
     }
 
@@ -180,7 +183,7 @@ private void PopulateDiagnosticsWithAnyValidationIssues()
     // ReSharper disable once CognitiveComplexity
     private void PopulateFromVogenDefaultsAttributeArgs(ImmutableArray<TypedConstant> argsExcludingUnderlyingType)
     {
-        if (argsExcludingUnderlyingType.Length > 12)
+        if (argsExcludingUnderlyingType.Length > 13)
         {
             throw new InvalidOperationException("Too many arguments for the attribute.");
         }
@@ -194,6 +197,11 @@ private void PopulateFromVogenDefaultsAttributeArgs(ImmutableArray<TypedConstant
                 continue;
             }
 
+            if (i == 12)
+            {
+                _systemTextJsonConverterFactoryGeneration = (SystemTextJsonConverterFactoryGeneration) v;
+            }
+
             if (i == 11)
             {
                 _isInitializedMethodGeneration = (IsInitializedMethodGeneration) v;

src/Vogen/Templates/AnyOtherType/AnyOtherType_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Boolean/Boolean_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Byte/Byte_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Char/Char_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/DateOnly/DateOnly_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 #if NET7_0_OR_GREATER_DO_NOT_USE
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {
@@ -12,7 +12,7 @@ public override void Write(System.Text.Json.Utf8JsonWriter writer, VOTYPE value,
             }
         }
 #elif NET6_0_OR_GREATER
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/DateTime/DateTime_SystemTextJsonConverter.cs

@@ -1,4 +1,4 @@
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/DateTimeOffset/DateTimeOffset_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Decimal/Decimal_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Double/Double_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Guid/Guid_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Int/Int_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Long/Long_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Short/Short_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/Single/Single_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/String/String_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {

src/Vogen/Templates/TimeOnly/TimeOnly_SystemTextJsonConverter.cs

@@ -1,5 +1,5 @@
 #if NET7_0_OR_GREATER_DO_NOT_USE // as of .NET 7, STJ doesn't seem to have a `GetTimeOnly` method
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {
@@ -12,7 +12,7 @@ public override void Write(System.Text.Json.Utf8JsonWriter writer, VOTYPE value,
             }
         }
 #elif NET6_0_OR_GREATER
-        class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
+        internal class VOTYPESystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<VOTYPE>
         {
             public override VOTYPE Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options)
             {