Merge branch 'main' into stevosyan/add-tags-to-create-sub-proto

Author: Sophia Tevosyan

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## v1.17.2
+## v1.18.0
 - Add taskentity support to durabletasksourcegenerator by Copilot ([#517](https://github.com/microsoft/durabletask-dotnet/pull/517))
 - Bump azure.identity by dependabot[bot] ([#525](https://github.com/microsoft/durabletask-dotnet/pull/525))
 - Bump google.protobuf by dependabot[bot] ([#529](https://github.com/microsoft/durabletask-dotnet/pull/529))

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>
 ```
 

eng/targets/Release.props

@@ -17,7 +17,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>1.17.2</VersionPrefix>
+    <VersionPrefix>1.18.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
   </PropertyGroup>
 

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)
     {