Skip to content

Commit

Permalink
Implement asynchronous support in ODataJsonLightParameterDeserializer (…
Browse files Browse the repository at this point in the history 
…#2311)
  • Loading branch information
@gathogojr
gathogojr authored Feb 14, 2022
1 parent e2a4fc9 commit 9770082
Show file tree
Hide file tree
Showing 4 changed files with 594 additions and 2 deletions.
197 changes: 197 additions & 0 deletions src/Microsoft.OData.Core/JsonLight/ODataJsonLightParameterDeserializer.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ namespace Microsoft.OData.JsonLight
#region Namespaces
using System;
using System.Diagnostics;
using System.Threading.Tasks;
using Microsoft.OData.Edm;
using Microsoft.OData.Json;
using ODataErrorStrings = Microsoft.OData.Strings;
Expand All @@ -25,6 +26,14 @@ internal sealed class ODataJsonLightParameterDeserializer : ODataJsonLightProper
private static readonly Func<string, object> propertyAnnotationValueReader =
annotationName => { throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_PropertyAnnotationForParameters); };

/// <summary>OData property annotation asynchronous reader for parameter payloads.</summary>
private static readonly Func<string, Task<object>> propertyAnnotationValueReaderAsync =
annotationName =>
{
// Throw exception since property annotations are not supported in parameter payloads.
throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_PropertyAnnotationForParameters);
};

/// <summary>The JSON Light parameter reader.</summary>
private readonly ODataJsonLightParameterReader parameterReader;

Expand Down Expand Up @@ -216,5 +225,193 @@ internal bool ReadNextParameter(PropertyAndAnnotationCollector propertyAndAnnota

return parameterRead;
}

/// <summary>
/// Asynchronosly reads the next parameter from the parameters payload.
/// </summary>
/// <param name="propertyAndAnnotationCollector">The duplicate property names checker used to read a parameter payload.</param>
/// <returns>
/// A task that represents the asynchronous read operation.
/// The value of the TResult parameter contains true if a parameter was read from the payload; otherwise false.
/// </returns>
/// <remarks>
/// Pre-Condition: Property or EndObject the property node of the parameter to read or the end object node if there are not parameters
/// Post-Condition: Property or EndObject the node after the property value of a primitive, complex or null collection parameter
/// Any the start of the value representing a non-null collection parameter (the collection reader will fail if this is not a StartArray node)
/// </remarks>
internal async Task<bool> ReadNextParameterAsync(PropertyAndAnnotationCollector propertyAndAnnotationCollector)
{
Debug.Assert(propertyAndAnnotationCollector != null, "propertyAndAnnotationCollector != null");
this.AssertJsonCondition(JsonNodeType.Property, JsonNodeType.EndObject);

bool parameterRead = false;
if (this.JsonReader.NodeType == JsonNodeType.Property)
{
bool foundCustomInstanceAnnotation = false;

await this.ProcessPropertyAsync(
propertyAndAnnotationCollector,
propertyAnnotationValueReaderAsync,
async (propertyParsingResult, parameterName) =>
{
if (this.JsonReader.NodeType == JsonNodeType.Property)
{
// Read over property name
await this.JsonReader.ReadAsync()
.ConfigureAwait(false);
}

switch (propertyParsingResult)
{
case PropertyParsingResult.ODataInstanceAnnotation:
// OData instance annotations are not supported in parameter payloads.
throw new ODataException(ODataErrorStrings.ODataJsonLightPropertyAndValueDeserializer_UnexpectedAnnotationProperties(parameterName));

case PropertyParsingResult.CustomInstanceAnnotation:
await this.JsonReader.SkipValueAsync()
.ConfigureAwait(false);
foundCustomInstanceAnnotation = true;
break;

case PropertyParsingResult.PropertyWithoutValue:
throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_PropertyAnnotationWithoutPropertyForParameters(parameterName));

case PropertyParsingResult.EndOfObject:
break;

case PropertyParsingResult.MetadataReferenceProperty:
throw new ODataException(ODataErrorStrings.ODataJsonLightPropertyAndValueDeserializer_UnexpectedMetadataReferenceProperty(parameterName));

case PropertyParsingResult.PropertyWithValue:
IEdmTypeReference parameterTypeReference = this.parameterReader.GetParameterTypeReference(parameterName);
Debug.Assert(parameterTypeReference != null, "parameterTypeReference != null");

ODataParameterReaderState state;
object parameterValue;
EdmTypeKind parameterTypeKind = parameterTypeReference.TypeKind();
switch (parameterTypeKind)
{
case EdmTypeKind.Primitive:
IEdmPrimitiveTypeReference primitiveTypeReference = parameterTypeReference.AsPrimitive();
if (primitiveTypeReference.PrimitiveKind() == EdmPrimitiveTypeKind.Stream)
{
throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_UnsupportedPrimitiveParameterType(parameterName, primitiveTypeReference.PrimitiveKind()));
}

parameterValue = await this.ReadNonEntityValueAsync(
payloadTypeName: null,
expectedValueTypeReference: primitiveTypeReference,
propertyAndAnnotationCollector: null,
collectionValidator: null,
validateNullValue: true,
isTopLevelPropertyValue: false,
insideResourceValue: false,
propertyName: parameterName).ConfigureAwait(false);
state = ODataParameterReaderState.Value;
break;

case EdmTypeKind.Enum:
IEdmEnumTypeReference enumTypeReference = parameterTypeReference.AsEnum();
parameterValue = await this.ReadNonEntityValueAsync(
payloadTypeName: null,
expectedValueTypeReference: enumTypeReference,
propertyAndAnnotationCollector: null,
collectionValidator: null,
validateNullValue: true,
isTopLevelPropertyValue: false,
insideResourceValue: false,
propertyName: parameterName).ConfigureAwait(false);
state = ODataParameterReaderState.Value;
break;

case EdmTypeKind.TypeDefinition:
IEdmTypeDefinitionReference typeDefinitionReference = parameterTypeReference.AsTypeDefinition();
parameterValue = await this.ReadNonEntityValueAsync(
payloadTypeName: null,
expectedValueTypeReference: typeDefinitionReference,
propertyAndAnnotationCollector: null,
collectionValidator: null,
validateNullValue: true,
isTopLevelPropertyValue: false,
insideResourceValue: false,
propertyName: parameterName).ConfigureAwait(false);
state = ODataParameterReaderState.Value;
break;

case EdmTypeKind.Complex:
case EdmTypeKind.Entity:
parameterValue = null;
state = ODataParameterReaderState.Resource;
break;

case EdmTypeKind.Collection:
parameterValue = null;
if (this.JsonReader.NodeType == JsonNodeType.PrimitiveValue)
{
// NOTE: we support null collections in parameter payloads but nowhere else.
parameterValue = await this.JsonReader.ReadPrimitiveValueAsync()
.ConfigureAwait(false);
if (parameterValue != null)
{
throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_NullCollectionExpected(JsonNodeType.PrimitiveValue, parameterValue));
}

state = ODataParameterReaderState.Value;
}
else if (((IEdmCollectionType)parameterTypeReference.Definition).ElementType.IsStructured())
{
state = ODataParameterReaderState.ResourceSet;
}
else
{
state = ODataParameterReaderState.Collection;
}

break;
default:

throw new ODataException(ODataErrorStrings.ODataJsonLightParameterDeserializer_UnsupportedParameterTypeKind(parameterName, parameterTypeReference.TypeKind()));
}

parameterRead = true;
this.parameterReader.EnterScope(state, parameterName, parameterValue);
Debug.Assert(
state == ODataParameterReaderState.Collection || state == ODataParameterReaderState.Resource || state == ODataParameterReaderState.ResourceSet || this.JsonReader.NodeType == JsonNodeType.Property || this.JsonReader.NodeType == JsonNodeType.EndObject,
"Expected any node for a collection; 'Property' or 'EndObject' if it is a primitive or complex value.");
break;

default:
throw new ODataException(ODataErrorStrings.General_InternalError(InternalErrorCodes.ODataJsonLightParameterDeserializer_ReadNextParameter));
}
}).ConfigureAwait(false);

if (foundCustomInstanceAnnotation)
{
return await this.ReadNextParameterAsync(propertyAndAnnotationCollector)
.ConfigureAwait(false);
}
}

if (!parameterRead && this.JsonReader.NodeType == JsonNodeType.EndObject)
{
await this.JsonReader.ReadEndObjectAsync()
.ConfigureAwait(false);
await this.ReadPayloadEndAsync(isReadingNestedPayload: false)
.ConfigureAwait(false);

// Pop the scope for the previous parameter if there is any
if (this.parameterReader.State != ODataParameterReaderState.Start)
{
this.parameterReader.PopScope(this.parameterReader.State);
}

// Pop the 'Start' scope and enter the 'Completed' scope
this.parameterReader.PopScope(ODataParameterReaderState.Start);
this.parameterReader.EnterScope(ODataParameterReaderState.Completed, name: null, value: null);
this.AssertJsonCondition(JsonNodeType.EndOfInput);
}

return parameterRead;
}
}
}
Loading

0 comments on commit 9770082

Please sign in to comment.