Add GetGrain() overload for IdSpan grain identity to IGrainFactory (#9539)

* Move most IGrainFactory.GetGrain overloads to extension methods
Add IGrainFactory.GetGrainType and IGrainFactory.GetGrainInterfaceType

* Revert "Move most IGrainFactory.GetGrain overloads to extension methods"

This reverts commit 3223e68.

* add GetGrainInterfaceType() and GetGrainType()

* smaller scope of changes

* split into two methods instead of one with optional parameter
add tests

---------

Co-authored-by: Will Gunaratne <will@avius.com>
Co-authored-by: Reuben Bond <203839+ReubenBond@users.noreply.github.com>

Author: 3 people

src/Orleans.Core.Abstractions/Core/IGrainFactory.cs

@@ -4,6 +4,40 @@
 
 namespace Orleans
 {
+    public static class GrainFactoryExtensions
+    {
+        /// <summary>
+        /// Returns a reference for the provided grain id which implements the specified interface type.
+        /// </summary>
+        /// <param name="grainFactory">The grain factory.</param>
+        /// <param name="grainPrimaryKey">The primary key of the grain</param>
+        /// <param name="grainClassNamePrefix">An optional class name prefix used to find the runtime type of the grain.</param>
+        /// <typeparam name="TGrainInterface">The grain interface type which the returned grain reference must implement.</typeparam>
+        /// <returns>
+        /// A reference for the provided grain id which implements the specified interface type.
+        /// </returns>
+        public static TGrainInterface GetGrain<TGrainInterface>(this IGrainFactory grainFactory, IdSpan grainPrimaryKey, string grainClassNamePrefix) where TGrainInterface : IGrain
+        {
+            ArgumentNullException.ThrowIfNull(grainFactory);
+            return grainFactory.GetGrain(typeof(TGrainInterface), grainPrimaryKey, grainClassNamePrefix).AsReference<TGrainInterface>();
+        }
+
+        /// <summary>
+        /// Returns a reference for the provided grain id which implements the specified interface type.
+        /// </summary>
+        /// <param name="grainFactory">The grain factory.</param>
+        /// <param name="grainPrimaryKey">The primary key of the grain</param>
+        /// <typeparam name="TGrainInterface">The grain interface type which the returned grain reference must implement.</typeparam>
+        /// <returns>
+        /// A reference for the provided grain id which implements the specified interface type.
+        /// </returns>
+        public static TGrainInterface GetGrain<TGrainInterface>(this IGrainFactory grainFactory, IdSpan grainPrimaryKey) where TGrainInterface : IGrain
+        {
+            ArgumentNullException.ThrowIfNull(grainFactory);
+            return grainFactory.GetGrain(typeof(TGrainInterface), grainPrimaryKey).AsReference<TGrainInterface>();
+        }
+    }
+
     /// <summary>
     /// Functionality for creating references to grains.
     /// </summary>
@@ -190,5 +224,26 @@ public interface IGrainFactory
         /// A reference for the provided grain id which implements the specified interface type.
         /// </returns>
         IAddressable GetGrain(GrainId grainId, GrainInterfaceType interfaceType);
+
+        /// <summary>
+        /// Returns a reference for the provided grain id which implements the specified interface type.
+        /// </summary>
+        /// <param name="interfaceType">The grain interface type which the returned grain reference must implement.</param>
+        /// <param name="grainKey">The primary key of the grain</param>
+        /// <param name="grainClassNamePrefix">A class name prefix used to find the runtime type of the grain.</param>
+        /// <returns>
+        /// A reference for the provided grain id which implements the specified interface type.
+        /// </returns>
+        IAddressable GetGrain(Type interfaceType, IdSpan grainKey, string grainClassNamePrefix);
+
+        /// <summary>
+        /// Returns a reference for the provided grain id which implements the specified interface type.
+        /// </summary>
+        /// <param name="interfaceType">The grain interface type which the returned grain reference must implement.</param>
+        /// <param name="grainKey">The primary key of the grain</param>
+        /// <returns>
+        /// A reference for the provided grain id which implements the specified interface type.
+        /// </returns>
+        IAddressable GetGrain(Type interfaceType, IdSpan grainKey);
     }
 }

src/Orleans.Core/Core/ClusterClient.cs

@@ -153,6 +153,14 @@ public object Cast(IAddressable grain, Type outputGrainInterfaceType)
         public IAddressable GetGrain(GrainId grainId, GrainInterfaceType interfaceType)
             => _runtimeClient.InternalGrainFactory.GetGrain(grainId, interfaceType);
 
+        /// <inheritdoc />
+        public IAddressable GetGrain(Type interfaceType, IdSpan grainKey, string grainClassNamePrefix)
+            => _runtimeClient.InternalGrainFactory.GetGrain(interfaceType, grainKey, grainClassNamePrefix);
+
+        /// <inheritdoc />
+        public IAddressable GetGrain(Type interfaceType, IdSpan grainKey)
+            => _runtimeClient.InternalGrainFactory.GetGrain(interfaceType, grainKey);
+
         [LoggerMessage(
             Level = LogLevel.Information,
             Message = "Client shutting down."
@@ -164,5 +172,6 @@ public IAddressable GetGrain(GrainId grainId, GrainInterfaceType interfaceType)
             Message = "Client shutdown completed."
         )]
         private static partial void LogClientShutdownCompleted(ILogger logger);
+      
     }
-}
+}

src/Orleans.Core/Core/GrainFactory.cs

@@ -190,6 +190,9 @@ public IAddressable GetGrain(GrainId grainId, GrainInterfaceType interfaceType)
             return this.referenceActivator.CreateReference(grainId, interfaceType);
         }
 
+        /// <inheritdoc />
+        public IAddressable GetGrain(Type interfaceType, IdSpan grainKey) => GetGrain(interfaceType, grainKey, null);
+
         /// <summary>
         /// Gets a grain reference which implements the specified grain interface type and has the specified grain key, without specifying the grain type directly.
         /// </summary>
@@ -201,8 +204,10 @@ public IAddressable GetGrain(GrainId grainId, GrainInterfaceType interfaceType)
         /// <param name="grainKey">The <see cref="GrainId.Key"/> portion of the grain id.</param>
         /// <param name="grainClassNamePrefix">An optional grain class name prefix.</param>
         /// <returns>A grain reference which implements the provided interface.</returns>
-        private IAddressable GetGrain(Type interfaceType, IdSpan grainKey, string grainClassNamePrefix)
+        public IAddressable GetGrain(Type interfaceType, IdSpan grainKey, string grainClassNamePrefix = null)
         {
+            ArgumentNullException.ThrowIfNull(interfaceType);
+
             var grainInterfaceType = this.interfaceTypeResolver.GetGrainInterfaceType(interfaceType);
 
             GrainType grainType;

src/Orleans.Runtime/Core/InternalClusterClient.cs

@@ -146,9 +146,22 @@ public IGrain GetGrain(Type grainInterfaceType, long grainPrimaryKey, string key
             return this.grainFactory.GetGrain(grainInterfaceType, grainPrimaryKey);
         }
 
+        /// <inheritdoc />
         public IAddressable GetGrain(GrainId grainId, GrainInterfaceType interfaceId)
         {
             return this.grainFactory.GetGrain(grainId, interfaceId);
         }
+
+        /// <inheritdoc />
+        public IAddressable GetGrain(Type interfaceType, IdSpan grainKey, string grainClassNamePrefix)
+        {
+            return this.grainFactory.GetGrain(interfaceType, grainKey, grainClassNamePrefix);
+        }
+
+        /// <inheritdoc />
+        public IAddressable GetGrain(Type interfaceType, IdSpan grainKey)
+        {
+            return this.grainFactory.GetGrain(interfaceType, grainKey);
+        }
     }
 }

test/DefaultCluster.Tests/GrainFactoryTests.cs

@@ -225,5 +225,33 @@ public async Task GetGuidGrain()
             var g = this.GrainFactory.GetGrain<IGuidGrain>(Guid.NewGuid());
             Assert.True(await g.Foo());
         }
+
+        [Fact, TestCategory("BVT"), TestCategory("Factory"), TestCategory("GetGrain")]
+        public async Task GetGrainIdSpanGeneric()
+        {
+            var g = GrainFactory.GetGrain<IDerivedFromBase>(GrainIdKeyExtensions.CreateIntegerKey(0));
+            await g.Foo();
+        }
+
+        [Fact, TestCategory("BVT"), TestCategory("Factory"), TestCategory("GetGrain")]
+        public async Task GetGrainIdSpan()
+        {
+            var g = GrainFactory.GetGrain(typeof(IDerivedFromBase), GrainIdKeyExtensions.CreateIntegerKey(0));
+            await g.AsReference<IBase>().Foo();
+        }
+
+        [Fact, TestCategory("BVT"), TestCategory("Factory"), TestCategory("GetGrain")]
+        public async Task GetGrainIdSpanGenericPrefix()
+        {
+            var g = GrainFactory.GetGrain<IBase>(GrainIdKeyExtensions.CreateIntegerKey(0), BaseGrain.GrainPrefix);
+            await g.Foo();
+        }
+
+        [Fact, TestCategory("BVT"), TestCategory("Factory"), TestCategory("GetGrain")]
+        public async Task GetGrainIdSpanPrefix()
+        {
+            var g = GrainFactory.GetGrain(typeof(IBase), GrainIdKeyExtensions.CreateIntegerKey(0), BaseGrain.GrainPrefix);
+            await g.AsReference<IBase>().Foo();
+        }
     }
 }