Dapr - Update lifecycle hook to propagate WaitAnnotations #1078
Conversation
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
Contributor
Author
|
@dotnet-policy-service agree |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds WaitAnnotation propagation from resources to their Dapr sidecars and CLI components, ensuring that dependencies specified with .WaitFor() are properly respected by Dapr infrastructure. This addresses issue #1073.
Key Changes
- Lifecycle hook now propagates WaitAnnotations from parent resources to Dapr sidecar resources
- Lifecycle hook now propagates WaitAnnotations from parent resources to Dapr CLI executable resources
- Added comprehensive unit tests covering scenarios with no WaitAnnotations, single WaitAnnotation, and multiple WaitAnnotations
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/CommunityToolkit.Aspire.Hosting.Dapr/DaprDistributedApplicationLifecycleHook.cs |
Added WaitAnnotation propagation logic at lines 64-71 (sidecar) and 216-223 (CLI) to copy wait dependencies from parent resources |
tests/CommunityToolkit.Aspire.Hosting.Dapr.Tests/WithDaprSidecarTests.cs |
Removed unused import and added three unit tests to verify WaitAnnotation handling in different scenarios |
Comment on lines
+114
to
+180
| [Fact] | ||
| public void ResourceWithDaprSidecarAndNoWaitAnnotations_CreatesBasicSidecar() | ||
| { | ||
| var builder = DistributedApplication.CreateBuilder(); | ||
|
|
||
| var app = builder.AddProject<Projects.CommunityToolkit_Aspire_Hosting_Dapr_ServiceA>("test") | ||
| .WithDaprSidecar(); | ||
|
|
||
| // Verify no wait annotations on the main resource | ||
| Assert.Empty(app.Resource.Annotations.OfType<WaitAnnotation>()); | ||
|
|
||
| // Verify the sidecar resource exists | ||
| var sidecarResource = Assert.Single(builder.Resources.OfType<DaprSidecarResource>()); | ||
|
|
||
| // Verify the sidecar is properly linked | ||
| var sidecarAnnotation = Assert.Single(app.Resource.Annotations.OfType<DaprSidecarAnnotation>()); | ||
| Assert.Equal(sidecarResource, sidecarAnnotation.Sidecar); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void ResourceWithWaitAnnotationAndDaprSidecar_SetsUpCorrectDependencies() | ||
| { | ||
| var builder = DistributedApplication.CreateBuilder(); | ||
|
|
||
| var database = builder.AddContainer("db", "postgres"); | ||
|
|
||
| var app = builder.AddProject<Projects.CommunityToolkit_Aspire_Hosting_Dapr_ServiceA>("test") | ||
| .WaitFor(database) | ||
| .WithDaprSidecar(); | ||
|
|
||
| // Verify the main resource has the wait annotation | ||
| var waitAnnotation = Assert.Single(app.Resource.Annotations.OfType<WaitAnnotation>()); | ||
| Assert.Equal("db", waitAnnotation.Resource.Name); | ||
|
|
||
| // Verify the sidecar resource exists | ||
| var sidecarResource = Assert.Single(builder.Resources.OfType<DaprSidecarResource>()); | ||
| Assert.NotNull(sidecarResource); | ||
|
|
||
| // The actual propagation happens in the lifecycle hook, but we can verify the setup is correct | ||
| var sidecarAnnotation = Assert.Single(app.Resource.Annotations.OfType<DaprSidecarAnnotation>()); | ||
| Assert.Equal(sidecarResource, sidecarAnnotation.Sidecar); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void ResourceWithMultipleWaitAnnotationsAndDaprSidecar_HasAllWaitDependencies() | ||
| { | ||
| var builder = DistributedApplication.CreateBuilder(); | ||
|
|
||
| var database = builder.AddContainer("db", "postgres"); | ||
| var redis = builder.AddContainer("cache", "redis"); | ||
|
|
||
| var app = builder.AddProject<Projects.CommunityToolkit_Aspire_Hosting_Dapr_ServiceA>("test") | ||
| .WaitFor(database) | ||
| .WaitFor(redis) | ||
| .WithDaprSidecar(); | ||
|
|
||
| // Verify the main resource has both wait annotations | ||
| var waitAnnotations = app.Resource.Annotations.OfType<WaitAnnotation>().ToList(); | ||
| Assert.Equal(2, waitAnnotations.Count); | ||
| Assert.Contains(waitAnnotations, w => w.Resource.Name == "db"); | ||
| Assert.Contains(waitAnnotations, w => w.Resource.Name == "cache"); | ||
|
|
||
| // Verify the sidecar resource exists and is properly linked | ||
| var sidecarResource = Assert.Single(builder.Resources.OfType<DaprSidecarResource>()); | ||
| var sidecarAnnotation = Assert.Single(app.Resource.Annotations.OfType<DaprSidecarAnnotation>()); | ||
| Assert.Equal(sidecarResource, sidecarAnnotation.Sidecar); | ||
| } |
There was a problem hiding this comment.
The tests verify the setup of WaitAnnotations on the main resource but do not verify that these annotations are actually propagated to the Dapr sidecar and CLI resources during lifecycle hook execution. Consider adding an integration test that calls app.Build() and app.StartAsync() to verify that the lifecycle hook properly propagates WaitAnnotations to the sidecar and CLI resources. This would ensure the propagation logic works as expected at runtime.
This was referenced Jan 14, 2026
Bump CommunityToolkit.Aspire.Hosting.Flagd from 13.0.0 to 13.1.0
askpt/openfeature-aspire-sample#270
Closed
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #1073
PR Checklist