Add extension methods for registering entities by type

Author: cgillum

CHANGELOG.md

@@ -7,6 +7,8 @@
 - Add specific logging for NotFound error on worker connection by @halspang in ([#413](https://github.com/microsoft/durabletask-dotnet/pull/413))
 - Add user agent header to gRPC called in ([#417](https://github.com/microsoft/durabletask-dotnet/pull/417))
 - Enrich User-Agent Header in gRPC Metadata to indicate Client or Worker as caller ([#421](https://github.com/microsoft/durabletask-dotnet/pull/421))
+- Add extension methods for registering entities by type
+
 ## v1.10.0
 
 - Update DurableTask.Core to v3.1.0 and Bump version to v1.10.0 by @nytian in ([#411](https://github.com/microsoft/durabletask-dotnet/pull/411))

src/Abstractions/DurableTaskRegistry.Activities.cs

@@ -6,7 +6,8 @@
 namespace Microsoft.DurableTask;
 
 /// <summary>
-/// Container for registered <see cref="ITaskOrchestrator" /> and <see cref="ITaskActivity" /> implementations.
+/// Container for registered <see cref="ITaskOrchestrator" />, <see cref="ITaskActivity" />,
+/// and <see cref="Microsoft.DurableTask.Entities.ITaskEntity"/> implementations.
 /// </summary>
 public sealed partial class DurableTaskRegistry
 {

src/Abstractions/DurableTaskRegistry.Entities.cs

@@ -0,0 +1,77 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.DurableTask.Entities;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Microsoft.DurableTask;
+
+/// <summary>
+/// Container for registered <see cref="ITaskOrchestrator" />, <see cref="ITaskActivity" />,
+/// and <see cref="ITaskEntity"/> implementations.
+/// </summary>
+public partial class DurableTaskRegistry
+{
+    /// <summary>
+    /// Registers an entity factory.
+    /// </summary>
+    /// <param name="name">The name of the entity to register.</param>
+    /// <param name="type">The entity type.</param>
+    /// <returns>The same registry, for call chaining.</returns>
+    public DurableTaskRegistry AddEntity(TaskName name, Type type)
+    {
+        // TODO: Compile a constructor expression for performance.
+        Check.ConcreteType<ITaskEntity>(type);
+        return this.AddEntity(name, sp => (ITaskEntity)ActivatorUtilities.CreateInstance(sp, type));
+    }
+
+    /// <summary>
+    /// Registers an entity factory. The TaskName used is derived from the provided type information.
+    /// </summary>
+    /// <param name="type">The entity type.</param>
+    /// <returns>The same registry, for call chaining.</returns>
+    public DurableTaskRegistry AddEntity(Type type)
+        => this.AddEntity(type.GetTaskName(), type);
+
+    /// <summary>
+    /// Registers an entity factory.
+    /// </summary>
+    /// <typeparam name="TEntity">The type of entity to register.</typeparam>
+    /// <param name="name">The name of the entity to register.</param>
+    /// <returns>The same registry, for call chaining.</returns>
+    public DurableTaskRegistry AddEntity<TEntity>(TaskName name)
+        where TEntity : class, ITaskEntity
+        => this.AddEntity(name, typeof(TEntity));
+
+    /// <summary>
+    /// Registers an entity factory. The TaskName used is derived from the provided type information.
+    /// </summary>
+    /// <typeparam name="TEntity">The type of entity to register.</typeparam>
+    /// <returns>The same registry, for call chaining.</returns>
+    public DurableTaskRegistry AddEntity<TEntity>()
+        where TEntity : class, ITaskEntity
+        => this.AddEntity(typeof(TEntity));
+
+    /// <summary>
+    /// Registers an entity singleton.
+    /// </summary>
+    /// <param name="name">The name of the entity to register.</param>
+    /// <param name="entity">The entity instance to use.</param>
+    /// <returns>The same registry, for call chaining.</returns>
+    public DurableTaskRegistry AddEntity(TaskName name, ITaskEntity entity)
+    {
+        Check.NotNull(entity);
+        return this.AddEntity(name, _ => entity);
+    }
+
+    /// <summary>
+    /// Registers an entity singleton.
+    /// </summary>
+    /// <param name="entity">The entity instance to use.</param>
+    /// <returns>The same registry, for call chaining.</returns>
+    public DurableTaskRegistry AddEntity(ITaskEntity entity)
+    {
+        Check.NotNull(entity);
+        return this.AddEntity(entity.GetType().GetTaskName(), entity);
+    }
+}

src/Abstractions/DurableTaskRegistry.Orchestrators.cs

@@ -4,7 +4,8 @@
 namespace Microsoft.DurableTask;
 
 /// <summary>
-/// Container for registered <see cref="ITaskOrchestrator" /> and <see cref="ITaskActivity" /> implementations.
+/// Container for registered <see cref="ITaskOrchestrator" />, <see cref="ITaskActivity" />,
+/// and <see cref="Microsoft.DurableTask.Entities.ITaskEntity"/> implementations.
 /// </summary>
 public partial class DurableTaskRegistry
 {

src/Abstractions/DurableTaskRegistry.cs

@@ -6,7 +6,8 @@
 namespace Microsoft.DurableTask;
 
 /// <summary>
-/// Container for registered <see cref="ITaskOrchestrator" /> and <see cref="ITaskActivity" /> implementations.
+/// Container for registered <see cref="ITaskOrchestrator" />, <see cref="ITaskActivity" />,
+/// and <see cref="ITaskEntity"/> implementations.
 /// </summary>
 public sealed partial class DurableTaskRegistry
 {

src/ScheduledTasks/Extension/DurableTaskWorkerBuilderExtensions.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 using Microsoft.DurableTask.Worker;
-using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.DurableTask.ScheduledTasks;
 
@@ -18,7 +17,7 @@ public static void UseScheduledTasks(this IDurableTaskWorkerBuilder builder)
     {
         builder.AddTasks(r =>
         {
-            r.AddEntity(nameof(Schedule), sp => ActivatorUtilities.CreateInstance<Schedule>(sp));
+            r.AddEntity<Schedule>();
             r.AddOrchestrator<ExecuteScheduleOperationOrchestrator>();
         });
     }