No urls in the CustomResources.AppHost dashboard

[johanpolson]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

in the csproj CustomResources.AppHost
in the file playground\CustomResources\CustomResources.AppHost\TalkingClockResource.cs
i see

.WithUrl("https://www.speaking-clock.com/", "Speaking Clock")

But when I run the example I get no urls in the dashboard.

Expected Behavior

No response

Steps To Reproduce

No response

Exceptions (if any)

No response

.NET Version info

No response

Anything else?

No response

[mitchdenny]

@DamianEdwards

[davidfowl]

It’s because it’s not firing the endpoints allocated event. Hmm @DamianEdwards that changed in the kast PR, I’m not sure it makes sense to be required here though

[DamianEdwards]

@davidfowl which is the change that made this stop working? Why did we stop firing the endpoints allocated event for resources without endpoints?

[davidfowl]

The problem is this logic

aspire/src/Aspire.Hosting/Orchestrator/ApplicationOrchestrator.cs

Lines 119 to 129 in 9e4ed4f

	IEnumerable<UrlSnapshot> urls = [];
	if (resource.TryGetUrls(out var resourceUrls))
	{
	urls = resourceUrls.Select(url => new UrlSnapshot(Name: url.Endpoint?.EndpointName, Url: url.Url, IsInternal: url.DisplayLocation == UrlDisplayLocation.DetailsOnly)
	{
	IsInactive = true,
	DisplayProperties = new(url.DisplayText ?? "", url.DisplayOrder ?? 0)
	});
	}
	await _notificationService.PublishUpdateAsync(resource, s => s with { Urls = [.. urls] }).ConfigureAwait(false);

, this part needs to happen again in BeforeResourceStart

[DamianEdwards]

Ah, they get initialized as IsInactive = true which means they don't show in the dashboard. They don't get moved to IsInactive = false at any point right now. Also if the resource has no lifetime, they should likely be initialized as IsInactive = false.

[DamianEdwards]

This is going to require a bigger change. New changes:

• Process callbacks for non-endpoint URLs for all resources in a new InitializeResource handler, unless a new bool property on ResourceUrlAnnotation is set to true that defers this processing until AfterResourceEndpointsAllocated
• Stop publishing the AfterResourceEndpointsAllocated for custom controlled resources
• Custom resources with endpoints are now responsible for publishing the AfterResourceEndpointsAllocated event for themselves
• Process callbacks for endpoint URLs in the AfterResourceEndpointsAllocated event handler and set IsInactive to true for DCP controlled resources

[DamianEdwards]

Upon more investigation, the plans above won't work as is, as URL specification is all done through registered callbacks at the lowest layer and they can only be run once (similar to how resource environment variables work). Some URLs maybe depend on endpoints (indeed all endpoints get a URL created for them automatically before the URL callbacks are run) so the one time callbacks are run has to be after endpoints are allocated.

New idea:

• URL processing happens like it does today (in the ResourceEndpointsAllocatedEvent handler) but only endpoint URLs are initialized as inactive. Non-endpoint URLs will get initialized as active and will thus show up in the dashboard immediately.
• For DCP controlled resources, the endpoint URLs will be marked active once DCP service metadata indicates the endpoint is active
• For custom resources, it's up to the resource to mark endpoint URLs active sometime after the ResourceEndpointsAllocatedEvent event is fired.