-
Notifications
You must be signed in to change notification settings - Fork 53
Improve DurableTask source generator detection and add optional project type configuration #575
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.
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
+663
−12
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
8380c39
Initial plan
Copilot 08e6afe
Add DurableTaskGeneratorProjectType configuration option
Copilot e1488de
Add documentation for DurableTaskGeneratorProjectType configuration
Copilot b0d5222
Refactor project type checking to use HashSet for better maintainability
Copilot cbdc3b9
Simplify project type configuration to use Functions and Standalone m…
Copilot 9786732
Resolve merge conflicts with main branch
Copilot 9f38141
Merge branch 'main' into copilot/add-project-type-option
YunchuWang 4e50616
Improve project type detection to check for Azure Functions trigger a…
Copilot ca15e79
Update src/Generators/DurableTaskSourceGenerator.cs
YunchuWang c22adcc
Add tests for null projectType (default behavior)
Copilot f7f328c
Add test for auto-detection via trigger attributes
Copilot 311d8fe
Merge branch 'main' into copilot/add-project-type-option
YunchuWang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,63 @@ | ||
| Source generators for `Microsoft.DurableTask` | ||
|
|
||
| ## Overview | ||
|
|
||
| The `Microsoft.DurableTask.Generators` package provides source generators that automatically generate type-safe extension methods for orchestrators and activities. The generator automatically detects whether you're using Azure Functions or the Durable Task Scheduler and generates appropriate code for your environment. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Project Type Detection | ||
|
|
||
| The generator uses intelligent automatic detection to determine the project type: | ||
|
|
||
| 1. **Primary Detection**: Checks for Azure Functions trigger attributes (`OrchestrationTrigger`, `ActivityTrigger`, `EntityTrigger`) in your code | ||
| - If any methods use these trigger attributes, it generates Azure Functions-specific code | ||
| - Otherwise, it generates standalone Durable Task Worker code | ||
|
|
||
| 2. **Fallback Detection**: If no trigger attributes are found, checks if `Microsoft.Azure.Functions.Worker.Extensions.DurableTask` is referenced | ||
| - This handles projects that reference the Functions package but haven't defined triggers yet | ||
|
|
||
| This automatic detection solves the common issue where transitive dependencies on Functions packages would incorrectly trigger Functions mode even when not using Azure Functions. | ||
|
|
||
| ### Explicit Project Type Configuration (Optional) | ||
|
|
||
| In rare scenarios where you need to override the automatic detection, you can explicitly configure the project type using the `DurableTaskGeneratorProjectType` MSBuild property in your `.csproj` file: | ||
|
|
||
| ```xml | ||
| <PropertyGroup> | ||
| <DurableTaskGeneratorProjectType>Standalone</DurableTaskGeneratorProjectType> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| #### Supported Values | ||
|
|
||
| - `Auto` (default): Automatically detects project type using the intelligent detection described above | ||
| - `Functions`: Forces generation of Azure Functions-specific code | ||
| - `Standalone`: Forces generation of standalone Durable Task Worker code (includes `AddAllGeneratedTasks` method) | ||
|
|
||
| #### Example: Force Standalone Mode | ||
|
|
||
| ```xml | ||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||
| <PropertyGroup> | ||
| <TargetFramework>net8.0</TargetFramework> | ||
| <DurableTaskGeneratorProjectType>Standalone</DurableTaskGeneratorProjectType> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.DurableTask.Generators" OutputItemType="Analyzer" /> | ||
| <!-- Your other package references --> | ||
| </ItemGroup> | ||
| </Project> | ||
| ``` | ||
|
|
||
| With standalone mode, the generator produces the `AddAllGeneratedTasks` extension method for worker registration: | ||
|
|
||
| ```csharp | ||
| builder.Services.AddDurableTaskWorker(builder => | ||
| { | ||
| builder.AddTasks(r => r.AddAllGeneratedTasks()); | ||
| }); | ||
| ``` | ||
|
|
||
| For more information, see https://github.com/microsoft/durabletask-dotnet |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: This still makes me so sad 😅 You don't need to change it, just wanted to be sad about it :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is surely a beast.