Skip to content

Add TaskEntity support to DurableTaskSourceGenerator #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
torosent merged 8 commits into from
Dec 5, 2025
Merged

Add TaskEntity support to DurableTaskSourceGenerator #517

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c5e7c0
Initial plan
Copilot Dec 2, 2025
861a007
Add TaskEntity support to DurableTaskSourceGenerator
Copilot Dec 2, 2025
5abe338
func entity sourcegen support
YunchuWang Dec 3, 2025
27b5776
Merge branch 'main' into copilot/fix-taskentity-source-generator
YunchuWang Dec 3, 2025
27bb55b
unskip and fix func source gen tests
YunchuWang Dec 3, 2025
cf0ef4a
Merge branch 'main' into copilot/fix-taskentity-source-generator
YunchuWang Dec 5, 2025
45b5864
update build pkg props
YunchuWang Dec 5, 2025
43b873b
last line
YunchuWang Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,28 @@

<!-- Microsoft.Extensions.* Packages -->
<ItemGroup>
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="8.0.1" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="8.0.0" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.1" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.2" />
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="8.0.1" />
<PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.1" />
<PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.2" />
<PackageVersion Include="Microsoft.Extensions.Options" Version="8.0.2" />
<PackageVersion Include="Microsoft.Extensions.Options.DataAnnotations" Version="8.0.0" />
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Options" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Options.DataAnnotations" Version="10.0.0" />
</ItemGroup>

<!-- Azure.* Packages -->
<ItemGroup>
<PackageVersion Include="Azure.Identity" Version="1.17.1" />
<PackageVersion Include="Azure.Storage.Blobs" Version="12.26.0" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker" Version="2.2.0" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker" Version="2.51.0" />
</ItemGroup>

<!-- DurableTask Packages -->
<ItemGroup>
<PackageVersion Include="Microsoft.Azure.DurableTask.Core" Version="3.6.0" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.DurableTask" Version="1.2.2" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.DurableTask" Version="1.10.0" />
</ItemGroup>

<!-- Grpc / Protobuf Packages -->
Expand Down Expand Up @@ -80,10 +80,11 @@
<PackageVersion Include="DotNext" Version="4.13.1" Condition="'$(TargetFramework)' != 'net8.0' AND '$(TargetFramework)' != 'net10.0'" />
<PackageVersion Include="DotNext" Version="5.19.0" Condition="'$(TargetFramework)' == 'net8.0' OR '$(TargetFramework)' == 'net10.0'" />
<PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
<PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
<PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="10.0.0" />
<PackageVersion Include="System.Linq.Async" Version="6.0.1" />
<PackageVersion Include="System.Text.Json" Version="8.0.5" />
<PackageVersion Include="System.Text.Json" Version="10.0.0" />
<PackageVersion Include="System.Collections.Immutable" Version="8.0.0" />
</ItemGroup>

</Project>

5 changes: 3 additions & 2 deletions src/Abstractions/DurableTaskAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ namespace Microsoft.DurableTask;
/// </summary>
/// <remarks>
/// This attribute is meant to be used on class definitions that derive from
/// <see cref="TaskOrchestrator{TInput, TOutput}"/> or <see cref="TaskActivity{TInput, TOutput}"/>.
/// <see cref="TaskOrchestrator{TInput, TOutput}"/>, <see cref="TaskActivity{TInput, TOutput}"/>,
/// or TaskEntity{TState} from the Microsoft.DurableTask.Entities namespace.
/// It is used specifically by build-time source generators to generate type-safe methods for invoking
/// orchestrations or activities.
/// orchestrations, activities, or registering entities.
/// </remarks>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class DurableTaskAttribute : Attribute
Expand Down
3 changes: 2 additions & 1 deletion src/Generators/AzureFunctions/DurableFunction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ public enum DurableFunctionKind
{
Unknown,
Orchestration,
Activity
Activity,
Entity
}

public class DurableFunction
Expand Down
9 changes: 8 additions & 1 deletion src/Generators/AzureFunctions/SyntaxNodeUtility.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ public static bool TryGetFunctionKind(MethodDeclarationSyntax method, out Durabl
kind = DurableFunctionKind.Activity;
return true;
}

if (attribute.ToString().Equals("EntityTrigger", StringComparison.Ordinal))
{
kind = DurableFunctionKind.Entity;
return true;
}
}
}

Expand Down Expand Up @@ -125,7 +131,8 @@ public static bool TryGetParameter(
{
string attributeName = attribute.Name.ToString();
if ((kind == DurableFunctionKind.Activity && attributeName == "ActivityTrigger") ||
(kind == DurableFunctionKind.Orchestration && attributeName == "OrchestratorTrigger"))
(kind == DurableFunctionKind.Orchestration && attributeName == "OrchestratorTrigger") ||
(kind == DurableFunctionKind.Entity && attributeName == "EntityTrigger"))
{
TypeInfo info = model.GetTypeInfo(methodParam.Type);
if (info.Type is INamedTypeSymbol named)
Expand Down
99 changes: 80 additions & 19 deletions src/Generators/DurableTaskSourceGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public void Initialize(IncrementalGeneratorInitializationContext context)

string className = classType.ToDisplayString();
INamedTypeSymbol? taskType = null;
bool isActivity = false;
DurableTaskKind kind = DurableTaskKind.Orchestrator;

INamedTypeSymbol? baseType = classType.BaseType;
while (baseType != null)
Expand All @@ -105,27 +105,51 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
if (baseType.Name == "TaskActivity")
{
taskType = baseType;
isActivity = true;
kind = DurableTaskKind.Activity;
break;
}
else if (baseType.Name == "TaskOrchestrator")
{
taskType = baseType;
isActivity = false;
kind = DurableTaskKind.Orchestrator;
break;
}
else if (baseType.Name == "TaskEntity")
{
taskType = baseType;
kind = DurableTaskKind.Entity;
break;
}
}

baseType = baseType.BaseType;
}

if (taskType == null || taskType.TypeParameters.Length <= 1)
// TaskEntity has 1 type parameter (TState), while TaskActivity and TaskOrchestrator have 2 (TInput, TOutput)
if (taskType == null)
{
return null;
}

ITypeSymbol inputType = taskType.TypeArguments.First();
ITypeSymbol outputType = taskType.TypeArguments.Last();
if (kind == DurableTaskKind.Entity)
{
// Entity only has a single TState type parameter
if (taskType.TypeParameters.Length < 1)
{
return null;
}
}
else
{
// Orchestrator and Activity have TInput and TOutput type parameters
if (taskType.TypeParameters.Length <= 1)
{
return null;
}
}

ITypeSymbol? inputType = kind == DurableTaskKind.Entity ? null : taskType.TypeArguments.First();
ITypeSymbol? outputType = kind == DurableTaskKind.Entity ? null : taskType.TypeArguments.Last();

string taskName = classType.Name;
if (attribute.ArgumentList?.Arguments.Count > 0)
Expand All @@ -134,7 +158,7 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
taskName = context.SemanticModel.GetConstantValue(expression).ToString();
}

return new DurableTaskTypeInfo(className, taskName, inputType, outputType, isActivity);
return new DurableTaskTypeInfo(className, taskName, inputType, outputType, kind);
}

static DurableFunction? GetDurableFunction(GeneratorSyntaxContext context)
Expand Down Expand Up @@ -165,23 +189,28 @@ static void Execute(
bool isDurableFunctions = compilation.ReferencedAssemblyNames.Any(
assembly => assembly.Name.Equals("Microsoft.Azure.Functions.Worker.Extensions.DurableTask", StringComparison.OrdinalIgnoreCase));

// Separate tasks into orchestrators and activities
// Separate tasks into orchestrators, activities, and entities
List<DurableTaskTypeInfo> orchestrators = new();
List<DurableTaskTypeInfo> activities = new();
List<DurableTaskTypeInfo> entities = new();

foreach (DurableTaskTypeInfo task in allTasks)
{
if (task.IsActivity)
{
activities.Add(task);
}
else if (task.IsEntity)
{
entities.Add(task);
}
else
{
orchestrators.Add(task);
}
}

int found = activities.Count + orchestrators.Count + allFunctions.Length;
int found = activities.Count + orchestrators.Count + entities.Count + allFunctions.Length;
if (found == 0)
{
return;
Expand Down Expand Up @@ -264,7 +293,8 @@ public static class GeneratedDurableTaskExtensions
AddRegistrationMethodForAllTasks(
sourceBuilder,
orchestrators,
activities);
activities,
entities);
}

sourceBuilder.AppendLine(" }").AppendLine("}");
Expand Down Expand Up @@ -368,7 +398,8 @@ public GeneratedActivityContext(TaskName name, string instanceId)
static void AddRegistrationMethodForAllTasks(
StringBuilder sourceBuilder,
IEnumerable<DurableTaskTypeInfo> orchestrators,
IEnumerable<DurableTaskTypeInfo> activities)
IEnumerable<DurableTaskTypeInfo> activities,
IEnumerable<DurableTaskTypeInfo> entities)
{
// internal so it does not conflict with other projects with this generated file.
sourceBuilder.Append($@"
Expand All @@ -387,39 +418,69 @@ internal static DurableTaskRegistry AddAllGeneratedTasks(this DurableTaskRegistr
builder.AddActivity<{taskInfo.TypeName}>();");
}

foreach (DurableTaskTypeInfo taskInfo in entities)
{
sourceBuilder.Append($@"
builder.AddEntity<{taskInfo.TypeName}>();");
}

sourceBuilder.AppendLine($@"
return builder;
}}");
}

enum DurableTaskKind
{
Orchestrator,
Activity,
Entity
}

class DurableTaskTypeInfo
{
public DurableTaskTypeInfo(
string taskType,
string taskName,
ITypeSymbol? inputType,
ITypeSymbol? outputType,
bool isActivity)
DurableTaskKind kind)
{
this.TypeName = taskType;
this.TaskName = taskName;
this.InputType = GetRenderedTypeExpression(inputType);
this.InputParameter = this.InputType + " input";
if (this.InputType[this.InputType.Length - 1] == '?')
this.Kind = kind;

// Entities only have a state type parameter, not input/output
if (kind == DurableTaskKind.Entity)
{
this.InputParameter += " = default";
this.InputType = string.Empty;
this.InputParameter = string.Empty;
this.OutputType = string.Empty;
}
else
{
this.InputType = GetRenderedTypeExpression(inputType);
this.InputParameter = this.InputType + " input";
if (this.InputType[this.InputType.Length - 1] == '?')
{
this.InputParameter += " = default";
}

this.OutputType = GetRenderedTypeExpression(outputType);
this.IsActivity = isActivity;
this.OutputType = GetRenderedTypeExpression(outputType);
}
}

public string TypeName { get; }
public string TaskName { get; }
public string InputType { get; }
public string InputParameter { get; }
public string OutputType { get; }
public bool IsActivity { get; }
public DurableTaskKind Kind { get; }

public bool IsActivity => this.Kind == DurableTaskKind.Activity;

public bool IsOrchestrator => this.Kind == DurableTaskKind.Orchestrator;

public bool IsEntity => this.Kind == DurableTaskKind.Entity;

static string GetRenderedTypeExpression(ITypeSymbol? symbol)
{
Expand Down
Loading
Loading