explicitly list dlls to load; support trimming better

Author: gregsdennis

LearnJsonEverything/LearnJsonEverything.csproj

@@ -5,9 +5,9 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
 	  <NoWarn>NU1701</NoWarn>
-	  <PublishTrimmed>false</PublishTrimmed>
 	  <LangVersion>latest</LangVersion>
     <WasmEnableWebcil>false</WasmEnableWebcil>
+    <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
   </PropertyGroup>
 
   <ItemGroup>

LearnJsonEverything/Services/CompilationHelpers.cs

@@ -0,0 +1,53 @@
+using Microsoft.CodeAnalysis;
+
+namespace LearnJsonEverything.Services;
+
+public static class CompilationHelpers
+{
+	private static MetadataReference[]? _references;
+
+	private static readonly string[] _ensuredAssemblies =
+	[
+		"Json.More",
+		"JsonPointer.Net",
+		"JsonSchema.Net",
+		"LearnJsonEverything.Template",
+	];
+
+	public static async Task<MetadataReference[]> LoadAssemblyReferences(HttpClient client)
+	{
+		if (_references is null)
+		{
+			var refs = AppDomain.CurrentDomain.GetAssemblies();
+			var names = refs
+				.Where(x => !x.IsDynamic)
+				.Select(x => x.FullName!.Split(',')[0])
+				.Concat(_ensuredAssemblies)
+				.OrderBy(x => x)
+				.ToArray();
+			
+			var references = new MetadataReference[names.Length];
+			int i = 0;
+			foreach (var assemblyName in names)
+			{
+				var source = $"/_framework/{assemblyName}.dll";
+				try
+				{
+					var stream = await client.GetStreamAsync(source);
+					Console.WriteLine($"Loading {assemblyName}...");
+					references[i] = MetadataReference.CreateFromStream(stream);
+					i++;
+				}
+				catch (Exception e)
+				{
+					Console.WriteLine(e);
+					Console.WriteLine(source);
+				}
+			}
+
+			_references = references;
+		}
+
+		return _references;
+	}
+}

LearnJsonEverything/Services/DataManager.cs

@@ -10,7 +10,7 @@ public class DataManager
 	public DataManager(ILocalStorageService localStorage)
 	{
 		_localStorage = localStorage;
-		_cache = new Dictionary<string, string>();
+		_cache = [];
 	}
 
 	public async Task Set(string key, string value)
@@ -26,7 +26,10 @@ public async Task Set(string key, string value)
 
 		value = await _localStorage.GetItemAsync<string>(key);
 
-		_cache[key] = value;
+		if (value is null)
+			_cache.Remove(key);
+		else
+			_cache[key] = value;
 
 		return value;
 	}

LearnJsonEverything/Services/LessonData.cs

@@ -1,5 +1,7 @@
 using System.Text.Json.Nodes;
 
+#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
+
 namespace LearnJsonEverything.Services;
 
 public class LessonData
@@ -9,5 +11,5 @@ public class LessonData
 	public string Title { get; set; }
 	public string Instructions { get; set; }
 	public string ContextCode { get; set; }
-	public JsonArray? Tests { get; set; }
+	public JsonArray Tests { get; set; }
 }

LearnJsonEverything/Services/LessonPlan.cs

@@ -1,4 +1,5 @@
-using System.Text.Json.Serialization;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace LearnJsonEverything.Services;
 
@@ -37,4 +38,21 @@ public LessonPlan(LessonData[] lessonData)
 
 		return _lessonData[index];
 	}
+}
+
+public class LessonPlanJsonConverter : JsonConverter<LessonPlan>
+{
+	public override LessonPlan? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+	{
+#pragma warning disable IL2026 // Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code
+		var lessonData = JsonSerializer.Deserialize<LessonData[]>(ref reader, options)!;
+#pragma warning restore IL2026 // Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code
+
+		return new LessonPlan(lessonData);
+	}
+
+	public override void Write(Utf8JsonWriter writer, LessonPlan value, JsonSerializerOptions options)
+	{
+		throw new NotImplementedException();
+	}
 }

LearnJsonEverything/Services/LessonPlanJsonConverter.cs

@@ -1,4 +1,5 @@
-using System.Reflection;
+using System.Diagnostics.CodeAnalysis;
+using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Nodes;
 using Json.More;
@@ -12,7 +13,7 @@ namespace LearnJsonEverything.Services.Runners;
 
 public static class SchemaRunner
 {
-	private class SchemaTest
+	public class SchemaTest
 	{
 		public JsonNode? Instance { get; set; }
 		public bool IsValid { get; set; }
@@ -40,10 +41,6 @@ private class SchemaTest
 	private const string WarnIcon = "⚠";
 	private const string MessageIcon = "ⓘ";
 
-	//public static string ErrorIcon = "<span style=\"foreground:red;\">❌</span>";
-	//public static string WarnIcon = "<span style=\"foreground:amber;\">⚠</span>";
-	//public static string MessageIcon = "<span style=\"foreground:lightblue;\">ⓘ</span>";
-
 	public static string BuildInstructions(LessonData lesson) => Instructions
 		.Replace("/* TITLE */", lesson.Title)
 		.Replace("/* INSTRUCTIONS */", lesson.Instructions)
@@ -52,21 +49,18 @@ public static string BuildInstructions(LessonData lesson) => Instructions
 
 	private static string BuildTestList(JsonArray testData)
 	{
-		var tests = testData.Deserialize<SchemaTest[]>(SerializerOptions);
-		var lines = new List<string>
-		{
+		var tests = testData.Deserialize(SerializerContext.Default.SchemaTestArray)!;
+		string[] lines =
+		[
 			"| Instance | Is Valid |",
-			"|:-|:-:|"
-		};
-
-		foreach (var test in tests)
-		{
-			lines.Add($"|`{test.Instance.AsJsonString()}`|{test.IsValid}|");
-		}
+			"|:-|:-:|",
+			.. tests.Select(test => $"|`{test.Instance.AsJsonString()}`|{test.IsValid}|")
+		];
 
 		return string.Join(Environment.NewLine, lines);
 	}
 
+	[RequiresUnreferencedCode("")]
 	public static string[] Run(string userCode, LessonData lesson, MetadataReference[] references)
 	{
 		var fullSource = lesson.ContextCode
@@ -106,7 +100,7 @@ public static string[] Run(string userCode, LessonData lesson, MetadataReference
 		var type = assembly.DefinedTypes.Single(x => !x.IsInterface && x.ImplementedInterfaces.Contains(typeof(ILessonRunner<EvaluationResults>)));
 		var runner = (ILessonRunner<EvaluationResults>) Activator.CreateInstance(type)!;
 
-		var tests = lesson.Tests.Deserialize<SchemaTest[]>(SerializerOptions);
+		var tests = lesson.Tests.Deserialize(SerializerContext.Default.SchemaTestArray)!;
 		var results = new List<string>();
 
 		foreach (var test in tests)
@@ -117,12 +111,6 @@ public static string[] Run(string userCode, LessonData lesson, MetadataReference
 
 		// run the code
 
-		return results.ToArray();
-	}
-
-	private static string ToLiteral(this string valueTextForCompiler)
-	{
-		var formatted = SymbolDisplay.FormatLiteral(valueTextForCompiler, true);
-		return formatted;
+		return [.. results];
 	}
 }

LearnJsonEverything/Services/Runners/SchemaRunner.cs

@@ -1,15 +1,28 @@
-using System.Text.Encodings.Web;
-using System.Text.Json;
+using LearnJsonEverything.Services.Runners;
+using Microsoft.CodeAnalysis.CSharp;
+using System.Text.Json.Nodes;
+using System.Text.Json.Serialization;
+using Json.Schema;
 
-namespace LearnJsonEverything.Services
+namespace LearnJsonEverything.Services;
+
+public static class SerializationHelpers
 {
-	public static class SerializationHelpers
+	public static string ToLiteral(this string valueTextForCompiler)
 	{
-		public static readonly JsonSerializerOptions SerializerOptions = new()
-		{
-			WriteIndented = true,
-			Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
-			PropertyNameCaseInsensitive = true
-		};
+		var formatted = SymbolDisplay.FormatLiteral(valueTextForCompiler, true);
+		return formatted;
 	}
 }
+
+[JsonSerializable(typeof(JsonSchema))]
+[JsonSerializable(typeof(JsonNode))]
+[JsonSerializable(typeof(JsonObject))]
+[JsonSerializable(typeof(JsonArray))]
+[JsonSerializable(typeof(LessonPlan))]
+[JsonSerializable(typeof(LessonData))]
+[JsonSerializable(typeof(LessonData[]))]
+[JsonSerializable(typeof(SchemaRunner.SchemaTest))]
+[JsonSerializable(typeof(SchemaRunner.SchemaTest[]))]
+[JsonSourceGenerationOptions(WriteIndented = true, PropertyNameCaseInsensitive = true)]
+internal partial class SerializerContext : JsonSerializerContext;

LearnJsonEverything/Services/SerializationHelpers.cs

@@ -23,6 +23,7 @@
 
 
 @code {
+#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
 	[Parameter]
 	public string Title { get; set; }
 	[Parameter]
@@ -35,4 +36,5 @@
 	public string DocsUrl { get; set; }
 	[Parameter]
 	public bool Flipped { get; set; }
+#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
 }

LearnJsonEverything/Shared/Feature.razor

@@ -51,7 +51,6 @@
 #pragma warning disable CS8618
 	private StandaloneCodeEditor _codeEditor;
 	private StandaloneCodeEditor _outputEditor;
-	private MetadataReference[] _references;
 	private LessonPlan _lessons;
 	private LessonData? _currentLesson;
 
@@ -71,7 +70,7 @@
 			var userCode = await _codeEditor.GetValue();
 
 			await _outputEditor.SetValue("");
-			var results = SchemaRunner.Run(userCode, _currentLesson!, _references);
+			var results = SchemaRunner.Run(userCode, _currentLesson!, await CompilationHelpers.LoadAssemblyReferences(Client));
 			await _outputEditor.SetValue(string.Join(Environment.NewLine, results!));
 		}
 		catch (Exception e)
@@ -81,76 +80,45 @@
 		}
 	}
 
-	private Task PreviousLesson()
+	private void PreviousLesson()
 	{
 		_currentLesson = _lessons.GetPrevious(_currentLesson?.Id);
-		return LoadLesson();
+		LoadLesson();
 	}
 
-	private Task NextLesson()
+	private void NextLesson()
 	{
 		_currentLesson = _lessons.GetNext(_currentLesson?.Id);
-		return LoadLesson();
+		LoadLesson();
 	}
 
-	private Task Reset()
+	private void Reset()
 	{
-		return LoadLesson();
+		LoadLesson();
 	}
 
-	private async Task LoadLesson()
+	private void LoadLesson()
 	{
 		_currentLesson ??= _lessons[0];
 		Instructions = SchemaRunner.BuildInstructions(_currentLesson);
 	}
 
 	protected override async Task OnInitializedAsync()
 	{
-		await LoadAssemblyReferences();
+		_ = await CompilationHelpers.LoadAssemblyReferences(Client);
 		await DownloadLessonPlan();
 
-		await LoadLesson();
+		LoadLesson();
 
 		await base.OnInitializedAsync();
 	}
 
-	private async Task LoadAssemblyReferences()
-	{
-		var refs = AppDomain.CurrentDomain.GetAssemblies();
-
-		var references = new MetadataReference[refs.Length];
-
-		foreach (var reference in refs.Where(x => !x.IsDynamic))
-		{
-			Console.WriteLine($"{reference.FullName}\n  Location - {reference.Location}\n");
-		}
-
-		int i = 0;
-		foreach (var reference in refs.Where(x => !x.IsDynamic))
-		{
-			var source = $"/_framework/{reference.FullName!.Split(',')[0]}.dll";
-			try
-			{
-				var stream = await Client.GetStreamAsync(source);
-				references[i] = MetadataReference.CreateFromStream(stream);
-				i++;
-			}
-			catch (Exception e)
-			{
-				Console.WriteLine(e);
-				Console.WriteLine(source);
-			}
-		}
-
-		_references = references.ToArray();
-	}
-
 	private async Task DownloadLessonPlan()
 	{
 		var yamlText = await Client.GetStringAsync(LessonSource);
 		var yaml = YamlSerializer.Parse(yamlText);
 		var json = yaml.ToJsonNode().FirstOrDefault();
 		Console.WriteLine(json.AsJsonString());
-		_lessons = json.Deserialize<LessonPlan>(SerializerOptions)!;
+		_lessons = json.Deserialize(SerializerContext.Default.LessonPlan)!;
 	}
 }