Use System.Text.Json's source generated code to deserialize WebEvents #32374
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,21 +6,26 @@ | |
| using System; | ||
| using System.Diagnostics.CodeAnalysis; | ||
| using System.Text.Json; | ||
| using System.Text.Json.Serialization; | ||
| using System.Text.Json.Serialization.Metadata; | ||
| using Microsoft.AspNetCore.Components.RenderTree; | ||
|
|
||
| namespace Microsoft.AspNetCore.Components.Web | ||
| { | ||
| internal class WebEventData | ||
| { | ||
| // This class represents the second half of parsing incoming event data, | ||
| // once the event ID (and possibly the type of the eventArgs) becomes known. | ||
| public static WebEventData Parse( | ||
| Renderer renderer, | ||
| WebEventJsonContext jsonSerializerContext, | ||
| string eventDescriptorJson, | ||
| string eventArgsJson) | ||
| { | ||
| WebEventDescriptor eventDescriptor; | ||
| try | ||
| { | ||
| eventDescriptor = Deserialize(eventDescriptorJson, jsonSerializerContext.WebEventDescriptor); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
|
|
@@ -29,14 +34,18 @@ public static WebEventData Parse(Renderer renderer, JsonSerializerOptions jsonSe | |
|
|
||
| return Parse( | ||
| renderer, | ||
| jsonSerializerContext, | ||
| eventDescriptor, | ||
| eventArgsJson); | ||
| } | ||
|
|
||
| public static WebEventData Parse( | ||
| Renderer renderer, | ||
| WebEventJsonContext jsonSerializerContext, | ||
| WebEventDescriptor eventDescriptor, | ||
| string eventArgsJson) | ||
| { | ||
| var parsedEventArgs = ParseEventArgsJson(renderer, jsonSerializerContext, eventDescriptor.EventHandlerId, eventDescriptor.EventName, eventArgsJson); | ||
| return new WebEventData( | ||
| eventDescriptor.BrowserRendererId, | ||
| eventDescriptor.EventHandlerId, | ||
|
|
@@ -60,29 +69,35 @@ private WebEventData(int browserRendererId, ulong eventHandlerId, EventFieldInfo | |
|
|
||
| public EventArgs EventArgs { get; } | ||
|
|
||
| private static EventArgs ParseEventArgsJson( | ||
| Renderer renderer, | ||
| WebEventJsonContext jsonSerializerContext, | ||
| ulong eventHandlerId, | ||
| string eventName, | ||
| string eventArgsJson) | ||
| { | ||
| try | ||
| { | ||
| if (TryDeserializeStandardWebEventArgs(eventName, eventArgsJson, jsonSerializerContext, out var eventArgs)) | ||
| { | ||
| return eventArgs; | ||
| } | ||
|
|
||
| // For custom events, the args type is determined from the associated delegate | ||
| var eventArgsType = renderer.GetEventArgsType(eventHandlerId); | ||
| return (EventArgs)JsonSerializer.Deserialize(eventArgsJson, eventArgsType, jsonSerializerContext.Options)!; | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| throw new InvalidOperationException($"There was an error parsing the event arguments. EventId: '{eventHandlerId}'.", e); | ||
| } | ||
| } | ||
|
|
||
| private static bool TryDeserializeStandardWebEventArgs( | ||
| string eventName, | ||
| string eventArgsJson, | ||
| WebEventJsonContext jsonSerializerContext, | ||
| [NotNullWhen(true)] out EventArgs? eventArgs) | ||
| { | ||
| // For back-compatibility, we recognize the built-in list of web event names and hard-code | ||
| // rules about the deserialization type for their eventargs. This makes it possible to declare | ||
|
|
@@ -97,13 +112,13 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| case "change": | ||
| // Special case for ChangeEventArgs because its value type can be one of | ||
| // several types, and System.Text.Json doesn't pick types dynamically | ||
| eventArgs = DeserializeChangeEventArgs(eventArgsJson, jsonSerializerContext); | ||
| return true; | ||
|
|
||
| case "copy": | ||
| case "cut": | ||
| case "paste": | ||
| eventArgs = Deserialize<ClipboardEventArgs>(eventArgsJson, jsonSerializerContext.ClipboardEventArgs); | ||
| return true; | ||
|
|
||
| case "drag": | ||
|
|
@@ -113,20 +128,20 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| case "dragover": | ||
| case "dragstart": | ||
| case "drop": | ||
| eventArgs = Deserialize<DragEventArgs>(eventArgsJson, jsonSerializerContext.DragEventArgs); | ||
| return true; | ||
|
|
||
| case "focus": | ||
| case "blur": | ||
| case "focusin": | ||
| case "focusout": | ||
| eventArgs = Deserialize<FocusEventArgs>(eventArgsJson, jsonSerializerContext.FocusEventArgs); | ||
| return true; | ||
|
|
||
| case "keydown": | ||
| case "keyup": | ||
| case "keypress": | ||
| eventArgs = Deserialize<KeyboardEventArgs>(eventArgsJson, jsonSerializerContext.KeyboardEventArgs); | ||
| return true; | ||
|
|
||
| case "contextmenu": | ||
|
|
@@ -137,11 +152,11 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| case "mousedown": | ||
| case "mouseup": | ||
| case "dblclick": | ||
| eventArgs = Deserialize<MouseEventArgs>(eventArgsJson, jsonSerializerContext.MouseEventArgs); | ||
| return true; | ||
|
|
||
| case "error": | ||
| eventArgs = Deserialize<ErrorEventArgs>(eventArgsJson, jsonSerializerContext.ErrorEventArgs); | ||
| return true; | ||
|
|
||
| case "loadstart": | ||
|
|
@@ -150,7 +165,7 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| case "load": | ||
| case "loadend": | ||
| case "progress": | ||
| eventArgs = Deserialize<ProgressEventArgs>(eventArgsJson, jsonSerializerContext.ProgressEventArgs); | ||
| return true; | ||
|
|
||
| case "touchcancel": | ||
|
|
@@ -159,7 +174,7 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| case "touchenter": | ||
| case "touchleave": | ||
| case "touchstart": | ||
| eventArgs = Deserialize<TouchEventArgs>(eventArgsJson, jsonSerializerContext.TouchEventArgs); | ||
| return true; | ||
|
|
||
| case "gotpointercapture": | ||
|
|
@@ -172,16 +187,16 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| case "pointerout": | ||
| case "pointerover": | ||
| case "pointerup": | ||
| eventArgs = Deserialize<PointerEventArgs>(eventArgsJson, jsonSerializerContext.PointerEventArgs); | ||
| return true; | ||
|
|
||
| case "wheel": | ||
| case "mousewheel": | ||
| eventArgs = Deserialize<WheelEventArgs>(eventArgsJson, jsonSerializerContext.WheelEventArgs); | ||
| return true; | ||
|
|
||
| case "toggle": | ||
| eventArgs = Deserialize<EventArgs>(eventArgsJson, jsonSerializerContext.EventArgs); | ||
| return true; | ||
|
|
||
| default: | ||
|
|
@@ -219,13 +234,11 @@ private static bool TryDeserializeStandardWebEventArgs(string eventName, string | |
| return null; | ||
| } | ||
|
|
||
| static T Deserialize<T>(string json, JsonTypeInfo<T?> jsonTypeInfo) => JsonSerializer.Deserialize(json, jsonTypeInfo)!; | ||
|
|
||
| private static ChangeEventArgs DeserializeChangeEventArgs(string eventArgsJson, WebEventJsonContext jsonSerializerContext) | ||
| { | ||
| var changeArgs = Deserialize(eventArgsJson, jsonSerializerContext.ChangeEventArgs); | ||
| var jsonElement = (JsonElement)changeArgs.Value!; | ||
| switch (jsonElement.ValueKind) | ||
| { | ||
|
|
@@ -245,4 +258,22 @@ private static ChangeEventArgs DeserializeChangeEventArgs(string eventArgsJson) | |
| return changeArgs; | ||
| } | ||
| } | ||
|
|
||
| [JsonSerializable(typeof(WebEventDescriptor))] | ||
| [JsonSerializable(typeof(WebEventDescriptor))] | ||
| [JsonSerializable(typeof(EventArgs))] | ||
| [JsonSerializable(typeof(ChangeEventArgs))] | ||
| [JsonSerializable(typeof(ClipboardEventArgs))] | ||
| [JsonSerializable(typeof(DragEventArgs))] | ||
| [JsonSerializable(typeof(ErrorEventArgs))] | ||
| [JsonSerializable(typeof(FocusEventArgs))] | ||
| [JsonSerializable(typeof(KeyboardEventArgs))] | ||
| [JsonSerializable(typeof(MouseEventArgs))] | ||
| [JsonSerializable(typeof(PointerEventArgs))] | ||
| [JsonSerializable(typeof(ProgressEventArgs))] | ||
| [JsonSerializable(typeof(TouchEventArgs))] | ||
| [JsonSerializable(typeof(WheelEventArgs))] | ||
| internal sealed partial class WebEventJsonContext : JsonSerializerContext | ||
|
There was a problem hiding this comment. It looks like it would be cleaner to have a global public class JsonSourceGenerationModeAttribute : JsonAttribute
{
public JsonSourceGenerationModeAttribute(JsonSourceGenerationMode mode) { }
}Building on #32374 (comment), we'd have [JsonSourceGenerationMode(JsonSourceGenerationMode.Metadata | JsonSourceGenerationMode.Serialization)]
[JsonSerializable(typeof(WebEventDescriptor)]
[JsonSerializable(typeof(EventArgs)]
internal sealed partial class WebEventJsonContext : JsonSerializerContext
{
}
Contributor
Author
There was a problem hiding this comment. That does seem like a better alternative. It feels unusual to want fine-grained control over the serialization behavior on a per-type basis. That said, I imagine most users wouldn't really configure this since the extra IL for serialization isn't really noticeable. |
||
| { | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.