Introduce ResourceCreatingEvent #5359
Merged
Conversation
This file contains 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
dotnet-issue-labeler
bot
added
the
area-app-model
eerhardt
reviewed
Aug 20, 2024
radical
reviewed
Aug 20, 2024
tests/Aspire.Hosting.Tests/Eventing/DistributedApplicationBuilderEventingTests.cs
Show resolved
Hide resolved
radical
reviewed
Aug 20, 2024
tests/Aspire.Hosting.Tests/Eventing/DistributedApplicationBuilderEventingTests.cs
Show resolved
Hide resolved
davidfowl
reviewed
Aug 21, 2024
src/Aspire.Hosting.Azure/Provisioning/Provisioners/AzureProvisioner.cs
Outdated
Show resolved
Hide resolved
davidfowl
reviewed
Aug 21, 2024
…urceCreated/AfterResourceStarted.
mitchdenny
changed the title
…ove ResourceCreated/AfterResourceStarted." This reverts commit 058f25b.
eerhardt
reviewed
Aug 21, 2024
| /// Resources that are created by orchestrators may not yet be ready to handle requests. | ||
| /// </remarks> | ||
| [Experimental("ASPIREEVENTING001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")] | ||
| public class BeforeResourceStartedEvent(IResource resource, IServiceProvider services) : IDistributedApplicationResourceEvent |
There was a problem hiding this comment.
I think this name still violates the naming guidelines.
✔️ DO give events names with a concept of before and after, using the present and past tenses.
For example, a close event that is raised before a window is closed would be called Closing, and one that is raised after the window is closed would be called Closed.
❌ DO NOT use "Before" or "After" prefixes or postfixes to indicate pre- and post-events. Use present and past tenses as just described.
Suggested change
| public class BeforeResourceStartedEvent(IResource resource, IServiceProvider services) : IDistributedApplicationResourceEvent | |
| public class ResourceStartingEvent(IResource resource, IServiceProvider services) : IDistributedApplicationResourceEvent |
There was a problem hiding this comment.
Agree these names aren't 100% right. But we will be doing a follow up.
eerhardt
reviewed
Aug 21, 2024
| @@ -217,6 +220,9 @@ private async Task ProvisionAzureResources( | |||
|
|
|||
| private async Task ProcessResourceAsync(IConfiguration configuration, Lazy<Task<ProvisioningContext>> provisioningContextLazy, IAzureResource resource, CancellationToken cancellationToken) | |||
| { | |||
| var beforeResourceStartedEvent = new BeforeResourceStartedEvent(resource, serviceProvider); | |||
| await eventing.PublishAsync(beforeResourceStartedEvent, cancellationToken).ConfigureAwait(false); | |||
There was a problem hiding this comment.
Are there tests that can be written for the Azure provisioning event?
There was a problem hiding this comment.
That component isn't currently testable
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
This PR introduces a new eventing event
ResourceCreatingEvent. This work is related to enablingWaitFor` support.Fixes # (issue)
Checklist
<remarks />and<code />elements on your triple slash comments?Microsoft Reviewers: Open in CodeFlow