Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: gRPC Agent Runtime Serialization Registration #5513

Merged
merged 2 commits into from
Feb 12, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion .github/workflows/dotnet-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ jobs:
dotnet-version: '9.0.x'
- name: Install Temp Global.JSON
run: |
echo "{\"sdk\": {\"version\": \"9.0.101\"}}" > global.json
echo "{\"sdk\": {\"version\": \"9.0\"}}" > global.json
- name: Install .NET Aspire workload
run: dotnet workload install aspire
- name: Install dev certs
Expand Down
38 changes: 38 additions & 0 deletions dotnet/src/Microsoft.AutoGen/Core.Grpc/AgentExtensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// AgentExtensions.cs

using System.Reflection;
using Google.Protobuf;
using Microsoft.AutoGen.Contracts;
using Microsoft.AutoGen.Core.Grpc;

namespace Microsoft.AutoGen.Core;

internal static partial class AgentExtensions
{
private static readonly Type ProtobufIMessage = typeof(IMessage<>);
private static bool IsProtobufType(this Type type)
{
// TODO: Support the non-generic IMessage as well
Type specializedIMessageType = ProtobufIMessage.MakeGenericType(type);

// type T needs to derive from IMessage<T>
return specializedIMessageType.IsAssignableFrom(type);
}

public static void RegisterHandledMessageTypes(this IHostableAgent agent, IProtoSerializationRegistry registry)
{
Type agentRuntimeType = agent.GetType();

MethodInfo[] messageHandlers = agentRuntimeType.GetHandlers();

foreach (MethodInfo handler in messageHandlers)
{
Type messageType = handler.GetParameters().First().ParameterType;
if (messageType.IsProtobufType() && registry.GetSerializer(messageType) == null)
{
registry.RegisterSerializer(messageType);
}
}
}
}
20 changes: 16 additions & 4 deletions dotnet/src/Microsoft.AutoGen/Core.Grpc/GrpcAgentRuntime.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@

namespace Microsoft.AutoGen.Core.Grpc;

internal sealed class AgentsContainer(IAgentRuntime hostingRuntime)
internal sealed class AgentsContainer(IAgentRuntime hostingRuntime, IProtoSerializationRegistry serializationRegistry)
{
private readonly IAgentRuntime hostingRuntime = hostingRuntime;
private readonly IProtoSerializationRegistry serializationRegistry = serializationRegistry;

private Dictionary<Contracts.AgentId, IHostableAgent> agentInstances = new();
public Dictionary<string, ISubscriptionDefinition> Subscriptions = new();
Expand All @@ -29,6 +30,10 @@ public async ValueTask<IHostableAgent> EnsureAgentAsync(Contracts.AgentId agentI
}

agent = await factoryFunc(agentId, this.hostingRuntime);

// Just-in-Time register the message types so we can deserialize them
agent.RegisterHandledMessageTypes(this.serializationRegistry);

this.agentInstances.Add(agentId, agent);
}

Expand Down Expand Up @@ -92,7 +97,7 @@ public GrpcAgentRuntime(AgentRpc.AgentRpcClient client,
this._shutdownCts = CancellationTokenSource.CreateLinkedTokenSource(hostApplicationLifetime.ApplicationStopping);

this._messageRouter = new GrpcMessageRouter(client, this, _clientId, logger, this._shutdownCts.Token);
this._agentsContainer = new AgentsContainer(this);
this._agentsContainer = new AgentsContainer(this, this.SerializationRegistry);

this.ServiceProvider = serviceProvider;
}
Expand Down Expand Up @@ -231,8 +236,6 @@ private async ValueTask HandlePublish(CloudEvent evt, CancellationToken cancella

var messageId = evt.Id;
var typeName = evt.Attributes[Constants.DATA_SCHEMA_ATTR].CeString;
var serializer = SerializationRegistry.GetSerializer(typeName) ?? throw new Exception();
var message = serializer.Deserialize(evt.ProtoData);

var messageContext = new MessageContext(messageId, cancellationToken)
{
Expand All @@ -241,13 +244,22 @@ private async ValueTask HandlePublish(CloudEvent evt, CancellationToken cancella
IsRpc = false
};

// We may not have a Serializer registered yet, if this is the first time we are instantiating the agent
IProtobufMessageSerializer? serializer = SerializationRegistry.GetSerializer(typeName);
object? message = serializer?.Deserialize(evt.ProtoData);

// Iterate over subscriptions values to find receiving agents
foreach (var subscription in this._agentsContainer.Subscriptions.Values)
{
if (subscription.Matches(topic))
{
var recipient = subscription.MapToAgent(topic);
var agent = await this._agentsContainer.EnsureAgentAsync(recipient);

// give the serializer a second chance to have been registered
serializer ??= SerializationRegistry.GetSerializer(typeName) ?? throw new Exception($"Could not find a serializer for message of type {typeName}");
message ??= serializer.Deserialize(evt.ProtoData);

await agent.OnMessageAsync(message, messageContext);
}
}
Expand Down
Loading