Update variable replacement during deserialization to use replacement settings class and add AKV replacement logic. #2882
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
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,113 @@ | ||
| // 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; | ||
|
|
||
| /// <summary> | ||
| /// Converter factory for AzureKeyVaultOptions that can optionally perform variable replacement. | ||
| /// </summary> | ||
| internal class AzureKeyVaultOptionsConverterFactory : JsonConverterFactory | ||
| { | ||
| // Determines whether to replace environment variable with its | ||
| // value or not while deserializing. | ||
| private readonly DeserializationVariableReplacementSettings? _replacementSettings; | ||
|
|
||
| /// <param name="replaceEnvVar">Whether to replace environment variable with its | ||
| /// value or not while deserializing.</param> | ||
| internal AzureKeyVaultOptionsConverterFactory(DeserializationVariableReplacementSettings? replacementSettings = null) | ||
| { | ||
| _replacementSettings = replacementSettings; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override bool CanConvert(Type typeToConvert) | ||
| { | ||
| return typeToConvert.IsAssignableTo(typeof(AzureKeyVaultOptions)); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override JsonConverter? CreateConverter(Type typeToConvert, JsonSerializerOptions options) | ||
| { | ||
| return new AzureKeyVaultOptionsConverter(_replacementSettings); | ||
| } | ||
|
|
||
| private class AzureKeyVaultOptionsConverter : JsonConverter<AzureKeyVaultOptions> | ||
| { | ||
| // Determines whether to replace environment variable with its | ||
| // value or not while deserializing. | ||
| private readonly DeserializationVariableReplacementSettings? _replacementSettings; | ||
|
|
||
| /// <param name="replaceEnvVar">Whether to replace environment variable with its | ||
| /// value or not while deserializing.</param> | ||
| public AzureKeyVaultOptionsConverter(DeserializationVariableReplacementSettings? replacementSettings) | ||
| { | ||
| _replacementSettings = replacementSettings; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Reads AzureKeyVaultOptions with optional variable replacement. | ||
| /// </summary> | ||
| public override AzureKeyVaultOptions? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) | ||
| { | ||
| if (reader.TokenType is JsonTokenType.StartObject) | ||
| { | ||
| string? endpoint = null; | ||
| AKVRetryPolicyOptions? retryPolicy = null; | ||
|
|
||
| while (reader.Read()) | ||
| { | ||
| if (reader.TokenType is JsonTokenType.EndObject) | ||
| { | ||
| return new AzureKeyVaultOptions | ||
| { | ||
| Endpoint = endpoint, | ||
| RetryPolicy = retryPolicy | ||
| }; | ||
| } | ||
|
|
||
| string? property = reader.GetString(); | ||
| reader.Read(); | ||
|
|
||
| switch (property) | ||
| { | ||
| case "endpoint": | ||
| if (reader.TokenType is JsonTokenType.String) | ||
| { | ||
| endpoint = reader.DeserializeString(_replacementSettings); | ||
| } | ||
|
|
||
| break; | ||
|
|
||
| case "retry-policy": | ||
| if (reader.TokenType is JsonTokenType.StartObject) | ||
| { | ||
| // Pass the replaceEnvVar setting to the retry policy converter | ||
| retryPolicy = JsonSerializer.Deserialize<AKVRetryPolicyOptions>(ref reader, options); | ||
| } | ||
|
|
||
| break; | ||
|
|
||
| default: | ||
| reader.Skip(); | ||
|
There was a problem hiding this comment. Why do we want to skip an incorrect property? Shouldn't we want to throw an error? |
||
| break; | ||
| } | ||
| } | ||
| } | ||
| else if (reader.TokenType is JsonTokenType.Null) | ||
|
There was a problem hiding this comment. nit: I think it would be better to put this on top so it is consistent with other ConverterFactories |
||
| { | ||
| return null; | ||
| } | ||
|
|
||
| throw new JsonException("Invalid AzureKeyVaultOptions format"); | ||
| } | ||
|
|
||
| public override void Write(Utf8JsonWriter writer, AzureKeyVaultOptions value, JsonSerializerOptions options) | ||
| { | ||
| JsonSerializer.Serialize(writer, value, options); | ||
|
There was a problem hiding this comment. Do we always want to write the options back into the config? I would expect to only write values if the user wants to do it in the first place. |
||
| } | ||
| } | ||
| } | ||
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.
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.
Maybe make the comment a bit more descriptive, to show that it can replace the variable with either AKV, an environment variable, or nothing during deserialization.