Support Garnet as a replacement for Redis with Aspire/ServiceDiscovery

[flensrocker]

When using Garnet with Aspire like

var redis = builder.AddGarnet("redis");

var orleans = builder.AddOrleans("demo")
  .WithClustering(redis);
// etc.

and referencing Aspire.StackExchange.Redis in the Orleans project, where I call

builder.AddKeyedRedisClient("redis");

I get the exception

Unhandled exception. System.InvalidOperationException: Could not find Clustering provider named 'Garnet'. This can indicate that either the 'Microsoft.Orleans.Sdk' or the provider's package are not referenced by your application.

because the environment variable Orleans__Clustering__ProviderType is set to Garnet.

For me it looks like there's "just"™️ the RegisterProviderAttribute missing in

• RedisClusteringProviderBuilder
• RedisRemindersProviderBuilder
• RedisGrainStorageProviderBuilder
• RedisGrainDirectoryProviderBuilder

There's already another attribute for the provider type "AzureRedisCache". So maybe adding another one for "Garnet" would be enough?
And should Valkey be added, too?

Or is there another way to override the ProviderType of Garnet as "Redis"?

diff --git a/src/Redis/Orleans.Clustering.Redis/Hosting/RedisClusteringProviderBuilder.cs b/src/Redis/Orleans.Clustering.Redis/Hosting/RedisClusteringProviderBuilder.cs
index ab77727f1..2a1dc5e3c 100644
--- a/src/Redis/Orleans.Clustering.Redis/Hosting/RedisClusteringProviderBuilder.cs
+++ b/src/Redis/Orleans.Clustering.Redis/Hosting/RedisClusteringProviderBuilder.cs
@@ -11,9 +11,11 @@

 [assembly: RegisterProvider("Redis", "Clustering", "Silo", typeof(RedisClusteringProviderBuilder))]
 [assembly: RegisterProvider("AzureRedisCache", "Clustering", "Silo", typeof(RedisClusteringProviderBuilder))]
+[assembly: RegisterProvider("Garnet", "Clustering", "Silo", typeof(RedisClusteringProviderBuilder))]

 [assembly: RegisterProvider("Redis", "Clustering", "Client", typeof(RedisClusteringProviderBuilder))]
 [assembly: RegisterProvider("AzureRedisCache", "Clustering", "Client", typeof(RedisClusteringProviderBuilder))]
+[assembly: RegisterProvider("Garnet", "Clustering", "Client", typeof(RedisClusteringProviderBuilder))]

 namespace Orleans.Clustering.Redis.Hosting;

diff --git a/src/Redis/Orleans.GrainDirectory.Redis/Hosting/RedisGrainDirectoryProviderBuilder.cs b/src/Redis/Orleans.GrainDirectory.Redis/Hosting/RedisGrainDirectoryProviderBuilder.cs
index 4981fa791..df4beec59 100644
--- a/src/Redis/Orleans.GrainDirectory.Redis/Hosting/RedisGrainDirectoryProviderBuilder.cs
+++ b/src/Redis/Orleans.GrainDirectory.Redis/Hosting/RedisGrainDirectoryProviderBuilder.cs
@@ -11,6 +11,7 @@

 [assembly: RegisterProvider("Redis", "GrainDirectory", "Silo", typeof(RedisGrainDirectoryProviderBuilder))]
 [assembly: RegisterProvider("AzureRedisCache", "GrainDirectory", "Silo", typeof(RedisGrainDirectoryProviderBuilder))]
+[assembly: RegisterProvider("Garnet", "GrainDirectory", "Silo", typeof(RedisGrainDirectoryProviderBuilder))]

 namespace Orleans.Hosting;

diff --git a/src/Redis/Orleans.Persistence.Redis/Hosting/RedisGrainStorageProviderBuilder.cs b/src/Redis/Orleans.Persistence.Redis/Hosting/RedisGrainStorageProviderBuilder.cs
index 43447fe16..052a77a5e 100644
--- a/src/Redis/Orleans.Persistence.Redis/Hosting/RedisGrainStorageProviderBuilder.cs
+++ b/src/Redis/Orleans.Persistence.Redis/Hosting/RedisGrainStorageProviderBuilder.cs
@@ -12,6 +12,7 @@

 [assembly: RegisterProvider("Redis", "GrainStorage", "Silo", typeof(RedisGrainStorageProviderBuilder))]
 [assembly: RegisterProvider("AzureRedisCache", "GrainStorage", "Silo", typeof(RedisGrainStorageProviderBuilder))]
+[assembly: RegisterProvider("Garnet", "GrainStorage", "Silo", typeof(RedisGrainStorageProviderBuilder))]

 namespace Orleans.Hosting;

diff --git a/src/Redis/Orleans.Reminders.Redis/Hosting/RedisRemindersProviderBuilder.cs b/src/Redis/Orleans.Reminders.Redis/Hosting/RedisRemindersProviderBuilder.cs
index 974750460..15fa80288 100644
--- a/src/Redis/Orleans.Reminders.Redis/Hosting/RedisRemindersProviderBuilder.cs
+++ b/src/Redis/Orleans.Reminders.Redis/Hosting/RedisRemindersProviderBuilder.cs
@@ -10,6 +10,7 @@

 [assembly: RegisterProvider("Redis", "Reminders", "Silo", typeof(RedisRemindersProviderBuilder))]
 [assembly: RegisterProvider("AzureRedisCache", "Reminders", "Silo", typeof(RedisRemindersProviderBuilder))]
+[assembly: RegisterProvider("Garnet", "Reminders", "Silo", typeof(RedisRemindersProviderBuilder))]

 namespace Orleans.Hosting;

[flensrocker]

Using the AddRedis resource like in

var redis = builder
  .AddRedis("redis")
  .WithImageRegistry("ghcr.io")
  .WithImage("microsoft/garnet", "1")
  .WithEntrypoint("/app/GarnetServer")
  .WithDataVolume("redis-data");

doesn't work anymore, because of

[sys] Added new ContainerNetworkConnection: ContainerName = redis-ftxdszja
    _________
   /_||___||_\      Garnet 1.0.91 64 bit; standalone mode
   '. \   / .'      Listening on: 0.0.0.0:6379 and 1 more
     '.\ /.'        https://aka.ms/GetGarnet
       '.'
 
* Ready to accept connections
07::03::42 warn: Session[0] [10.89.0.1:38606] [02B89EAA] Received malformed input message. Trying to skip line.

The service stays unhealthy.

According to dotnet/aspire#7024 it seems that Aspire (13.1.0) is doing some Redis specific stuff, that breaks with Garnet (it worked with Aspire 13.0.1).
Hence the question if the RegisterProviderAttributes should be added.

[ReubenBond]

The RegisterProviderAttributes are needed if Garnet has a different resource type than Redis (which it probably does) and there is no 'ToRedis()' type of method that makes it appear as a Redis resource (which AFAIK there isn't, at least not currently).

[flensrocker]

Another alternative would be to extend the "get provider type algorithm" over here:
https://github.com/dotnet/aspire/blob/main/src/Aspire.Hosting.Orleans/ProviderConfiguration.cs#L25

// Use a simple transformation to get the provider type: remove the "Resource" suffix if it exists.
var providerType = resourceType.EndsWith(resource) ? resourceType[..^resource.Length] : resourceType;

so one can override the type.

But that's something I'm even less familar with.

In Aspire Redis and Garnet are different resource types (GarnetResource and RedisResource)

I don't think that it's "doable" to transform the GarnetResource into a RedisResource, so that the type name matches the expected string in Orleans.

[flensrocker]

Hm, I may try to use the overload with the IProviderConfiguration and provide something manually.

https://github.com/dotnet/aspire/blob/bebbf7797d040fad6462043a932312a0a083ccb2/src/Aspire.Hosting.Orleans/OrleansServiceExtensions.cs#L104

[flensrocker]

This "works on my machine" as a workaround, I added a string? customProviderType = null as a parameter.
It may be something to add to the .WithClustering (and other) extensions for simpler override. 🤷

using Aspire.Hosting.Orleans;

namespace Playground.AppHost;

internal sealed class CustomProviderConfiguration(string providerType, string? serviceKey = null, IResourceBuilder<IResourceWithConnectionString>? resource = null) : IProviderConfiguration
{
  internal static CustomProviderConfiguration Create(IResourceBuilder<IResourceWithConnectionString> resourceBuilder, string? customProviderType = null)
  {
    const string resource = "Resource";
    var serviceKey = resourceBuilder.Resource.Name;
    var resourceType = resourceBuilder.Resource.GetType().Name;

    // Use a simple transformation to get the provider type: remove the "Resource" suffix if it exists.
    var providerType = customProviderType ?? (resourceType.EndsWith(resource) ? resourceType[..^resource.Length] : resourceType);

    return new(providerType, serviceKey, resourceBuilder);
  }

  public void ConfigureResource<T>(IResourceBuilder<T> resourceBuilder, string configurationSectionName) where T : IResourceWithEnvironment
  {
    var envVarPrefix = configurationSectionName.Replace(":", "__");
    resourceBuilder.WithEnvironment($"Orleans__{envVarPrefix}__ProviderType", providerType);
    if (!string.IsNullOrEmpty(serviceKey))
    {
      resourceBuilder.WithEnvironment($"Orleans__{envVarPrefix}__ServiceKey", serviceKey);
    }

    if (resource is not null)
    {
      resourceBuilder.WithReference(resource);
    }
  }
}

and in the AppHost.cs:

var redis = builder
  .AddGarnet("redis")
  .WithDataVolume("playground-garnet-data");

var orleans = builder
  .AddOrleans("playground-orleans")
  .WithServiceId("playground")
  .WithClusterId("default")
  .WithClustering(CustomProviderConfiguration.Create(redis, "Redis"))
  .WithMemoryGrainStorage("PubSubStore");

[ReubenBond]

That looks reasonable to me. You could also add the custom resource type name as an annotation instead of wrapping the resource builder, and then we can pick up that annotation in the With* methods

[flensrocker]

Thanks, I will use that to make myself more comfortable with Aspire, because right now I don't know enough. 🤓
I read something about annotations, so now's the time to actually understand them!

[flensrocker]

You mean e.g. as a .WithOrleansProviderType("Redis") on the Garnet resource, that can be picked up by the ProviderConfiguration.Create, right?

At least that would make sense to me at a first look.
I can try that tomorrow!

[flensrocker]

I added my first draft over there: dotnet/aspire#13630