Add schema and serialization support for autoentities wildcard enhancement #2973
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,111 @@ | ||||||||||||||||||
| // Copyright (c) Microsoft Corporation. | ||||||||||||||||||
| // Licensed under the MIT License. | ||||||||||||||||||
|
|
||||||||||||||||||
| using System.Text.Json; | ||||||||||||||||||
| using System.Text.Json.Serialization; | ||||||||||||||||||
| using Azure.DataApiBuilder.Config.ObjectModel; | ||||||||||||||||||
|
|
||||||||||||||||||
| namespace Azure.DataApiBuilder.Config.Converters; | ||||||||||||||||||
|
|
||||||||||||||||||
| internal class AutoentityConverter : JsonConverter<Autoentity> | ||||||||||||||||||
| { | ||||||||||||||||||
| // Settings for variable replacement during deserialization. | ||||||||||||||||||
| private readonly DeserializationVariableReplacementSettings? _replacementSettings; | ||||||||||||||||||
|
|
||||||||||||||||||
| /// <param name="replacementSettings">Settings for variable replacement during deserialization. | ||||||||||||||||||
| /// If null, no variable replacement will be performed.</param> | ||||||||||||||||||
| public AutoentityConverter(DeserializationVariableReplacementSettings? replacementSettings = null) | ||||||||||||||||||
| { | ||||||||||||||||||
| _replacementSettings = replacementSettings; | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| /// <inheritdoc/> | ||||||||||||||||||
| public override Autoentity? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) | ||||||||||||||||||
| { | ||||||||||||||||||
| if (reader.TokenType is JsonTokenType.StartObject) | ||||||||||||||||||
| { | ||||||||||||||||||
| // Initialize all sub-properties to null. | ||||||||||||||||||
| AutoentityPatterns? patterns = null; | ||||||||||||||||||
| AutoentityTemplate? template = null; | ||||||||||||||||||
| EntityPermission[]? permissions = null; | ||||||||||||||||||
|
|
||||||||||||||||||
| while (reader.Read()) | ||||||||||||||||||
| { | ||||||||||||||||||
| if (reader.TokenType == JsonTokenType.EndObject) | ||||||||||||||||||
| { | ||||||||||||||||||
| return new Autoentity(patterns, template, permissions); | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| string? propertyName = reader.GetString(); | ||||||||||||||||||
|
|
||||||||||||||||||
| reader.Read(); | ||||||||||||||||||
| switch (propertyName) | ||||||||||||||||||
| { | ||||||||||||||||||
| case "patterns": | ||||||||||||||||||
| AutoentityPatternsConverter patternsConverter = new(_replacementSettings); | ||||||||||||||||||
| patterns = patternsConverter.Read(ref reader, typeof(AutoentityPatterns), options); | ||||||||||||||||||
| break; | ||||||||||||||||||
|
|
||||||||||||||||||
| case "template": | ||||||||||||||||||
| AutoentityTemplateConverter templateConverter = new(_replacementSettings); | ||||||||||||||||||
| template = templateConverter.Read(ref reader, typeof(AutoentityTemplate), options); | ||||||||||||||||||
| break; | ||||||||||||||||||
|
|
||||||||||||||||||
| case "permissions": | ||||||||||||||||||
| permissions = JsonSerializer.Deserialize<EntityPermission[]>(ref reader, options); | ||||||||||||||||||
| break; | ||||||||||||||||||
|
|
||||||||||||||||||
| default: | ||||||||||||||||||
| throw new JsonException($"Unexpected property {propertyName}"); | ||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| throw new JsonException("Unable to read the Autoentities"); | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| /// <summary> | ||||||||||||||||||
| /// When writing the autoentities back to a JSON file, only write the properties | ||||||||||||||||||
| /// if they are user provided. This avoids polluting the written JSON file with properties | ||||||||||||||||||
| /// the user most likely omitted when writing the original DAB runtime config file. | ||||||||||||||||||
| /// This Write operation is only used when a RuntimeConfig object is serialized to JSON. | ||||||||||||||||||
| /// </summary> | ||||||||||||||||||
| /// <inheritdoc/> | ||||||||||||||||||
| public override void Write(Utf8JsonWriter writer, Autoentity value, JsonSerializerOptions options) | ||||||||||||||||||
| { | ||||||||||||||||||
| writer.WriteStartObject(); | ||||||||||||||||||
|
|
||||||||||||||||||
| AutoentityPatterns? patterns = value?.Patterns; | ||||||||||||||||||
| if (patterns?.UserProvidedIncludeOptions is true | ||||||||||||||||||
| || patterns?.UserProvidedExcludeOptions is true | ||||||||||||||||||
| || patterns?.UserProvidedNameOptions is true) | ||||||||||||||||||
| { | ||||||||||||||||||
| AutoentityPatternsConverter autoentityPatternsConverter = options.GetConverter(typeof(AutoentityPatterns)) as AutoentityPatternsConverter ?? | ||||||||||||||||||
| throw new JsonException("Failed to get autoentities.patterns options converter"); | ||||||||||||||||||
| writer.WritePropertyName("patterns"); | ||||||||||||||||||
| autoentityPatternsConverter.Write(writer, patterns, options); | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| AutoentityTemplate? template = value?.Template; | ||||||||||||||||||
| if (template?.UserProvidedMcpOptions is true | ||||||||||||||||||
| || template?.UserProvidedRestOptions is true | ||||||||||||||||||
| || template?.UserProvidedGraphQLOptions is true | ||||||||||||||||||
| || template?.UserProvidedHealthOptions is true | ||||||||||||||||||
| || template?.UserProvidedCacheOptions is true) | ||||||||||||||||||
| { | ||||||||||||||||||
| AutoentityTemplateConverter autoentityTemplateConverter = options.GetConverter(typeof(AutoentityTemplate)) as AutoentityTemplateConverter ?? | ||||||||||||||||||
| throw new JsonException("Failed to get autoentities.template options converter"); | ||||||||||||||||||
| writer.WritePropertyName("template"); | ||||||||||||||||||
| autoentityTemplateConverter.Write(writer, template, options); | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
|
There was a problem hiding this comment. The
Suggested change
Collaborator
There was a problem hiding this comment. again, a valid suggestion |
||||||||||||||||||
| // Serialize permissions if user provided | ||||||||||||||||||
| if (value?.UserProvidedPermissionsOptions is true) | ||||||||||||||||||
| { | ||||||||||||||||||
| writer.WritePropertyName("permissions"); | ||||||||||||||||||
| JsonSerializer.Serialize(writer, value.Permissions, options); | ||||||||||||||||||
| } | ||||||||||||||||||
|
|
||||||||||||||||||
| writer.WriteEndObject(); | ||||||||||||||||||
| } | ||||||||||||||||||
| } | ||||||||||||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
AutoentityConverterRead method only handles "patterns" and "template" properties but doesn't handle the "permissions" property. The permissions are defined in theAutoentityclass (line 19) and in the JSON schema, but they are never deserialized from JSON. Add a case to handle "permissions" property deserialization.