Interaction service #9943

JamesNK · 2025-06-18T22:12:23Z

Description

Adds InteractionService. Used to prompt the user in the dashboard (included in PR) or CLI (TBD future)

Addresses #9807

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire-docs issue (consider using one of the following templates):
- No

captainsafia · 2025-06-18T22:46:53Z

src/Aspire.Dashboard/Components/Dialogs/InteractionsInputDialog.razor

+
+<FluentDialogFooter>
+    <FluentButton Appearance="Appearance.Accent" OnClick="@SaveAsync">
+        Save


Do we need to localize these?

There will be some default button labels that are localized. But I also think there will be an option for customizing the button names from InteractionService.

src/Aspire.Hosting/ApplicationModel/InteractionService.cs

captainsafia · 2025-06-18T22:54:39Z

src/Aspire.Hosting/ApplicationModel/InteractionService.cs

+    }
+}
+
+public sealed class InteractionInput


In the future, do we think this is an abstract base class with concrete types for every supported output type?

IMO have one class and have all properties on it for different input types. Input types will ignore properties that don't apply to them, e.g. checkbox ignores required, text ignores options, etc.

src/Aspire.Hosting/ApplicationModel/InteractionService.cs

playground/TestShop/TestShop.AppHost/Program.cs

src/Aspire.Dashboard/Aspire.Dashboard.csproj

mitchdenny · 2025-06-19T00:29:57Z

Overall, this looks good. There is a few nits like the name of InteractionService which I think we need to change just to avoid confusion within the team. No strong opinions on the alternative name. I think it's worth getting this in sooner rather than later so we can all start experimenting with it.

We can come back with API refinements and alignment for publish/deploy prompting.

JamesNK · 2025-06-19T02:21:32Z

There is a few nits like the name of InteractionService which I think we need to change just to avoid confusion within the team.

I think this is a pretty good name for what this does, and developers will use this type a lot in aspire code.

What else is called InteractionService? Does it make more sense this type changing its name or the other interaction service?

davidfowl · 2025-06-19T02:45:27Z

We don’t have a way to mark the Proto as experimental so that’s a risk here. I’m looking to see how impactful this change is to mainline scenarios. Seems it shouldn’t have an impact unless called directly?

JamesNK · 2025-06-19T03:27:59Z

We don’t have a way to mark the Proto as experimental so that’s a risk here. I’m looking to see how impactful this change is to mainline scenarios. Seems it shouldn’t have an impact unless called directly?

Something to consider is if the new gRPC method isn't implemented. For example, dashboard is deployed to ACA but they never implement the interaction service.

gRPC throws a NotImplemented status so it's easy to detect. Just need to make sure the dashboard doesn't go into an endless retry loop if the server returns that status.

davidfowl · 2025-06-19T03:34:09Z

is there value in a capability check somewhere in the Proto?

maddymontaquila · 2025-06-19T17:30:48Z

src/Aspire.Hosting/ApplicationModel/InteractionService.cs

+    {
+        options ??= MessageBoxInteractionOptions.CreateDefault();
+        options.Icon ??= MessageBoxIcon.Question;
+        options.PrimaryButtonText ??= "Yes";


If our default title is "Confirm command" (and we want to follow the fluent guideliens to a T) these should prob be "Confirm" and "Cancel"
https://fluent2.microsoft.design/components/web/react/core/dialog/usage#content

I copied Yes/No from what FluentUI does. I agree it's a little odd. Ok/Cancel would probably be better defaults.

The text can easily be customized by user when displaying a confirmation.

OK/Cancel is good then!

maddymontaquila · 2025-06-19T17:33:29Z

src/Aspire.Dashboard/Components/Dialogs/InteractionsInputDialog.razor

+
+@inject IStringLocalizer<Dialogs> Loc
+
+<FluentDialogHeader ShowDismiss="true">


IMO we should put the icon next to the header since it looks awkward next to the body. Thoughts?

I'm using the built-in message box from FluentUI: https://www.fluentui-blazor.net/MessageBox. Moving the icon would require creating a custom dialog.

We could do it in the future, but for now I think the default is good enough.

Ooooh I was looking at DialogBox in docs. Fine by me!

maddymontaquila · 2025-06-19T18:58:25Z

Added a couple things in a non blocking review but two other questions -

Do we want to "special case" cancelations so it doesnt say Failure and just says "Command execution canceled by user" or smthn?

Same w the popup (says failed canceled)

Do we need this blocking confirmation you think or is the top notif okay? I totally defer to you on this but I could go either way!

JamesNK · 2025-06-19T22:55:13Z

I'm just experimenting and testing with the interaction service in the playground app commands.

davidfowl · 2025-06-20T01:51:05Z

A few more things we have to consider:

What happens during tests (We need to handle when the dashboard is disabled.)
We need some api to know if the service is available.

JamesNK · 2025-06-20T09:56:45Z

~~A select's input is grayed out even after selecting a value. I think it is a bug in FluentUI. See microsoft/fluentui-blazor#3940~~

Fixed by changing the select binding.

JamesNK · 2025-06-20T09:58:53Z

What happens during tests (We need to handle when the dashboard is disabled.)

I think we'll expose IInteractionService. Tests can mock it. We could do something like bunit does and offer a test implementation that you can register callbacks for.

We need some api to know if the service is available.

What situation's wouldn't it be available? Publishing?

davidfowl · 2025-06-20T14:33:51Z

What situation's wouldn't it be available? Publishing?

I'm thinking when the dashboard is disabled and this is running headless without a console. Interactivity is not available. We'll also have this problem when we back parameters with this.

davidfowl · 2025-06-21T05:37:06Z

I think this change is good but we need a bool on the InteractionService to know if it's available and we should tie that to if the dashboard is enable for now. We need to be able to code around this defensively without risk of it hanging in various situations.

davidfowl · 2025-06-21T05:38:31Z

src/Aspire.Hosting/ApplicationModel/InteractionService.cs

+    {
+        cancellationToken.ThrowIfCancellationRequested();
+
+        var inputList = inputs.ToList();


nit why not make the input IReadOnlyList<InteractionInput>?

src/Aspire.Hosting/ApplicationModel/InteractionService.cs

mitchdenny · 2025-06-23T01:29:35Z

🎉⌚

github-actions bot added the area-dashboard label Jun 18, 2025

JamesNK requested review from davidfowl, DamianEdwards, captainsafia, eerhardt, adamint, sebastienros, maddymontaquila and karolz-ms June 18, 2025 22:59

captainsafia reviewed Jun 18, 2025

View reviewed changes

mitchdenny reviewed Jun 19, 2025

View reviewed changes

playground/TestShop/TestShop.AppHost/Program.cs Outdated Show resolved Hide resolved

mitchdenny reviewed Jun 19, 2025

View reviewed changes

src/Aspire.Dashboard/Aspire.Dashboard.csproj Show resolved Hide resolved

mitchdenny approved these changes Jun 19, 2025

View reviewed changes

Add interaction service

fdd6668

JamesNK force-pushed the jamesnk/interaction-service branch from ba9c0a9 to fdd6668 Compare June 19, 2025 03:31

JamesNK added 3 commits June 19, 2025 12:35

Refactor

eedd8c4

Refactor

715190c

Refactor

cdf8f09

maddymontaquila reviewed Jun 19, 2025

View reviewed changes

JamesNK added 3 commits June 20, 2025 12:49

Message bar

3c2d4c2

Fix build

ff29d7e

Fixes

fdc91e4

JamesNK added 2 commits June 20, 2025 21:12

XML docs, fix select display

6316cef

HTML in message

0e88404

JamesNK added 3 commits June 20, 2025 22:52

Localize buttons, return false on messagebox secondary action

d6a5234

Force select position below

6a8d2d0

Fix test

7e59dba

davidfowl reviewed Jun 21, 2025

View reviewed changes

src/Aspire.Hosting/ApplicationModel/InteractionService.cs Show resolved Hide resolved

davidfowl reviewed Jun 21, 2025

View reviewed changes

src/Aspire.Hosting/ApplicationModel/InteractionService.cs Show resolved Hide resolved

JamesNK marked this pull request as ready for review June 22, 2025 06:18

davidfowl approved these changes Jun 22, 2025

View reviewed changes

JamesNK merged commit ff68c9c into main Jun 22, 2025
252 checks passed

JamesNK deleted the jamesnk/interaction-service branch June 22, 2025 07:00

MihuBot mentioned this pull request Jun 24, 2025

[✨ Triage] dotnet/aspire#10013 by JamesNK - Darken dialogs displayed in dashboard darkmode MihuBot/runtime-utils#1154

Open


		@inject IStringLocalizer<Dialogs> Loc

		<FluentDialogHeader ShowDismiss="true">

Interaction service #9943

Interaction service #9943

Uh oh!

Conversation

JamesNK commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JamesNK Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JamesNK Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mitchdenny commented Jun 19, 2025

Uh oh!

JamesNK commented Jun 19, 2025

Uh oh!

davidfowl commented Jun 19, 2025

Uh oh!

JamesNK commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidfowl commented Jun 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maddymontaquila commented Jun 19, 2025

Uh oh!

JamesNK commented Jun 19, 2025

Uh oh!

davidfowl commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JamesNK commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JamesNK commented Jun 20, 2025

Uh oh!

davidfowl commented Jun 20, 2025

Uh oh!

davidfowl commented Jun 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mitchdenny commented Jun 23, 2025

Uh oh!

Uh oh!

JamesNK commented Jun 18, 2025 •

edited

Loading

JamesNK Jun 18, 2025 •

edited

Loading

JamesNK Jun 18, 2025 •

edited

Loading

JamesNK commented Jun 19, 2025 •

edited

Loading

davidfowl commented Jun 20, 2025 •

edited

Loading

JamesNK commented Jun 20, 2025 •

edited

Loading