Merge branch 'main' into copilot/add-roslyn-analyzer-function-check

Author: YunchuWang

README.md

@@ -35,7 +35,7 @@ To get started, add the [Microsoft.Azure.Functions.Worker.Extensions.DurableTask
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.DurableTask" Version="1.2.2" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.0.13" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.7.0" OutputItemType="Analyzer" />
-    <PackageReference Include="Microsoft.DurableTask.Generators" Version="1.0.0-preview.1" OutputItemType="Analyzer" />
+    <PackageReference Include="Microsoft.DurableTask.Generators" Version="1.0.0" OutputItemType="Analyzer" />
   </ItemGroup>
 ```
 

samples/AzureFunctionsApp/AzureFunctionsApp.csproj

@@ -5,14 +5,18 @@
     <AzureFunctionsVersion>v4</AzureFunctionsVersion>
     <OutputType>Exe</OutputType>
     <Nullable>enable</Nullable>
+    <!-- Disable SDK's source generation to allow reflection-based discovery of source-generated functions -->
+    <FunctionsEnableExecutorSourceGen>false</FunctionsEnableExecutorSourceGen>
+    <FunctionsEnableWorkerIndexing>false</FunctionsEnableWorkerIndexing>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Azure.Functions.Worker" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.DurableTask" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" OutputItemType="Analyzer" />
-    <PackageReference Include="Microsoft.DurableTask.Generators" OutputItemType="Analyzer" />
+    <!-- Reference the source generator project directly for local development -->
+    <ProjectReference Include="..\..\src\Generators\Generators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
   </ItemGroup>
 
   <ItemGroup>

samples/AzureFunctionsApp/Entities/Counter.cs

@@ -29,7 +29,11 @@ namespace AzureFunctionsApp.Entities;
 /// Example on how to dispatch to an entity which directly implements TaskEntity<TState>. Using TaskEntity<TState> gives
 /// the added benefit of being able to use DI. When using TaskEntity<TState>, state is deserialized to the "State"
 /// property. No other properties on this type will be serialized/deserialized.
+/// 
+/// Source generators are used to generate the [Function] method with [EntityTrigger] binding automatically.
+/// The generated function will be named "Counter" (based on the class name or the DurableTask attribute value).
 /// </summary>
+[DurableTask(nameof(Counter))]
 public class Counter : TaskEntity<int>
 {
     readonly ILogger logger;
@@ -49,19 +53,21 @@ public int Add(int input)
 
     public void Reset() => this.State = 0;
 
-    [Function("Counter")]
-    public Task DispatchAsync([EntityTrigger] TaskEntityDispatcher dispatcher)
-    {
-        // Can dispatch to a TaskEntity<TState> by passing a instance.
-        return dispatcher.DispatchAsync(this);
-    }
+    // Note: The [Function("Counter")] method is now auto-generated by the source generator.
+    // The generated code will look like:
+    // [Function(nameof(Counter))]
+    // public static Task Counter([EntityTrigger] TaskEntityDispatcher dispatcher)
+    // {
+    //     return dispatcher.DispatchAsync<Counter>();
+    // }
 
     [Function("Counter_Alt")]
     public static Task DispatchStaticAsync([EntityTrigger] TaskEntityDispatcher dispatcher)
     {
-        // Can also dispatch to a TaskEntity<TState> by using a static method.
-        // However, this is a different entity ID - "counter_alt" and not "counter". Even though it uses the same
-        // entity implementation, the function attribute has a different name, which determines the entity ID.
+        // This is kept as a manual example showing how to create an alternative entity function
+        // with a different name. This creates a separate entity ID "counter_alt" vs "counter".
+        // Even though it uses the same entity implementation, the function attribute has a different name,
+        // which determines the entity ID.
         return dispatcher.DispatchAsync<Counter>();
     }
 }

samples/AzureFunctionsApp/Entities/Lifetime.cs

@@ -4,6 +4,7 @@
 using System.Net;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Azure.Functions.Worker.Http;
+using Microsoft.DurableTask;
 using Microsoft.DurableTask.Client;
 using Microsoft.DurableTask.Client.Entities;
 using Microsoft.DurableTask.Entities;
@@ -16,7 +17,10 @@ namespace AzureFunctionsApp.Entities;
 /// is considered deleted when <see cref="TaskEntity{TState}.State"/> is <c>null</c> at the end of an operation. It
 /// is also possible to design an entity which remains stateless by always returning <c>null</c> from
 /// <see cref="InitializeState"/> and never assigning a non-null state.
+/// 
+/// Source generators are used to generate the [Function] method with [EntityTrigger] binding automatically.
 /// </summary>
+[DurableTask(nameof(Lifetime))]
 public class Lifetime : TaskEntity<MyState>
 {
     readonly ILogger logger;
@@ -34,14 +38,13 @@ public Lifetime(ILogger<Lifetime> logger)
     /// </summary>
     protected override bool AllowStateDispatch => base.AllowStateDispatch;
 
-    // NOTE: when using TaskEntity<TState>, you cannot use "RunAsync" as the entity trigger name as this conflicts
-    // with the base class method 'RunAsync'.
-    [Function(nameof(Lifetime))]
-    public Task DispatchAsync([EntityTrigger] TaskEntityDispatcher dispatcher)
-    {
-        this.logger.LogInformation("Dispatching entity");
-        return dispatcher.DispatchAsync(this);
-    }
+    // Note: The [Function(nameof(Lifetime))] method is now auto-generated by the source generator.
+    // The generated code will look like:
+    // [Function(nameof(Lifetime))]
+    // public static Task Lifetime([EntityTrigger] TaskEntityDispatcher dispatcher)
+    // {
+    //     return dispatcher.DispatchAsync<Lifetime>();
+    // }
 
     public MyState Get() => this.State;
 

samples/AzureFunctionsApp/Entities/User.cs

@@ -18,7 +18,11 @@ public record UserUpdate(string? Name, int? Age);
 
 /// <summary>
 /// This sample demonstrates how to bind to <see cref="TaskEntityContext"/> as well as dispatch to orchestrations.
+/// 
+/// Source generators are used to generate the [Function] method with [EntityTrigger] binding automatically.
+/// The generated function will be named "User" (based on the class name or the DurableTask attribute value).
 /// </summary>
+[DurableTask(nameof(User))]
 public class UserEntity : TaskEntity<User>
 {
     readonly ILogger logger;
@@ -68,12 +72,13 @@ public void Greet(TaskEntityContext context, string? message = null)
         // this.Context.ScheduleNewOrchestration(nameof(Greeting.GreetingOrchestration), input);
     }
 
-    [Function(nameof(User))]
-    public Task DispatchAsync([EntityTrigger] TaskEntityDispatcher dispatcher)
-    {
-        // Can dispatch to a TaskEntity<TState> by passing a instance.
-        return dispatcher.DispatchAsync(this);
-    }
+    // Note: The [Function(nameof(User))] method is now auto-generated by the source generator.
+    // The generated code will look like:
+    // [Function(nameof(User))]
+    // public static Task User([EntityTrigger] TaskEntityDispatcher dispatcher)
+    // {
+    //     return dispatcher.DispatchAsync<UserEntity>();
+    // }
 
     protected override User InitializeState(TaskEntityOperation entityOperation)
     {

src/Generators/DurableTaskSourceGenerator.cs

@@ -270,6 +270,15 @@ public static class GeneratedDurableTaskExtensions
                 }
             }
 
+            foreach (DurableTaskTypeInfo entity in entities)
+            {
+                if (isDurableFunctions)
+                {
+                    // Generate the function definition required to trigger entities in Azure Functions
+                    AddEntityFunctionDeclaration(sourceBuilder, entity);
+                }
+            }
+
             // Activity function triggers are supported for code-gen (but not orchestration triggers)
             IEnumerable<DurableFunction> activityTriggers = allFunctions.Where(
                 df => df.Kind == DurableFunctionKind.Activity);
@@ -316,6 +325,9 @@ static void AddOrchestratorFunctionDeclaration(StringBuilder sourceBuilder, Dura
         static void AddOrchestratorCallMethod(StringBuilder sourceBuilder, DurableTaskTypeInfo orchestrator)
         {
             sourceBuilder.AppendLine($@"
+        /// <summary>
+        /// Schedules a new instance of the <see cref=""{orchestrator.TypeName}""/> orchestrator.
+        /// </summary>
         /// <inheritdoc cref=""IOrchestrationSubmitter.ScheduleNewOrchestrationInstanceAsync""/>
         public static Task<string> ScheduleNew{orchestrator.TaskName}InstanceAsync(
             this IOrchestrationSubmitter client, {orchestrator.InputParameter}, StartOrchestrationOptions? options = null)
@@ -327,6 +339,9 @@ static void AddOrchestratorCallMethod(StringBuilder sourceBuilder, DurableTaskTy
         static void AddSubOrchestratorCallMethod(StringBuilder sourceBuilder, DurableTaskTypeInfo orchestrator)
         {
             sourceBuilder.AppendLine($@"
+        /// <summary>
+        /// Calls the <see cref=""{orchestrator.TypeName}""/> sub-orchestrator.
+        /// </summary>
         /// <inheritdoc cref=""TaskOrchestrationContext.CallSubOrchestratorAsync(TaskName, object?, TaskOptions?)""/>
         public static Task<{orchestrator.OutputType}> Call{orchestrator.TaskName}Async(
             this TaskOrchestrationContext context, {orchestrator.InputParameter}, TaskOptions? options = null)
@@ -338,6 +353,10 @@ static void AddSubOrchestratorCallMethod(StringBuilder sourceBuilder, DurableTas
         static void AddActivityCallMethod(StringBuilder sourceBuilder, DurableTaskTypeInfo activity)
         {
             sourceBuilder.AppendLine($@"
+        /// <summary>
+        /// Calls the <see cref=""{activity.TypeName}""/> activity.
+        /// </summary>
+        /// <inheritdoc cref=""TaskOrchestrationContext.CallActivityAsync(TaskName, object?, TaskOptions?)""/>
         public static Task<{activity.OutputType}> Call{activity.TaskName}Async(this TaskOrchestrationContext ctx, {activity.InputParameter}, TaskOptions? options = null)
         {{
             return ctx.CallActivityAsync<{activity.OutputType}>(""{activity.TaskName}"", input, options);
@@ -347,6 +366,10 @@ static void AddActivityCallMethod(StringBuilder sourceBuilder, DurableTaskTypeIn
         static void AddActivityCallMethod(StringBuilder sourceBuilder, DurableFunction activity)
         {
             sourceBuilder.AppendLine($@"
+        /// <summary>
+        /// Calls the <see cref=""{activity.FullTypeName}""/> activity.
+        /// </summary>
+        /// <inheritdoc cref=""TaskOrchestrationContext.CallActivityAsync(TaskName, object?, TaskOptions?)""/>
         public static Task<{activity.ReturnType}> Call{activity.Name}Async(this TaskOrchestrationContext ctx, {activity.Parameter}, TaskOptions? options = null)
         {{
             return ctx.CallActivityAsync<{activity.ReturnType}>(""{activity.Name}"", {activity.Parameter.Name}, options);
@@ -368,6 +391,17 @@ static void AddActivityFunctionDeclaration(StringBuilder sourceBuilder, DurableT
         }}");
         }
 
+        static void AddEntityFunctionDeclaration(StringBuilder sourceBuilder, DurableTaskTypeInfo entity)
+        {
+            // Generate the entity trigger function that dispatches to the entity implementation.
+            sourceBuilder.AppendLine($@"
+        [Function(nameof({entity.TaskName}))]
+        public static Task {entity.TaskName}([EntityTrigger] TaskEntityDispatcher dispatcher)
+        {{
+            return dispatcher.DispatchAsync<{entity.TypeName}>();
+        }}");
+        }
+
         /// <summary>
         /// Adds a custom ITaskActivityContext implementation used by code generated from <see cref="AddActivityFunctionDeclaration"/>.
         /// </summary>

src/Generators/Generators.csproj

@@ -21,7 +21,6 @@
   <PropertyGroup>
     <!-- This file intentionally versions separately from the other packages. -->
     <VersionPrefix>1.0.0</VersionPrefix>
-    <VersionSuffix>preview.1</VersionSuffix>
   </PropertyGroup>
 
   <ItemGroup>