Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 93 additions & 40 deletions src/WebJobs.Extensions.DurableTask/DurableHttpRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
using Microsoft.Extensions.Primitives;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Serialization;

namespace Microsoft.Azure.WebJobs.Extensions.DurableTask
{
Expand Down Expand Up @@ -134,8 +135,6 @@ public override void WriteJson(

private class TokenSourceConverter : JsonConverter
{
private static JsonSerializer tokenSerializer;

private enum TokenSourceType
{
None = 0,
Expand All @@ -149,8 +148,6 @@ public override bool CanConvert(Type objectType)

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
var safeTokenSerializer = GetTokenSourceSerializer(serializer);

JToken json = JToken.ReadFrom(reader);
if (json.Type == JTokenType.Null)
{
Expand All @@ -163,35 +160,42 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
if (Enum.TryParse((string)kindValue, out TokenSourceType tokenSourceKind) &&
tokenSourceKind == TokenSourceType.AzureManagedIdentity)
{
string resourceString = (string)jsonObject.GetValue("resource", StringComparison.Ordinal);

if (jsonObject.TryGetValue("options", out JToken optionsToken))
{
ManagedIdentityOptions managedIdentityOptions = optionsToken.ToObject<JObject>().ToObject<ManagedIdentityOptions>();
return new ManagedIdentityTokenSource(resourceString, managedIdentityOptions);
}

return new ManagedIdentityTokenSource(resourceString);
return CreateManagedIdentityTokenSource(jsonObject);
}

throw new NotSupportedException($"The token source kind '{kindValue.ToString(Formatting.None)}' is not supported.");
}
Comment thread
andystaples marked this conversation as resolved.
Resolved
else if (jsonObject.TryGetValue("$type", StringComparison.Ordinal, out JToken clrTypeValue))
{
Type runtimeType = Type.GetType((string)clrTypeValue, throwOnError: true);
return jsonObject.ToObject(runtimeType, safeTokenSerializer);
}
else
{
// Don't know how to deserialize this - use default behavior (this may fail)
return jsonObject.ToObject(objectType);
ParseTypeName((string)clrTypeValue, out string assemblyName, out string typeName);
if (string.Equals(typeName, typeof(ManagedIdentityTokenSource).FullName, StringComparison.Ordinal))
{
return CreateManagedIdentityTokenSource(jsonObject);
}

ISerializationBinder binder = GetCustomTokenSourceBinder(serializer);
Type runtimeType = binder.BindToType(assemblyName, typeName);
if (runtimeType == null || !typeof(ITokenSource).IsAssignableFrom(runtimeType) || runtimeType.IsAbstract || runtimeType.IsInterface)
{
throw new JsonSerializationException($"Type '{typeName}' is not a supported token source.");
}

jsonObject.Remove("$type");
return jsonObject.ToObject(runtimeType, GetTokenSourceSerializer(serializer));
}

throw new NotSupportedException("The token source kind is missing.");
}
Comment thread
andystaples marked this conversation as resolved.
Resolved

public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
if (value is ManagedIdentityTokenSource tokenSource)
if (value == null)
{
writer.WriteNull();
}
else if (value.GetType() == typeof(ManagedIdentityTokenSource))
{
var tokenSource = (ManagedIdentityTokenSource)value;
writer.WriteStartObject();
writer.WritePropertyName("kind");
writer.WriteValue(TokenSourceType.AzureManagedIdentity.ToString());
Expand All @@ -208,28 +212,35 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
}
else
{
// Don't know how to serialize this - use default behavior, forcing TypeNameHandling.Objects to correctly serialize ITokenSource
var safeTokenSerializer = GetTokenSourceSerializer(serializer);
safeTokenSerializer.Serialize(writer, value);
ISerializationBinder binder = GetCustomTokenSourceBinder(serializer);
binder.BindToName(value.GetType(), out string assemblyName, out string typeName);
if (string.IsNullOrWhiteSpace(typeName))
{
throw new JsonSerializationException($"The configured serialization binder did not provide a name for token source type '{value.GetType().FullName}'.");
}

string serializedTypeName = string.IsNullOrWhiteSpace(assemblyName) ? typeName : $"{typeName}, {assemblyName}";
JObject jsonObject = JObject.FromObject(value, GetTokenSourceSerializer(serializer));
jsonObject.AddFirst(new JProperty("$type", serializedTypeName));
jsonObject.WriteTo(writer);
}
}

private static JsonSerializer GetTokenSourceSerializer(JsonSerializer serializer)
private static ManagedIdentityTokenSource CreateManagedIdentityTokenSource(JObject jsonObject)
{
if (tokenSerializer != null)
string resourceString = (string)jsonObject.GetValue("resource", StringComparison.Ordinal);
if (jsonObject.TryGetValue("options", out JToken optionsToken))
{
return tokenSerializer;
ManagedIdentityOptions managedIdentityOptions = optionsToken.ToObject<ManagedIdentityOptions>();
Comment thread
andystaples marked this conversation as resolved.
Resolved
return new ManagedIdentityTokenSource(resourceString, managedIdentityOptions);
}

if (serializer.TypeNameHandling == TypeNameHandling.Objects
|| serializer.TypeNameHandling == TypeNameHandling.All)
{
tokenSerializer = serializer;
return tokenSerializer;
}
return new ManagedIdentityTokenSource(resourceString);
}

// Make sure these are all the settings when updating Newtonsoft.Json
tokenSerializer = new JsonSerializer
private static JsonSerializer GetTokenSourceSerializer(JsonSerializer serializer)
{
var tokenSourceSerializer = new JsonSerializer
{
Context = serializer.Context,
Culture = serializer.Culture,
Expand All @@ -255,17 +266,59 @@ private static JsonSerializer GetTokenSourceSerializer(JsonSerializer serializer
ReferenceLoopHandling = serializer.ReferenceLoopHandling,
StringEscapeHandling = serializer.StringEscapeHandling,
TraceWriter = serializer.TraceWriter,

// Enforcing TypeNameHandling.Objects to make sure ITokenSource gets serialized/deserialized correctly
TypeNameHandling = TypeNameHandling.Objects,
TypeNameHandling = TypeNameHandling.None,
};

foreach (var converter in serializer.Converters)
{
tokenSerializer.Converters.Add(converter);
tokenSourceSerializer.Converters.Add(converter);
}

return tokenSourceSerializer;
}

private static ISerializationBinder GetCustomTokenSourceBinder(JsonSerializer serializer)
{
if (serializer.SerializationBinder == null || serializer.SerializationBinder is DefaultSerializationBinder)
Comment thread
andystaples marked this conversation as resolved.
Resolved
{
throw new JsonSerializationException("Custom token sources require an explicitly configured serialization binder.");
}

return serializer.SerializationBinder;
}

private static void ParseTypeName(string serializedTypeName, out string assemblyName, out string typeName)
{
if (string.IsNullOrWhiteSpace(serializedTypeName))
{
throw new JsonSerializationException("The token source '$type' value is missing.");
}

int separatorIndex = FindAssemblySeparator(serializedTypeName);
typeName = separatorIndex < 0 ? serializedTypeName.Trim() : serializedTypeName.Substring(0, separatorIndex).Trim();
assemblyName = separatorIndex < 0 ? null : serializedTypeName.Substring(separatorIndex + 1).Trim();
}

private static int FindAssemblySeparator(string serializedTypeName)
{
int bracketDepth = 0;
for (int i = 0; i < serializedTypeName.Length; i++)
{
if (serializedTypeName[i] == '[')
{
bracketDepth++;
}
else if (serializedTypeName[i] == ']')
{
bracketDepth--;
}
else if (serializedTypeName[i] == ',' && bracketDepth == 0)
{
return i;
}
}

return tokenSerializer;
return -1;
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<RootNamespace>Microsoft.Azure.WebJobs.Extensions.DurableTask</RootNamespace>
<MajorVersion>3</MajorVersion>
<MinorVersion>14</MinorVersion>
<PatchVersion>0</PatchVersion>
<PatchVersion>1</PatchVersion>
<VersionPrefix>$(MajorVersion).$(MinorVersion).$(PatchVersion)</VersionPrefix>
<FileVersion>$(MajorVersion).$(MinorVersion).$(PatchVersion)</FileVersion>
<AssemblyVersion>$(MajorVersion).0.0.0</AssemblyVersion>
Expand Down
Loading
Loading